@gearbox-protocol/sdk 14.4.2 → 14.4.3

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

@@ -453,6 +453,20 @@ class CreditAccountsServiceV310 extends import_base.SDKConstruct {
       creditFacade: cm.creditFacade
     };
   }
+  /**
+   * {@inheritDoc ICreditAccountsService.defaultPartialLiquidationParams}
+   */
+  defaultPartialLiquidationParams(ca) {
+    const tokenOut = this.#getBestTokenOut(ca);
+    const optimalHF = this.getOptimalHFForPartialLiquidation(ca);
+    const repaidAmount = this.#calcOptimalRepaidAmount(ca, tokenOut, optimalHF);
+    const minSeizedAmount = this.#calcMinSeizedAmount(
+      ca,
+      tokenOut,
+      repaidAmount
+    );
+    return { tokenOut, optimalHF, repaidAmount, minSeizedAmount };
+  }
   /**
    * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
    */

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

@@ -448,6 +448,20 @@ class CreditAccountsServiceV310 extends SDKConstruct {
       creditFacade: cm.creditFacade
     };
   }
+  /**
+   * {@inheritDoc ICreditAccountsService.defaultPartialLiquidationParams}
+   */
+  defaultPartialLiquidationParams(ca) {
+    const tokenOut = this.#getBestTokenOut(ca);
+    const optimalHF = this.getOptimalHFForPartialLiquidation(ca);
+    const repaidAmount = this.#calcOptimalRepaidAmount(ca, tokenOut, optimalHF);
+    const minSeizedAmount = this.#calcMinSeizedAmount(
+      ca,
+      tokenOut,
+      repaidAmount
+    );
+    return { tokenOut, optimalHF, repaidAmount, minSeizedAmount };
+  }
   /**
    * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
    */

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

@@ -6,7 +6,7 @@ import type { KYCOpenAccountRequirements } from "../market/kyc/index.js";
 import type { OnchainSDK } from "../OnchainSDK.js";
 import { type RouterCASlice } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
-import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
+import type { AccountToCheck, AddCollateralProps, ChangeDeptProps, ClaimDelayedProps, ClaimFarmRewardsProps, CloseCreditAccountProps, CloseCreditAccountResult, CreditAccountOperationResult, CreditAccountTokensSlice, CreditManagerOperationResult, DefaultPartialLiquidationParams, ExecuteSwapProps, FullyLiquidateProps, FullyLiquidateResult, GetApprovalAddressProps, GetConnectedBotsResult, GetConnectedMigrationBotsResult, GetCreditAccountsOptions, GetOpenAccountRequirementsProps, GetPendingWithdrawalsProps, GetPendingWithdrawalsResult, ICreditAccountsService, OpenCAProps, PartiallyLiquidateProps, PreviewDelayedWithdrawalProps, PreviewDelayedWithdrawalResult, RepayAndLiquidateCreditAccountProps, RepayCreditAccountProps, Rewards, SetBotProps, StartDelayedWithdrawalProps, UpdateQuotasProps, WithdrawCollateralProps } from "./types.js";
 /**
  * Options for configuring the credit account service.
  **/
@@ -64,6 +64,10 @@ export declare class CreditAccountsServiceV310 extends SDKConstruct implements I
      * {@inheritDoc ICreditAccountsService.fullyLiquidate}
      **/
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
+    /**
+     * {@inheritDoc ICreditAccountsService.defaultPartialLiquidationParams}
+     */
+    defaultPartialLiquidationParams(ca: CreditAccountData): DefaultPartialLiquidationParams;
     /**
      * {@inheritDoc ICreditAccountsService.partiallyLiquidate}
      */

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

@@ -488,6 +488,24 @@ export interface FullyLiquidateProps {
      */
     debtOnly?: boolean;
 }
+export interface DefaultPartialLiquidationParams {
+    /**
+     * {@link PartiallyLiquidateProps.tokenOut}
+     */
+    tokenOut: Address;
+    /**
+     * {@link PartiallyLiquidateProps.repaidAmount}
+     */
+    repaidAmount: bigint;
+    /**
+     * {@link PartiallyLiquidateProps.minSeizedAmount}
+     */
+    minSeizedAmount: bigint;
+    /**
+     * {@link PartiallyLiquidateProps.optimalHF}
+     */
+    optimalHF: bigint;
+}
 export interface PartiallyLiquidateProps {
     /**
      * Credit account to liquidate
@@ -510,7 +528,9 @@ export interface PartiallyLiquidateProps {
     repaidAmount?: bigint;
     /**
      * Minimum amount of `token` to seize from `creditAccount`.
-     * If omitted, computed internally
+     * If `token` is a phantom token, it's withdrawn first, and its `depositedToken` is then sent to the liquidator.
+     * In this case, `minSeizedAmount` is denominated in `depositedToken`.
+     * If omitted, computed internally.
      */
     minSeizedAmount?: bigint;
     /**
@@ -713,14 +733,19 @@ export interface ICreditAccountsService extends Construct {
      * @returns Transaction data and optional loss policy data
      */
     fullyLiquidate(props: FullyLiquidateProps): Promise<FullyLiquidateResult>;
+    /**
+     * Calculates default partial liquidation parameters for a credit account
+     * These parameters are used as defaults for the {@link partiallyLiquidate} method.
+     * @param ca - Credit account to partially liquidate
+     */
+    defaultPartialLiquidationParams(ca: CreditAccountData): DefaultPartialLiquidationParams;
     /**
      * Generates transaction to partially liquidate credit account;
      *
      * Transaction partially liquidates credit account's debt in exchange for discounted collateral
      * by transferring underlying from the caller (requires approval to the credit manager) and uses it to repay
      * account's debt and pay fees to the treasury
-     * Transfers chosen collateral token at discounted oracle price to the liquidator (liquidation discount
-     * and fee are the same as for full liquidations, though fees are not deposited into the pool)
+     * Transfers chosen collateral token at discounted oracle price to the liquidator
      *
      * @param props - {@link PartiallyLiquidateProps}
      * @returns Raw transaction ready to be signed and sent

package/package.json

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