@ichidao/ichi-vaults-sdk 0.1.36 → 0.1.38

package/README.md

@@ -565,7 +565,7 @@ const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumbe
 | 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';
@@ -601,7 +601,7 @@ const userBalancesInVaultsBN: UserBalanceInVaultBN[] = await getAllUserBalances(
 | 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';
@@ -715,6 +715,9 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 | days   | number | undefined | false |
 
 <br/>
+
+> **Note:** This function may take several seconds to execute as it processes historical data. It is best suited for report generation and batched backend processes rather than user-facing interfaces where immediate responses are expected. For real-time UI updates, consider using [`getFeeAprs()`](#20-getfeeaprs) instead.
+
 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.
 
 ```typescript
@@ -771,8 +774,11 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 | forDays   | number[] | undefined | false |
 
 <br/>
-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.
+
+> **Note:** This function may take several seconds to execute as it processes historical data. It is best suited for report generation and batched backend processes rather than user-facing interfaces where immediate responses are expected. For real-time UI updates, consider using [`getFeeAprs()`](#20-getfeeaprs) instead.
+
+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
@@ -809,7 +815,7 @@ const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
 | 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 containing APR values for 1 day, 3 days, 7 days, and 30 days.
+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
 import { Web3Provider } from '@ethersproject/providers';
@@ -833,8 +839,8 @@ console.log(`1-day Fee APR: ${feeAprs.feeApr_1d}%`);
 | timeIntervals   | number[] | [1, 7, 30] | false |
 
 <br/>
-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.
+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.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -871,8 +877,11 @@ const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatio
 | timeIntervals   | number[] | [1, 7, 30] | false |
 
 <br/>
-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.
+
+> **Note:** This function may take several seconds to execute as it processes historical data. It is best suited for report generation and batched backend processes rather than user-facing interfaces where immediate responses are expected.
+
+The getVaultMetrics() function returns an array of [VaultMetrics](#vaultmetrics) objects for the periods of time specified by the 'timeIntervals' parameter.
+If 'timeIntervals' is not specified, it returns [VaultMetrics](#vaultmetrics) objects for time periods of 1, 7, and 30 days.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -909,7 +918,7 @@ const vaultMetrics: VaultMetrics[] = await getVaultMetrics(
 | jsonProvider   | JsonRpcProvider | - | false |
 
 <br/>
-This function returns IchiVault object.
+This function returns [IchiVault](#ichivault) object.
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -935,7 +944,7 @@ if (vaultInfo) {
 | pairedTokenAddress   | string | - | true |
 
 <br/>
-This function returns an array of all vaults (IchiVault[]) on the specified DEX that contain two tokens defined by the 'depositTokenAddress' and 'pairedTokenAddress' parameters.
+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
 import { Web3Provider } from '@ethersproject/providers';
@@ -991,7 +1000,7 @@ if (vaults.length === 0) {
 | dex   | SupportedDex | - | true
 
 <br/>
-This function returns an object of type VaultPositionsInfo.
+This function returns an object of type [VaultPositionsInfo](#vaultpositionsinfo).
 
 ```typescript
 import { Web3Provider } from '@ethersproject/providers';
@@ -1052,7 +1061,7 @@ const chains: SupportedChainId[] = getChainsForDex(dex);
 | 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';
@@ -1072,7 +1081,7 @@ const rewardInfo: RewardInfo = getRewardInfo(chainId, dex, vaultAddress);
 | 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';
@@ -1080,7 +1089,7 @@ import { getAllRewardInfo, SupportedChainId, SupportedDex } from '@ichidao/ichi-
 const chainId = SupportedChainId.Ink;
 const dex = SupportedDex.Velodrome;
 
-const chains: RewardInfo[] = getAllRewardInfo(chainId, dex);
+const allRewardInfo: RewardInfo[] = getAllRewardInfo(chainId, dex);
 ```
 
 #### 31. `getAllUserRewards()`
@@ -1093,7 +1102,7 @@ const chains: RewardInfo[] = getAllRewardInfo(chainId, dex);
 | 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';
@@ -1116,7 +1125,7 @@ const rewards: UserRewards[] = await getAllUserRewards(account, provider, dex);
 | 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';
@@ -1126,8 +1135,8 @@ 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);
+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.36
+   * ichi-vaults-sdk.js v0.1.38
    * Released under the MIT license.
    */
 
@@ -30,3 +30,4 @@ tslib_1.__exportStar(require("./functions/userRewards"), exports);
 tslib_1.__exportStar(require("./functions/claimRewards"), exports);
 tslib_1.__exportStar(require("./types/index"), exports);
 tslib_1.__exportStar(require("./utils/getGraphUrls"), exports);
+tslib_1.__exportStar(require("./utils/config/addresses"), exports);

package/dist/src/index.d.ts

@@ -17,3 +17,4 @@ export * from './functions/userRewards';
 export * from './functions/claimRewards';
 export * from './types/index';
 export * from './utils/getGraphUrls';
+export * from './utils/config/addresses';

package/dist/src/index.esm.js

@@ -2,7 +2,7 @@
   /**
    * @license
    * author: ICHI DAO <core@ichi.org>
-   * ichi-vaults-sdk.js v0.1.36
+   * ichi-vaults-sdk.js v0.1.38
    * Released under the MIT license.
    */
 
@@ -28,3 +28,4 @@ tslib_1.__exportStar(require("./functions/userRewards"), exports);
 tslib_1.__exportStar(require("./functions/claimRewards"), exports);
 tslib_1.__exportStar(require("./types/index"), exports);
 tslib_1.__exportStar(require("./utils/getGraphUrls"), exports);
+tslib_1.__exportStar(require("./utils/config/addresses"), exports);

package/dist/src/index.js

@@ -34,4 +34,5 @@ __exportStar(require("./functions/userRewards"), exports);
 __exportStar(require("./functions/claimRewards"), exports);
 __exportStar(require("./types/index"), exports);
 __exportStar(require("./utils/getGraphUrls"), exports);
+__exportStar(require("./utils/config/addresses"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA2C;AAC3C,4DAA0C;AAC1C,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,oDAAkC;AAClC,4DAA0C;AAC1C,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,uDAAqC;AACrC,2DAAyC;AACzC,qDAAmC;AACnC,6DAA2C;AAC3C,yDAAuC;AACvC,yDAAuC;AACvC,0DAAwC;AACxC,2DAAyC;AACzC,gDAA8B;AAC9B,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAA2C;AAC3C,4DAA0C;AAC1C,2DAAyC;AACzC,sDAAoC;AACpC,uDAAqC;AACrC,oDAAkC;AAClC,4DAA0C;AAC1C,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,uDAAqC;AACrC,2DAAyC;AACzC,qDAAmC;AACnC,6DAA2C;AAC3C,yDAAuC;AACvC,yDAAuC;AACvC,0DAAwC;AACxC,2DAAyC;AACzC,gDAA8B;AAC9B,uDAAqC;AACrC,2DAAyC"}

package/dist/src/src/index.d.ts

@@ -17,3 +17,4 @@ export * from './functions/userRewards';
 export * from './functions/claimRewards';
 export * from './types/index';
 export * from './utils/getGraphUrls';
+export * from './utils/config/addresses';

package/package.json

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