@ichidao/ichi-vaults-sdk 0.0.20 → 0.0.22

package/README.md

@@ -11,18 +11,24 @@ This sdk contains collection of functions to interact with IchiVault's smart con
      * [__Vault Functions__](#Vault)
         * [`approveDepositToken()`](#1-approveDepositToken)
         * [`deposit()`](#2-depositLP)
-        * [`withdraw()`](#3-withdraw)
-        * [`isDepositTokenApproved()`](#4-isDepositTokenApproved)
-        * [`isTokenAllowed()`](#5-isTokenAllowed)
-        * [`getMaxDepositAmount()`](#6-getMaxDepositAmount)
-        * [`getUserBalance()`](#7-getUserBalance)
-        * [`getUserAmounts()`](#8-getUserAmounts)
-        * [`getTotalSupply()`](#9-getTotalSupply)
-        * [`getTotalAmounts()`](#10-getTotalAmounts)
-        * [`getFeesCollected()`](#11-getFeesCollected)
-        * [`getFeesCollectedInfo()`](#12-getFeesCollectedInfo)
-        * [`getIchiVaultInfo()`](#13-getIchiVaultInfo)
-        * [`getVaultsByTokens()`](#14-getVaultsByTokens)
+        * [`depositNativeToken()`](#3-depositLP)
+        * [`approveVaultToken()`](#4-approveDepositToken)
+        * [`isVaultTokenApproved()`](#5-approveDepositToken)
+        * [`withdraw()`](#6-withdraw)
+        * [`withdrawWithSlippage()`](#7-withdraw)
+        * [`withdrawNativeToken()`](#8-withdraw)
+        * [`isDepositTokenApproved()`](#9-isDepositTokenApproved)
+        * [`isTokenAllowed()`](#10-isTokenAllowed)
+        * [`getMaxDepositAmount()`](#11-getMaxDepositAmount)
+        * [`getUserBalance()`](#12-getUserBalance)
+        * [`getUserAmounts()`](#13-getUserAmounts)
+        * [`getTotalSupply()`](#14-getTotalSupply)
+        * [`getTotalAmounts()`](#15-getTotalAmounts)
+        * [`getFeesCollected()`](#16-getFeesCollected)
+        * [`getFeesCollectedInfo()`](#17-getFeesCollectedInfo)
+        * [`getAverageDepositTokenRatios()`](#18-getAverageDepositTokenRatios)
+        * [`getIchiVaultInfo()`](#19-getIchiVaultInfo)
+        * [`getVaultsByTokens()`](#20-getVaultsByTokens)
 
 ## Installation
 Install with
@@ -114,7 +120,113 @@ const txnDetails = await deposit(
 )
 ```
 
-#### 3. `withdraw()`
+#### 3. `depositNativeToken()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| accountAddress   | string | - | true
+| amount0           | string \| number | - | true
+| amount1           | string \| number | - | 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
+| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
+
+<br/>
+
+```typescript
+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](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/providers/src.ts/json-rpc-provider.ts#L393) | - | true
+| dex   | SupportedDex | - | true |
+| shares   | 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/>
+
+```typescript
+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 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, | - | 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 |
+
+<br/>
+
+```typescript
+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 = 100
+const dex = SupportedDex.UniswapV3
+
+const isToken0Approved: boolean = await isDepositTokenApproved(
+    accountAddress,
+    amount,
+    vaultAddress,
+    web3Provider,
+    dex
+)
+```
+
+#### 6. `withdraw()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -154,7 +266,89 @@ const txnDetails = await withdraw(
 )
 ```
 
-#### 4. `isDepositTokenApproved()`
+#### 7. `withdrawWithSlippage()`
+
+| param | type |  default | required
+| -------- | -------- | -------- | --------
+| accountAddress   | string | - | true
+| shares           | string \| number | - | 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
+| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
+
+<br/>
+
+```typescript
+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 | - | 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
+| overrides         | [Overrides](https://github.com/ethers-io/ethers.js/blob/f97b92bbb1bde22fcc44100af78d7f31602863ab/packages/contracts/lib/index.d.ts#L7)  | undefined | false
+
+<br/>
+
+```typescript
+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
 | -------- | -------- | -------- | --------
@@ -187,7 +381,7 @@ const isToken0Approved: boolean = await isDepositTokenApproved(
 )
 ```
 
-#### 5. `isTokenAllowed()`
+#### 10. `isTokenAllowed()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -215,7 +409,7 @@ const isAllowed = await isTokenAllowed(
 
 ```
 
-#### 6. `getMaxDepositAmount()`
+#### 11. `getMaxDepositAmount()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -243,7 +437,7 @@ const maxAmount = await getMaxDepositAmount(
 
 ```
 
-#### 7. `getUserBalance()`
+#### 12. `getUserBalance()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -282,7 +476,7 @@ const sharesBN: BigNumber = await getUserBalance(
 )
 ```
 
-#### 8. `getUserAmounts()`
+#### 13. `getUserAmounts()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -321,7 +515,7 @@ const amountsBN: [BigNumber, BigNumber] & {amount0: BigNumber, amount1: BigNumbe
 )
 ```
 
-#### 9. `getTotalSupply()`
+#### 14. `getTotalSupply()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -358,7 +552,7 @@ const sharesBN: BigNumber = await getTotalSupply(
 )
 ```
 
-#### 10. `getTotalAmounts()`
+#### 15. `getTotalAmounts()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -396,7 +590,7 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 )
 ```
 
-#### 11. `getFeesCollected()`
+#### 16. `getFeesCollected()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -452,7 +646,7 @@ const amountsBN: [BigNumber, BigNumber] & {total0: BigNumber, total1: BigNumber}
 )
 ```
 
-#### 12. `getFeesCollectedInfo()`
+#### 17. `getFeesCollectedInfo()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -490,7 +684,43 @@ const feesInfo: FeesInfo[] = await getFeesCollectedInfo(
 )
 ```
 
-#### 13. `getIchiVaultInfo()`
+#### 18. `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,
+)
+```
+
+#### 19. `getIchiVaultInfo()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------
@@ -515,7 +745,7 @@ if (vaultInfo) {
 }
 ```
 
-#### 14. `getVaultsByTokens()`
+#### 20. `getVaultsByTokens()`
 
 | param | type |  default | required
 | -------- | -------- | -------- | --------

package/dist/src/functions/calculateDtr.d.ts

@@ -0,0 +1,3 @@
+import { JsonRpcProvider } from '@ethersproject/providers';
+import { AverageDepositTokenRatio, SupportedDex } from '../types';
+export declare function getAverageDepositTokenRatios(vaultAddress: string, jsonProvider: JsonRpcProvider, dex: SupportedDex, timeIntervals?: number[]): Promise<AverageDepositTokenRatio[]>;

package/dist/src/functions/calculateDtr.js

@@ -0,0 +1,220 @@
+"use strict";
+/* eslint-disable no-redeclare */
+/* eslint-disable import/prefer-default-export */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAverageDepositTokenRatios = void 0;
+var bignumber_1 = require("@ethersproject/bignumber");
+var types_1 = require("../types");
+// eslint-disable-next-line import/no-cycle
+var vault_1 = require("./vault");
+var vaultEvents_1 = require("./vaultEvents");
+var balances_1 = require("./balances");
+var formatBigInt_1 = __importDefault(require("../utils/formatBigInt"));
+var timestamps_1 = __importDefault(require("../utils/timestamps"));
+var deposit_1 = require("./deposit");
+var getPrice_1 = __importDefault(require("../utils/getPrice"));
+var calculateFees_1 = require("./calculateFees");
+var priceFromPool_1 = require("./priceFromPool");
+// total amounts at deposit or withdrawal in deposit tokens
+function getTotalAmountsAtTransactionEvent(objTransactionEvent, isVaultInverted, token0Decimals, token1Decimals, beforeEvent) {
+    var price0 = !isVaultInverted
+        ? 1
+        : (0, getPrice_1.default)(isVaultInverted, bignumber_1.BigNumber.from(objTransactionEvent.sqrtPrice), token0Decimals, token1Decimals);
+    var price1 = isVaultInverted
+        ? 1
+        : (0, getPrice_1.default)(isVaultInverted, bignumber_1.BigNumber.from(objTransactionEvent.sqrtPrice), token0Decimals, token1Decimals);
+    var amount0 = beforeEvent
+        ? Number((0, formatBigInt_1.default)(bignumber_1.BigNumber.from(objTransactionEvent.totalAmount0BeforeEvent), token0Decimals)) * price0
+        : Number((0, formatBigInt_1.default)(bignumber_1.BigNumber.from(objTransactionEvent.totalAmount0), token0Decimals)) * price0;
+    var amount1 = beforeEvent
+        ? Number((0, formatBigInt_1.default)(bignumber_1.BigNumber.from(objTransactionEvent.totalAmount1BeforeEvent), token1Decimals)) * price1
+        : Number((0, formatBigInt_1.default)(bignumber_1.BigNumber.from(objTransactionEvent.totalAmount1), token1Decimals)) * price1;
+    return [amount0, amount1];
+}
+function getDtrAtTransactionEvent(objTransactionEvent, isVaultInverted, token0Decimals, token1Decimals, beforeEvent) {
+    if (beforeEvent === void 0) { beforeEvent = false; }
+    var timestamp = objTransactionEvent.createdAtTimestamp;
+    var totalAmounts = getTotalAmountsAtTransactionEvent(objTransactionEvent, isVaultInverted, token0Decimals, token1Decimals, beforeEvent);
+    var dtr = isVaultInverted
+        ? (totalAmounts[1] / (totalAmounts[0] + totalAmounts[1])) * 100
+        : (totalAmounts[0] / (totalAmounts[0] + totalAmounts[1])) * 100;
+    return { atTimestamp: timestamp, percent: dtr };
+}
+function getDtrAtFeeCollectionEvent(objFeeCollectionEvent, isVaultInverted, token0Decimals, token1Decimals) {
+    var timestamp = objFeeCollectionEvent.createdAtTimestamp;
+    var totalAmounts = (0, calculateFees_1.getTotalAmountsAtFeeCollectionEvent)(objFeeCollectionEvent, isVaultInverted, token0Decimals, token1Decimals);
+    var dtr = isVaultInverted
+        ? (totalAmounts[1] / (totalAmounts[0] + totalAmounts[1])) * 100
+        : (totalAmounts[0] / (totalAmounts[0] + totalAmounts[1])) * 100;
+    return { atTimestamp: timestamp, percent: dtr };
+}
+// time Interval in days
+function getAllDtrsForTimeInterval(vaultAddress, jsonProvider, dex, timeInterval) {
+    return __awaiter(this, void 0, void 0, function () {
+        var chainId, vault, token0Decimals, token1Decimals, isVaultInverted, rebalances, collectedFees, deposits, withdraws, arrRebalances, arrOtherFees, arrDeposits, arrWithdraws, currentDtr, result;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, jsonProvider.getNetwork()];
+                case 1:
+                    chainId = (_b.sent()).chainId;
+                    if (!Object.values(types_1.SupportedChainId).includes(chainId)) {
+                        throw new Error("Unsupported chainId: ".concat(chainId !== null && chainId !== void 0 ? chainId : 'undefined'));
+                    }
+                    return [4 /*yield*/, (0, vault_1.getIchiVaultInfo)(chainId, dex, vaultAddress, jsonProvider)];
+                case 2:
+                    vault = _b.sent();
+                    if (!vault)
+                        throw new Error("Vault ".concat(vaultAddress, " not found on chain ").concat(chainId, " and dex ").concat(dex));
+                    return [4 /*yield*/, (0, balances_1.getTokenDecimals)(vault.tokenA, jsonProvider)];
+                case 3:
+                    token0Decimals = _b.sent();
+                    return [4 /*yield*/, (0, balances_1.getTokenDecimals)(vault.tokenB, jsonProvider)];
+                case 4:
+                    token1Decimals = _b.sent();
+                    return [4 /*yield*/, (0, deposit_1.isTokenAllowed)(1, vaultAddress, jsonProvider, dex)];
+                case 5:
+                    isVaultInverted = _b.sent();
+                    return [4 /*yield*/, (0, vaultEvents_1.getRebalances)(vaultAddress, jsonProvider, dex, timeInterval)];
+                case 6:
+                    rebalances = _b.sent();
+                    if (!rebalances)
+                        throw new Error("Error getting vault rebalances on ".concat(chainId, " for ").concat(vaultAddress));
+                    return [4 /*yield*/, (0, vaultEvents_1.getFeesCollectedEvents)(vaultAddress, jsonProvider, dex, timeInterval)];
+                case 7:
+                    collectedFees = _b.sent();
+                    if (!collectedFees)
+                        throw new Error("Error getting vault collected fees on ".concat(chainId, " for ").concat(vaultAddress));
+                    return [4 /*yield*/, (0, vaultEvents_1.getDeposits)(vaultAddress, jsonProvider, dex, timeInterval)];
+                case 8:
+                    deposits = _b.sent();
+                    if (!deposits)
+                        throw new Error("Error getting vault deposits on ".concat(chainId, " for ").concat(vaultAddress));
+                    return [4 /*yield*/, (0, vaultEvents_1.getWithdraws)(vaultAddress, jsonProvider, dex, timeInterval)];
+                case 9:
+                    withdraws = _b.sent();
+                    if (!withdraws)
+                        throw new Error("Error getting vault withdraws on ".concat(chainId, " for ").concat(vaultAddress));
+                    arrRebalances = rebalances
+                        .slice()
+                        .filter(function (r) { return Number(r.createdAtTimestamp) * 1000 > Date.now() - (0, timestamps_1.default)(timeInterval); })
+                        .map(function (e) { return getDtrAtFeeCollectionEvent(e, isVaultInverted, token0Decimals, token1Decimals); });
+                    arrOtherFees = collectedFees
+                        .slice()
+                        .filter(function (r) { return Number(r.createdAtTimestamp) * 1000 > Date.now() - (0, timestamps_1.default)(timeInterval); })
+                        .map(function (e) { return getDtrAtFeeCollectionEvent(e, isVaultInverted, token0Decimals, token1Decimals); });
+                    arrDeposits = deposits
+                        .slice()
+                        .filter(function (r) { return Number(r.createdAtTimestamp) * 1000 > Date.now() - (0, timestamps_1.default)(timeInterval); })
+                        .map(function (e) { return getDtrAtTransactionEvent(e, isVaultInverted, token0Decimals, token1Decimals); });
+                    arrWithdraws = withdraws
+                        .slice()
+                        .filter(function (r) { return Number(r.createdAtTimestamp) * 1000 > Date.now() - (0, timestamps_1.default)(timeInterval); })
+                        .map(function (e) { return getDtrAtTransactionEvent(e, isVaultInverted, token0Decimals, token1Decimals); });
+                    _a = {
+                        atTimestamp: Math.floor(Date.now() / 1000).toString()
+                    };
+                    return [4 /*yield*/, (0, priceFromPool_1.getCurrentDtr)(vaultAddress, jsonProvider, dex, isVaultInverted, token0Decimals, token1Decimals)];
+                case 10:
+                    currentDtr = (_a.percent = _b.sent(),
+                        _a);
+                    result = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], arrDeposits, true), arrWithdraws, true), arrRebalances, true), arrOtherFees, true), [currentDtr], false).sort(function (a, b) { return Number(b.atTimestamp) - Number(a.atTimestamp); });
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+function getAverageDtr(allDtrs) {
+    if (allDtrs.length === 0) {
+        return 0;
+    }
+    if (allDtrs.length === 1) {
+        return allDtrs[0].percent; // current value
+    }
+    var dtrsSum = 0;
+    for (var i = 0; i < allDtrs.length - 1; i += 1) {
+        dtrsSum +=
+            ((allDtrs[i].percent + allDtrs[i + 1].percent) / 2) *
+                (Number(allDtrs[i + 1].atTimestamp) - Number(allDtrs[i].atTimestamp));
+    }
+    return dtrsSum / (Number(allDtrs[allDtrs.length - 1].atTimestamp) - Number(allDtrs[0].atTimestamp));
+}
+// timeInterval in days
+function getAverageDepositTokenRatios(vaultAddress, jsonProvider, dex, timeIntervals) {
+    if (timeIntervals === void 0) { timeIntervals = [1, 7, 30]; }
+    return __awaiter(this, void 0, void 0, function () {
+        var forTimeIntervals, maxTimeInterval, allDtrs, result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    forTimeIntervals = timeIntervals;
+                    if (timeIntervals.length === 0) {
+                        forTimeIntervals = [0];
+                    }
+                    maxTimeInterval = Math.max.apply(Math, forTimeIntervals);
+                    return [4 /*yield*/, getAllDtrsForTimeInterval(vaultAddress, jsonProvider, dex, maxTimeInterval)];
+                case 1:
+                    allDtrs = _a.sent();
+                    result = [];
+                    forTimeIntervals.forEach(function (interval) {
+                        var dtrsForTimeInterval = interval === 0
+                            ? [allDtrs[0]]
+                            : allDtrs.filter(function (elem) { return Number(elem.atTimestamp) * 1000 >= Date.now() - (0, timestamps_1.default)(interval); });
+                        var averageDtr = getAverageDtr(dtrsForTimeInterval);
+                        result.push({ timePeriod: interval, percent: averageDtr });
+                    });
+                    return [2 /*return*/, result];
+            }
+        });
+    });
+}
+exports.getAverageDepositTokenRatios = getAverageDepositTokenRatios;
+//# sourceMappingURL=calculateDtr.js.map

package/dist/src/functions/calculateDtr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateDtr.js","sourceRoot":"","sources":["../../../src/functions/calculateDtr.ts"],"names":[],"mappings":";AAAA,iCAAiC;AACjC,iDAAiD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGjD,sDAAqD;AACrD,kCAOkB;AAClB,2CAA2C;AAC3C,iCAA2C;AAC3C,6CAAiG;AACjG,uCAA8C;AAC9C,uEAAiD;AACjD,mEAAqD;AACrD,qCAA2C;AAC3C,+DAAyC;AACzC,iDAAsE;AACtE,iDAAgD;AAEhD,2DAA2D;AAC3D,SAAS,iCAAiC,CACxC,mBAA0C,EAC1C,eAAwB,EACxB,cAAsB,EACtB,cAAsB,EACtB,WAAoB;IAEpB,IAAM,MAAM,GAAG,CAAC,eAAe;QAC7B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,IAAA,kBAAQ,EAAC,eAAe,EAAE,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;IAC7G,IAAM,MAAM,GAAG,eAAe;QAC5B,CAAC,CAAC,CAAC;QACH,CAAC,CAAC,IAAA,kBAAQ,EAAC,eAAe,EAAE,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;IAC7G,IAAM,OAAO,GAAG,WAAW;QACzB,CAAC,CAAC,MAAM,CAAC,IAAA,sBAAY,EAAC,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,MAAM;QAC5G,CAAC,CAAC,MAAM,CAAC,IAAA,sBAAY,EAAC,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC;IACpG,IAAM,OAAO,GAAG,WAAW;QACzB,CAAC,CAAC,MAAM,CAAC,IAAA,sBAAY,EAAC,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,MAAM;QAC5G,CAAC,CAAC,MAAM,CAAC,IAAA,sBAAY,EAAC,qBAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC;IACpG,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,SAAS,wBAAwB,CAC/B,mBAA0C,EAC1C,eAAwB,EACxB,cAAsB,EACtB,cAAsB,EACtB,WAA4B;IAA5B,4BAAA,EAAA,mBAA4B;IAE5B,IAAM,SAAS,GAAG,mBAAmB,CAAC,kBAAkB,CAAC;IACzD,IAAM,YAAY,GAAG,iCAAiC,CACpD,mBAAmB,EACnB,eAAe,EACf,cAAc,EACd,cAAc,EACd,WAAW,CACZ,CAAC;IACF,IAAM,GAAG,GAAG,eAAe;QACzB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG;QAC/D,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IAClE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAClD,CAAC;AAED,SAAS,0BAA0B,CACjC,qBAA2B,EAC3B,eAAwB,EACxB,cAAsB,EACtB,cAAsB;IAEtB,IAAM,SAAS,GAAG,qBAAqB,CAAC,kBAAkB,CAAC;IAC3D,IAAM,YAAY,GAAG,IAAA,mDAAmC,EACtD,qBAAqB,EACrB,eAAe,EACf,cAAc,EACd,cAAc,CACf,CAAC;IACF,IAAM,GAAG,GAAG,eAAe;QACzB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG;QAC/D,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;IAClE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC;AAClD,CAAC;AAED,wBAAwB;AACxB,SAAe,yBAAyB,CACtC,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,YAAoB;;;;;;wBAEA,qBAAM,YAAY,CAAC,UAAU,EAAE,EAAA;;oBAA3C,OAAO,GAAK,CAAA,SAA+B,CAAA,QAApC;oBAEf,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,wBAAgB,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;wBACtD,MAAM,IAAI,KAAK,CAAC,+BAAwB,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,WAAW,CAAE,CAAC,CAAC;qBACnE;oBAEa,qBAAM,IAAA,wBAAgB,EAAC,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,YAAY,CAAC,EAAA;;oBAAxE,KAAK,GAAG,SAAgE;oBAC9E,IAAI,CAAC,KAAK;wBAAE,MAAM,IAAI,KAAK,CAAC,gBAAS,YAAY,iCAAuB,OAAO,sBAAY,GAAG,CAAE,CAAC,CAAC;oBAC3E,qBAAM,IAAA,2BAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAAnE,cAAc,GAAG,SAAkD;oBAClD,qBAAM,IAAA,2BAAgB,EAAC,KAAK,CAAC,MAAM,EAAE,YAAY,CAAC,EAAA;;oBAAnE,cAAc,GAAG,SAAkD;oBACjD,qBAAM,IAAA,wBAAc,EAAC,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,CAAC,EAAA;;oBAA1E,eAAe,GAAG,SAAwD;oBAE7D,qBAAM,IAAA,2BAAa,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,CAAC,EAAA;;oBAA/E,UAAU,GAAG,SAAkE;oBACrF,IAAI,CAAC,UAAU;wBAAE,MAAM,IAAI,KAAK,CAAC,4CAAqC,OAAO,kBAAQ,YAAY,CAAE,CAAC,CAAC;oBAC/E,qBAAM,IAAA,oCAAsB,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,CAAC,EAAA;;oBAA3F,aAAa,GAAG,SAA2E;oBACjG,IAAI,CAAC,aAAa;wBAAE,MAAM,IAAI,KAAK,CAAC,gDAAyC,OAAO,kBAAQ,YAAY,CAAE,CAAC,CAAC;oBAC3F,qBAAM,IAAA,yBAAW,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,CAAC,EAAA;;oBAA3E,QAAQ,GAAG,SAAgE;oBACjF,IAAI,CAAC,QAAQ;wBAAE,MAAM,IAAI,KAAK,CAAC,0CAAmC,OAAO,kBAAQ,YAAY,CAAE,CAAC,CAAC;oBAC/E,qBAAM,IAAA,0BAAY,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,CAAC,EAAA;;oBAA7E,SAAS,GAAG,SAAiE;oBACnF,IAAI,CAAC,SAAS;wBAAE,MAAM,IAAI,KAAK,CAAC,2CAAoC,OAAO,kBAAQ,YAAY,CAAE,CAAC,CAAC;oBAE7F,aAAa,GAAG,UAAU;yBAC7B,KAAK,EAAE;yBACP,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAA,oBAAkB,EAAC,YAAY,CAAC,EAAnF,CAAmF,CAAC;yBAClG,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,0BAA0B,CAAC,CAAC,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,EAA9E,CAA8E,CAAC,CAAC;oBACxF,YAAY,GAAG,aAAa;yBAC/B,KAAK,EAAE;yBACP,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAA,oBAAkB,EAAC,YAAY,CAAC,EAAnF,CAAmF,CAAC;yBAClG,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,0BAA0B,CAAC,CAAC,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,EAA9E,CAA8E,CAAC,CAAC;oBACxF,WAAW,GAAG,QAAQ;yBACzB,KAAK,EAAE;yBACP,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAA,oBAAkB,EAAC,YAAY,CAAC,EAAnF,CAAmF,CAAC;yBAClG,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,wBAAwB,CAAC,CAAC,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,EAA5E,CAA4E,CAAC,CAAC;oBACtF,YAAY,GAAG,SAAS;yBAC3B,KAAK,EAAE;yBACP,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAA,oBAAkB,EAAC,YAAY,CAAC,EAAnF,CAAmF,CAAC;yBAClG,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,wBAAwB,CAAC,CAAC,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,EAA5E,CAA4E,CAAC,CAAC;;wBAE1F,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE;;oBAC5C,qBAAM,IAAA,6BAAa,EAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,CAAC,EAAA;;oBAF1G,UAAU,GAAG,CAEjB,UAAO,GAAE,SAAqG;0BAC1F,CAAA;oBAEhB,MAAM,GAAG,0EAAI,WAAW,SAAK,YAAY,SAAK,aAAa,SAAK,YAAY,UAAE,UAAU,UAAE,IAAI,CAClG,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,EAA7C,CAA6C,CACxD,CAAC;oBAEF,sBAAO,MAAM,EAAC;;;;CACf;AAED,SAAS,aAAa,CAAC,OAA4B;IACjD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,CAAC,CAAC;KACV;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE;QACxB,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,gBAAgB;KAC5C;IACD,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE;QAC9C,OAAO;YACL,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACnD,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;KACzE;IACD,OAAO,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;AACtG,CAAC;AAED,uBAAuB;AACvB,SAAsB,4BAA4B,CAChD,YAAoB,EACpB,YAA6B,EAC7B,GAAiB,EACjB,aAAoC;IAApC,8BAAA,EAAA,iBAA2B,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;;;;;;oBAEhC,gBAAgB,GAAG,aAAa,CAAC;oBACrC,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;wBAC9B,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAC;qBACxB;oBACK,eAAe,GAAG,IAAI,CAAC,GAAG,OAAR,IAAI,EAAQ,gBAAgB,CAAC,CAAC;oBACtC,qBAAM,yBAAyB,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,eAAe,CAAC,EAAA;;oBAA3F,OAAO,GAAG,SAAiF;oBAC3F,MAAM,GAAG,EAAgC,CAAC;oBAChD,gBAAgB,CAAC,OAAO,CAAC,UAAC,QAAQ;wBAChC,IAAM,mBAAmB,GACvB,QAAQ,KAAK,CAAC;4BACZ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;4BACd,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAA,oBAAkB,EAAC,QAAQ,CAAC,EAA5E,CAA4E,CAAC,CAAC;wBAC7G,IAAM,UAAU,GAAG,aAAa,CAAC,mBAAmB,CAAC,CAAC;wBACtD,MAAM,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;oBAC7D,CAAC,CAAC,CAAC;oBACH,sBAAO,MAAM,EAAC;;;;CACf;AAtBD,oEAsBC"}

package/dist/src/functions/calculateFees.d.ts

@@ -1,5 +1,6 @@
 import { JsonRpcProvider } from '@ethersproject/providers';
-import { FeesInfo, SupportedDex, TotalAmounts, TotalAmountsBN } from '../types';
+import { Fees, FeesInfo, SupportedDex, TotalAmounts, TotalAmountsBN } from '../types';
+export declare function getTotalAmountsAtFeeCollectionEvent(objFees: Fees, isVaultInverted: boolean, token0Decimals: number, token1Decimals: number): [number, number];
 export declare function getFeesCollected(vaultAddress: string, jsonProvider: JsonRpcProvider, dex: SupportedDex, days?: number): Promise<TotalAmounts>;
 export declare function getFeesCollected(vaultAddress: string, jsonProvider: JsonRpcProvider, dex: SupportedDex, raw: true, days?: number): Promise<TotalAmountsBN>;
 export declare function getFeesCollectedInfo(vaultAddress: string, jsonProvider: JsonRpcProvider, dex: SupportedDex, forDays?: number[]): Promise<FeesInfo[]>;