@ichidao/ichi-vaults-sdk 0.0.29 → 0.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/README.md +27 -5
  2. package/dist/src/functions/calculateApr.js +3 -2
  3. package/dist/src/functions/calculateApr.js.map +1 -1
  4. package/dist/src/index.cjs.js +1 -1
  5. package/dist/src/index.esm.js +1 -1
  6. package/package.json +1 -1
package/README.md CHANGED
@@ -830,7 +830,7 @@ const averageDtr: VaultApr[] = await getLpApr(
830
830
  )
831
831
  ```
832
832
 
833
- #### 22. `getAverageDepositTokenRatios()`
833
+ #### 22. `getLpPriceChange()`
834
834
 
835
835
  | param | type | default | required
836
836
  | -------- | -------- | -------- | --------
@@ -843,14 +843,14 @@ const averageDtr: VaultApr[] = await getLpApr(
843
843
 
844
844
  ```typescript
845
845
  import { Web3Provider } from '@ethersproject/providers';
846
- import { getFeesCollectedInfo, SupportedDex } from '@ichidao/ichi-vaults-sdk';
846
+ import { getLpPriceChange, SupportedDex } from '@ichidao/ichi-vaults-sdk';
847
847
 
848
848
  const web3Provider = new Web3Provider(YOUR_WEB3_PROVIDER);
849
849
  const vaultAddress = "0x3ac9...a5f132";
850
850
  const dex = SupportedDex.UniswapV3;
851
851
  const days = [2, 5, 14, 60];
852
852
 
853
- const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
853
+ const lpPriceChange: PriceChange[] = await getLpPriceChange(
854
854
  vaultAddress,
855
855
  web3Provider
856
856
  dex,
@@ -858,7 +858,7 @@ const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatio
858
858
 
859
859
  // - or -
860
860
 
861
- const averageDtr: AverageDepositTokenRatio[] = await getAverageDepositTokenRatios(
861
+ const lpPriceChange: PriceChange[] = await getLpPriceChange(
862
862
  vaultAddress,
863
863
  web3Provider
864
864
  dex,
@@ -1015,7 +1015,29 @@ type VaultApr = {
1015
1015
  ```typescript
1016
1016
  type PriceChange = {
1017
1017
  timeInterval: number; // in days
1018
- priceChange: number;
1018
+ priceChange: number; // percent
1019
+ }
1020
+ ```
1021
+
1022
+ ### UserAmountsBN
1023
+
1024
+ ```typescript
1025
+ type UserAmountsBN =
1026
+ [BigNumber, BigNumber] & { amount0: BigNumber; amount1: BigNumber };
1027
+ ```
1028
+
1029
+ ### UserAmounts
1030
+
1031
+ ```typescript
1032
+ type UserAmounts = [string, string] & { amount0: string; amount1: string };
1033
+ ```
1034
+
1035
+ ### UserAmountsInVault
1036
+
1037
+ ```typescript
1038
+ type UserAmountsInVault = {
1039
+ vaultAddress: string;
1040
+ userAmounts: UserAmounts;
1019
1041
  }
1020
1042
  ```
1021
1043
 
package/dist/src/functions/calculateApr.js CHANGED
@@ -136,11 +136,12 @@ function getLpPriceChange(vaultAddress, jsonProvider, dex, timeIntervals) {
136
136
  vaultEvents = _a.sent();
137
137
  arrDays.forEach(function (d) {
138
138
  var objLpPrice = getLpPriceAt(vaultEvents, d, isInv, decimals0, decimals1);
139
- if (!(objLpPrice === null || objLpPrice === void 0 ? void 0 : objLpPrice.priceChange)) {
139
+ var prevLpPrice = objLpPrice === null || objLpPrice === void 0 ? void 0 : objLpPrice.priceChange;
140
+ if (!prevLpPrice || prevLpPrice === 0) {
140
141
  result.push({ timeInterval: d, priceChange: null });
141
142
  }
142
143
  else {
143
- result.push({ timeInterval: d, priceChange: currLpPrice - objLpPrice.priceChange });
144
+ result.push({ timeInterval: d, priceChange: (currLpPrice - prevLpPrice) / prevLpPrice * 100 });
144
145
  }
145
146
  });
146
147
  return [2 /*return*/, result];
package/dist/src/functions/calculateApr.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"calculateApr.js","sourceRoot":"","sources":["../../../src/functions/calculateApr.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iCAAmC;AAEnC,2CAA2C;AAC3C,iCAA4C;AAC5C,iDAAmD;AACnD,iDAAiD;AACjD,6CAAmE;AACnE,kDAAyD;AACzD,+DAAyC;AAEzC,SAAS,YAAY,CACnB,WAAyB,EACzB,OAAe,EACf,eAAwB,EACxB,cAAsB,EACtB,cAAsB;IAEtB,IAAM,CAAC,GAAG,IAAA,6BAAe,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,IAAI,CAAC,CAAC,EAAE;QACN,OAAO,IAAI,CAAC;KACb;SAAM;QACL,IAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;QAC/E,IAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;QAEtE,IAAA,YAAY,GAAK,CAAC,aAAN,CAAO;QACnB,IAAA,YAAY,GAAK,CAAC,aAAN,CAAO;QACnB,IAAA,SAAS,GAAK,CAAC,UAAN,CAAO;QACxB,IAAM,KAAK,GAAG,IAAA,kBAAQ,EAAC,eAAe,EAAE,kBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAClH,IAAM,GAAG,GAAG,CAAC,eAAe;YAC1B,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK;YACrD,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACxD,IAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAM,IAAI,GAAG,IAAA,+BAAkB,EAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC;QAClF,IAAI,WAAW,KAAK,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,GAAG,WAAW,EAAE,CAAC;KAC/D;AACH,CAAC;AAED,SAAsB,QAAQ,CAC5B,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,aAAwB;;;;;wBAEN,qBAAM,IAAA,yBAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAlE,KAAK,GAAK,CAAA,SAAwD,CAAA,MAA7D;oBAEK,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAClD,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAC9D,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;oBAEZ,qBAAM,IAAA,8BAAc,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAA;;oBAAhG,WAAW,GAAG,SAAkF;oBAEhG,OAAO,GAAG,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBAEjF,MAAM,GAAG,EAAgB,CAAC;oBACZ,qBAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAtE,WAAW,GAAG,SAAwD;oBAC5E,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;wBAChB,IAAM,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;wBAC7E,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,WAAW,CAAA,EAAE;4BAC5B,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;yBAC7C;6BAAM;4BACL,IAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC;4BACrC,IAAM,GAAG,GAAG,CAAC,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;4BACrG,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,KAAA,EAAE,CAAC,CAAC;yBACvC;oBACH,CAAC,CAAC,CAAC;oBACH,sBAAO,MAAM,EAAC;;;;CACf;AA7BD,4BA6BC;AAED,SAAsB,gBAAgB,CACpC,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,aAAwB;;;;;wBAEN,qBAAM,IAAA,yBAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAlE,KAAK,GAAK,CAAA,SAAwD,CAAA,MAA7D;oBAEK,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAClD,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAC9D,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;oBAEZ,qBAAM,IAAA,8BAAc,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAA;;oBAAhG,WAAW,GAAG,SAAkF;oBAEhG,OAAO,GAAG,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBAEjF,MAAM,GAAG,EAAmB,CAAC;oBACf,qBAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAtE,WAAW,GAAG,SAAwD;oBAC5E,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;wBAChB,IAAM,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;wBAC7E,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,WAAW,CAAA,EAAE;4BAC5B,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;yBACrD;6BAAM;4BACL,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,WAAW,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;yBACrF;oBACH,CAAC,CAAC,CAAC;oBACH,sBAAO,MAAM,EAAC;;;;CACf;AA3BD,4CA2BC"}
1
+ {"version":3,"file":"calculateApr.js","sourceRoot":"","sources":["../../../src/functions/calculateApr.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iCAAmC;AAEnC,2CAA2C;AAC3C,iCAA4C;AAC5C,iDAAmD;AACnD,iDAAiD;AACjD,6CAAmE;AACnE,kDAAyD;AACzD,+DAAyC;AAEzC,SAAS,YAAY,CACnB,WAAyB,EACzB,OAAe,EACf,eAAwB,EACxB,cAAsB,EACtB,cAAsB;IAEtB,IAAM,CAAC,GAAG,IAAA,6BAAe,EAAC,WAAW,EAAE,OAAO,CAAC,CAAC;IAChD,IAAI,CAAC,CAAC,EAAE;QACN,OAAO,IAAI,CAAC;KACb;SAAM;QACL,IAAM,oBAAoB,GAAG,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;QAC/E,IAAM,mBAAmB,GAAG,eAAe,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,cAAc,CAAC;QAEtE,IAAA,YAAY,GAAK,CAAC,aAAN,CAAO;QACnB,IAAA,YAAY,GAAK,CAAC,aAAN,CAAO;QACnB,IAAA,SAAS,GAAK,CAAC,UAAN,CAAO;QACxB,IAAM,KAAK,GAAG,IAAA,kBAAQ,EAAC,eAAe,EAAE,kBAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,EAAE,CAAC,CAAC;QAClH,IAAM,GAAG,GAAG,CAAC,eAAe;YAC1B,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK;YACrD,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACxD,IAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;QAC1C,IAAM,IAAI,GAAG,IAAA,+BAAkB,EAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,CAAC;QAClF,IAAI,WAAW,KAAK,CAAC,EAAE;YACrB,OAAO,IAAI,CAAC;SACb;QACD,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,GAAG,WAAW,EAAE,CAAC;KAC/D;AACH,CAAC;AAED,SAAsB,QAAQ,CAC5B,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,aAAwB;;;;;wBAEN,qBAAM,IAAA,yBAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAlE,KAAK,GAAK,CAAA,SAAwD,CAAA,MAA7D;oBAEK,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAClD,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAC9D,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;oBAEZ,qBAAM,IAAA,8BAAc,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAA;;oBAAhG,WAAW,GAAG,SAAkF;oBAEhG,OAAO,GAAG,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBAEjF,MAAM,GAAG,EAAgB,CAAC;oBACZ,qBAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAtE,WAAW,GAAG,SAAwD;oBAC5E,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;wBAChB,IAAM,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;wBAC7E,IAAI,CAAC,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,WAAW,CAAA,EAAE;4BAC5B,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;yBAC7C;6BAAM;4BACL,IAAM,IAAI,GAAG,UAAU,CAAC,YAAY,CAAC;4BACrC,IAAM,GAAG,GAAG,CAAC,CAAC,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,WAAW,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;4BACrG,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,GAAG,KAAA,EAAE,CAAC,CAAC;yBACvC;oBACH,CAAC,CAAC,CAAC;oBACH,sBAAO,MAAM,EAAC;;;;CACf;AA7BD,4BA6BC;AAED,SAAsB,gBAAgB,CACpC,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,aAAwB;;;;;wBAEN,qBAAM,IAAA,yBAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAlE,KAAK,GAAK,CAAA,SAAwD,CAAA,MAA7D;oBAEK,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAClD,qBAAM,IAAA,gCAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAA9D,SAAS,GAAG,SAAkD;oBAC9D,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;oBAEZ,qBAAM,IAAA,8BAAc,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,EAAA;;oBAAhG,WAAW,GAAG,SAAkF;oBAEhG,OAAO,GAAG,aAAa,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBAEjF,MAAM,GAAG,EAAmB,CAAC;oBACf,qBAAM,IAAA,+BAAiB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAAtE,WAAW,GAAG,SAAwD;oBAC5E,OAAO,CAAC,OAAO,CAAC,UAAC,CAAC;wBAChB,IAAM,UAAU,GAAG,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;wBAC7E,IAAM,WAAW,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,WAAW,CAAC;wBAC5C,IAAI,CAAC,WAAW,IAAI,WAAW,KAAK,CAAC,EAAE;4BACrC,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;yBACrD;6BAAM;4BACL,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,WAAW,GAAG,WAAW,CAAC,GAAG,WAAW,GAAG,GAAG,EAAE,CAAC,CAAC;yBAChG;oBACH,CAAC,CAAC,CAAC;oBACH,sBAAO,MAAM,EAAC;;;;CACf;AA5BD,4CA4BC"}
package/dist/src/index.cjs.js CHANGED
@@ -2,7 +2,7 @@
2
2
  /**
3
3
  * @license
4
4
  * author: ICHI DAO <core@ichi.org>
5
- * ichi-vaults-sdk.js v0.0.29
5
+ * ichi-vaults-sdk.js v0.0.30
6
6
  * Released under the MIT license.
7
7
  */
8
8
 
package/dist/src/index.esm.js CHANGED
@@ -2,7 +2,7 @@
2
2
  /**
3
3
  * @license
4
4
  * author: ICHI DAO <core@ichi.org>
5
- * ichi-vaults-sdk.js v0.0.29
5
+ * ichi-vaults-sdk.js v0.0.30
6
6
  * Released under the MIT license.
7
7
  */
8
8
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ichidao/ichi-vaults-sdk",
3
- "version": "0.0.29",
3
+ "version": "0.0.30",
4
4
  "description": "The ICHI Vaults SDK",
5
5
  "main": "dist/src/index.cjs.js",
6
6
  "module": "dist/src/index.esm.js",