@ichidao/ichi-vaults-sdk 0.0.19 → 0.0.21

package/README.md

@@ -20,8 +20,10 @@ This sdk contains collection of functions to interact with IchiVault's smart con
         * [`getTotalSupply()`](#9-getTotalSupply)
         * [`getTotalAmounts()`](#10-getTotalAmounts)
         * [`getFeesCollected()`](#11-getFeesCollected)
-        * [`getIchiVaultInfo()`](#12-getIchiVaultInfo)
-        * [`getVaultsByTokens()`](#13-getVaultsByTokens)
+        * [`getFeesCollectedInfo()`](#12-getFeesCollectedInfo)
+        * [`getAverageDepositTokenRatios()`](#13-getAverageDepositTokenRatios)
+        * [`getIchiVaultInfo()`](#14-getIchiVaultInfo)
+        * [`getVaultsByTokens()`](#15-getVaultsByTokens)
 
 ## Installation
 Install with
@@ -44,8 +46,8 @@ npm install @ichidao/ichi-vaults-sdk
 | tokenIdx           | 0 \| 1 | - | true
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true | 
-| amount   | string \| number | undefined | false | 
+| dex   | SupportedDex | - | true |
+| amount   | string \| number | undefined | false |
 | overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
 
 <br/>
@@ -61,17 +63,17 @@ const amount = 100
 const dex = SupportedDex.UniswapV3
 
 const txnDetails = await approveDepositToken(
-    accountAddress, 
+    accountAddress,
     0, // token idx can be 0 or 1
-    vaultAddress, 
+    vaultAddress,
     web3Provider,
     dex,
     amount // (optional)
 );
 
-await txnDetails.wait(); 
+await txnDetails.wait();
 
-// can now deposit token0 
+// can now deposit token0
 // ...
 ```
 
@@ -82,10 +84,10 @@ await txnDetails.wait();
 | accountAddress   | string | - | true
 | amount0           | string \| number | - | true
 | amount1           | string \| number | - | true
-| vaultAddress   | string | - | true 
+| vaultAddress   | string | - | true
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| percentSlippage   | number | 1 | false 
+| dex   | SupportedDex | - | true
+| percentSlippage   | number | 1 | false
 | overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
 
 <br/>
@@ -100,13 +102,13 @@ const dex = SupportedDex.UniswapV3
 const accountAddress = "0xaaaa...aaaaaa"
 
 const amount0 = 100
-const amount1 = 0 
- 
+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, 
+    vaultAddress,
     web3Provider,
     dex,
     1 // acceptable slippage (percents)
@@ -119,9 +121,9 @@ const txnDetails = await deposit(
 | -------- | -------- | -------- | --------
 | accountAddress   | string | - | true
 | shares           | string \| number | - | true
-| vaultAddress   | string | - | true 
+| vaultAddress   | string | - | true
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
+| dex   | SupportedDex | - | true
 | overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
 
 <br/>
@@ -137,7 +139,7 @@ const accountAddress = "0xaaaa...aaaaaa"
 
 const totalUserShares: string = await getUserBalance(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
 )
@@ -146,8 +148,8 @@ let shares = Number(totalUserShare) * 0.5 // 50% of user deshare balance
 
 const txnDetails = await withdraw(
     accountAddress,
-    shares, 
-    vaultAddress, 
+    shares,
+    vaultAddress,
     web3Provider,
     dex
 )
@@ -180,7 +182,7 @@ const isToken0Approved: boolean = await isDepositTokenApproved(
     accountAddress,
     0, // token idx can be 0 or 1
     amount,
-    vaultAddress, 
+    vaultAddress,
     web3Provider,
     dex
 )
@@ -193,7 +195,7 @@ const isToken0Approved: boolean = await isDepositTokenApproved(
 | tokenIdx           | 0 \| 1 | - | true
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true | 
+| dex   | SupportedDex | - | true |
 
 <br/>
 
@@ -207,7 +209,7 @@ const dex = SupportedDex.UniswapV3
 
 const isAllowed = await isTokenAllowed(
     0, // token idx can be 0 or 1
-    vaultAddress, 
+    vaultAddress,
     web3Provider,
     dex
 )
@@ -221,7 +223,7 @@ const isAllowed = await isTokenAllowed(
 | tokenIdx           | 0 \| 1 | - | true
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true | 
+| dex   | SupportedDex | - | true |
 
 <br/>
 
@@ -235,7 +237,7 @@ const dex = SupportedDex.UniswapV3
 
 const maxAmount = await getMaxDepositAmount(
     0, // token idx can be 0 or 1
-    vaultAddress, 
+    vaultAddress,
     web3Provider,
     dex
 )
@@ -249,8 +251,8 @@ const maxAmount = await getMaxDepositAmount(
 | accountAddress   | string | - | true |
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| raw   | true | undefined | false | 
+| dex   | SupportedDex | - | true
+| raw   | true | undefined | false |
 
 <br/>
 
@@ -265,16 +267,16 @@ const accountAddress = "0xaaaa...aaaaaa"
 
 const shares: string = await getUserBalance(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex
 )
 
-// - or - 
+// - or -
 
 const sharesBN: BigNumber = await getUserBalance(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true
@@ -288,8 +290,8 @@ const sharesBN: BigNumber = await getUserBalance(
 | accountAddress   | string | - | true |
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| raw   | true | undefined | false | 
+| dex   | SupportedDex | - | true
+| raw   | true | undefined | false |
 
 <br/>
 
@@ -304,16 +306,16 @@ const accountAddress = "0xaaaa...aaaaaa"
 
 const amounts: [string, string] & {amount0: string, amount1: string} = await getUserAmounts(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
 )
 
-// - or - 
+// - or -
 
 const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumber} = await getUserAmounts(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true
@@ -326,8 +328,8 @@ const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumbe
 | -------- | -------- | -------- | --------
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| raw   | true | undefined | false | 
+| dex   | SupportedDex | - | true
+| raw   | true | undefined | false |
 
 <br/>
 
@@ -341,16 +343,16 @@ const dex = SupportedDex.UniswapV3
 
 const shares: string = await getTotalSupply(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
 )
 
-// - or - 
+// - or -
 
 const sharesBN: BigNumber = await getTotalSupply(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true
@@ -363,8 +365,8 @@ const sharesBN: BigNumber = await getTotalSupply(
 | -------- | -------- | -------- | --------
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| raw   | true | undefined | false | 
+| dex   | SupportedDex | - | true
+| raw   | true | undefined | false |
 
 <br/>
 
@@ -379,16 +381,16 @@ const accountAddress = "0xaaaa...aaaaaa"
 
 const amounts: [string, string] & {total0: string, total1: string} = await getTotalAmounts(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
 )
 
-// - or - 
+// - or -
 
 const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getTotalAmounts(
     accountAddress,
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true
@@ -401,9 +403,9 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 | -------- | -------- | -------- | --------
 | vaultAddress   | string | - | true |
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
-| dex   | SupportedDex | - | true 
-| rawOrDays   | true or number | undefined | false | 
-| days   | number | undefined | false | 
+| dex   | SupportedDex | - | true
+| rawOrDays   | true or number | undefined | false |
+| days   | number | undefined | false |
 
 <br/>
 
@@ -417,33 +419,33 @@ const dex = SupportedDex.UniswapV3;
 const days = 7;
 
 const amounts: [string, string] & {total0: string, total1: string} = await getFeesCollected(
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
 )
 
-// - or - 
+// - or -
 
 const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getFeesCollected(
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true
 )
 
-// - or - 
+// - or -
 
 const amounts: [string, string] & {total0: string, total1: string} = await getFeesCollected(
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     days
 )
 
-// - or - 
+// - or -
 
 const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber} = await getFeesCollected(
-    vaultAddress, 
+    vaultAddress,
     web3Provider
     dex,
     true,
@@ -451,12 +453,86 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 )
 ```
 
-#### 12. `getIchiVaultInfo()`
+#### 12. `getFeesCollectedInfo()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| vaultAddress   | string | - | true |
+| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
+| dex   | SupportedDex | - | true
+| forDays   | number[] | undefined | false |
+
+<br/>
+If forDays is not specified, returns FeesInfo for time periods of 1, 7, and 30 days.
+<br/>
+
+```typescript
+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,
+)
+```
+
+#### 13. `getAverageDepositTokenRatios()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| vaultAddress   | string | - | true |
+| jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
+| dex   | SupportedDex | - | true
+| timeIntervals   | number[] | [1, 7, 30] | false |
+
+<br/>
+
+```typescript
+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,
+)
+```
+
+#### 14. `getIchiVaultInfo()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
 | chain      | SupportedChain | - | true
-| dex   | SupportedDex | - | true 
+| dex   | SupportedDex | - | true
 | vaultAddress   | string | - | true |
 | jsonProvider   | JsonRpcProvider | - | false |
 
@@ -476,12 +552,12 @@ if (vaultInfo) {
 }
 ```
 
-#### 13. `getVaultsByTokens()`
+#### 15. `getVaultsByTokens()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
 | chain      | SupportedChain | - | true
-| dex   | SupportedDex | - | true 
+| dex   | SupportedDex | - | true
 | depositTokenAddress   | string | - | true |
 | pairedTokenAddress   | string | - | true |
 
@@ -513,6 +589,7 @@ enum SupportedChainId {
   arbitrum = 42161,
   bsc = 56,
   eon = 7332,
+  fantom = 250,
   hedera_testnet = 296,
   linea = 59144,
   mainnet = 1,
@@ -528,6 +605,7 @@ enum SupportedChainId {
 enum SupportedDex {
   Ascent = 'Ascent',
   Blueprint = 'Blueprint',
+  Equalizer = 'Equalizer',
   Horiza = 'Horiza',
   Lynex = 'Lynex',
   Pancakeswap = 'PancakeSwap',
@@ -553,3 +631,14 @@ interface IchiVault {
   allowTokenB: boolean;
 }
 ```
+
+### FeesInfo
+
+```typescript
+type FeesInfo  = {
+  timePeriod: number; // in days
+  feeAmount0: string; // in token0
+  feeAmount1: string; // in token1
+  pctAPR: number; // yearly APR based on the timePeriod
+}
+```