Giter VIP home page Giter VIP logo

klend-sdk's Introduction

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

Sync with smart contracts

  • Copy the program .so, idl and codegen
$ yarn
$ cp ../kamino-lending/target/deploy/kamino_lending.so deps/programs/kamino_lending.so
$ cp ../kamino-lending/target/idl/kamino_lending.json src/idl.json
$ yarn codegen

klend-sdk's People

Contributors

hubbleprotocolbot avatar mihalex98 avatar andreihrs avatar sourdzl avatar egor-humandone avatar elliotkennedy avatar peroxy avatar y2kappa avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.