@gearbox-protocol/sdk 14.3.0 → 14.4.0

package/dist/cjs/dev/index.js

@@ -25,6 +25,7 @@ __export(dev_exports, {
 module.exports = __toCommonJS(dev_exports);
 __reExport(dev_exports, require("./AccountOpener.js"), module.exports);
 __reExport(dev_exports, require("./calcLiquidatableLTs.js"), module.exports);
+__reExport(dev_exports, require("./claimDSToken.js"), module.exports);
 __reExport(dev_exports, require("./claimFromFaucet.js"), module.exports);
 __reExport(dev_exports, require("./create2.js"), module.exports);
 __reExport(dev_exports, require("./createAnvilClient.js"), module.exports);
@@ -49,6 +50,7 @@ __reExport(dev_exports, require("./types.js"), module.exports);
   logSplitterTransport,
   ...require("./AccountOpener.js"),
   ...require("./calcLiquidatableLTs.js"),
+  ...require("./claimDSToken.js"),
   ...require("./claimFromFaucet.js"),
   ...require("./create2.js"),
   ...require("./createAnvilClient.js"),

package/dist/cjs/sdk/accounts/CreditAccountsServiceV310.js

@@ -454,10 +454,63 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
     };
   }
   /**
-   * {@inheritDoc ICreditAccountsService.calcMinSeizedAmount}
+   * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
    */
-  calcMinSeizedAmount(props) {
-    const { account, token, repaidAmount } = props;
+  async partiallyLiquidate(props) {
+    const { account, to } = props;
+    const tokenOut = props.tokenOut ?? this.#getBestTokenOut(account);
+    const optimalHF = props.optimalHF ?? this.getOptimalHFForPartialLiquidation(account);
+    const repaidAmount = props.repaidAmount ?? this.#calcOptimalRepaidAmount(account, tokenOut, optimalHF);
+    const minSeizedAmount = props.minSeizedAmount ?? this.#calcMinSeizedAmount(account, tokenOut, repaidAmount);
+    const cm = this.sdk.marketRegister.findCreditManager(account.creditManager);
+    const updates = await this.getOnDemandPriceUpdates(account, true);
+    const tx = cm.creditFacade.partiallyLiquidateCreditAccount(
+      account.creditAccount,
+      tokenOut,
+      repaidAmount,
+      minSeizedAmount,
+      to,
+      updates
+    );
+    return tx;
+  }
+  /**
+   * Picks the most valuable enabled non-underlying collateral token on the
+   * credit account (by oracle value in underlying).
+   *
+   * Ported from solidity:
+   * https://github.com/Gearbox-protocol/router-v3/blob/main/contracts/liquidation/AbstractLiquidator.sol#L270
+   */
+  #getBestTokenOut(account) {
+    const market = this.sdk.marketRegister.findByCreditManager(
+      account.creditManager
+    );
+    const underlying = market.underlying;
+    let bestVal = 0n;
+    let bestToken;
+    for (const t of account.tokens) {
+      if (t.token === underlying) continue;
+      if ((t.mask & account.enabledTokensMask) === 0n) continue;
+      if (t.balance === 0n) continue;
+      const val = market.priceOracle.convert(t.token, underlying, t.balance);
+      if (val > bestVal) {
+        bestVal = val;
+        bestToken = t.token;
+      }
+    }
+    if (!bestToken) {
+      throw new Error(
+        `cannot determine tokenOut for partial liquidation of ${this.sdk.labelAddress(account.creditAccount)}: no enabled non-underlying collateral with value`
+      );
+    }
+    return bestToken;
+  }
+  /**
+   * Returns the minimum amount of `token` collateral that must be seized when
+   * repaying `repaidAmount` of underlying. Mirrors the on-chain liquidation
+   * discount math, expired-aware.
+   */
+  #calcMinSeizedAmount(account, token, repaidAmount) {
     const market = this.sdk.marketRegister.findByCreditManager(
       account.creditManager
     );
@@ -473,21 +526,55 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
     return tokenAmount * 9990n / BigInt(fee);
   }
   /**
-   * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
+   * Computes the optimal `repaidAmount` (in underlying) that brings the credit
+   * account's health factor close to `optimalHF` after partial liquidation.
+   *
+   * Ported from solidity:
+   * https://github.com/Gearbox-protocol/router-v3/blob/56e2d515ec6d9bb1e324e71c3708e59710779b24/contracts/liquidation/AbstractLiquidator.sol#L292
    */
-  async partiallyLiquidate(props) {
-    const { account, token, repaidAmount, minSeizedAmount, to } = props;
-    const cm = this.sdk.marketRegister.findCreditManager(account.creditManager);
-    const updates = await this.getOnDemandPriceUpdates(account, true);
-    const tx = cm.creditFacade.partiallyLiquidateCreditAccount(
-      account.creditAccount,
-      token,
-      repaidAmount,
-      minSeizedAmount,
-      to,
-      updates
+  #calcOptimalRepaidAmount(account, token, optimalHF) {
+    const suite = this.sdk.marketRegister.findCreditManager(
+      account.creditManager
     );
-    return tx;
+    const market = this.sdk.marketRegister.findByCreditManager(
+      account.creditManager
+    );
+    const cm = suite.creditManager;
+    const feeLiquidation = suite.isExpired ? cm.feeLiquidationExpired : cm.feeLiquidation;
+    const liquidationDiscount = suite.isExpired ? cm.liquidationDiscountExpired : cm.liquidationDiscount;
+    const discount = BigInt(liquidationDiscount) - BigInt(feeLiquidation);
+    const ltTokenOut = cm.liquidationThresholds.get(token);
+    if (ltTokenOut === void 0) {
+      throw new Error(
+        `token ${this.sdk.labelAddress(token)} is not a collateral token in credit manager ${this.sdk.labelAddress(account.creditManager)}`
+      );
+    }
+    const totalDebt = account.debt + account.accruedInterest + account.accruedFees;
+    const twvUnderlying = market.priceOracle.convertFromUSD(
+      market.underlying,
+      account.twvUSD
+    );
+    const denominator = discount * optimalHF / import_constants.PERCENTAGE_FACTOR - BigInt(ltTokenOut);
+    if (denominator <= 0n) {
+      throw new Error(
+        "cannot compute optimal repaid amount: invalid liquidation parameters (discount * hfOptimal <= ltTokenOut)"
+      );
+    }
+    const numerator = totalDebt * optimalHF - twvUnderlying * import_constants.PERCENTAGE_FACTOR;
+    if (numerator <= 0n) {
+      return 0n;
+    }
+    const optimalValueSeized = numerator / denominator;
+    let repaidAmount = optimalValueSeized * discount / import_constants.PERCENTAGE_FACTOR;
+    const minDebt = suite.creditFacade.minDebt;
+    if (totalDebt < minDebt) {
+      return 0n;
+    }
+    const surplusDebt = totalDebt - minDebt;
+    if (repaidAmount > surplusDebt) {
+      repaidAmount = surplusDebt * 999n / 1000n;
+    }
+    return repaidAmount;
   }
   /**
    * {@inheritDoc ICreditAccountsService.closeCreditAccount}

package/dist/esm/dev/index.js

@@ -1,5 +1,6 @@
 export * from "./AccountOpener.js";
 export * from "./calcLiquidatableLTs.js";
+export * from "./claimDSToken.js";
 export * from "./claimFromFaucet.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";

package/dist/esm/sdk/accounts/CreditAccountsServiceV310.js

@@ -449,10 +449,63 @@ class CreditAccountsServiceV310 extends SDKConstruct {
     };
   }
   /**
-   * {@inheritDoc ICreditAccountsService.calcMinSeizedAmount}
+   * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
    */
-  calcMinSeizedAmount(props) {
-    const { account, token, repaidAmount } = props;
+  async partiallyLiquidate(props) {
+    const { account, to } = props;
+    const tokenOut = props.tokenOut ?? this.#getBestTokenOut(account);
+    const optimalHF = props.optimalHF ?? this.getOptimalHFForPartialLiquidation(account);
+    const repaidAmount = props.repaidAmount ?? this.#calcOptimalRepaidAmount(account, tokenOut, optimalHF);
+    const minSeizedAmount = props.minSeizedAmount ?? this.#calcMinSeizedAmount(account, tokenOut, repaidAmount);
+    const cm = this.sdk.marketRegister.findCreditManager(account.creditManager);
+    const updates = await this.getOnDemandPriceUpdates(account, true);
+    const tx = cm.creditFacade.partiallyLiquidateCreditAccount(
+      account.creditAccount,
+      tokenOut,
+      repaidAmount,
+      minSeizedAmount,
+      to,
+      updates
+    );
+    return tx;
+  }
+  /**
+   * Picks the most valuable enabled non-underlying collateral token on the
+   * credit account (by oracle value in underlying).
+   *
+   * Ported from solidity:
+   * https://github.com/Gearbox-protocol/router-v3/blob/main/contracts/liquidation/AbstractLiquidator.sol#L270
+   */
+  #getBestTokenOut(account) {
+    const market = this.sdk.marketRegister.findByCreditManager(
+      account.creditManager
+    );
+    const underlying = market.underlying;
+    let bestVal = 0n;
+    let bestToken;
+    for (const t of account.tokens) {
+      if (t.token === underlying) continue;
+      if ((t.mask & account.enabledTokensMask) === 0n) continue;
+      if (t.balance === 0n) continue;
+      const val = market.priceOracle.convert(t.token, underlying, t.balance);
+      if (val > bestVal) {
+        bestVal = val;
+        bestToken = t.token;
+      }
+    }
+    if (!bestToken) {
+      throw new Error(
+        `cannot determine tokenOut for partial liquidation of ${this.sdk.labelAddress(account.creditAccount)}: no enabled non-underlying collateral with value`
+      );
+    }
+    return bestToken;
+  }
+  /**
+   * Returns the minimum amount of `token` collateral that must be seized when
+   * repaying `repaidAmount` of underlying. Mirrors the on-chain liquidation
+   * discount math, expired-aware.
+   */
+  #calcMinSeizedAmount(account, token, repaidAmount) {
     const market = this.sdk.marketRegister.findByCreditManager(
       account.creditManager
     );
@@ -468,21 +521,55 @@ class CreditAccountsServiceV310 extends SDKConstruct {
     return tokenAmount * 9990n / BigInt(fee);
   }
   /**
-   * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
+   * Computes the optimal `repaidAmount` (in underlying) that brings the credit
+   * account's health factor close to `optimalHF` after partial liquidation.
+   *
+   * Ported from solidity:
+   * https://github.com/Gearbox-protocol/router-v3/blob/56e2d515ec6d9bb1e324e71c3708e59710779b24/contracts/liquidation/AbstractLiquidator.sol#L292
    */
-  async partiallyLiquidate(props) {
-    const { account, token, repaidAmount, minSeizedAmount, to } = props;
-    const cm = this.sdk.marketRegister.findCreditManager(account.creditManager);
-    const updates = await this.getOnDemandPriceUpdates(account, true);
-    const tx = cm.creditFacade.partiallyLiquidateCreditAccount(
-      account.creditAccount,
-      token,
-      repaidAmount,
-      minSeizedAmount,
-      to,
-      updates
+  #calcOptimalRepaidAmount(account, token, optimalHF) {
+    const suite = this.sdk.marketRegister.findCreditManager(
+      account.creditManager
     );
-    return tx;
+    const market = this.sdk.marketRegister.findByCreditManager(
+      account.creditManager
+    );
+    const cm = suite.creditManager;
+    const feeLiquidation = suite.isExpired ? cm.feeLiquidationExpired : cm.feeLiquidation;
+    const liquidationDiscount = suite.isExpired ? cm.liquidationDiscountExpired : cm.liquidationDiscount;
+    const discount = BigInt(liquidationDiscount) - BigInt(feeLiquidation);
+    const ltTokenOut = cm.liquidationThresholds.get(token);
+    if (ltTokenOut === void 0) {
+      throw new Error(
+        `token ${this.sdk.labelAddress(token)} is not a collateral token in credit manager ${this.sdk.labelAddress(account.creditManager)}`
+      );
+    }
+    const totalDebt = account.debt + account.accruedInterest + account.accruedFees;
+    const twvUnderlying = market.priceOracle.convertFromUSD(
+      market.underlying,
+      account.twvUSD
+    );
+    const denominator = discount * optimalHF / PERCENTAGE_FACTOR - BigInt(ltTokenOut);
+    if (denominator <= 0n) {
+      throw new Error(
+        "cannot compute optimal repaid amount: invalid liquidation parameters (discount * hfOptimal <= ltTokenOut)"
+      );
+    }
+    const numerator = totalDebt * optimalHF - twvUnderlying * PERCENTAGE_FACTOR;
+    if (numerator <= 0n) {
+      return 0n;
+    }
+    const optimalValueSeized = numerator / denominator;
+    let repaidAmount = optimalValueSeized * discount / PERCENTAGE_FACTOR;
+    const minDebt = suite.creditFacade.minDebt;
+    if (totalDebt < minDebt) {
+      return 0n;
+    }
+    const surplusDebt = totalDebt - minDebt;
+    if (repaidAmount > surplusDebt) {
+      repaidAmount = surplusDebt * 999n / 1000n;
+    }
+    return repaidAmount;
   }
   /**
    * {@inheritDoc ICreditAccountsService.closeCreditAccount}

package/dist/types/dev/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./AccountOpener.js";
 export * from "./calcLiquidatableLTs.js";
+export * from "./claimDSToken.js";
 export * from "./claimFromFaucet.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";

package/dist/types/sdk/accounts/CreditAccountsServiceV310.d.ts

@@ -64,10 +64,6 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
      * {@inheritDoc ICreditAccountsService.fullyLiquidate}
      **/
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
-    /**
-     * {@inheritDoc ICreditAccountsService.calcMinSeizedAmount}
-     */
-    calcMinSeizedAmount(props: PartiallyLiquidateProps): bigint;
     /**
      * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
      */

package/dist/types/sdk/accounts/types.d.ts

@@ -488,41 +488,37 @@ export interface FullyLiquidateProps {
      */
     debtOnly?: boolean;
 }
-export interface CalcMinSeizedAmountProps {
-    /**
-     * Credit account to liquidate
-     */
-    account: RouterCASlice;
-    /**
-     * Collateral token to seize
-     */
-    token: Address;
-    /**
-     * Amount of underlying token to repay
-     */
-    repaidAmount: bigint;
-}
 export interface PartiallyLiquidateProps {
     /**
      * Credit account to liquidate
      */
-    account: RouterCASlice;
+    account: CreditAccountData;
     /**
      * Address to transfer underlying left after liquidation
      */
     to: Address;
     /**
-     * Collateral token to seize
+     * Collateral token to seize.
+     * If omitted, the most valuable enabled non-underlying collateral token
+     * (by oracle)
      */
-    token: Address;
+    tokenOut?: Address;
     /**
-     * Amount of underlying token to repay
+     * Amount of underlying token to repay.
+     * If omitted, computed internally
      */
-    repaidAmount: bigint;
+    repaidAmount?: bigint;
     /**
-     * Minimum amount of `token` to seize from `creditAccount`
+     * Minimum amount of `token` to seize from `creditAccount`.
+     * If omitted, computed internally
      */
-    minSeizedAmount: bigint;
+    minSeizedAmount?: bigint;
+    /**
+     * Target health factor for partial liquidation (4 digits precision, 10000 = 100%).
+     * If omitted, defaults to {@link ICreditAccountsService.getOptimalHFForPartialLiquidation}.
+     * Only used when `repaidAmount` is not explicitly provided.
+     */
+    optimalHF?: bigint;
 }
 /**
  * EIP-2612 permit signature data for a token, enabling gasless approval for credit account operations.
@@ -717,13 +713,6 @@ export interface ICreditAccountsService extends Construct {
      * @returns Transaction data and optional loss policy data
      */
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
-    /**
-     * Calculates minimum amount of collateral token to seize from credit account
-     * for partial liquidation, can be passed to {@link partiallyLiquidate} as `minSeizedAmount`
-     * @param props - {@link CalcMinSeizedAmountProps}
-     * @returns Minimum amount of collateral token to seize
-     */
-    calcMinSeizedAmount(props: CalcMinSeizedAmountProps): bigint;
     /**
      * Generates transaction to partially liquidate credit account;
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.3.0",
+  "version": "14.4.0",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.js",