KaminoApi
Defined in: protocol-lending-kamino-solana/src/api.ts:112
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KaminoApi(
endpoint?,fetchImpl?,timeoutMs?):KaminoApi
Defined in: protocol-lending-kamino-solana/src/api.ts:114
timeoutMs bounds each call (default 15 s): a silent API must not hang a read or a write’s build.
Parameters
Section titled “Parameters”endpoint?
Section titled “endpoint?”string = KAMINO_API
fetchImpl?
Section titled “fetchImpl?”{(input, init?): Promise<Response>; (input, init?): Promise<Response>; }
timeoutMs?
Section titled “timeoutMs?”number = 15_000
Returns
Section titled “Returns”KaminoApi
Methods
Section titled “Methods”buildLendBorrow()
Section titled “buildLendBorrow()”buildLendBorrow(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:251
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
buildLendDeposit()
Section titled “buildLendDeposit()”buildLendDeposit(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:249
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
buildLendRepay()
Section titled “buildLendRepay()”buildLendRepay(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:252
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
buildLendWithdraw()
Section titled “buildLendWithdraw()”buildLendWithdraw(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:250
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
buildVaultDeposit()
Section titled “buildVaultDeposit()”buildVaultDeposit(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:246
Base64 unsigned v0 transaction: deposit amount (decimal, token units) into an Earn vault.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
buildVaultWithdraw()
Section titled “buildVaultWithdraw()”buildVaultWithdraw(
p):Promise<string>
Defined in: protocol-lending-kamino-solana/src/api.ts:248
Base64 unsigned v0 transaction: redeem amount SHARES (decimal).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<string>
getReserves()
Section titled “getReserves()”getReserves(
market):Promise<ApiReserve[]>
Defined in: protocol-lending-kamino-solana/src/api.ts:154
A market’s reserves with live rates.
Parameters
Section titled “Parameters”market
Section titled “market”string
Returns
Section titled “Returns”Promise<ApiReserve[]>
getUserObligations()
Section titled “getUserObligations()”getUserObligations(
market,user):Promise<ApiObligation[]>
Defined in: protocol-lending-kamino-solana/src/api.ts:231
The user’s obligations (loans) in a market.
Parameters
Section titled “Parameters”market
Section titled “market”string
string
Returns
Section titled “Returns”Promise<ApiObligation[]>
getVault()
Section titled “getVault()”getVault(
vault):Promise<ApiVault>
Defined in: protocol-lending-kamino-solana/src/api.ts:186
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ApiVault>
getVaultMetrics()
Section titled “getVaultMetrics()”getVaultMetrics(
vault):Promise<ApiVaultMetrics>
Defined in: protocol-lending-kamino-solana/src/api.ts:190
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ApiVaultMetrics>
getVaultPosition()
Section titled “getVaultPosition()”getVaultPosition(
user,vault):Promise<ApiVaultPosition>
Defined in: protocol-lending-kamino-solana/src/api.ts:201
The user’s shares in one vault; a user the vault has never seen is a zero position.
Parameters
Section titled “Parameters”string
string
Returns
Section titled “Returns”Promise<ApiVaultPosition>
listMarkets()
Section titled “listMarkets()”listMarkets():
Promise<ApiMarket[]>
Defined in: protocol-lending-kamino-solana/src/api.ts:145
Every Kamino Lend market (Main Market first).
Returns
Section titled “Returns”Promise<ApiMarket[]>
listVaultPositions()
Section titled “listVaultPositions()”listVaultPositions(
user):Promise<ApiVaultPosition[]>
Defined in: protocol-lending-kamino-solana/src/api.ts:211
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<ApiVaultPosition[]>
listVaults()
Section titled “listVaults()”listVaults():
Promise<ApiVault[]>
Defined in: protocol-lending-kamino-solana/src/api.ts:181
Every Earn vault (kVault) on the mainnet program.
Returns
Section titled “Returns”Promise<ApiVault[]>