@gearbox-protocol/sdk 16.0.0-next.27 → 16.0.0-next.29

package/dist/types/model/previews.d.ts

@@ -4,7 +4,7 @@ import { BorrowRateBreakdown } from "./positions.js";
 import { Address, Hex } from "viem";
 //#region src/model/previews.d.ts
 /**
- * ERC4626 pool operation kind, as surfaced on a {@link PoolOperationPreview}.
+ * ERC4626 pool operation kind, as surfaced on a {@link PreviewLpVerify}.
  **/
 type PoolOperationType = "Deposit" | "Mint" | "Withdraw" | "Redeem";
 /**
@@ -96,7 +96,12 @@ interface OperationPreviewError {
    */
   message: string;
 }
-interface PoolOperationPreview {
+/**
+ * What a pool transaction that already exists would do — the counterpart of
+ * `prepare.deposit`, `prepare.withdraw` and `prepare.redeem`, read off calldata
+ * rather than planned into it.
+ **/
+interface PreviewLpVerify {
   operation: PoolOperationType;
   /**
    * Pool address
@@ -138,18 +143,15 @@ interface PoolOperationPreview {
   error?: OperationPreviewError;
 }
 /**
- * A credit account as an operation leaves it, answered by both halves of the
- * SDK: `prepare`, which walks a request forward into the calls that realise it,
- * and `preview`, which decodes calls that already exist and replays them back.
- *
- * `totalDebt`, `totalValue`, `leverage` and `healthFactor` mean here exactly
- * what they mean on a {@link StrategyPosition}, down to the token an amount
- * names — an RWA market reports USDC, not the dcUSDC wrapper the pool holds.
+ * The market a credit operation acts on, reported the same way by every half of
+ * the SDK: the calldata previews, the intents engine's projections and the
+ * open-strategy walk all carry it, so a screen naming the market needs nothing
+ * beside the result it already holds.
  **/
-interface AccountProjection {
+interface CreditOperationMarket {
   /**
-   * Credit manager the account belongs to. Carried on the projection itself so
-   * a caller weighing one — `checkSimulation` among them — needs nothing beside
+   * Credit manager the account belongs to. Carried on the result itself so a
+   * caller weighing one — `checkSimulation` among them — needs nothing beside
    * it to find the market.
    */
   creditManager: Address;
@@ -157,6 +159,67 @@ interface AccountProjection {
    * Human-readable credit manager name.
    */
   name: string;
+  /**
+   * Market configurator of the market {@link creditManager} belongs to — the
+   * on-chain identity of the curator, which is what a curator link and a
+   * curator name resolve from. Not a personal wallet.
+   */
+  curator: Address;
+  /**
+   * What a liquidation takes off the account, in basis points: the premium the
+   * liquidator keeps plus the protocol's own fee.
+   *
+   * Not the credit manager's `liquidationDiscount`, which is the complement of
+   * the premium alone (`100% - liquidationPremium`) and says what share of the
+   * collateral repays the debt. This is the figure a position screen labels
+   * "Liquidation Discount": `liquidationPremium + feeLiquidation`.
+   */
+  liquidationDiscount: Bps;
+}
+/**
+ * What an account is worth and what it is made of, once an operation has run.
+ *
+ * The measured half of a {@link AccountProjection}: read off the balances the
+ * walk arrived at, without a formula between them and the answer.
+ **/
+interface AccountHoldings {
+  /**
+   * Everything the account holds, denominated in the market's underlying.
+   **/
+  totalValue: TokenAmount;
+  /**
+   * What it would take to settle the loan: principal plus accrued interest and
+   * fees, in the market's underlying.
+   **/
+  totalDebt: TokenAmount;
+  /**
+   * Own funds in the position: `totalValue` less `totalDebt`, in the market's
+   * underlying. The read model leaves a strategy caller to subtract these two
+   * itself; a projection reports the figure so an "own funds" row reads the
+   * same on every screen that shows one.
+   **/
+  netValue: TokenAmount;
+  /**
+   * What the account holds, token by token.
+   **/
+  assets: TokenAmount[];
+  /**
+   * Quota bought for each collateral, denominated in the market's underlying
+   * rather than in the collateral token — the same convention as
+   * {@link PositionCollateral.quota}. A token the account leaves unquoted is
+   * absent rather than present at zero.
+   **/
+  quotas: TokenAmount[];
+}
+/**
+ * The risk and cost of an account, derived from what it holds.
+ *
+ * The computed half of a {@link AccountProjection}, and the reason it is a type
+ * of its own: every one of these is a formula over the same
+ * {@link AccountSnapshot}, so both halves of the SDK get them from one place —
+ * `sdk.positions.metrics` — and cannot drift into two answers for one account.
+ **/
+interface AccountMetrics {
   /**
    * Health factor in basis points: below `10000` the account is liquidatable.
    *
@@ -168,16 +231,20 @@ interface AccountProjection {
    * token's main and reserve oracle feeds, which is what the credit manager
    * switches to for a call that hands funds over.
    *
-   * Absent only where the walk had no reason to weigh it: the intents engine
-   * computes it for an operation that hands funds over, which is the one the
-   * credit manager holds to safe prices on-chain. Both preview builders and
-   * `openNewStrategy` always report it.
+   * Always reported, whether or not the operation in question hands anything
+   * over: which of the two factors decides a transaction is a property of the
+   * call the caller ends up sending, and a screen showing the account is
+   * entitled to both.
    *
    * @example `11800` where `healthFactor` is `12500`
    **/
-  safeHealthFactor?: Bps;
+  safeHealthFactor: Bps;
   /**
    * Cost of the debt, broken down by source.
+   *
+   * Half of the breakdown rests on the debt and the quotas alone (`base`,
+   * `totalOnDebt`) and half on the position's value (`total`, `quotas[].rate`),
+   * which is why it counts as a {@link RoutedField}.
    **/
   borrowRate: BorrowRateBreakdown;
   /**
@@ -197,39 +264,114 @@ interface AccountProjection {
    * unleveraged; `0` if underwater.
    **/
   leverage: Leverage;
+}
+/**
+ * A credit account as an operation leaves it, answered by both halves of the
+ * SDK: `prepare`, which walks a request forward into the calls that realise it,
+ * and `preview`, which decodes calls that already exist and replays them back.
+ *
+ * Both answer in this same vocabulary, and from the same builder
+ * (`sdk.positions.projection`), so the two descriptions of one operation can be
+ * compared field by field — which is what
+ * `previewMatchesPrepare.test.ts` does.
+ *
+ * This shape is the expected branch of a routed leg, which is what `prepare`
+ * reports; `preview` sees only the floor and answers with an
+ * {@link EstimatedProjection}, the same fields with the routed ones marked
+ * `est`. Where nothing routes the two coincide exactly.
+ *
+ * `totalDebt`, `totalValue`, `leverage` and `healthFactor` mean here exactly
+ * what they mean on a {@link StrategyPosition}, down to the token an amount
+ * names — an RWA market reports USDC, not the dcUSDC wrapper the pool holds.
+ **/
+interface AccountProjection extends CreditOperationMarket, AccountHoldings, AccountMetrics {}
+/**
+ * The fields of an {@link AccountProjection} a routed leg's outcome decides.
+ *
+ * A swap is quoted twice: the amount the pathfinder expects to return, and the
+ * floor it is willing to guarantee once slippage is allowed for. `prepare` has
+ * both and reports the expected one — that is where the position lands.
+ * `preview` reads a transaction that already exists, and calldata carries only
+ * the floor, so its answer is the worst case the same operation can settle at.
+ *
+ * Everything not listed here is the same number on either branch: the debt and
+ * the quotas are named by the calls themselves.
+ *
+ * The borrow rate is listed despite being half made of those two. `base` and
+ * `totalOnDebt` are branch-independent — the pool's rate at the projected
+ * utilization, and the quota rates over the debt — but `total` and the per-token
+ * `quotas[].rate` normalize against `totalValue`, so a floor-branch breakdown
+ * quotes the same cost against a smaller position and comes out higher. One
+ * field cannot be half prefixed, and the half that moves is the half a screen
+ * shows, so the whole breakdown carries the marker.
+ **/
+type RoutedField = "totalValue" | "netValue" | "assets" | "healthFactor" | "safeHealthFactor" | "borrowRate" | "timeToLiquidation" | "liquidationPrice" | "leverage";
+/**
+ * `x` becomes `estX`, for a projection assembled from the guaranteed floor.
+ *
+ * The prefix is not decoration: an `estHealthFactor` and a `healthFactor` are
+ * answers to different questions, and naming them alike would invite a screen
+ * to show one as the other or a test to hold them equal.
+ **/
+type Estimated<T> = { [K in keyof T as `est${Capitalize<string & K>}`]: T[K]; };
+/**
+ * A projection as `preview` can answer it: the branch-independent half under the
+ * shared names, and everything a route decides marked `est`.
+ *
+ * Same builder, same formulas, same units as an {@link AccountProjection} — only
+ * the snapshot underneath is the floor rather than the expected outcome.
+ **/
+type EstimatedProjection = Omit<AccountProjection, RoutedField> & Estimated<Pick<AccountProjection, RoutedField>>;
+/**
+ * Renames a projection's routed fields, for a caller that built one from floor
+ * balances.
+ *
+ * Lives beside the type so the two cannot drift: a field added to
+ * {@link RoutedField} fails to compile until it is renamed here too.
+ **/
+declare function asEstimated(p: AccountProjection): EstimatedProjection;
+/**
+ * What an operation moved, as opposed to where it left the account.
+ *
+ * Only `preview` reports these: it is handed both sides of the transaction and
+ * diffs them, while `prepare` is asked to reach a state and answers with the
+ * calls that get there. Split out so the two halves agree on the names for the
+ * day prepare reports deltas too.
+ **/
+interface AccountStateChange {
   /**
-   * Everything the account holds, denominated in the market's underlying.
-   **/
-  totalValue: TokenAmount;
-  /**
-   * What it would take to settle the loan: principal plus accrued interest and
-   * fees, in the market's underlying.
-   **/
-  totalDebt: TokenAmount;
-  /**
-   * Own funds in the position: `totalValue` less `totalDebt`, in the market's
-   * underlying. The read model leaves a strategy caller to subtract these two
-   * itself; a projection reports the figure so an "own funds" row reads the
-   * same on every screen that shows one.
-   **/
-  netValue: TokenAmount;
+   * Debt after minus debt before. A repayment settles interest and fees
+   * before principal, so this is the payment itself rather than the part of
+   * it the principal happened to absorb.
+   */
+  totalDebtChange: TokenAmount;
   /**
-   * What the account holds, token by token.
-   **/
-  assets: TokenAmount[];
+   * Quotas after minus quotas before. Denominated in the market's underlying
+   * like {@link AccountHoldings.quotas}, so `token` names the collateral the
+   * quota applies to rather than the amount's own unit.
+   */
+  quotasChange: TokenAmount[];
   /**
-   * Quota bought for each collateral, denominated in the market's underlying
-   * rather than in the collateral token — the same convention as
-   * {@link PositionCollateral.quota}. A token the account leaves unquoted is
-   * absent rather than present at zero.
-   **/
-  quotas: TokenAmount[];
+   * Assets after minus assets before.
+   *
+   * Unprefixed despite resting on the same floor balances as
+   * {@link EstimatedProjection.estAssets}: `prepare` reports no deltas at all,
+   * so there is no expected-branch figure of this name to be mistaken for.
+   */
+  assetsChange: TokenAmount[];
 }
-interface OpenCreditAccountPreview extends AccountProjection {
+/**
+ * What an account-opening transaction that already exists would do — the
+ * counterpart of `prepare.openNewStrategy`, read off calldata rather than
+ * planned into it.
+ **/
+interface PreviewOpenStrategyVerify extends EstimatedProjection {
   operation: "OpenCreditAccount" | "RWAOpenCreditAccount";
   /**
    * Collateral token this position is a strategy in: the first quoted token,
-   * with its balance taken from `assets`. Undefined when nothing is quoted.
+   * with its balance taken from `estAssets` — so, like them, the floor the
+   * route guarantees rather than what it expects to return.
+   * Undefined when nothing is quoted.
    */
   targetCollateral?: TokenAmount;
   /**
@@ -242,12 +384,18 @@ interface OpenCreditAccountPreview extends AccountProjection {
   collateralAdded: TokenAmount[];
   /**
    * Set when preview encountered non-fatal errors, all fields are
-   * still computed best-effort, but derived fields (`assets`,
-   * `targetCollateral`, `netValue`) may be unreliable in that case.
+   * still computed best-effort, but derived fields (`estAssets`,
+   * `targetCollateral`, `estNetValue`) may be unreliable in that case.
    */
   error?: OperationPreviewError;
 }
-interface AdjustCreditAccountPreview extends AccountProjection {
+/**
+ * What a transaction on an existing account would do — the counterpart of the
+ * `prepare` flows that adjust one (`depositStrategy`, `withdrawStrategy`,
+ * `addCollateral`, `withdrawCollateral`, `adjustLeverage`), read off calldata
+ * rather than planned into it.
+ **/
+interface PreviewAdjustStrategyVerify extends EstimatedProjection, AccountStateChange {
   operation: "AdjustCreditAccount";
   /**
    * Credit account that is being adjusted
@@ -265,22 +413,6 @@ interface AdjustCreditAccountPreview extends AccountProjection {
    * Tokens that were withdrawn as collateral during account adjustment.
    */
   collateralWithdrawn: TokenAmount[];
-  /**
-   * Debt after minus debt before. A repayment settles interest and fees
-   * before principal, so this is the payment itself rather than the part of
-   * it the principal happened to absorb.
-   */
-  totalDebtChange: TokenAmount;
-  /**
-   * Quotas after minus quotas before. Denominated in the market's underlying
-   * like {@link AccountProjection.quotas}, so `token` names the collateral the
-   * quota applies to rather than the amount's own unit.
-   */
-  quotasChange: TokenAmount[];
-  /**
-   * Assets after minus assets before
-   */
-  assetsChange: TokenAmount[];
   /**
    * Intent of the delayed withdrawal this transaction claims; set when the
    * multicall claims a delayed withdrawal
@@ -288,12 +420,21 @@ interface AdjustCreditAccountPreview extends AccountProjection {
   intent?: DelayedIntent;
   /**
    * Set when preview encountered non-fatal errors, all fields are
-   * still computed best-effort, but derived fields (`assets`, `assetsChange`,
-   * `totalValue`) may be unreliable in that case.
+   * still computed best-effort, but derived fields (`estAssets`, `assetsChange`,
+   * `estTotalValue`) may be unreliable in that case.
    */
   error?: OperationPreviewError;
 }
-interface CloseCreditAccountPreview {
+/**
+ * What an exit transaction that already exists would do — the counterpart of
+ * `prepare.withdrawStrategy` asked for everything, read off calldata rather
+ * than planned into it.
+ *
+ * Carries no {@link AccountProjection}: the account it describes ends up empty,
+ * so there is no position left to weigh — what a caller wants to know is the
+ * payout. The market it happened in is still named, as everywhere else.
+ **/
+interface PreviewExitStrategyVerify extends CreditOperationMarket {
   operation: "CloseCreditAccount";
   /**
    * True when the account is closed permanently (facade `closeCreditAccount`
@@ -301,14 +442,6 @@ interface CloseCreditAccountPreview {
    * (plain multicall).
    */
   permanent: boolean;
-  /**
-   * Credit manager the account belongs to
-   */
-  creditManager: Address;
-  /**
-   * Human-readable credit manager name
-   */
-  name: string;
   /**
    * Credit account that is being closed
    */
@@ -333,7 +466,15 @@ interface CloseCreditAccountPreview {
    */
   error?: OperationPreviewError;
 }
-interface RepayCreditAccountPreview {
+/**
+ * What a settling repayment that already exists would do — the counterpart of
+ * `prepare.repayStrategy` asked for the whole debt, read off calldata rather
+ * than planned into it.
+ *
+ * Carries no {@link AccountProjection} for the same reason the exit does not:
+ * the loan ends here, so the risk metrics have nothing left to describe.
+ **/
+interface PreviewRepayStrategyVerify extends CreditOperationMarket {
   operation: "RepayCreditAccount";
   /**
    * True when the account is closed permanently (facade `closeCreditAccount`
@@ -341,14 +482,6 @@ interface RepayCreditAccountPreview {
    * (plain multicall).
    */
   permanent: boolean;
-  /**
-   * Credit manager the account belongs to
-   */
-  creditManager: Address;
-  /**
-   * Human-readable credit manager name
-   */
-  name: string;
   /**
    * Credit account that is being repaid
    */
@@ -369,7 +502,7 @@ interface RepayCreditAccountPreview {
   /**
    * Total debt repaid: principal + accrued interest + fees, in underlying.
    *
-   * The same quantity an {@link AdjustCreditAccountPreview} reports as
+   * The same quantity a {@link PreviewAdjustStrategyVerify} reports as
    * `totalDebtChange`, with the sign a repayment screen reads: positive for
    * what the wallet parted with.
    */
@@ -391,27 +524,19 @@ interface RepayCreditAccountPreview {
  * account: what the transaction does in the same block, before any delayed
  * withdrawal is claimed.
  */
-type InstantOperationPreview = AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview;
+type PreviewInstantStrategyVerify = PreviewAdjustStrategyVerify | PreviewExitStrategyVerify | PreviewRepayStrategyVerify;
 /**
  * Preview of a multicall that requests a delayed withdrawal (e.g. Securitize
  * redemption): the source token is spent now and a withdrawal phantom token is received;
  * the actual claim token materializes later, when the withdrawal is claimed and
  * the recorded (if any) is resumed
  */
-interface DelayedCreditAccountOperationPreview {
+interface PreviewDelayedStrategyVerify extends CreditOperationMarket {
   operation: "DelayedCreditAccountOperation";
   /**
    * Credit account the operation is performed on
    */
   creditAccount: Address;
-  /**
-   * Credit manager the account belongs to
-   */
-  creditManager: Address;
-  /**
-   * Human-readable credit manager name
-   */
-  name: string;
   /**
    * Decoded from the withdrawal request's extraData; undefined when the
    * request carries no intent (e.g. Mellow)
@@ -421,19 +546,19 @@ interface DelayedCreditAccountOperationPreview {
    * What this transaction does right now: the delayed withdrawal is
    * represented by the phantom token among the account's assets
    */
-  instantPreview: InstantOperationPreview;
+  instantPreview: PreviewInstantStrategyVerify;
   /**
    * Best-effort state after the withdrawal is claimed and the intent is
    * resumed; claim-only (phantom burned, claim token received) when
    * `intent` is undefined
    */
-  delayedPreview: InstantOperationPreview;
+  delayedPreview: PreviewInstantStrategyVerify;
 }
 /**
  * Result of previewing a raw operation calldata: currently pool operations and
  * credit account opening, adjustment, closure, repayment and delayed
  * withdrawal operations are supported.
  */
-type OperationPreview = PoolOperationPreview | OpenCreditAccountPreview | AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview | DelayedCreditAccountOperationPreview;
+type OperationPreview = PreviewLpVerify | PreviewOpenStrategyVerify | PreviewAdjustStrategyVerify | PreviewExitStrategyVerify | PreviewRepayStrategyVerify | PreviewDelayedStrategyVerify;
 //#endregion
-export { AccountProjection, AdjustCreditAccountPreview, CloseCreditAccountPreview, DelayedCreditAccountOperationPreview, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPRICEABLE_TOKEN, ERROR_UNSUPPORTED_OUT_OF_BRACKET_CALL, InstantOperationPreview, OpenCreditAccountPreview, OperationPreview, OperationPreviewError, PoolOperationPreview, PoolOperationType, PreviewOperationInput, PreviewOperationOptions, RepayCreditAccountPreview };
+export { AccountHoldings, AccountMetrics, AccountProjection, AccountStateChange, CreditOperationMarket, ERROR_ADAPTER_CALL_OUTSIDE_BRACKET, ERROR_INVALID_TRANSACTION_VALUE, ERROR_MALFORMED_BRACKET, ERROR_NON_ADAPTER_CALL_IN_BRACKET, ERROR_UNPREVIEWABLE_ADAPTER_CALL, ERROR_UNPRICEABLE_TOKEN, ERROR_UNSUPPORTED_OUT_OF_BRACKET_CALL, Estimated, EstimatedProjection, OperationPreview, OperationPreviewError, PoolOperationType, PreviewAdjustStrategyVerify, PreviewDelayedStrategyVerify, PreviewExitStrategyVerify, PreviewInstantStrategyVerify, PreviewLpVerify, PreviewOpenStrategyVerify, PreviewOperationInput, PreviewOperationOptions, PreviewRepayStrategyVerify, RoutedField, asEstimated };

package/dist/types/onchain/accounts/intents/open-strategy.d.ts

@@ -1,4 +1,4 @@
-import { Bps, TokenAmount } from "../../../model/primitives.js";
+import { TokenAmount } from "../../../model/primitives.js";
 import { AccountProjection } from "../../../model/previews.js";
 import "../../../model/index.js";
 import { Asset } from "../../base/types.js";
@@ -33,14 +33,20 @@ interface OpenStrategyProps {
  * both `minQuota` and `averageQuota`, so there is nothing to gain by dropping one.
  */
 interface OpenStrategyPreview extends Omit<AccountProjection, "assets" | "quotas"> {
-  /**
-   * The same factor with collateral valued at safe prices, which is what the
-   * credit manager weighs an opening at on-chain. Always reported here: an
-   * opening always hands the pool's funds over.
-   **/
-  safeHealthFactor: Bps;
   /** What the routed leg lost to market depth; `undefined` if not measured. */
   priceImpact: PathLossRate | undefined;
+  /**
+   * What the position's collateral costs in the market underlying right now, in
+   * the oracle's 8-decimal fixed point — the same scale and the same pair as
+   * {@link liquidationPrice}, so a screen showing both reads them as one pair.
+   *
+   * `null` where there is no pair to quote: an account holding zero or several
+   * non-underlying assets, or one whose collateral the oracle cannot price.
+   *
+   * Simulations only. A calldata preview is not asked for it: it reports what a
+   * transaction does, not what the market costs while a form is open.
+   */
+  currentPrice: bigint | null;
   /** Expected post-open balances. */
   averageAssets: TokenAmount[];
   /** Floor post-open balances after slippage. */

package/dist/types/onchain/accounts/intents/testing/market.d.ts

@@ -74,6 +74,7 @@ interface MarketSdkExtras {
   forbiddenTokens?: Address[];
   /** What a routed swap returns; linear when omitted. */
   routeQuote?: (amount: bigint) => bigint;
+  routeFloor?: (amount: bigint) => bigint;
 }
 /** Mock SDK on the shared fixture market. */
 declare function buildMarketSdk(extras?: MarketSdkExtras): OnchainSDK;

package/dist/types/onchain/accounts/intents/testing/sdk-mock.d.ts

@@ -13,6 +13,17 @@ import { Address } from "viem";
  * from their inputs, so `result.calls` pins down which ops reached the
  * assembler and in which order.
  */
+/** Market configurator the mock market is governed by — the curator's address. */
+declare const MOCK_MARKET_CONFIGURATOR: Address;
+/**
+ * Liquidation fees of the mock suite: a 3% premium (the manager reports its
+ * complement) on top of a 1.5% protocol fee, so the discount a screen shows is
+ * 450bps.
+ */
+declare const MOCK_LIQUIDATION_FEES: {
+  feeLiquidation: number;
+  liquidationDiscount: number;
+};
 /** Recognizable router call embedded in routed leg results. */
 declare const MOCK_ROUTER_CALL: MultiCall;
 /** Router call of the many-to-one leg an exit routes. */
@@ -121,6 +132,13 @@ interface BuildMockSdkArgs {
    * same proportion.
    */
   routeQuote?: (amount: bigint) => bigint;
+  /**
+   * The floor a route guarantees, from what it expects to return. The default
+   * quotes no slippage at all — floor and expectation coincide — which is what
+   * every case that is not about the difference between the two wants, since it
+   * keeps the projected state and the amounts in the calls one number.
+   */
+  routeFloor?: (amount: bigint) => bigint;
 }
 /** One redemption venue of the mock compressor. */
 interface MockDelayedVenue {

package/dist/types/onchain/accounts/intents/types.d.ts

@@ -41,6 +41,18 @@ interface OperationState extends AccountProjection {
    * routed or nothing could be measured — never a manufactured zero.
    */
   priceImpact: PathLossRate | undefined;
+  /**
+   * What the position's collateral costs in the market underlying right now, in
+   * the oracle's 8-decimal fixed point — the same scale and the same pair as
+   * {@link liquidationPrice}, so a screen showing both reads them as one pair.
+   *
+   * `null` where there is no pair to quote: an account holding zero or several
+   * non-underlying assets, or one whose collateral the oracle cannot price.
+   *
+   * Simulations only. A calldata preview is not asked for it: it reports what a
+   * transaction does, not what the market costs while a form is open.
+   */
+  currentPrice: bigint | null;
 }
 /**
  * What a preview yields: the operation chain, the state it projects, and the