@ichidao/ichi-vaults-sdk

@ichidao/ichi-vaults-sdk

This sdk contains collection of functions to interact with IchiVault's smart contract.

Table of Contents

• Installation
• Subgraphs
• Usage
  • Vault Functions
    • approveDepositToken()
    • deposit()
    • depositNativeToken()
    • approveVaultToken()
    • isVaultTokenApproved()
    • withdraw()
    • withdrawWithSlippage()
    • withdrawNativeToken()
    • isDepositTokenApproved()
    • isTokenAllowed()
    • getMaxDepositAmount()
    • getUserBalance()
    • getUserAmounts()
    • getAllUserBalances()
    • getAllUserAmounts()
    • getTotalSupply()
    • getTotalAmounts()
    • getFeesCollected()
    • getFeesCollectedInfo()
    • getFeeAprs()
    • getAverageDepositTokenRatios()
    • getVaultMetrics()
    • getIchiVaultInfo()
    • getVaultsByTokens()
    • getVaultsByPool()
    • getVaultPositions()
    • getSupportedDexes()
    • getChainsForDex()
    • getRewardInfo()
    • getAllRewardInfo()
    • getAllUserRewards()
    • getUserRewards()
    • claimRewards()

Installation

Install with

yarn add @ichidao/ichi-vaults-sdk

or

npm install @ichidao/ichi-vaults-sdk

Usage

Subgraphs

This SDK uses subgraphs to obtain information about ICHI vaults. The subgraphs are deployed in the Subgraph Studio and published on Arbitrum One. If you prefer to use published subgraphs, you need to add your subgraph API key to the SUBGRAPH_API_KEY environment variable. Otherwise, the SDK will use the subgraph's Studio endpoint.

Note for Flow users: The Flow blockchain uses Alchemy subgraph instead of Subgraph Studio. If you're using this SDK on Flow, you need to provide your own Alchemy subgraph API key by adding it to the ALCHEMY_SUBGRAPH_API_KEY environment variable.

Vault

1. approveDepositToken()

param	type	default	required
accountAddress	string	-	true
tokenIdx	0 | 1	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
amount	string | number | BigNumber	undefined	false
overrides	Overrides	undefined	false

This function approves tokens for deposit into the vault and must be called before the deposit() function. The 'amount' parameter can be either a string or a number, representing the number of tokens in major units. For instance, if the deposit token is wETH, 'amount' being equal to 0.5 or '0.5' signifies 0.5 wETH. If the 'amount' parameter is not specified the token will be approved for the maximum allowable amount.

import { Web3Provider } from '@ethersproject/providers';
import { approveDepositToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const accountAddress = "0xaaaa...aaaaaa"
const amount = 100
const dex = SupportedDex.UniswapV3

const txnDetails = await approveDepositToken(
    accountAddress,
    0, // token idx can be 0 or 1
    vaultAddress,
    web3Provider,
    dex,
    amount // (optional)
);

await txnDetails.wait();

// can now deposit token0
// ...

2. deposit()

param	type	default	required
accountAddress	string	-	true
amount0	string | number | BigNumber	-	true
amount1	string | number | BigNumber	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
percentSlippage	number	1	false
overrides	Overrides	undefined	false

This function facilitates deposits into the vault. The 'amount0' and 'amount1' parameters can be either a string or a number, representing the number of tokens in major units. For instance, if the deposit token is wETH, 'amount' being equal to 0.5 or '0.5' signifies 0.5 wETH. One of the 'amount' parameters must be set to zero. Use the isTokenAllowed() function to determing if a token could be deposited.

import { Web3Provider } from '@ethersproject/providers';
import { deposit, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const amount0 = 100
const amount1 = 0

const txnDetails = await deposit(
    accountAddress,
    amount0, // can be 0 when only depositing amount1
    amount1, // can be 0 when only depositing amount0
    vaultAddress,
    web3Provider,
    dex,
    1 // acceptable slippage (percents)
)

3. depositNativeToken()

param	type	default	required
accountAddress	string	-	true
amount0	string | number | BigNumber	-	true
amount1	string | number | BigNumber	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
percentSlippage	number	1	false
overrides	Overrides	undefined	false

This function deposits native tokens of the chain into the vault if the vault accepts wrapped native token deposits. The 'amount0' and 'amount1' parameters can be either a string or a number, representing the number of tokens in major units. For instance, if the deposit token is wETH, 'amount' being equal to 0.5 or '0.5' signifies 0.5 wETH, and 0.5 ETH will be deposited. The other 'amount' parameter must be set to zero.

import { Web3Provider } from '@ethersproject/providers';
import { deposit, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const amount0 = 100
const amount1 = 0

const txnDetails = await depositNativeToken(
    accountAddress,
    amount0, // can be 0 when only depositing amount1
    amount1, // can be 0 when only depositing amount0
    vaultAddress,
    web3Provider,
    dex,
    1 // acceptable slippage (percents)
)

4. approveVaultToken()

param	type	default	required
accountAddress	string	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
shares	string | number | BigNumber	undefined	false
overrides	Overrides	undefined	false

The approveVaultToken() function facilitates the approval of vault tokens for the withdrawWithSlipage() and withdrawNativeToken functions. The 'shares' parameter can be either a string or a number, representing the number of vault tokens in major units. For example, if 'shares' is equal to 0.5 or '0.5', it signifies 0.5 vault token. If the 'shares' parameter is not specified, the token will be approved for the maximum allowable amount.

import { Web3Provider } from '@ethersproject/providers';
import { approveVaultToken, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const accountAddress = "0xaaaa...aaaaaa"
const amount = 100
const dex = SupportedDex.UniswapV3

const txnDetails = await approveVaultToken(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
    amount // (optional)
);

await txnDetails.wait();

// can now deposit token0
// ...

5. isVaultTokenApproved()

param	type	default	required
accountAddress	string	-	true
shares	string | number | BigNumber,	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

This function returns true if the vault token allowance is non-zero and greater than or equal to the specified amount. The 'shares' parameter can be either a string or a number, representing the number of vault tokens in major units. For example, if 'shares' is equal to 0.5 or '0.5', it signifies 0.5 vault token.

import { Web3Provider } from '@ethersproject/providers';
import { isVaultTokenApproved, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const accountAddress = "0xaaaa...aaaaaa"
const amount = 100
const dex = SupportedDex.UniswapV3

const isApproved: boolean = await isVaultTokenApproved(
    accountAddress,
    amount,
    vaultAddress,
    web3Provider,
    dex
)

6. withdraw()

param	type	default	required
accountAddress	string	-	true
shares	string | number | BigNumber	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
overrides	Overrides	undefined	false

This function facilitates the withdrawal of the specified amount of shares from the vault. As a result, both vault tokens are added to the user's account. The 'shares' parameter can be either a string or a number, representing the number of vault tokens to be withdrawn from the vault, specified in major units. For instance, if 'shares' is equal to 0.5 or '0.5', it signifies 0.5 vault token.

import { Web3Provider } from '@ethersproject/providers';
import { getUserBalance, withdraw, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const totalUserShares: string = await getUserBalance(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
)

let shares = Number(totalUserShare) * 0.5 // 50% of user deshare balance

const txnDetails = await withdraw(
    accountAddress,
    shares,
    vaultAddress,
    web3Provider,
    dex
)

7. withdrawWithSlippage()

param	type	default	required
accountAddress	string	-	true
shares	string | number | BigNumber	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
percentSlippage	number	1	false
overrides	Overrides	undefined	false

Similar to the withdraw() function, this function facilitates the withdrawal of the specified amount of shares from the vault. Furthermore, it enables the setting of the slippage for the withdrawal transaction. By default, the slippage is set to 1%. If the slippage exceeds the specified amount, the transaction will not be executed. Ensure to use the approveVaultToken() function before invoking withdrawWithSlippage().

import { Web3Provider } from '@ethersproject/providers';
import { getUserBalance, withdraw, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const totalUserShares: string = await getUserBalance(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
)

let shares = Number(totalUserShare) * 0.5 // 50% of user deshare balance

const txnDetails = await withdraw(
    accountAddress,
    shares,
    vaultAddress,
    web3Provider,
    dex
)

8. withdrawNativeToken()

param	type	default	required
accountAddress	string	-	true
shares	string | number | BigNumber	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
percentSlippage	number	1	false
overrides	Overrides	undefined	false

Similar to the withdraw() function, this function facilitates the withdrawal of the specified amount of shares from the vault. This function could be used for vaults in which one of the tokens is a wrapped native token of the chain. Both vault tokens are added to the user's account after the withdrawal. Additionally, the wrapped token is converted to the native token. Ensure to use the approveVaultToken() function before invoking withdrawNativeToken().

import { Web3Provider } from '@ethersproject/providers';
import { getUserBalance, withdraw, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const totalUserShares: string = await getUserBalance(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex
)

let shares = Number(totalUserShare) * 0.5 // 50% of user deshare balance

const txnDetails = await withdraw(
    accountAddress,
    shares,
    vaultAddress,
    web3Provider,
    dex
)

9. isDepositTokenApproved()

param	type	default	required
accountAddress	string	-	true
tokenIdx	0 | 1	-	true
amount	string | number,	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

This function returns true if the token allowance is non-zero and greater than or equal to the specified amount. The 'amount' parameter can be either a string or a number, representing the number of tokens in major units. For instance, if the deposit token is wETH, 'amount' being equal to 0.5 or '0.5' signifies 0.5 wETH.

import { Web3Provider } from '@ethersproject/providers';
import { isDepositTokenApproved, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const accountAddress = "0xaaaa...aaaaaa"
const amount = '10.5'
const dex = SupportedDex.UniswapV3

const isToken0Approved: boolean = await isDepositTokenApproved(
    accountAddress,
    0, // token idx can be 0 or 1
    amount,
    vaultAddress,
    web3Provider,
    dex
)

10. isTokenAllowed()

param	type	default	required
tokenIdx	0 | 1	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

Returns true if deposits of the specified token are allowed.

import { Web3Provider } from '@ethersproject/providers';
import { isTokenAllowed, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3

const isAllowed = await isTokenAllowed(
    0, // token idx can be 0 or 1
    vaultAddress,
    web3Provider,
    dex
)

11. getMaxDepositAmount()

param	type	default	required
tokenIdx	0 | 1	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

Returns a BigNumber representing the maximum allowed deposit amount.

import { Web3Provider } from '@ethersproject/providers';
import { getMaxDepositAmount, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3

const maxAmount = await getMaxDepositAmount(
    0, // token idx can be 0 or 1
    vaultAddress,
    web3Provider,
    dex
)

12. getUserBalance()

param	type	default	required
accountAddress	string	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

This function returns the number of user shares in the vault. If the 'raw' parameter is included, it returns a BigNumber.

import { Web3Provider } from '@ethersproject/providers';
import { getUserBalance, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const shares: string = await getUserBalance(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const sharesBN: BigNumber = await getUserBalance(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
    true
)

13. getUserAmounts()

param	type	default	required
accountAddress	string	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

The getUserAmounts() function returns the amounts of tokens in the vault owned by the user. If 'raw' is specified, it returns BigNumber's.

import { Web3Provider } from '@ethersproject/providers';
import { getUserAmounts, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const amounts: [string, string] & {amount0: string, amount1: string} = await getUserAmounts(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumber} = await getUserAmounts(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
    true
)

14. getAllUserBalances()

param	type	default	required
accountAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

This function returns user balances for all vaults on the specified decentralized exchange (DEX). The result is cached for 2 minutes by default. You can set your own cache TTL by adding the CACHE_TTL environment variable in millisecond. For example, CACHE_TTL = 60000 is 1 minute.

import { Web3Provider } from '@ethersproject/providers';
import { getAllUserBalances, SupportedDex, UserBalanceInVault, UserBalanceInVaultBN } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const userBalancesInVaults: UserBalanceInVault[] = await getAllUserBalances(
    accountAddress,
    web3Provider,
    dex
)

// - or -

const userBalancesInVaultsBN: UserBalanceInVaultBN[] = await getAllUserBalances(
    accountAddress,
    web3Provider,
    dex,
    true
)

15. getAllUserAmounts()

param	type	default	required
accountAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

This function returns user token amounts in all vaults on the specified decentralized exchange (DEX). The result is cached for 2 minutes by default. You can set your own cache TTL by adding the CACHE_TTL environment variable in millisecond. For example, CACHE_TTL = 60000 is 1 minute.

import { Web3Provider } from '@ethersproject/providers';
import { getAllUserAmounts, SupportedDex, UserAmountsInVault, UserAmountsInVaultBN } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const amounts: UserAmountsInVault[] = await getAllUserAmounts(
    accountAddress,
    web3Provider,
    dex,
)

// - or -

const amountsBN: UserAmountsInVaultBN[] = await getAllUserAmounts(
    accountAddress,
    web3Provider,
    dex,
    true
)

16. getTotalSupply()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

This function returns the total number of shares in the vault.

import { Web3Provider } from '@ethersproject/providers';
import { getTotalSupply, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3

const shares: string = await getTotalSupply(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const sharesBN: BigNumber = await getTotalSupply(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
    true
)

17. getTotalAmounts()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	false

This function returns the total number of tokens in the vault.

import { Web3Provider } from '@ethersproject/providers';
import { getTotalAmounts, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3
const accountAddress = "0xaaaa...aaaaaa"

const amounts: [string, string] & {total0: string, total1: string} = await getTotalAmounts(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getTotalAmounts(
    accountAddress,
    vaultAddress,
    web3Provider,
    dex,
    true
)

18. getFeesCollected()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
rawOrDays	true or number	undefined	false
days	number	undefined	false

The getFeesCollected() function returns the number of fees collected for the specified number of days. If the 'days' parameter is not included, it returns the number of fees collected since the vault's inception.

import { Web3Provider } from '@ethersproject/providers';
import { getFeesCollected, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.UniswapV3;
const days = 7;

const amounts: [string, string] & {total0: string, total1: string} = await getFeesCollected(
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getFeesCollected(
    vaultAddress,
    web3Provider,
    dex,
    true
)

// - or -

const amounts: [string, string] & {total0: string, total1: string} = await getFeesCollected(
    vaultAddress,
    web3Provider,
    dex,
    days
)

// - or -

const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getFeesCollected(
    vaultAddress,
    web3Provider,
    dex,
    true,
    days
)

19. getFeesCollectedInfo()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
forDays	number[]	undefined	false

The getFeesCollectedInfo() function returns an array of FeesInfo objects representing the number of fees collected for the periods of time specified by the 'forDays' parameter, along with the fee Annual Percentage Rate (APR) for those periods. If 'forDays' is not specified, it returns FeesInfo for time periods of 1, 7, and 30 days.

import { Web3Provider } from '@ethersproject/providers';
import { getFeesCollectedInfo, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.UniswapV3;
const days = [2, 5, 14, 60];

const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
    vaultAddress,
    web3Provider,
    dex,
    days
)

20. getFeeAprs()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

The getFeeAprs() function calculates and returns fee Annual Percentage Rates (APRs) for the specified vault over different standard time periods. It returns an object of type FeeAprData containing APR values for 1 day, 3 days, 7 days, and 30 days.

import { Web3Provider } from '@ethersproject/providers';
import { getFeeAprs, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.hSwap;

const feeAprs = await getFeeAprs(vaultAddress, provider, dex);
console.log(`1-day Fee APR: ${feeAprs.feeApr_1d}%`);

21. getAverageDepositTokenRatios()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
timeIntervals	number[]	[1, 7, 30]	false

The getAverageDepositTokenRatios() function returns an array of DepositTokenRatio objects representing the average deposit token ratio for the periods of time specified by the 'timeIntervals' parameter. If 'timeIntervals' is not specified, it returns DepositTokenRatio objects for time periods of 1, 7, and 30 days.

import { Web3Provider } from '@ethersproject/providers';
import { getFeesCollectedInfo, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.UniswapV3;
const days = [2, 5, 14, 60];

const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
    vaultAddress,
    web3Provider,
    dex,
    days
)

22. getVaultMetrics()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
timeIntervals	number[]	[1, 7, 30]	false

The getVaultMetrics() function returns an array of VaultMetrics objects for the periods of time specified by the 'timeIntervals' parameter. If 'timeIntervals' is not specified, it returns VaultMetrics objects for time periods of 1, 7, and 30 days.

import { Web3Provider } from '@ethersproject/providers';
import { getVaultMetrics, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.UniswapV3;
const days = [2, 5, 14, 60];

const vaultMetrics: VaultMetrics[] = await getVaultMetrics(
    vaultAddress,
    web3Provider,
    dex
)

// - or -

const vaultMetrics: VaultMetrics[] = await getVaultMetrics(
    vaultAddress,
    web3Provider,
    dex,
    days
)

23. getIchiVaultInfo()

param	type	default	required
chain	SupportedChain	-	true
dex	SupportedDex	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	false

This function returns IchiVault object.

import { Web3Provider } from '@ethersproject/providers';
import { getIchiVaultInfo, SupportedDex, SupportedChain, IchiVault } from '@ichidao/ichi-vaults-sdk';

const vaultAddress = "0x3ac9...a5f132"
const dex = SupportedDex.UniswapV3;
const chain = SupportedChain.Polygon;

const vaultInfo = await getIchiVaultInfo(chain, dex, vaultAddress);
if (vaultInfo) {
    const addressTokenA = vaultInfo.tokenA;
}

24. getVaultsByTokens()

param	type	default	required
chain	SupportedChain	-	true
dex	SupportedDex	-	true
depositTokenAddress	string	-	true
pairedTokenAddress	string	-	true

This function returns an array of all vaults (IchiVault[]) on the specified DEX that contain two tokens defined by the 'depositTokenAddress' and 'pairedTokenAddress' parameters.

import { Web3Provider } from '@ethersproject/providers';
import { getVaultsByTokens, SupportedDex, SupportedChain, IchiVault } from '@ichidao/ichi-vaults-sdk';

const depositToken = "0x1b...bfd6"
const pairedToken = "0x11...c4d6"
const dex = SupportedDex.UniswapV3;
const chain = SupportedChain.Polygon;

const vaults = await getVaultsByTokens(chain, dex, depositToken, pairedToken)
if (vaults.length === 0) {
    console.log("Couldn't find vaults with these parameters")
} else {
    const vaultAddress = vaults[0].id;
}

25. getVaultsByPool()

param	type	default	required
poolAddress	string	-	true
chain	SupportedChainId	-	true
dex	SupportedDex	-	true

This function returns an array of all vaults ({ vault: string }[]) deployed on the specified pool.

import { Web3Provider } from '@ethersproject/providers';
import { getVaultsByPool, SupportedDex, SupportedChainId } from '@ichidao/ichi-vaults-sdk';

const poolAddress = "0x1b...2fd6"
const dex = SupportedDex.UniswapV3;
const chain = SupportedChainId.Polygon;

const vaults = await getVaultsByPool(poolAddress, chain, dex)
if (vaults.length === 0) {
    console.log("Couldn't find vaults with these parameters")
} else {
    const vaultAddress = vaults[0].vault;
}

26. getVaultPositions()

param	type	default	required
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

This function returns an object of type VaultPositionsInfo.

import { Web3Provider } from '@ethersproject/providers';
import { getVaultPositions, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const vaultAddress = "0x3ac9...a5f132";
const dex = SupportedDex.UniswapV3;

const vaultPositions: VaultPositionsInfo = await getVaultPositions(
    vaultAddress,
    web3Provider,
    dex
);
const currentTick = vaultPositions.currentTick;

27. getSupportedDexes()

param	type	default	required
chainId	SupportedChainId	-	true

This function returns all supported dexes for chain specified by chainId. Result is an array of SupportedDex.

import { getSupportedDexes, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const chainId = SupportedChainId.polygon;

const dexes: SupportedDex[] = getSupportedDexes(chainId);

28. getChainsForDex()

param	type	default	required
dex	SupportedDex	-	true

This function returns all supported chains for the specified dex. Result is an array of SupportedChainId.

import { getChainsForDex, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const dex = SupportedChainId.UniswapV3;

const chains: SupportedChainId[] = getChainsForDex(dex);

29. getRewardInfo()

param	type	default	required
chainId	SupportedChainId	-	true
dex	SupportedDex	-	true
vaultAddress	string	-	true

This function returns information about reward rates and farming contract for the specified vault. This functions is specific for the Velodrome vaults.

import { getRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const vaultAddress = "0x3e4...45a";
const chainId = SupportedChainId.Ink;
const dex = SupportedDex.Velodrome;

const rewardInfo: RewardInfo = getRewardInfo(chainId, dex, vaultAddress);

30. getAllRewardInfo()

param	type	default	required
chainId	SupportedChainId	-	true
dex	SupportedDex	-	true

This function returns information about reward rates and farming contract for all vaults on the dex. This functions is specific for the Velodrome vaults.

import { getAllRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const chainId = SupportedChainId.Ink;
const dex = SupportedDex.Velodrome;

const chains: RewardInfo[] = getAllRewardInfo(chainId, dex);

31. getAllUserRewards()

param	type	default	required
accountAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	-

This function returns user rewards for all vaults on the dex. This functions is specific for the Velodrome vaults.

import { getAllUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const account = "0x123...890";
const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const dex = SupportedDex.Velodrome;

const rewards: UserRewards[] = await getAllUserRewards(account, provider, dex);

32. getUserRewards()

param	type	default	required
accountAddress	string	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true
raw	true	undefined	-

This function returns claimable reward amounts for the specified vault and user account. This functions is specific for the Velodrome vaults.

import { getUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const account = "0x123...890";
const vaultAddress = "0x3e4...45a";
const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const dex = SupportedDex.Velodrome;

const rewards: UserRewardByToken[] = getUserRewards(account, vaultAddress, provider, dex);
const rewardsBN: UserRewardByTokenBN[] = getUserRewards(account, vaultAddress, provider, dex, true);

33. claimRewards()

param	type	default	required
accountAddress	string	-	true
vaultAddress	string	-	true
jsonProvider	JsonRpcProvider	-	true
dex	SupportedDex	-	true

This function transfers rewards from the reward contract to the specified account. This functions is specific for the Velodrome vaults.

import { claimRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';

const account = "0x123...890";
const vaultAddress = "0x3e4...45a";
const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
const dex = SupportedDex.Velodrome;

await claimRewards(account, vaultAddress, provider, dex);

Types

SupportedChainId

enum SupportedChainId {
  arbitrum = 42161,
  arthera = 10242,
  arthera_testnet = 10243,
  base = 8453,
  base_sepolia = 84532,
  berachain = 80094,
  berachain = 80084,
  blast = 81457,
  blast_sepolia_testnet = 168587773,
  bsc = 56,
  celo = 42220,
  citrea_testnet = 5115,
  eon = 7332,
  evmos = 9001,
  fantom = 250,
  flare = 14,
  flow = 747,
  fuse = 122,
  haven1 = 8811,
  haven1_devnet = 8110,
  hedera = 295,
  hedera_testnet = 296,
  hemi = 43111,
  hyperevm = 999,
  ink = 57073,
  ink_sepolia = 763373,
  kava = 2222,
  linea = 59144,
  mainnet = 1,
  mantle = 5000,
  mode = 34443,
  monad_testnet = 10143,
  moonbeam = 1284,
  nibiru = 6900,
  polygon = 137,
  polygon_zkevm = 1101,
  real = 111188,
  rootstock = 30,
  scroll = 534352,
  skale_europa = 2046399126,
  sonic = 146,
  tac = 239,
  taiko = 167000,
  taiko_hekla = 167009,
  unichain = 130,
  unreal = 18233,
  x_layer_testnet = 195,
  zircuit = 48900,
  zksync_era = 324,
  zksync_era_testnet = 280,
}

SupportedDex

enum SupportedDex {
  Aerodrome = 'Aerodrome',
  Agni = 'Agni',
  Ascent = 'Ascent',
  Atlantis = 'Anlantis',
  Blueprint = 'Blueprint',
  Cleo = 'Cleo',
  Crust = 'Crust',
  Equalizer = 'Equalizer',
  Fenix = 'Fenix',
  Forge = 'Forge',
  Henjin = 'Henjin',
  Honeypot = 'Honeypot',
  hSwap = 'hSwap',
  Hydrex = 'Hydrex',
  HyperSwap = 'HyperSwap',
  Kim = 'Kim',
  Kinetix = 'Kinetix',
  KittyPunch = 'KittyPunch',
  Kodiak = 'Kodiak',
  Linehub = 'Linehub',
  Lynex = 'Lynex',
  Metavault = 'Metavault',
  Nile = 'Nile',
  Ocelex = 'Ocelex',
  Pancakeswap = 'PancakeSwap',
  Pearl = 'Pearl',
  Quickswap = 'QuickSwap',
  Ramses = 'Ramses',
  Reservoir = 'Reservoir',
  Retro = 'Retro',
  Satsuma = 'Satsuma',
  SaucerSwap = 'SaucerSwap',
  Snap = 'Snap',
  SparkDex = 'SparkDex',
  SparkDexV1 = 'SparkDexV1',
  SpiritSwap = 'SpiritSwap',
  StellaSwap = 'StellaSwap',
  Sushiswap = 'SushiSwap',
  SwapX = 'SwapX',
  Thena = 'Thena',
  ThenaV3Fees = 'ThenaV3Fees',
  ThenaV3Rewards = 'ThenaV3Rewards',
  Thirdfy = 'Thirdfy',
  Thruster = 'Thruster',
  Trebleswap = 'Trebleswap',
  Ubeswap = 'Ubeswap',
  UniswapV3 = 'Uniswap V3',
  Velocore = 'Velocore',
  Velodrome = 'Velodrome',
  Voltage = 'Voltage',
  Wasabee = 'Wasabee',
  XSwap = 'XSwap',
}

IchiVault

interface IchiVault {
  id: string; // vault address
  tokenA: string; // token0 address
  tokenB: string; // token1 address
  allowTokenA: boolean;
  allowTokenB: boolean;
  holdersCount?: string // number of vault LP holders
  fee?: string
  farmingContract?: string; // used for Velodrome vaults only
  rewardTokens?: {
    // used for Velodrome vaults only
    token: string;
    tokenDecimals: number;
  }[];
}

FeesInfo

type FeesInfo  = {
  timePeriod: number; // in days
  feeAmount0: string; // in token0
  feeAmount1: string; // in token1
  pctAPR: number; // yearly APR based on the timePeriod
}

AverageDepositTokenRatio

type AverageDepositTokenRatio  = {
  timePeriod: number; // in days
  percent: number;
}

VaultApr

type VaultApr  = {
  timeInterval: number; // in days
  apr: number; // percent
}

FeeAprData

export type FeeAprData = {
  feeApr_1d: number | null;
  feeApr_3d: number | null;
  feeApr_7d: number | null;
  feeApr_30d: number | null;
};

PriceChange

type PriceChange  = {
  timeInterval: number; // in days
  priceChange: number; // percent
}

VaultMetrics

type VaultMetrics  = {
  timeInterval: number; // in days
  lpPriceChange: number | null;
  lpApr: number | null; // percent
  avgDtr: number;
  feeApr: number;
}

UserAmountsBN

type UserAmountsBN =
  [BigNumber, BigNumber] & { amount0: BigNumber; amount1: BigNumber };

UserAmounts

type UserAmounts = [string, string] & { amount0: string; amount1: string };

UserAmountsInVault

type UserAmountsInVault = {
  vaultAddress: string;
  userAmounts: UserAmounts;
}

UserAmountsInVaultBN

type UserAmountsInVaultBN = {
  vaultAddress: string;
  userAmounts: UserAmountsBN;
}

UserBalanceInVault

type UserBalanceInVault = {
  vaultAddress: string;
  shares: string;
  stakedShares?: string;
};

UserBalanceInVaultBN

type UserBalanceInVaultBN = {
  vaultAddress: string;
  shares: BigNumber;
  stakedShares?: BigNumber;
};

VaultPositionsInfo

type VaultPositionsInfo = {
  currentTick: number,
  currentPrice: number,
  positions: {
    tickLower: number,
    tickUpper: number,
    priceLower: number,
    priceUpper: number,
    liquidity: string;
    amountToken0: string;
    amountToken1: string;
    positionTvl: number; // in deposit tokens
  } [],
}

RewardToken

used for Velodrome vaults only

type RewardToken = {
  rewardRatePerToken_1d: string;
  rewardRatePerToken_3d: string;
  token: string;
  tokenDecimals: number;
};

UserRewardsByToken

type UserRewardsByToken = {
  token: string;
  tokenDecimals: number;
  rewardAmount: string;
};

UserRewardsByTokenBN

type UserRewardsByTokenBN = {
  token: string;
  tokenDecimals: number;
  rewardAmount: BigNumber;
};

RewardInfo

type RewardInfo = {
  id: string;
  farmingContract: {
    id: string;
    rewardTokens: RewardToken[];
  };
};

UserRewards

type UserRewards = {
  vaultAddress: string;
  rewardTokens: UserRewardsByToken[];
};

UserRewardsBN

type UserRewardsBN = {
  vaultAddress: string;
  rewardTokens: UserRewardsByTokenBN[];
};