Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 1.94 KB

README.md

File metadata and controls

76 lines (54 loc) · 1.94 KB
Raw

Installation

# npm
npm install @hubbleprotocol/kamino-lending-sdk

# yarn
yarn add @hubbleprotocol/kamino-lending-sdk

Kamino Lending Typescript SDK

This is the Kamino Lending Typescript SDK to interact with the Kamino Lend smart contract

Basic usage

Reading data

// There are three levels of data you can request (and cache) about the lending market.
// 1. Initalize market with parameters and metadata
const market = await KaminoMarket.load(
  connection,
  new PublicKey("7u3HeHxYDLhnCoErrtycNokbQYbWGzLs6JSDqGAv5PfF") // main market address. Defaults to 'Main' market
);
console.log(market.reserves.map((reserve) => reserve.config.loanToValueRatio));

// 2. Refresh reserves
await market.loadReserves();

const usdcReserve = market.getReserve("USDC");
console.log(usdcReserve?.stats.totalDepositsWads.toString());


// Refresh all cached data
market.refreshAll();

const obligation = market.getObligationByWallet("WALLET_PK");
console.log(obligation.stats.borrowLimit);

Perform lending action

const kaminoAction = await KaminoAction.buildDepositTxns(
  kaminoMarket,
  amountBase,
  symbol,
  new VanillaObligation(PROGRAM_ID),
);

const env = await initEnv('mainnet-beta');
await sendTransactionFromAction(env, sendTransaction); // sendTransaction from wallet adapter or custom

FAQ

Client

  • npx ts-node src/client.ts deposit --url --owner ./keypair.json --token USDH --amount 10
  • npx ts-node src/client.ts deposit --url --owner ./keypair.json --token SOL --amount 10

Codegen

  • Copy the new idl from the kamino-lending program to src/idl.json
  • yarn codegen

Setup localnet

  • Ensure deps contains the correct .so you want to test against. Either build it from the main repo or dump it from mainnet
  • yarn start-validator

Run tests

  • yarn start-validator-and-test
  • Or, if the local validator is already running, yarn test

TODO:

Better sdk documentation