@gearbox-protocol/sdk 15.1.0-next.6 → 15.1.0-next.7

package/dist/types/sdk/positions/calcHealthFactor.d.ts

@@ -0,0 +1,45 @@
+import { Bps } from "../../model/primitives.js";
+import "../../model/index.js";
+import { AccountSnapshot } from "./types.js";
+import { Address } from "viem";
+//#region src/sdk/positions/calcHealthFactor.d.ts
+/**
+ * Inputs of {@link calcHealthFactor}.
+ **/
+interface CalcHealthFactorProps {
+  snapshot: AccountSnapshot;
+  /**
+   * Market underlying. Debt and quota balances are valued in this token.
+   **/
+  underlying: Address;
+  /**
+   * Token decimals. Missing keys default to 18.
+   **/
+  decimals: Record<Address, number>;
+  /**
+   * Oracle prices in 8-decimal (`PRICE_DECIMALS`) fixed point. A missing key
+   * is an unpriceable token and contributes nothing.
+   **/
+  prices: Record<Address, bigint>;
+  /**
+   * Liquidation thresholds in basis points. Missing keys are treated as 0.
+   **/
+  liquidationThresholds: Record<Address, Bps>;
+  /**
+   * Whether each token's quota is currently active. Missing keys are inactive.
+   **/
+  activeQuotas: Record<Address, boolean>;
+}
+/**
+ * Health factor of an account state, in basis points (`10000` = 1.0).
+ *
+ * Collateral is valued under liquidation thresholds, with quoted tokens
+ * capped by their quota, and compared against the debt's value. An account
+ * with no debt reports `65535` (`MAX_UINT16`), the contract's own sentinel
+ * scaled down. Formulas are in parity with the legacy `calcHealthFactor`.
+ * Tokens with no price in {@link CalcHealthFactorProps.prices} contribute
+ * nothing.
+ **/
+declare function calcHealthFactor(props: CalcHealthFactorProps): Bps;
+//#endregion
+export { CalcHealthFactorProps, calcHealthFactor };

package/dist/types/sdk/positions/calcLiquidationPrice.d.ts

@@ -0,0 +1,12 @@
+import { CalcLiquidationPriceProps } from "./calcLiquidationPriceForTarget.js";
+//#region src/sdk/positions/calcLiquidationPrice.d.ts
+/**
+ * Liquidation price of an account state's target collateral, in the oracle's
+ * 8-decimal (`PRICE_DECIMALS`) fixed point.
+ *
+ * As the frontend does, a liquidation price only exists when the account
+ * holds exactly one non-dust non-underlying asset; otherwise `null`.
+ **/
+declare function calcLiquidationPrice(props: CalcLiquidationPriceProps): bigint | null;
+//#endregion
+export { calcLiquidationPrice };

package/dist/types/sdk/positions/calcLiquidationPriceForTarget.d.ts

@@ -0,0 +1,43 @@
+import { Bps } from "../../model/primitives.js";
+import "../../model/index.js";
+import { AccountSnapshot } from "./types.js";
+import { Address } from "viem";
+//#region src/sdk/positions/calcLiquidationPriceForTarget.d.ts
+/**
+ * Shared market-side inputs of a liquidation-price calculation.
+ **/
+interface CalcLiquidationPriceProps {
+  snapshot: AccountSnapshot;
+  /**
+   * Market underlying. Its balance under its LT is subtracted from the debt.
+   **/
+  underlying: Address;
+  /**
+   * Token decimals. Missing keys default to 18.
+   **/
+  decimals: Record<Address, number>;
+  /**
+   * Liquidation thresholds in basis points. Missing keys are treated as 0.
+   **/
+  liquidationThresholds: Record<Address, Bps>;
+}
+/**
+ * Inputs of {@link calcLiquidationPriceForTarget}.
+ **/
+interface CalcLiquidationPriceForTargetProps extends CalcLiquidationPriceProps {
+  /**
+   * Collateral token whose liquidation price to compute.
+   **/
+  targetToken: Address;
+}
+/**
+ * Liquidation price of an explicitly named collateral token, in
+ * `PRICE_DECIMALS` fixed point; `0n` when the account holds none of it or the
+ * token has no liquidation threshold. Formula is in parity with the legacy
+ * `liquidationPrice`: the effective debt (debt less the underlying balance's
+ * contribution under its threshold) over the threshold-weighted target
+ * balance.
+ **/
+declare function calcLiquidationPriceForTarget(props: CalcLiquidationPriceForTargetProps): bigint;
+//#endregion
+export { CalcLiquidationPriceForTargetProps, CalcLiquidationPriceProps, calcLiquidationPriceForTarget };

package/dist/types/sdk/positions/calcTimeToLiquidationMs.d.ts

@@ -0,0 +1,15 @@
+import { Bps } from "../../model/primitives.js";
+import "../../model/index.js";
+//#region src/sdk/positions/calcTimeToLiquidationMs.d.ts
+/**
+ * Estimated milliseconds until `healthFactorBps` decays to `10000` (1.0)
+ * while the debt grows at `totalBorrowRateOnDebt` (basis points relative to
+ * the debt, as {@link BorrowRateBreakdown.totalOnDebt} reports it).
+ *
+ * `null` when the account is already at or under the liquidation threshold,
+ * or when the debt carries no borrow rate at all. Formula is in parity with
+ * the legacy `getTimeToLiquidation`.
+ **/
+declare function calcTimeToLiquidationMs(healthFactorBps: Bps, totalBorrowRateOnDebt: bigint): bigint | null;
+//#endregion
+export { calcTimeToLiquidationMs };

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

@@ -1,4 +1,9 @@
-import { ListPositionsProps, ListPositionsPropsBase } from "./types.js";
+import { AccountSnapshot, ListPositionsProps, ListPositionsPropsBase, ListStrategyPositionsProps, accountSnapshotFromCreditAccountData } from "./types.js";
+import { CalcBorrowRateProps, calcBorrowRate } from "./calcBorrowRate.js";
+import { CalcHealthFactorProps, calcHealthFactor } from "./calcHealthFactor.js";
+import { CalcLiquidationPriceForTargetProps, CalcLiquidationPriceProps, calcLiquidationPriceForTarget } from "./calcLiquidationPriceForTarget.js";
+import { calcLiquidationPrice } from "./calcLiquidationPrice.js";
+import { calcTimeToLiquidationMs } from "./calcTimeToLiquidationMs.js";
 import { MultichainPositionsService } from "./MultichainPositionsService.js";
 import { PositionsService } from "./PositionsService.js";
-export { ListPositionsProps, ListPositionsPropsBase, MultichainPositionsService, PositionsService };
+export { AccountSnapshot, CalcBorrowRateProps, CalcHealthFactorProps, CalcLiquidationPriceForTargetProps, CalcLiquidationPriceProps, ListPositionsProps, ListPositionsPropsBase, ListStrategyPositionsProps, MultichainPositionsService, PositionsService, accountSnapshotFromCreditAccountData, calcBorrowRate, calcHealthFactor, calcLiquidationPrice, calcLiquidationPriceForTarget, calcTimeToLiquidationMs };

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

@@ -1,7 +1,9 @@
 import { WithBlock } from "../types/multichain.js";
+import { Asset, CreditAccountData } from "../base/types.js";
 import { PositionFilter } from "../../model/positions.js";
 import "../../model/index.js";
 import "../types/index.js";
+import "../base/index.js";
 import { Address } from "viem";
 //#region src/sdk/positions/types.d.ts
 /**
@@ -30,5 +32,60 @@ interface ListPositionsPropsBase {
  * {@link MultichainPositionsService.list}.
  **/
 type ListPositionsProps<Multichain extends boolean = false> = ListPositionsPropsBase & WithBlock<Multichain>;
+/**
+ * Props for {@link PositionsService.listStrategyPositions}.
+ **/
+interface ListStrategyPositionsProps {
+  /**
+   * Wallet whose credit accounts to describe. RWA accounts are resolved from
+   * the investor EOA, see {@link ICreditAccountsService.getBorrowerCreditAccounts}.
+   **/
+  owner: Address;
+  /**
+   * Whether to include accounts that carry no debt.
+   **/
+  includeZeroDebt: boolean;
+  /**
+   * Block to read at. Defaults to the latest block.
+   **/
+  blockNumber?: bigint;
+}
+/**
+ * The one input every position-metric function takes: a credit account's
+ * state — its credit manager, token balances, quota holdings, total debt and
+ * total value in the market's underlying — actual or projected.
+ *
+ * Everything else (decimals, prices, liquidation thresholds, quota rates,
+ * the pool's base rate) is supplied at the calculation site.
+ **/
+interface AccountSnapshot {
+  /**
+   * Credit manager the account is (or will be) opened in.
+   **/
+  creditManager: Address;
+  /**
+   * Token balances of the account.
+   **/
+  assets: Asset[];
+  /**
+   * Quota holdings of the account: quota balances are denominated in the
+   * market's underlying.
+   **/
+  quotas: Asset[];
+  /**
+   * Debt principal plus accrued interest and fees, in underlying.
+   **/
+  totalDebt: bigint;
+  /**
+   * Total account value in underlying.
+   **/
+  totalValue: bigint;
+}
+/**
+ * Builds an {@link AccountSnapshot} from on-chain credit account data: the
+ * enabled, above-dust tokens become assets and quotas, and `totalDebt` is
+ * principal plus accrued interest and fees.
+ **/
+declare function accountSnapshotFromCreditAccountData(ca: CreditAccountData): AccountSnapshot;
 //#endregion
-export { ListPositionsProps, ListPositionsPropsBase };
+export { AccountSnapshot, ListPositionsProps, ListPositionsPropsBase, ListStrategyPositionsProps, accountSnapshotFromCreditAccountData };

package/package.json

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