@gearbox-protocol/sdk 14.12.0-next.73 → 14.12.0-next.75

package/dist/types/sdk/market/math.d.ts

@@ -98,5 +98,64 @@ declare function positionLeverage(totalDebt: bigint, totalValue: bigint): Levera
  * ```
  **/
 declare function additionalBorrowApyBps(quotaRate: Bps, leverage: Leverage): Bps;
+/**
+ * {@link PERCENTAGE_FACTOR} less a 0.1% safety buffer.
+ *
+ * Partial liquidation amounts are computed off prices that can drift between
+ * quoting and execution, so both the seized and the repaid amount are pulled
+ * this far away from the boundary the contracts would revert on.
+ **/
+declare const PARTIAL_LIQUIDATION_BUFFER_BPS = 9990n;
+/**
+ * Minimum collateral a partial liquidation must seize for a given repayment,
+ * derived from the liquidation discount and buffered by
+ * {@link PARTIAL_LIQUIDATION_BUFFER_BPS}.
+ *
+ * @param tokenAmount - Repaid amount converted from underlying into the seized
+ * token by the oracle.
+ * @param liquidationDiscount - Discount in effect for this account, in basis
+ * points (the expired variant once the credit manager has expired).
+ **/
+declare function minSeizedAmount(tokenAmount: bigint, liquidationDiscount: Bps): bigint;
+/**
+ * Inputs of {@link optimalRepaidAmount}, all resolved against the account's
+ * market and credit manager by the caller.
+ **/
+interface OptimalRepaidAmountProps {
+  /** Debt principal plus accrued interest and fees, in underlying. */
+  totalDebt: bigint;
+  /** Threshold-weighted value of the account, converted to underlying. */
+  twvUnderlying: bigint;
+  /** Credit facade's minimum debt, in underlying. */
+  minDebt: bigint;
+  /** Health factor to aim for, in basis points. */
+  optimalHF: bigint;
+  /** `liquidationDiscount - feeLiquidation`, in basis points. */
+  discount: bigint;
+  /** Liquidation threshold of the seized token, in basis points. */
+  ltTokenOut: bigint;
+}
+/**
+ * Amount of underlying whose repayment brings the account's health factor close
+ * to `optimalHF`, capped so the account keeps at least `minDebt` of debt.
+ *
+ * Ported from solidity:
+ * https://github.com/Gearbox-protocol/router-v3/blob/56e2d515ec6d9bb1e324e71c3708e59710779b24/contracts/liquidation/AbstractLiquidator.sol#L292
+ *
+ * @returns The repaid amount, or `0n` when the account is already healthy
+ * enough or carries less than the minimum debt.
+ * @throws If the discounted target health factor does not exceed the seized
+ * token's liquidation threshold, in which case no repayment improves the
+ * account.
+ **/
+declare function optimalRepaidAmount({ totalDebt, twvUnderlying, minDebt, optimalHF, discount, ltTokenOut }: OptimalRepaidAmountProps): bigint;
+/**
+ * Health factor a partial liquidation should target, in basis points: just
+ * above 1, by enough to cover up to 1% of borrow cost so the account does not
+ * fall back under water immediately.
+ *
+ * @param borrowRate - Blended borrow rate of the account, in basis points.
+ **/
+declare function optimalHFForPartialLiquidation(borrowRate: bigint): bigint;
 //#endregion
-export { additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, positionLeverage, rayToBps, usdToNumber, utilizationBps };
+export { OptimalRepaidAmountProps, PARTIAL_LIQUIDATION_BUFFER_BPS, additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount, positionLeverage, rayToBps, usdToNumber, utilizationBps };

package/dist/types/sdk/market/oracle/PriceOracleBaseContract.d.ts

@@ -2,15 +2,15 @@ import { Amount, TokenAmount } from "../../../model/primitives.js";
 import { PriceFeedData, PriceFeedSummary } from "../../../model/opportunities.js";
 import "../../../model/index.js";
 import { AddressMap } from "../../utils/AddressMap.js";
-import { PriceOracleData } from "../../base/types.js";
+import { CreditAccountTokensSlice, PriceOracleData } from "../../base/types.js";
 import { DelegatedMulticall } from "../../utils/viem/executeDelegatedMulticalls.js";
 import "../../utils/viem/index.js";
 import { PriceOracleStateHuman } from "../../types/state-human.js";
-import { IPriceFeedContract, UpdatePriceFeedsResult } from "../pricefeeds/types.js";
+import { IPriceFeedContract, PriceUpdate, UpdatePriceFeedsResult } from "../pricefeeds/types.js";
 import { PriceFeedRef } from "../pricefeeds/PriceFeedRef.js";
 import "../pricefeeds/index.js";
 import PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
-import { IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions } from "./types.js";
+import { IPriceOracleContract, PriceFeedsForAccountOptions, PriceFeedsForTokensOptions } from "./types.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import "../../utils/index.js";
 import "../../types/index.js";
@@ -51,7 +51,18 @@ declare abstract class PriceOracleBaseContract<abi extends Abi | readonly unknow
    * {@inheritDoc IPriceOracleContract.priceFeedsForTokens}
    **/
   priceFeedsForTokens(tokens: Address[], opts?: PriceFeedsForTokensOptions): IPriceFeedContract[];
-  abstract onDemandPriceUpdates(creditFacade: Address, updates?: UpdatePriceFeedsResult): OnDemandPriceUpdates;
+  /**
+   * {@inheritDoc IPriceOracleContract.priceUpdateTxsForAccount}
+   **/
+  priceUpdateTxsForAccount(account: CreditAccountTokensSlice, opts?: PriceFeedsForAccountOptions): Promise<UpdatePriceFeedsResult>;
+  /**
+   * {@inheritDoc IPriceOracleContract.priceUpdatesForAccount}
+   **/
+  priceUpdatesForAccount(account: CreditAccountTokensSlice, opts?: PriceFeedsForAccountOptions): Promise<PriceUpdate[]>;
+  /**
+   * {@inheritDoc IPriceOracleContract.priceUpdatesForTokens}
+   **/
+  priceUpdatesForTokens(tokens: Address[], opts?: PriceFeedsForTokensOptions): Promise<PriceUpdate[]>;
   /**
    * {@inheritDoc IPriceOracleContract.mainPrice}
    **/

package/dist/types/sdk/market/oracle/PriceOracleV310Contract.d.ts

@@ -1,7 +1,4 @@
 import { PriceOracleData } from "../../base/types.js";
-import { UpdatePriceFeedsResult } from "../pricefeeds/types.js";
-import "../pricefeeds/index.js";
-import { OnDemandPriceUpdates } from "./types.js";
 import { PriceOracleBaseContract } from "./PriceOracleBaseContract.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import "../../base/index.js";
@@ -345,13 +342,6 @@ declare const abi: readonly [{
 type abi = typeof abi;
 declare class PriceOracleV310Contract extends PriceOracleBaseContract<abi> {
   constructor(sdk: OnchainSDK, data: PriceOracleData);
-  /**
-   * Converts previously obtained price updates into CreditFacade multicall entry
-   * @param creditFacade
-   * @param updates
-   * @returns
-   */
-  onDemandPriceUpdates(creditFacade: Address, updates?: UpdatePriceFeedsResult): OnDemandPriceUpdates;
   /**
    * {@inheritDoc IPriceOracleContract.updateAndConvert}
    **/

package/dist/types/sdk/market/oracle/index.d.ts

@@ -1,4 +1,4 @@
-import { IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions } from "./types.js";
+import { IPriceOracleContract, PriceFeedsForAccountOptions, PriceFeedsForTokensOptions } from "./types.js";
 import { createPriceOracle } from "./createPriceOracle.js";
 import { PriceOracleV310Contract } from "./PriceOracleV310Contract.js";
-export { IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions, PriceOracleV310Contract, createPriceOracle };
+export { IPriceOracleContract, PriceFeedsForAccountOptions, PriceFeedsForTokensOptions, PriceOracleV310Contract, createPriceOracle };

package/dist/types/sdk/market/oracle/types.d.ts

@@ -2,7 +2,7 @@ import { Amount, TokenAmount } from "../../../model/primitives.js";
 import { PriceFeedData, PriceFeedSummary } from "../../../model/opportunities.js";
 import "../../../model/index.js";
 import { AddressMap } from "../../utils/AddressMap.js";
-import { IBaseContract } from "../../base/types.js";
+import { CreditAccountTokensSlice, IBaseContract } from "../../base/types.js";
 import { DelegatedMulticall } from "../../utils/viem/executeDelegatedMulticalls.js";
 import "../../utils/viem/index.js";
 import { PriceOracleStateHuman } from "../../types/state-human.js";
@@ -10,7 +10,6 @@ import { IPriceFeedContract, PriceUpdate, UpdatePriceFeedsResult } from "../pric
 import { PriceFeedRef } from "../pricefeeds/PriceFeedRef.js";
 import "../pricefeeds/index.js";
 import PriceFeedAnswerMap from "./PriceFeedAnswerMap.js";
-import { MultiCall } from "../../types/transactions.js";
 import "../../utils/index.js";
 import "../../types/index.js";
 import "../../base/index.js";
@@ -33,12 +32,15 @@ interface PriceFeedsForTokensOptions {
   reserve?: boolean;
 }
 /**
- * On demand price updates acceptable by both credit facade multicall and
- * as raw PriceUpdate in liquidator calls.
- */
-interface OnDemandPriceUpdates {
-  raw: PriceUpdate[];
-  multicall: MultiCall[];
+ * Filter and extra inputs controlling which feeds to update for a credit
+ * account.
+ **/
+interface PriceFeedsForAccountOptions extends PriceFeedsForTokensOptions {
+  /**
+   * Extra tokens to price alongside the account's underlying and its enabled
+   * non-dust balances.
+   **/
+  extraTokens?: Address[];
 }
 /**
  * Public interface for a Gearbox price oracle contract.
@@ -97,12 +99,26 @@ interface IPriceOracleContract extends IBaseContract {
    **/
   priceFeedsForTokens: (tokens: Address[], opts?: PriceFeedsForTokensOptions) => IPriceFeedContract[];
   /**
-   * Converts previously obtained price updates into CreditFacade
-   * multicall entries and raw `PriceUpdateV310` structures.
-   * @param creditFacade - Address of the credit facade that will receive the multicall.
-   * @param updates - Price update result to convert. When omitted, uses latest cached updates.
+   * Generates the price feed update transactions an account needs to be
+   * valued: one per feed of its underlying, of every enabled token it holds a
+   * non-dust balance of, and of any `extraTokens`.
+   * @param account - Account whose tokens to cover.
+   * @param opts - Feed type filter and extra tokens to price.
+   **/
+  priceUpdateTxsForAccount: (account: CreditAccountTokensSlice, opts?: PriceFeedsForAccountOptions) => Promise<UpdatePriceFeedsResult>;
+  /**
+   * Same as {@link priceUpdateTxsForAccount}, but returns raw price update
+   * structures instead of transactions.
+   * @param account - Account whose tokens to cover.
+   * @param opts - Feed type filter and extra tokens to price.
+   **/
+  priceUpdatesForAccount: (account: CreditAccountTokensSlice, opts?: PriceFeedsForAccountOptions) => Promise<PriceUpdate[]>;
+  /**
+   * Raw price update structures for the feeds of the given tokens.
+   * @param tokens - Token addresses to price.
+   * @param opts - Feed type filter.
    **/
-  onDemandPriceUpdates: (creditFacade: Address, updates?: UpdatePriceFeedsResult) => OnDemandPriceUpdates;
+  priceUpdatesForTokens: (tokens: Address[], opts?: PriceFeedsForTokensOptions) => Promise<PriceUpdate[]>;
   /**
    * Converts an amount from one token to another using latest known prices.
    * @param from - Source token address.
@@ -188,4 +204,4 @@ interface IPriceOracleContract extends IBaseContract {
   stateHuman: (raw?: boolean) => PriceOracleStateHuman;
 }
 //#endregion
-export { IPriceOracleContract, OnDemandPriceUpdates, PriceFeedsForTokensOptions };
+export { IPriceOracleContract, PriceFeedsForAccountOptions, PriceFeedsForTokensOptions };

package/dist/types/sdk/market/rwa/securitize/SecuritizeRWAFactory.d.ts

@@ -1,8 +1,8 @@
 import { RWA_FACTORY_SECURITIZE } from "./constants.js";
-import { GetOpenAccountRequirementsProps } from "../../../accounts/types.js";
 import { IRWAFactory, RWACompressorInvestorData, RWAFactoryData } from "../types.js";
 import { SecuritizeDegenNFT } from "./SecuritizeDegenNFT.js";
 import { DStokenData, SecuritizeInvestorData, SecuritizeMissingOpenAccountRequirements, SecuritizeOpenAccountRequirements, SecuritizeOperationArgs, SecuritizeRWAFactoryStateHuman } from "./types.js";
+import { GetOpenAccountRequirementsProps } from "../../../accounts/types.js";
 import { MultiCall, RawTx } from "../../../types/transactions.js";
 import { OnchainSDK } from "../../../OnchainSDK.js";
 import "../../../types/index.js";

package/dist/types/sdk/market/rwa/types.d.ts

@@ -1,9 +1,9 @@
 import { iRWACompressorAbi } from "../../../abi/rwa/iRWACompressor.js";
 import { IBaseContract, Unarray } from "../../base/types.js";
 import { RWA_FACTORY_SECURITIZE } from "./securitize/constants.js";
-import { GetOpenAccountRequirementsProps } from "../../accounts/types.js";
 import { SecuritizeInvestorData, SecuritizeMissingOpenAccountRequirements, SecuritizeOpenAccountRequirements, SecuritizeOperationArgs, SecuritizeRWAFactoryStateHuman } from "./securitize/types.js";
 import "./securitize/index.js";
+import { GetOpenAccountRequirementsProps } from "../../accounts/types.js";
 import { MultiCall, RawTx } from "../../types/transactions.js";
 import "../../types/index.js";
 import "../../base/index.js";

package/dist/types/sdk/opportunities/index.d.ts

@@ -1,4 +1,4 @@
-import { additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, positionLeverage, rayToBps, usdToNumber, utilizationBps } from "../market/math.js";
+import { OptimalRepaidAmountProps, PARTIAL_LIQUIDATION_BUFFER_BPS, additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount, positionLeverage, rayToBps, usdToNumber, utilizationBps } from "../market/math.js";
 import { MultichainOpportunitiesService } from "./MultichainOpportunitiesService.js";
 import { OpportunitiesService } from "./OpportunitiesService.js";
-export { MultichainOpportunitiesService, OpportunitiesService, additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, positionLeverage, rayToBps, usdToNumber, utilizationBps };
+export { MultichainOpportunitiesService, OpportunitiesService, OptimalRepaidAmountProps, PARTIAL_LIQUIDATION_BUFFER_BPS, additionalBorrowApyBps, borrowApyBps, healthFactorBps, maxLeverage, minSeizedAmount, optimalHFForPartialLiquidation, optimalRepaidAmount, positionLeverage, rayToBps, usdToNumber, utilizationBps };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.73",
+  "version": "14.12.0-next.75",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

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

@@ -1,12 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/sdk/accounts/constants.ts
-/**
-* Token balances at or below this threshold are treated as dust and ignored,
-* consistent with the rest of the SDK (see `filterDust`).
-*
-* Shared by every service that describes what a credit account holds, so that
-* a liquidation row and a position row agree on which balances exist at all.
-**/
-const DUST_THRESHOLD = 10n;
-//#endregion
-exports.DUST_THRESHOLD = DUST_THRESHOLD;

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

@@ -1,11 +0,0 @@
-//#region src/sdk/accounts/constants.ts
-/**
-* Token balances at or below this threshold are treated as dust and ignored,
-* consistent with the rest of the SDK (see `filterDust`).
-*
-* Shared by every service that describes what a credit account holds, so that
-* a liquidation row and a position row agree on which balances exist at all.
-**/
-const DUST_THRESHOLD = 10n;
-//#endregion
-export { DUST_THRESHOLD };

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

@@ -1,11 +0,0 @@
-//#region src/sdk/accounts/constants.d.ts
-/**
- * Token balances at or below this threshold are treated as dust and ignored,
- * consistent with the rest of the SDK (see `filterDust`).
- *
- * Shared by every service that describes what a credit account holds, so that
- * a liquidation row and a position row agree on which balances exist at all.
- **/
-declare const DUST_THRESHOLD = 10n;
-//#endregion
-export { DUST_THRESHOLD };