@gearbox-protocol/sdk 3.0.0-next.210 → 3.0.0-next.211

package/lib/core/creditAccount.d.ts

@@ -84,6 +84,10 @@ interface LiquidationPriceProps {
     targetToken: Address;
     assets: Record<Address, Asset>;
 }
+export interface TimeToLiquidationProps {
+    totalBorrowRate_debt: bigint;
+    healthFactor: number;
+}
 export declare class CreditAccountData {
     readonly isSuccessful: boolean;
     readonly priceFeedsNeeded: Address[];
@@ -140,5 +144,10 @@ export declare class CreditAccountData {
     static calcQuotaBorrowRate({ quotas, quotaRates }: CalcQuotaBorrowRateProps): bigint;
     static calcRelativeBaseBorrowRate({ debt, baseRateWithFee, assetAmountInUnderlying, }: CalcRelativeBaseBorrowRateProps): bigint;
     static liquidationPrice({ liquidationThresholds, debt, underlyingToken, targetToken, assets, }: LiquidationPriceProps): bigint;
+    /**
+     * Calculates the time remaining until liquidation for a credit account.
+     * @returns The time remaining until liquidation in milliseconds.
+     */
+    static getTimeToLiquidation({ healthFactor, totalBorrowRate_debt, }: TimeToLiquidationProps): bigint;
 }
 export {};

package/lib/core/creditAccount.js

@@ -399,5 +399,18 @@ class CreditAccountData {
         return ((effectiveDebt * sdk_gov_1.PRICE_DECIMALS * sdk_gov_1.PERCENTAGE_FACTOR) /
             (effectiveTargetBalance * lpLT));
     }
+    /**
+     * Calculates the time remaining until liquidation for a credit account.
+     * @returns The time remaining until liquidation in milliseconds.
+     */
+    static getTimeToLiquidation({ healthFactor, totalBorrowRate_debt, }) {
+        if (healthFactor <= sdk_gov_1.PERCENTAGE_FACTOR || totalBorrowRate_debt === 0n)
+            return 0n;
+        // (HF - 1) / (br_D / year) or (HF - 1) * (year / br_D)
+        const HF_1 = BigInt(healthFactor) - sdk_gov_1.PERCENTAGE_FACTOR;
+        const brPerYear = (BigInt(sdk_gov_1.SECONDS_PER_YEAR) * sdk_gov_1.PERCENTAGE_FACTOR * sdk_gov_1.PERCENTAGE_DECIMALS) /
+            totalBorrowRate_debt;
+        return (HF_1 * brPerYear * 1000n) / sdk_gov_1.PERCENTAGE_FACTOR;
+    }
 }
 exports.CreditAccountData = CreditAccountData;

package/lib/core/creditAccount.spec.js

@@ -1619,3 +1619,27 @@ describe("CreditAccount calcRelativeBaseBorrowRate test", () => {
         (0, chai_1.expect)(result).to.be.eq(250n);
     });
 });
+describe("CreditAccount getTimeToLiquidation test", () => {
+    it("should return 0 when HF < 1", () => {
+        const result = creditAccount_1.CreditAccountData.getTimeToLiquidation({
+            healthFactor: 9000,
+            totalBorrowRate_debt: 250n,
+        });
+        (0, chai_1.expect)(result).to.be.eq(0n);
+    });
+    it("should return 0 when br_debt === 0", () => {
+        const result = creditAccount_1.CreditAccountData.getTimeToLiquidation({
+            healthFactor: 9000,
+            totalBorrowRate_debt: 0n,
+        });
+        (0, chai_1.expect)(result).to.be.eq(0n);
+    });
+    it("should calculate time to liquidation correctly", () => {
+        const result = creditAccount_1.CreditAccountData.getTimeToLiquidation({
+            healthFactor: 13750,
+            totalBorrowRate_debt: 20n * 10000n,
+        });
+        // 59_130_000
+        (0, chai_1.expect)(result).to.be.eq(59130000n * 1000n);
+    });
+});

package/package.json

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