@gearbox-protocol/sdk 3.0.0-next.30 → 3.0.0-next.32

package/lib/core/creditAccount.d.ts

@@ -7,7 +7,7 @@ export interface CalcOverallAPYProps {
     caAssets: Array<Asset>;
     lpAPY: LpTokensAPY | undefined;
     quotas: Record<string, Asset>;
-    quotaRates: Record<string, Pick<QuotaInfo, "rate">>;
+    quotaRates: Record<string, Pick<QuotaInfo, "isActive" | "rate">>;
     prices: Record<string, bigint>;
     totalValue: bigint | undefined;
     debt: bigint | undefined;
@@ -17,6 +17,7 @@ export interface CalcOverallAPYProps {
 export interface CalcHealthFactorProps {
     assets: Array<Asset>;
     quotas: Record<string, Asset>;
+    quotasInfo: Record<string, Pick<QuotaInfo, "isActive">>;
     prices: Record<string, bigint>;
     liquidationThresholds: Record<string, bigint>;
     underlyingToken: string;
@@ -36,7 +37,7 @@ interface CalcQuotaUpdateReturnType {
 }
 export interface CalcQuotaBorrowRateProps {
     quotas: Record<string, Asset>;
-    quotaRates: Record<string, Pick<QuotaInfo, "rate">>;
+    quotaRates: Record<string, Pick<QuotaInfo, "isActive" | "rate">>;
     borrowAmount: bigint;
 }
 export declare class CreditAccountData {
@@ -87,7 +88,7 @@ export declare class CreditAccountData {
     static calcOverallAPY({ caAssets, lpAPY, prices, quotas, quotaRates, totalValue, debt, baseBorrowRate, underlyingToken, }: CalcOverallAPYProps): bigint | undefined;
     hash(): string;
     static hash(creditManager: string, borrower: string): string;
-    static calcHealthFactor({ assets, quotas, liquidationThresholds, underlyingToken, borrowed, prices, }: CalcHealthFactorProps): number;
+    static calcHealthFactor({ assets, quotas, quotasInfo, liquidationThresholds, underlyingToken, borrowed, prices, }: CalcHealthFactorProps): number;
     static calcQuotaUpdate({ quotas, initialQuotas, assetsAfterUpdate, allowedToSpend, allowedToObtain, }: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
     static calcQuotaBorrowRate({ quotas, quotaRates, borrowAmount, }: CalcQuotaBorrowRateProps): number;
 }

package/lib/core/creditAccount.js

@@ -170,9 +170,10 @@ class CreditAccountData {
             const tokenDecimals = sdk_gov_1.decimals[symbol];
             const money = price_1.PriceUtils.calcTotalPrice(price, amount, tokenDecimals);
             const apyMoney = money * BigInt(apy);
-            const { balance: quotaAmount = 0n } = quotas[tokenAddressLC] || {};
+            const { rate: quotaAPY = 0, isActive = false } = quotaRates?.[tokenAddressLC] || {};
+            const { balance: quotaBalance = 0n } = quotas[tokenAddressLC] || {};
+            const quotaAmount = isActive ? quotaBalance : 0n;
             const quotaMoney = price_1.PriceUtils.calcTotalPrice(underlyingPrice || 0n, quotaAmount, underlyingTokenDecimals);
-            const { rate: quotaAPY = 0 } = quotaRates[tokenAddressLC] || {};
             const quotaAPYMoney = quotaMoney * BigInt(quotaAPY);
             return acc + apyMoney - quotaAPYMoney;
         }, 0n);
@@ -191,7 +192,7 @@ class CreditAccountData {
     static hash(creditManager, borrower) {
         return `${creditManager.toLowerCase()}:${borrower.toLowerCase()}`;
     }
-    static calcHealthFactor({ assets, quotas, liquidationThresholds, underlyingToken, borrowed, prices, }) {
+    static calcHealthFactor({ assets, quotas, quotasInfo, liquidationThresholds, underlyingToken, borrowed, prices, }) {
         const [, underlyingDecimals] = (0, sdk_gov_1.extractTokenData)(underlyingToken);
         const underlyingPrice = prices[underlyingToken] || 0n;
         const assetLTMoney = assets.reduce((acc, { token: tokenAddress, balance: amount }) => {
@@ -199,8 +200,10 @@ class CreditAccountData {
             const lt = liquidationThresholds[tokenAddress] || 0n;
             const price = prices[tokenAddress] || 0n;
             const tokenMoney = price_1.PriceUtils.calcTotalPrice(price, amount, tokenDecimals);
+            const { isActive = false } = quotasInfo?.[tokenAddress] || {};
             const quota = quotas[tokenAddress];
-            const quotaMoney = price_1.PriceUtils.calcTotalPrice(underlyingPrice, quota?.balance || 0n, underlyingDecimals);
+            const quotaBalance = isActive ? quota?.balance || 0n : 0n;
+            const quotaMoney = price_1.PriceUtils.calcTotalPrice(underlyingPrice, quotaBalance, underlyingDecimals);
             // if quota is undefined, then it is not a quoted token
             const money = quota
                 ? math_1.BigIntMath.min(quotaMoney, tokenMoney)
@@ -214,8 +217,15 @@ class CreditAccountData {
     }
     static calcQuotaUpdate({ quotas, initialQuotas, assetsAfterUpdate, allowedToSpend, allowedToObtain, }) {
         const r = Object.values(quotas).reduce((acc, cmQuota) => {
-            const { token } = cmQuota;
+            const { token, isActive } = cmQuota;
             const { quota: initialQuota = 0n } = initialQuotas[token] || {};
+            if (!isActive) {
+                acc.desiredQuota[token] = {
+                    balance: initialQuota,
+                    token,
+                };
+                return acc;
+            }
             const after = assetsAfterUpdate[token];
             const { amountInTarget = 0n } = after || {};
             const desiredQuota = (amountInTarget * 101n) / 100n;
@@ -254,8 +264,9 @@ class CreditAccountData {
         if (borrowAmount <= 0)
             return 0;
         const totalRateBalance = Object.values(quotas).reduce((acc, { token, balance }) => {
-            const { rate = 0 } = quotaRates[token] || {};
-            const rateBalance = balance * BigInt(rate);
+            const { rate = 0, isActive = false } = quotaRates?.[token] || {};
+            const quotaBalance = isActive ? balance : 0n;
+            const rateBalance = quotaBalance * BigInt(rate);
             return acc + rateBalance;
         }, 0n);
         const quotaBorrowRate = Number(totalRateBalance / borrowAmount);

package/lib/core/creditAccount.spec.js

@@ -36,6 +36,7 @@ const caWithoutLP = {
     rates: {
         [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
             rate: 38434,
+            isActive: true,
         },
     },
 };
@@ -63,6 +64,7 @@ const caWithLP = {
     rates: {
         [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
             rate: 38434,
+            isActive: true,
         },
     },
 };
@@ -225,11 +227,17 @@ const defaultCA = {
             token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase(),
         },
     },
+    quotasInfo: {
+        [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
+            isActive: true,
+        },
+    },
 };
 describe("CreditAccount calcHealthFactor test", () => {
     it("health factor is calculated correctly", () => {
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: defaultCA.assets,
             prices,
             liquidationThresholds,
@@ -241,6 +249,7 @@ describe("CreditAccount calcHealthFactor test", () => {
     it("health factor calculation has no division by zero error", () => {
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: [],
             prices: {},
             liquidationThresholds: {},
@@ -257,6 +266,7 @@ describe("CreditAccount calcHealthFactor test", () => {
         const afterAdd = assets_1.AssetUtils.sumAssets(defaultCA.assets, [collateral]);
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: afterAdd,
             prices,
             liquidationThresholds,
@@ -276,6 +286,7 @@ describe("CreditAccount calcHealthFactor test", () => {
         ]);
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: afterDecrease,
             prices,
             liquidationThresholds,
@@ -295,6 +306,7 @@ describe("CreditAccount calcHealthFactor test", () => {
         ]);
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: afterIncrease,
             prices,
             liquidationThresholds,
@@ -319,6 +331,7 @@ describe("CreditAccount calcHealthFactor test", () => {
         const afterSwap = assets_1.AssetUtils.sumAssets(afterSub, [getAsset]);
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: {},
+            quotasInfo: {},
             assets: afterSwap,
             prices,
             liquidationThresholds,
@@ -330,6 +343,7 @@ describe("CreditAccount calcHealthFactor test", () => {
     it("health factor with sufficient quotas is calculated correctly", () => {
         const result = creditAccount_1.CreditAccountData.calcHealthFactor({
             quotas: defaultCA.quotas,
+            quotasInfo: defaultCA.quotasInfo,
             assets: defaultCA.assets,
             prices,
             liquidationThresholds,
@@ -346,6 +360,23 @@ describe("CreditAccount calcHealthFactor test", () => {
                     token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase(),
                 },
             },
+            quotasInfo: defaultCA.quotasInfo,
+            assets: defaultCA.assets,
+            prices,
+            liquidationThresholds,
+            underlyingToken: defaultCA.underlyingToken,
+            borrowed: defaultCA.debt,
+        });
+        (0, chai_1.expect)(result).to.be.eq(9300);
+    });
+    it("health factor with disabled quota is calculated correctly", () => {
+        const result = creditAccount_1.CreditAccountData.calcHealthFactor({
+            quotas: defaultCA.quotas,
+            quotasInfo: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
+                    isActive: false,
+                },
+            },
             assets: defaultCA.assets,
             prices,
             liquidationThresholds,
@@ -678,15 +709,15 @@ describe("CreditAccount calcQuotaUpdate test", () => {
             quotas: cmQuotas,
             initialQuotas: caQuota,
             assetsAfterUpdate: {
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
                     amountInTarget: 10n,
                     balance: 0n,
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
                 },
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
                     amountInTarget: 0n,
                     balance: 0n,
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
                 },
             },
             allowedToObtain: {},
@@ -709,6 +740,59 @@ describe("CreditAccount calcQuotaUpdate test", () => {
             },
         });
     });
+    it("shouldn't change quota if it is disabled", () => {
+        const result = creditAccount_1.CreditAccountData.calcQuotaUpdate({
+            quotas: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
+                    isActive: false,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                    isActive: false,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                    isActive: false,
+                },
+            },
+            initialQuotas: caQuota,
+            assetsAfterUpdate: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                    amountInTarget: 10n,
+                    balance: 0n,
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                    amountInTarget: 0n,
+                    balance: 0n,
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                },
+            },
+            allowedToObtain: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {},
+            },
+            allowedToSpend: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {},
+            },
+        });
+        (0, chai_1.expect)(result.quotaIncrease).to.be.deep.eq([]);
+        (0, chai_1.expect)(result.quotaDecrease).to.be.deep.eq([]);
+        (0, chai_1.expect)(result.desiredQuota).to.be.deep.eq({
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                balance: 5n,
+                token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
+            },
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                balance: 10n,
+                token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+            },
+            [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
+                balance: 0n,
+                token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+            },
+        });
+    });
 });
 describe("CreditAccount calcQuotaBorrowRate test", () => {
     it("should calculate quota rate (same amounts, different rates)", () => {
@@ -730,12 +814,15 @@ describe("CreditAccount calcQuotaBorrowRate test", () => {
             quotaRates: {
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
                     rate: 5,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
                     rate: 10,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
                     rate: 15,
+                    isActive: true,
                 },
             },
             borrowAmount: 30n,
@@ -761,12 +848,15 @@ describe("CreditAccount calcQuotaBorrowRate test", () => {
             quotaRates: {
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
                     rate: 10,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
                     rate: 10,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
                     rate: 10,
+                    isActive: true,
                 },
             },
             borrowAmount: 30n,
@@ -792,16 +882,53 @@ describe("CreditAccount calcQuotaBorrowRate test", () => {
             quotaRates: {
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
                     rate: 10,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
                     rate: 10,
+                    isActive: true,
                 },
                 [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
                     rate: 10,
+                    isActive: true,
                 },
             },
             borrowAmount: 60n,
         });
         (0, chai_1.expect)(result).to.be.eq(5);
     });
+    it("should calculate quota rate (disabled quota)", () => {
+        const result = creditAccount_1.CreditAccountData.calcQuotaBorrowRate({
+            quotas: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.DAI,
+                    balance: 5n,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
+                    balance: 10n,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
+                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
+                    balance: 15n,
+                },
+            },
+            quotaRates: {
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI]: {
+                    rate: 10,
+                    isActive: true,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH]: {
+                    rate: 10,
+                    isActive: false,
+                },
+                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH]: {
+                    rate: 10,
+                    isActive: true,
+                },
+            },
+            borrowAmount: 50n,
+        });
+        (0, chai_1.expect)(result).to.be.eq(4);
+    });
 });

package/lib/core/pool.d.ts

@@ -23,7 +23,7 @@ export declare class PoolData {
     readonly zappers: Record<string, PoolZapper>;
     readonly totalAssets: bigint;
     readonly totalSupply: bigint;
-    readonly borrowAPY7D: number | undefined;
+    readonly supplyAPY7D: number | undefined;
     readonly depositAPY: number;
     readonly borrowAPY: number;
     readonly interestModel: LinearModel;

package/lib/core/pool.js

@@ -26,7 +26,7 @@ class PoolData {
     zappers;
     totalAssets;
     totalSupply;
-    borrowAPY7D;
+    supplyAPY7D;
     depositAPY;
     borrowAPY;
     interestModel;
@@ -92,7 +92,7 @@ class PoolData {
         this.totalSupply = (0, sdk_gov_1.toBigInt)(payload.totalSupply);
         this.depositAPY = (0, formatter_1.rayToNumber)((0, sdk_gov_1.toBigInt)(payload.supplyRate) * sdk_gov_1.PERCENTAGE_DECIMALS);
         this.borrowAPY = (0, formatter_1.rayToNumber)((0, sdk_gov_1.toBigInt)(payload.baseInterestRate) * sdk_gov_1.PERCENTAGE_DECIMALS);
-        this.borrowAPY7D = payload.borrowAPY7D;
+        this.supplyAPY7D = payload.supplyAPY7D;
         this.interestModel = {
             interestModel: payload.lirm.interestModel.toLowerCase(),
             U_1: payload.lirm.U_1,

package/lib/payload/pool.d.ts

@@ -4,7 +4,7 @@ import { ZapperInfoStructOutput } from "../types/IDataCompressorV2_10";
 import { LinearModelStructOutput, PoolDataStructOutput } from "../types/IDataCompressorV3_00";
 export type PoolDataPayload = Omit<ExcludeArrayProps<PoolDataStructOutput>, "zappers"> & {
     zappers: Array<PoolZapper>;
-    borrowAPY7D: number | undefined;
+    supplyAPY7D: number | undefined;
 };
 export type LinearModel = Omit<ExcludeArrayProps<LinearModelStructOutput>, "version"> & {
     version: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "3.0.0-next.30",
+  "version": "3.0.0-next.32",
   "description": "Gearbox SDK",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",