@everlend/general-pool NPM

Everlend general-pool package

NB! This package is deprecated and not supported anymore. You can find the up-to-date package here: @everlend/sdk. and the documentation here: @everlend/sdk typedocs

TypeScript Docs (deprecated)

What's Everlend?

Everlend is a lending aggregator and optimizer. Get the best rates on your deposits and loans, always.

What's a general pool?

A general pool is an implementation of Solana pool program, which is responsible for storing users' liquidity and minting collateral tokens. There’s a general pool for every token supported by Everlend. When users interact with Everlend, they actually work with general pools, e.g. users' deposits and withdrawals are made via them.

The SDK allows interacting with Everlend general pools, specifically:

getting general pools for tokens, e.g. there's a general pool for USDT, USDC etc.
getting user's withdrawal requests
preparing deposit transactions to a general pool
preparing withdrawal request transactions from a general pool
preparing withdrawal transactions from a general pool
preparing transactions for initializing a mining account for a user to allow receiving liquidity mining rewards
preparing transactions for claiming liquidity mining rewards
preparing transactions for transferring deposits

It's still work in progress. In the future the SDK will be expanded with other useful features such as getting APYs for tokens etc.

Installation

Yarn

$ yarn add @everlend/general-pool

NPM

npm install @everlend/general-pool

Usage

Find pools

import { Pool } from '@everlend/general-pool'

const pools = await Pool.findMany(connection, {
  poolMarket,
})

Find user's withdrawal requests

import { UserWithdrawalRequest } from '@everlend/general-pool'

const userWithdrawalRequests = await UserWithdrawalRequest.findMany(connection, {
  from,
})

Prepare a deposit transaction

import { prepareDepositTx } from '@everlend/general-pool'

const depositTx = await prepareDepositTx(
  { connection, payerPublicKey },
  pool,
  amount,
  rewardPool,
  rewardAccount,
  source,
  destination,
)

Prepare a withdrawal request transaction

import { prepareWithdrawalRequestTx } from '@everlend/general-pool'

const withdrawalRequestTx = await prepareWithdrawalRequestTx(
  { connection, payerPublicKey },
  pool,
  collateralAmount,
  rewardPool,
  rewardAccount,
  source,
  destination,
)

Prepare a withdrawal transaction

import { prepareWithdrawalTx } from '@everlend/general-pool'

const withdrawalTx = await prepareWithdrawalTx(
  {
    connection,
    payerPublicKey,
  },
  withdrawalRequest,
)