@gearbox-protocol/sdk 3.0.0-next.95 → 3.0.0-next.97

package/lib/core/creditAccount.d.ts

@@ -52,6 +52,13 @@ export interface CalcAvgQuotaBorrowRateProps {
     quotaRates: Record<string, Pick<QuotaInfo, "isActive" | "rate">>;
     totalValue: bigint;
 }
+interface LiquidationPriceProps {
+    liquidationThresholds: Record<string, bigint>;
+    debt: bigint;
+    underlyingToken: string;
+    targetToken: string;
+    assets: Record<string, Asset>;
+}
 export declare class CreditAccountData {
     readonly isSuccessful: boolean;
     readonly addr: string;
@@ -100,5 +107,6 @@ export declare class CreditAccountData {
     static calcQuotaUpdate({ quotas, initialQuotas, assetsAfterUpdate, allowedToSpend, allowedToObtain, quotaReserve, }: CalcQuotaUpdateProps): CalcQuotaUpdateReturnType;
     static calcQuotaBorrowRate({ quotas, quotaRates }: CalcQuotaBorrowRateProps): bigint;
     static calcRelativeBaseBorrowRate({ debt, baseRateWithFee, assetAmountInUnderlying, totalValue, }: CalcRelativeBaseBorrowRateProps): bigint;
+    static liquidationPrice({ liquidationThresholds, debt, underlyingToken, targetToken, assets, }: LiquidationPriceProps): bigint;
 }
 export {};

package/lib/core/creditAccount.js

@@ -182,24 +182,26 @@ class CreditAccountData {
     static calcHealthFactor({ assets, quotas, quotasInfo, liquidationThresholds, underlyingToken, debt, prices, }) {
         const [, underlyingDecimals] = (0, sdk_gov_1.extractTokenData)(underlyingToken);
         const underlyingPrice = prices[underlyingToken] || 0n;
-        const assetLTMoney = assets.reduce((acc, { token: tokenAddress, balance: amount }) => {
+        const assetMoney = assets.reduce((acc, { token: tokenAddress, balance: amount }) => {
             const [, tokenDecimals] = (0, sdk_gov_1.extractTokenData)(tokenAddress);
             const lt = liquidationThresholds[tokenAddress] || 0n;
             const price = prices[tokenAddress] || 0n;
             const tokenMoney = price_1.PriceUtils.calcTotalPrice(price, amount, tokenDecimals);
+            const tokenLtMoney = (tokenMoney * lt) / sdk_gov_1.PERCENTAGE_FACTOR;
             const { isActive = false } = quotasInfo?.[tokenAddress] || {};
             const quota = quotas[tokenAddress];
             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)
-                : tokenMoney;
-            const ltMoney = money * lt;
-            return acc + ltMoney;
+                ? math_1.BigIntMath.min(quotaMoney, tokenLtMoney)
+                : tokenLtMoney;
+            return acc + money;
         }, 0n);
         const borrowedMoney = price_1.PriceUtils.calcTotalPrice(underlyingPrice || sdk_gov_1.PRICE_DECIMALS, debt, underlyingDecimals);
-        const hfInPercent = borrowedMoney > 0n ? assetLTMoney / borrowedMoney : 0n;
+        const hfInPercent = borrowedMoney > 0n
+            ? (assetMoney * sdk_gov_1.PERCENTAGE_FACTOR) / borrowedMoney
+            : 0n;
         return Number(hfInPercent);
     }
     static calcQuotaUpdate({ quotas, initialQuotas, assetsAfterUpdate, allowedToSpend, allowedToObtain, quotaReserve, }) {
@@ -262,5 +264,21 @@ class CreditAccountData {
             return 0n;
         return ((debt * BigInt(baseRateWithFee) * assetAmountInUnderlying) / totalValue);
     }
+    static liquidationPrice({ liquidationThresholds, debt, underlyingToken, targetToken, assets, }) {
+        const underlyingTokenLC = underlyingToken.toLowerCase();
+        const [, underlyingDecimals = 18] = (0, sdk_gov_1.extractTokenData)(underlyingTokenLC);
+        const { balance: underlyingBalance = 0n } = assets[underlyingTokenLC] || {};
+        const effectiveDebt = ((debt - underlyingBalance) * sdk_gov_1.WAD) / 10n ** BigInt(underlyingDecimals);
+        const targetTokenLC = targetToken.toLowerCase();
+        const [, targetDecimals = 18] = (0, sdk_gov_1.extractTokenData)(targetTokenLC);
+        const { balance: targetBalance = 0n } = assets[targetTokenLC] || {};
+        const effectiveTargetBalance = (targetBalance * sdk_gov_1.WAD) / 10n ** BigInt(targetDecimals);
+        const lpLT = liquidationThresholds[targetTokenLC] || 0n;
+        if (targetBalance <= 0n || lpLT <= 0n)
+            return 0n;
+        return ((effectiveDebt * sdk_gov_1.PRICE_DECIMALS * sdk_gov_1.PERCENTAGE_FACTOR) /
+            effectiveTargetBalance /
+            lpLT);
+    }
 }
 exports.CreditAccountData = CreditAccountData;

package/lib/core/strategy.d.ts

@@ -1,4 +1,3 @@
-import { Asset } from "./assets";
 import { CreditManagerData } from "./creditManager";
 export interface StrategyPayload {
     apy?: number;
@@ -9,14 +8,6 @@ export interface StrategyPayload {
     unleveragableCollateral: Array<string>;
     leveragableCollateral: Array<string>;
 }
-interface LiquidationPriceProps {
-    prices: Record<string, bigint>;
-    liquidationThresholds: Record<string, bigint>;
-    debt: bigint;
-    underlyingToken: string;
-    targetToken: string;
-    assets: Record<string, Asset>;
-}
 interface CalculateMaxAPYProps {
     apy: number;
     leverage: number;
@@ -34,7 +25,6 @@ export declare class Strategy {
     constructor(payload: StrategyPayload);
     static maxLeverage(lpToken: string, cms: Array<PartialCM>): number;
     static maxAPY({ apy, leverage, baseRateWithFee, quotaRateWithFee, }: CalculateMaxAPYProps): number;
-    static liquidationPrice({ prices, liquidationThresholds, debt, underlyingToken, targetToken, assets, }: LiquidationPriceProps): bigint;
     protected static maxLeverageThreshold(lpToken: string, cms: Array<PartialCM>): readonly [bigint, string];
 }
 type PartialCM = Pick<CreditManagerData, "liquidationThresholds" | "address">;

package/lib/core/strategy.js

@@ -2,8 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Strategy = void 0;
 const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
-const math_1 = require("../utils/math");
-const price_1 = require("../utils/price");
 class Strategy {
     apy;
     name;
@@ -34,21 +32,6 @@ class Strategy {
             Number(sdk_gov_1.LEVERAGE_DECIMALS);
         return collateralTerm + Math.floor(debtTerm);
     }
-    static liquidationPrice({ prices, liquidationThresholds, debt, underlyingToken, targetToken, assets, }) {
-        const underlyingTokenLC = underlyingToken.toLowerCase();
-        const [, underlyingDecimals = 18] = (0, sdk_gov_1.extractTokenData)(underlyingTokenLC);
-        const { balance: underlyingBalance = 0n } = assets[underlyingTokenLC] || {};
-        const underlyingPrice = prices[underlyingTokenLC] || sdk_gov_1.PRICE_DECIMALS;
-        const borrowedMoney = price_1.PriceUtils.calcTotalPrice(underlyingPrice, math_1.BigIntMath.max(0n, debt - underlyingBalance), underlyingDecimals);
-        const targetTokenLC = targetToken.toLowerCase();
-        const [, targetDecimals = 18] = (0, sdk_gov_1.extractTokenData)(targetTokenLC);
-        const { balance: targetBalance = 0n } = assets[targetTokenLC] || {};
-        const lpLT = liquidationThresholds[targetTokenLC] || 0n;
-        const lpPrice = prices[targetTokenLC] || sdk_gov_1.PRICE_DECIMALS;
-        const lpMoney = price_1.PriceUtils.calcTotalPrice(lpPrice, targetBalance, targetDecimals);
-        const lpLTMoney = (lpMoney * lpLT) / sdk_gov_1.PERCENTAGE_FACTOR;
-        return lpLTMoney > 0n ? (borrowedMoney * sdk_gov_1.WAD) / lpLTMoney : 0n;
-    }
     static maxLeverageThreshold(lpToken, cms) {
         const lpTokenLC = lpToken.toLowerCase();
         const ltByCM = cms.map(cm => {

package/package.json

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

package/lib/core/strategy.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/core/strategy.spec.js

@@ -1,117 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
-const chai_1 = require("chai");
-const formatter_1 = require("../utils/formatter");
-const strategy_1 = require("./strategy");
-const pools = {
-    "0x1": {
-        borrowRate: 27543,
-    },
-    "0x2": {
-        borrowRate: 5736,
-    },
-};
-const prices = {
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: (0, formatter_1.toBN)("1738.11830000", sdk_gov_1.PRICE_DECIMALS_POW),
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI.toLowerCase()]: (0, formatter_1.toBN)("0.99941103", sdk_gov_1.PRICE_DECIMALS_POW),
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: (0, formatter_1.toBN)("1703.87588096", sdk_gov_1.PRICE_DECIMALS_POW),
-};
-const liquidationThresholds = {
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.DAI.toLowerCase()]: 9300n,
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: 8500n,
-    [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: 9000n,
-};
-describe("Strategy test", () => {
-    it("maxAPY calculation is correct", () => {
-        const result = strategy_1.Strategy.maxAPY({
-            apy: 53203,
-            leverage: 10 * Number(sdk_gov_1.LEVERAGE_DECIMALS),
-            baseRateWithFee: pools["0x1"].borrowRate,
-            quotaRateWithFee: 0,
-        });
-        (0, chai_1.expect)(result).to.be.eq(284143);
-    });
-    it("liquidationPrice: calculation is correct", () => {
-        const result = strategy_1.Strategy.liquidationPrice({
-            liquidationThresholds,
-            prices,
-            debt: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
-            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-            assets: {
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-                },
-            },
-        });
-        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.992");
-    });
-    it("liquidationPrice: zero result when debt is compensated", () => {
-        const result = strategy_1.Strategy.liquidationPrice({
-            liquidationThresholds,
-            prices,
-            debt: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
-            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-            assets: {
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-                },
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-                },
-            },
-        });
-        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.000");
-    });
-    it("liquidationPrice: zero result when debt is overcompensated", () => {
-        const result = strategy_1.Strategy.liquidationPrice({
-            liquidationThresholds,
-            prices,
-            debt: (0, formatter_1.toBN)("350", sdk_gov_1.decimals.WETH),
-            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-            assets: {
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-                },
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("450", sdk_gov_1.decimals.WETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-                },
-            },
-        });
-        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.000");
-    });
-    it("liquidationPrice: zero result when debt is not compensated", () => {
-        const result = strategy_1.Strategy.liquidationPrice({
-            liquidationThresholds,
-            prices,
-            debt: (0, formatter_1.toBN)("450", sdk_gov_1.decimals.WETH),
-            underlyingToken: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-            targetToken: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-            assets: {
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.STETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("400", sdk_gov_1.decimals.STETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.STETH,
-                },
-                [sdk_gov_1.tokenDataByNetwork.Mainnet.WETH.toLowerCase()]: {
-                    balance: (0, formatter_1.toBN)("100", sdk_gov_1.decimals.WETH),
-                    token: sdk_gov_1.tokenDataByNetwork.Mainnet.WETH,
-                },
-            },
-        });
-        (0, chai_1.expect)(Number((0, formatter_1.toSignificant)(result, sdk_gov_1.WAD_DECIMALS_POW)).toFixed(3)).to.be.eq("0.992");
-    });
-    it("maxLeverage is correct", () => {
-        const result = strategy_1.Strategy.maxLeverage(sdk_gov_1.tokenDataByNetwork.Mainnet.STETH, [
-            { address: "0x1", liquidationThresholds },
-        ]);
-        (0, chai_1.expect)(result).to.be.eq(9 * Number(sdk_gov_1.LEVERAGE_DECIMALS));
-    });
-});