KaminoVaultProtocolSolana

Defined in: protocol-lending-kamino-solana/src/vault.ts:98

A Kamino Earn vault (kVault) as a LendingProtocol: supply deposits the vault’s asset for shares (kept in the wallet; staked in the vault farm with skipFarm: false), withdraw redeems shares for the asset; borrow / repay reject, a vault does not lend to its depositors.

The transaction comes from Kamino’s API and is signed only after the wallet’s guard proves it carries only the instructions the operation takes, on this vault and the wallet’s own accounts, and moves exactly the declared balances (the deposit out, the asset in at the minimum, no other token account touched). The bounds come from the chain: the share price from the vault’s state and its reserves, the position from the wallet’s shares account and farm stake; the API’s price must agree with it. Reads (getVault, getPosition, APY, TVL) are the API’s.

Extends

KaminoBase<KaminoVaultConfig>

Constructors

Constructor

new KaminoVaultProtocolSolana(account, config): KaminoVaultProtocolSolana

Defined in: protocol-lending-kamino-solana/src/vault.ts:102

Parameters

account

IWalletAccountReadOnly | IWalletAccount

config

KaminoVaultConfig

Returns

KaminoVaultProtocolSolana

Overrides

KaminoBase.constructor

Properties

_account

protected readonly _account: IWalletAccountReadOnly | IWalletAccount

Defined in: core/dist/index-QWdcwE6y.d.ts:309

Inherited from

KaminoBase._account

_config

protected readonly _config: KaminoVaultConfig

Defined in: core/dist/index-QWdcwE6y.d.ts:310

Inherited from

KaminoBase._config

api

readonly api: KaminoApi

Defined in: protocol-lending-kamino-solana/src/base.ts:72

Inherited from

KaminoBase.api

rentAllowance

protected readonly rentAllowance: bigint

Defined in: protocol-lending-kamino-solana/src/base.ts:74

Inherited from

KaminoBase.rentAllowance

slippageBps

protected readonly slippageBps: number

Defined in: protocol-lending-kamino-solana/src/base.ts:73

Inherited from

KaminoBase.slippageBps

vault

readonly vault: string

Defined in: protocol-lending-kamino-solana/src/vault.ts:99

Methods

borrow()

borrow(): Promise<LendingResult>

Defined in: protocol-lending-kamino-solana/src/vault.ts:310

Borrow against collateral.

Returns

Promise<LendingResult>

Overrides

KaminoBase.borrow

decimals()

protected decimals(mint): Promise<number>

Defined in: protocol-lending-kamino-solana/src/base.ts:104

Mint decimals: the account reads the mint when it can; well-known mints need no RPC.

Parameters

mint

string

Returns

Promise<number>

Inherited from

KaminoBase.decimals

describeActivity()

describeActivity(_tx, _ctx): ActivityItem | null

Defined in: core/dist/index-QWdcwE6y.d.ts:320

Recognize one of this protocol’s own transactions in an address’s history and describe it for the wallet’s activity feed (“Supplied 100 USDC · Aave v3”). Return null when the transaction is not this protocol’s: the kit then asks the next module and finally falls back to send / receive / approve / contract call. Must be pure and synchronous: no network, no account state. The conformance suite feeds every module its recorded fixtures through this method.

Parameters

_tx

ChainTx

_ctx

DescribeActivityContext

Returns

ActivityItem | null

Inherited from

KaminoBase.describeActivity

getApy()

getApy(): Promise<number>

Defined in: protocol-lending-kamino-solana/src/vault.ts:164

Net APY in percent.

Returns

Promise<number>

getPosition()

getPosition(): Promise<VaultPosition>

Defined in: protocol-lending-kamino-solana/src/vault.ts:169

Shares (wallet + farm) and what they are worth now.

Returns

Promise<VaultPosition>

getVault()

getVault(): Promise<VaultInfo>

Defined in: protocol-lending-kamino-solana/src/vault.ts:158

The vault as the API describes it: asset, shares, rate, fees, TVL.

Returns

Promise<VaultInfo>

guard()

protected guard(expect, instructions): SerializedGuard

Defined in: protocol-lending-kamino-solana/src/base.ts:121

Parameters

me()

protected me(): Promise<string>

Defined in: protocol-lending-kamino-solana/src/base.ts:98

Returns

Promise<string>

Inherited from

KaminoBase.me

memo()

protected memo(): string | undefined

Defined in: protocol-lending-kamino-solana/src/base.ts:169

Returns

string | undefined

Inherited from

KaminoBase.memo

quoteBorrow()

quoteBorrow(): Promise<LendingQuote>

Defined in: protocol-lending-kamino-solana/src/vault.ts:311

Network fee of borrow.

Returns

Promise<LendingQuote>

Overrides

KaminoBase.quoteBorrow

quoteBuilt()

protected quoteBuilt(base64, expect, instructions): Promise<{ fee: bigint; }>

Defined in: protocol-lending-kamino-solana/src/base.ts:153

Simulate the built transaction through the account’s guard and return its fee; nothing is signed.

Parameters

base64

string

expect

Expectation

instructions

readonly InstructionRule[]

Returns

Promise<{ fee: bigint; }>

Inherited from

KaminoBase.quoteBuilt

quoteRepay()

quoteRepay(): Promise<LendingQuote>

Defined in: protocol-lending-kamino-solana/src/vault.ts:313

Network fee of repay.

Returns

Promise<LendingQuote>

Overrides

KaminoBase.quoteRepay

quoteSupply()

quoteSupply(o): Promise<VaultSupplyQuote>

Defined in: protocol-lending-kamino-solana/src/vault.ts:250

Network fee of supply.

Parameters

o

KaminoVaultSupplyOptions

Returns

Promise<VaultSupplyQuote>

Overrides

KaminoBase.quoteSupply

quoteWithdraw()

quoteWithdraw(o): Promise<VaultWithdrawQuote>

Defined in: protocol-lending-kamino-solana/src/vault.ts:295

Network fee of withdraw.

Parameters

o

KaminoVaultWithdrawOptions

Returns

Promise<VaultWithdrawQuote>

Overrides

KaminoBase.quoteWithdraw

readChain()

protected readChain(addresses): Promise<(ChainAccount | null)[]>

Defined in: protocol-lending-kamino-solana/src/base.ts:127

Accounts from the chain through the wallet’s RPC, in the order asked (null where none exists).

Parameters

addresses

readonly string[]

Returns

Promise<(ChainAccount | null)[]>

Inherited from

KaminoBase.readChain

receiveExpectation()

protected receiveExpectation(mint, expected, extraLamports?, max?): Expectation

Defined in: protocol-lending-kamino-solana/src/base.ts:146

The wallet must receive at least expected × (1 − slippage) of mint (and at most max, when given); rent is the only SOL it may lose.

Parameters

mint

string

expected

bigint

extraLamports?

bigint = 0n

max?

bigint

Returns

Expectation

Inherited from

KaminoBase.receiveExpectation

repay()

repay(): Promise<LendingResult>

Defined in: protocol-lending-kamino-solana/src/vault.ts:312

Repay a borrow.

Returns

Promise<LendingResult>

Overrides

KaminoBase.repay

requireSigningAccount()

protected requireSigningAccount(methodName): IWalletAccount

Defined in: core/dist/index-QWdcwE6y.d.ts:322

The account, narrowed to a signing one, or a ReadOnlyAccountError naming the caller.

Parameters

methodName

string

Returns

IWalletAccount

Inherited from

KaminoBase.requireSigningAccount

requireSolana()

protected requireSolana(): void

Defined in: protocol-lending-kamino-solana/src/base.ts:89

Refuse anything that is not a mainnet Solana account before an API call is made in its name.

Returns

void

Inherited from

KaminoBase.requireSolana

sendBuilt()

protected sendBuilt(base64, expect, instructions, method): Promise<{ fee: bigint; hash: string; }>

Defined in: protocol-lending-kamino-solana/src/base.ts:161

Guard, sign and broadcast the built transaction; the account refuses before signing if the proof fails.

Parameters

base64

string

expect

Expectation

instructions

readonly InstructionRule[]

method

string

Returns

Promise<{ fee: bigint; hash: string; }>

Inherited from

KaminoBase.sendBuilt

spendExpectation()

protected spendExpectation(mint, amount, extraLamports?): Expectation

Defined in: protocol-lending-kamino-solana/src/base.ts:136

The wallet sends amount of mint (SOL counts on the lamport side) and may lose rent on top.

Parameters

mint

string

amount

bigint

extraLamports?

bigint = 0n

Returns

Expectation

Inherited from

KaminoBase.spendExpectation

state()

protected state(): Promise<ApiVault>

Defined in: protocol-lending-kamino-solana/src/vault.ts:119

The vault’s static state (cached per instance), checked against what the API cannot choose: it is this vault, on the kVault program, its shares mint is the one the program derives for it, and it takes the configured asset. Mint decimals come from the chain when the account can read them (round 3, H7: a changed sharesMint turned the withdraw guard into a pass for any token).