@ichidao/ichi-vaults-sdk 0.1.37 → 0.1.39

package/README.md

@@ -564,8 +564,7 @@ const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumbe
 | dex   | SupportedDex | - | true
 | raw   | true | undefined | false |
 
-<br/>
-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.
+This function returns user balances (as [UserBalanceInVault](#userbalanceinvault) or [UserBalanceInVaultBN](#userbalanceinvaultbn)) 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.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -575,7 +574,7 @@ const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
 const dex = SupportedDex.UniswapV3
 const accountAddress = "0xaaaa...aaaaaa"
 
-const userBalancesInVaults: [UserBalanceInVault](#userbalanceinvault)[] = await getAllUserBalances(
+const userBalancesInVaults: UserBalanceInVault[] = await getAllUserBalances(
     accountAddress,
     web3Provider,
     dex
@@ -583,7 +582,7 @@ const userBalancesInVaults: [UserBalanceInVault](#userbalanceinvault)[] = await
 
 // - or -
 
-const userBalancesInVaultsBN: [UserBalanceInVaultBN](#userbalanceinvaultbn)[] = await getAllUserBalances(
+const userBalancesInVaultsBN: UserBalanceInVaultBN[] = await getAllUserBalances(
     accountAddress,
     web3Provider,
     dex,
@@ -600,8 +599,7 @@ const userBalancesInVaultsBN: [UserBalanceInVaultBN](#userbalanceinvaultbn)[] =
 | dex   | SupportedDex | - | true
 | raw   | true | undefined | false |
 
-<br/>
-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.
+This function returns user token amounts (as [UserAmountsInVault](#useramountsinvault) or [UserAmountsInVaultBN](#useramountsinvaultbn)) 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.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -611,7 +609,7 @@ const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
 const dex = SupportedDex.UniswapV3
 const accountAddress = "0xaaaa...aaaaaa"
 
-const amounts: [UserAmountsInVault](#useramountsinvault)[] = await getAllUserAmounts(
+const amounts: UserAmountsInVault[] = await getAllUserAmounts(
     accountAddress,
     web3Provider,
     dex,
@@ -619,7 +617,7 @@ const amounts: [UserAmountsInVault](#useramountsinvault)[] = await getAllUserAmo
 
 // - or -
 
-const amountsBN: [UserAmountsInVaultBN](#useramountsinvaultbn)[] = await getAllUserAmounts(
+const amountsBN: UserAmountsInVaultBN[] = await getAllUserAmounts(
     accountAddress,
     web3Provider,
     dex,
@@ -779,7 +777,6 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 
 The getFeesCollectedInfo() function returns an array of [FeesInfo](#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](#feesinfo) for time periods of 1, 7, and 30 days.
-<br/>
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -790,7 +787,7 @@ const vaultAddress = "0x3ac9...a5f132";
 const dex = SupportedDex.UniswapV3;
 const days = [2, 5, 14, 60];
 
-const feesInfo: [FeesInfo](#feesinfo)[] = await getFeesCollectedInfo(
+const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
     vaultAddress,
     web3Provider,
     dex
@@ -798,7 +795,7 @@ const feesInfo: [FeesInfo](#feesinfo)[] = await getFeesCollectedInfo(
 
 // - or -
 
-const feesInfo: [FeesInfo](#feesinfo)[] = await getFeesCollectedInfo(
+const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
     vaultAddress,
     web3Provider,
     dex,
@@ -814,7 +811,6 @@ const feesInfo: [FeesInfo](#feesinfo)[] = await getFeesCollectedInfo(
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
 | dex   | SupportedDex | - | true
 
-<br/>
 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](#feeaprdata) containing APR values for 1 day, 3 days, 7 days, and 30 days.
 
 ```typescript
@@ -838,7 +834,6 @@ console.log(`1-day Fee APR: ${feeAprs.feeApr_1d}%`);
 | dex   | SupportedDex | - | true
 | timeIntervals   | number[] | [1, 7, 30] | false |
 
-<br/>
 The getAverageDepositTokenRatios() function returns an array of [AverageDepositTokenRatio](#averagedeposittokenratio) objects representing the average deposit token ratio for the periods of time specified by the 'timeIntervals' parameter.
 If 'timeIntervals' is not specified, it returns [AverageDepositTokenRatio](#averagedeposittokenratio) objects for time periods of 1, 7, and 30 days.
 
@@ -851,7 +846,7 @@ const vaultAddress = "0x3ac9...a5f132";
 const dex = SupportedDex.UniswapV3;
 const days = [2, 5, 14, 60];
 
-const averageDtr: [AverageDepositTokenRatio](#averagedeposittokenratio)[] = await getAverageDepositTokenRatios(
+const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
     vaultAddress,
     web3Provider,
     dex
@@ -859,7 +854,7 @@ const averageDtr: [AverageDepositTokenRatio](#averagedeposittokenratio)[] = awai
 
 // - or -
 
-const averageDtr: [AverageDepositTokenRatio](#averagedeposittokenratio)[] = await getAverageDepositTokenRatios(
+const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
     vaultAddress,
     web3Provider,
     dex,
@@ -892,7 +887,7 @@ const vaultAddress = "0x3ac9...a5f132";
 const dex = SupportedDex.UniswapV3;
 const days = [2, 5, 14, 60];
 
-const vaultMetrics: [VaultMetrics](#vaultmetrics)[] = await getVaultMetrics(
+const vaultMetrics: VaultMetrics[] = await getVaultMetrics(
     vaultAddress,
     web3Provider,
     dex
@@ -900,7 +895,7 @@ const vaultMetrics: [VaultMetrics](#vaultmetrics)[] = await getVaultMetrics(
 
 // - or -
 
-const vaultMetrics: [VaultMetrics](#vaultmetrics)[] = await getVaultMetrics(
+const vaultMetrics: VaultMetrics[] = await getVaultMetrics(
     vaultAddress,
     web3Provider,
     dex,
@@ -917,8 +912,7 @@ const vaultMetrics: [VaultMetrics](#vaultmetrics)[] = await getVaultMetrics(
 | vaultAddress   | string | - | true |
 | jsonProvider   | JsonRpcProvider | - | false |
 
-<br/>
-This function returns [IchiVault](#ichivault) object.
+This function returns an [IchiVault](#ichivault) object.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -943,7 +937,6 @@ if (vaultInfo) {
 | depositTokenAddress   | string | - | true |
 | pairedTokenAddress   | string | - | true |
 
-<br/>
 This function returns an array of all vaults ([IchiVault](#ichivault)[]) on the specified DEX that contain two tokens defined by the 'depositTokenAddress' and 'pairedTokenAddress' parameters.
 
 ```typescript
@@ -999,7 +992,6 @@ if (vaults.length === 0) {
 | jsonProvider      | [JsonRpcProvider](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
 | dex   | SupportedDex | - | true
 
-<br/>
 This function returns an object of type [VaultPositionsInfo](#vaultpositionsinfo).
 
 ```typescript
@@ -1010,7 +1002,7 @@ const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
 const vaultAddress = "0x3ac9...a5f132";
 const dex = SupportedDex.UniswapV3;
 
-const vaultPositions: [VaultPositionsInfo](#vaultpositionsinfo) = await getVaultPositions(
+const vaultPositions: VaultPositionsInfo = await getVaultPositions(
     vaultAddress,
     web3Provider,
     dex
@@ -1060,8 +1052,7 @@ const chains: SupportedChainId[] = getChainsForDex(dex);
 | dex   | SupportedDex | - | true |
 | vaultAddress   | string | - | true |
 
-<br/>
-This function returns information about reward rates and farming contract for the specified vault. This functions is specific for the Velodrome vaults.
+This function returns [RewardInfo](#rewardinfo) about reward rates and farming contract for the specified vault. This function is specific for Velodrome vaults.
 
 ```typescript
 import { getRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';
@@ -1070,7 +1061,7 @@ const vaultAddress = "0x3e4...45a";
 const chainId = SupportedChainId.Ink;
 const dex = SupportedDex.Velodrome;
 
-const rewardInfo: [RewardInfo](#rewardinfo) = getRewardInfo(chainId, dex, vaultAddress);
+const rewardInfo: RewardInfo = getRewardInfo(chainId, dex, vaultAddress);
 ```
 
 #### 30. `getAllRewardInfo()`
@@ -1080,8 +1071,7 @@ const rewardInfo: [RewardInfo](#rewardinfo) = getRewardInfo(chainId, dex, vaultA
 | chainId   | SupportedChainId | - | true |
 | dex   | SupportedDex | - | true |
 
-<br/>
-This function returns information about reward rates and farming contract for all vaults on the dex. This functions is specific for the Velodrome vaults.
+This function returns an array of [RewardInfo](#rewardinfo) about reward rates and farming contracts for all vaults on the dex. This function is specific for Velodrome vaults.
 
 ```typescript
 import { getAllRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-vaults-sdk';
@@ -1089,7 +1079,7 @@ import { getAllRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-
 const chainId = SupportedChainId.Ink;
 const dex = SupportedDex.Velodrome;
 
-const chains: [RewardInfo](#rewardinfo)[] = getAllRewardInfo(chainId, dex);
+const allRewardInfo: RewardInfo[] = getAllRewardInfo(chainId, dex);
 ```
 
 #### 31. `getAllUserRewards()`
@@ -1101,8 +1091,7 @@ const chains: [RewardInfo](#rewardinfo)[] = getAllRewardInfo(chainId, dex);
 | dex   | SupportedDex | - | true |
 | raw   | true | undefined | - | false |
 
-<br/>
-This function returns user rewards for all vaults on the dex. This functions is specific for the Velodrome vaults.
+This function returns user rewards (as [UserRewards](#userrewards)) for all vaults on the dex. This function is specific for Velodrome vaults.
 
 ```typescript
 import { getAllUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';
@@ -1111,7 +1100,7 @@ const account = "0x123...890";
 const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
 const dex = SupportedDex.Velodrome;
 
-const rewards: [UserRewards](#userrewards)[] = await getAllUserRewards(account, provider, dex);
+const rewards: UserRewards[] = await getAllUserRewards(account, provider, dex);
 ```
 
 #### 32. `getUserRewards()`
@@ -1124,8 +1113,7 @@ const rewards: [UserRewards](#userrewards)[] = await getAllUserRewards(account,
 | dex   | SupportedDex | - | true |
 | raw   | true | undefined | - | false |
 
-<br/>
-This function returns claimable reward amounts for the specified vault and user account. This functions is specific for the Velodrome vaults.
+This function returns claimable reward amounts (as [UserRewardsByToken](#userrewardsbytoken) or [UserRewardsByTokenBN](#userrewardsbytokenbn)) for the specified vault and user account. This function is specific for Velodrome vaults.
 
 ```typescript
 import { getUserRewards, SupportedDex } from '@ichidao/ichi-vaults-sdk';
@@ -1135,8 +1123,8 @@ const vaultAddress = "0x3e4...45a";
 const provider = new Web3Provider(YOUR_WEB3_PROVIDER);
 const dex = SupportedDex.Velodrome;
 
-const rewards: [UserRewardsByToken](#userrewardsbytoken)[] = getUserRewards(account, vaultAddress, provider, dex);
-const rewardsBN: [UserRewardsByTokenBN](#userrewardsbytokenbn)[] = getUserRewards(account, vaultAddress, provider, dex, true);
+const rewards: UserRewardsByToken[] = getUserRewards(account, vaultAddress, provider, dex);
+const rewardsBN: UserRewardsByTokenBN[] = getUserRewards(account, vaultAddress, provider, dex, true);
 ```
 
 #### 33. `claimRewards()`

package/dist/src/index.cjs.js

@@ -2,7 +2,7 @@
   /**
    * @license
    * author: ICHI DAO <core@ichi.org>
-   * ichi-vaults-sdk.js v0.1.37
+   * ichi-vaults-sdk.js v0.1.39
    * Released under the MIT license.
    */
 

package/dist/src/index.esm.js

@@ -2,7 +2,7 @@
   /**
    * @license
    * author: ICHI DAO <core@ichi.org>
-   * ichi-vaults-sdk.js v0.1.37
+   * ichi-vaults-sdk.js v0.1.39
    * Released under the MIT license.
    */
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ichidao/ichi-vaults-sdk",
-  "version": "0.1.37",
+  "version": "0.1.39",
   "description": "The ICHI Vaults SDK",
   "main": "dist/src/index.cjs.js",
   "module": "dist/src/index.esm.js",