@gearbox-protocol/sdk 15.1.0-next.13 → 15.1.0-next.15

package/dist/types/model/positions.schema.d.ts

@@ -207,6 +207,30 @@ declare const poolPositionSchema: z.ZodObject<{
       }, z.core.$strip>>;
     }, z.core.$strip>], "kind">>>;
   }, z.core.$strip>;
+  apyAvg7D: z.ZodOptional<z.ZodObject<{
+    totalApy: z.ZodOptional<z.ZodNumber>;
+    organicApy: z.ZodNumber;
+    rewards: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"token">;
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      supplyApr: z.ZodOptional<z.ZodNumber>;
+      borrowApr: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"point">;
+      points: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        multiplier: z.ZodNullable<z.ZodNumber>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>], "kind">>>;
+  }, z.core.$strip>>;
   pnl: z.ZodOptional<z.ZodObject<{
     organic: z.ZodObject<{
       value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
@@ -255,6 +279,20 @@ declare const poolPositionSchema: z.ZodObject<{
     }, z.core.$strip>], "kind">>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * {@link TokenQuotaRate}
+ **/
+declare const tokenQuotaRateSchema: z.ZodObject<{
+  token: z.ZodObject<{
+    chainId: z.ZodNumber;
+    address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+    symbol: z.ZodString;
+    name: z.ZodString;
+    decimals: z.ZodNumber;
+    assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+  }, z.core.$strip>;
+  rate: z.ZodNumber;
+}, z.core.$strip>;
 /**
  * {@link BorrowRateBreakdown}
  **/
@@ -262,7 +300,17 @@ declare const borrowRateBreakdownSchema: z.ZodObject<{
   total: z.ZodNumber;
   totalOnDebt: z.ZodNumber;
   base: z.ZodNumber;
-  quotas: z.ZodRecord<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>, z.ZodNumber>;
+  quotas: z.ZodArray<z.ZodObject<{
+    token: z.ZodObject<{
+      chainId: z.ZodNumber;
+      address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+      symbol: z.ZodString;
+      name: z.ZodString;
+      decimals: z.ZodNumber;
+      assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+    }, z.core.$strip>;
+    rate: z.ZodNumber;
+  }, z.core.$strip>>;
 }, z.core.$strip>;
 /**
  * {@link StrategyPosition}
@@ -283,6 +331,7 @@ declare const strategyPositionSchema: z.ZodObject<{
   }, z.core.$strip>>;
   leverage: z.ZodNumber;
   borrowApy: z.ZodNumber;
+  borrowApyAvg7D: z.ZodOptional<z.ZodNumber>;
   netApy: z.ZodOptional<z.ZodObject<{
     totalApy: z.ZodOptional<z.ZodNumber>;
     organicApy: z.ZodNumber;
@@ -307,6 +356,30 @@ declare const strategyPositionSchema: z.ZodObject<{
       }, z.core.$strip>>;
     }, z.core.$strip>], "kind">>>;
   }, z.core.$strip>>;
+  netApyAvg7D: z.ZodOptional<z.ZodObject<{
+    totalApy: z.ZodOptional<z.ZodNumber>;
+    organicApy: z.ZodNumber;
+    rewards: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"token">;
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      supplyApr: z.ZodOptional<z.ZodNumber>;
+      borrowApr: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"point">;
+      points: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        multiplier: z.ZodNullable<z.ZodNumber>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>], "kind">>>;
+  }, z.core.$strip>>;
   totalDebt: z.ZodObject<{
     value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
@@ -336,7 +409,33 @@ declare const strategyPositionSchema: z.ZodObject<{
     total: z.ZodNumber;
     totalOnDebt: z.ZodNumber;
     base: z.ZodNumber;
-    quotas: z.ZodRecord<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>, z.ZodNumber>;
+    quotas: z.ZodArray<z.ZodObject<{
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      rate: z.ZodNumber;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
+  borrowRateAvg7D: z.ZodOptional<z.ZodObject<{
+    total: z.ZodNumber;
+    totalOnDebt: z.ZodNumber;
+    base: z.ZodNumber;
+    quotas: z.ZodArray<z.ZodObject<{
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      rate: z.ZodNumber;
+    }, z.core.$strip>>;
   }, z.core.$strip>>;
   timeToLiquidation: z.ZodOptional<z.ZodNullable<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>>;
   liquidationPrice: z.ZodOptional<z.ZodNullable<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>>;
@@ -473,6 +572,30 @@ declare const positionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
       }, z.core.$strip>>;
     }, z.core.$strip>], "kind">>>;
   }, z.core.$strip>;
+  apyAvg7D: z.ZodOptional<z.ZodObject<{
+    totalApy: z.ZodOptional<z.ZodNumber>;
+    organicApy: z.ZodNumber;
+    rewards: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"token">;
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      supplyApr: z.ZodOptional<z.ZodNumber>;
+      borrowApr: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"point">;
+      points: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        multiplier: z.ZodNullable<z.ZodNumber>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>], "kind">>>;
+  }, z.core.$strip>>;
   pnl: z.ZodOptional<z.ZodObject<{
     organic: z.ZodObject<{
       value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
@@ -536,6 +659,7 @@ declare const positionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
   }, z.core.$strip>>;
   leverage: z.ZodNumber;
   borrowApy: z.ZodNumber;
+  borrowApyAvg7D: z.ZodOptional<z.ZodNumber>;
   netApy: z.ZodOptional<z.ZodObject<{
     totalApy: z.ZodOptional<z.ZodNumber>;
     organicApy: z.ZodNumber;
@@ -560,6 +684,30 @@ declare const positionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
       }, z.core.$strip>>;
     }, z.core.$strip>], "kind">>>;
   }, z.core.$strip>>;
+  netApyAvg7D: z.ZodOptional<z.ZodObject<{
+    totalApy: z.ZodOptional<z.ZodNumber>;
+    organicApy: z.ZodNumber;
+    rewards: z.ZodOptional<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+      kind: z.ZodLiteral<"token">;
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      supplyApr: z.ZodOptional<z.ZodNumber>;
+      borrowApr: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>, z.ZodObject<{
+      kind: z.ZodLiteral<"point">;
+      points: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        multiplier: z.ZodNullable<z.ZodNumber>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>], "kind">>>;
+  }, z.core.$strip>>;
   totalDebt: z.ZodObject<{
     value: z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>;
     valueUsd: z.ZodNullable<z.ZodNumber>;
@@ -589,7 +737,33 @@ declare const positionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
     total: z.ZodNumber;
     totalOnDebt: z.ZodNumber;
     base: z.ZodNumber;
-    quotas: z.ZodRecord<z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>, z.ZodNumber>;
+    quotas: z.ZodArray<z.ZodObject<{
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      rate: z.ZodNumber;
+    }, z.core.$strip>>;
+  }, z.core.$strip>>;
+  borrowRateAvg7D: z.ZodOptional<z.ZodObject<{
+    total: z.ZodNumber;
+    totalOnDebt: z.ZodNumber;
+    base: z.ZodNumber;
+    quotas: z.ZodArray<z.ZodObject<{
+      token: z.ZodObject<{
+        chainId: z.ZodNumber;
+        address: z.ZodCodec<z.ZodString, z.ZodCustom<`0x${string}`, `0x${string}`>>;
+        symbol: z.ZodString;
+        name: z.ZodString;
+        decimals: z.ZodNumber;
+        assetType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"Stable">, z.ZodLiteral<"ETH">, z.ZodLiteral<"BTC">]>>;
+      }, z.core.$strip>;
+      rate: z.ZodNumber;
+    }, z.core.$strip>>;
   }, z.core.$strip>>;
   timeToLiquidation: z.ZodOptional<z.ZodNullable<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>>;
   liquidationPrice: z.ZodOptional<z.ZodNullable<z.ZodCodec<z.ZodUnion<[z.ZodString, z.ZodBigInt]>, z.ZodBigInt>>>;
@@ -883,4 +1057,4 @@ declare const positionTransactionSchema: z.ZodObject<{
   }, z.core.$strip>>;
 }, z.core.$strip>;
 //#endregion
-export { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenRewardsPnLSchema };
+export { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema, pointsRewardsPnLSchema, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, rewardsPnLSchema, strategyPositionKeySchema, strategyPositionSchema, tokenQuotaRateSchema, tokenRewardsPnLSchema };

package/dist/types/{preview/preview/types.d.ts → model/previews.d.ts}

@@ -1,12 +1,48 @@
-import { DelayedIntent } from "../../sdk/accounts/withdrawal-compressor/types.js";
-import { Asset } from "../../sdk/base/types.js";
-import { PositionMetrics } from "../../model/positions.js";
-import "../../model/index.js";
-import "../../sdk/index.js";
-import { PoolOperationType } from "../parse/types-pools.js";
-import "../parse/index.js";
-import { Address } from "viem";
-//#region src/preview/preview/types.d.ts
+import { Bps, ChainId, Leverage, TokenAmount } from "./primitives.js";
+import { DelayedIntent } from "./delayed-intents.js";
+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}.
+ **/
+type PoolOperationType = "Deposit" | "Mint" | "Withdraw" | "Redeem";
+/**
+ * Raw-calldata operation to preview: the chain and the transaction fields.
+ * The on-chain SDK is resolved from {@link chainId} by the caller.
+ **/
+interface PreviewOperationInput {
+  /**
+   * Chain the transaction is sent on.
+   **/
+  chainId: ChainId;
+  /**
+   * Contract address that was called.
+   **/
+  to: Address;
+  /**
+   * Raw calldata of the operation.
+   **/
+  calldata: Hex;
+  /**
+   * Transaction sender.
+   **/
+  sender: Address;
+  /**
+   * Transaction `msg.value`, required for native-token zapper deposits.
+   **/
+  value?: bigint;
+}
+/**
+ * Options for previewing a raw operation.
+ **/
+interface PreviewOperationOptions {
+  /**
+   * Block to read/simulate at; defaults to latest. Only set for testnet
+   * forks.
+   **/
+  blockNumber?: bigint;
+}
 /**
  * Broken `storeExpectedBalances`/`compareBalances` bracket structure:
  * `storeExpectedBalances` without a matching `compareBalances`, nested
@@ -65,6 +101,10 @@ interface PoolOperationPreview {
    * Pool address
    */
   pool: Address;
+  /**
+   * Human-readable pool name
+   */
+  name: string;
   /**
    * Token that goes from user to pool
    * In case of deposit, underlying for direct deposit, zapper input for zapper-routed deposit
@@ -74,7 +114,7 @@ interface PoolOperationPreview {
    * transaction calldata alone and requires an additional async call
    * (previewMint/previewWithdraw).
    */
-  tokenIn: Asset;
+  tokenIn: TokenAmount;
   /**
    * Token that goes from pool to user
    * In case of deposit, pool shares (diesel token) for direct deposit or zapper token out
@@ -84,24 +124,64 @@ interface PoolOperationPreview {
    * transaction calldata alone and requires an additional async call
    * (previewDeposit/previewRedeem).
    */
-  tokenOut: Asset;
+  tokenOut: TokenAmount;
+  /**
+   * Diesel rate of the pool: underlying per 1 diesel share, RAY-scaled
+   * (`1e27`).
+   */
+  shareRate: bigint;
   /**
    * Set when preview encountered non-fatal errors, all fields are
    * still computed best-effort
    */
   error?: OperationPreviewError;
 }
-interface OpenCreditAccountPreview extends PositionMetrics {
+interface OpenCreditAccountPreview {
   operation: "OpenCreditAccount" | "RWAOpenCreditAccount";
+  /**
+   * Health factor in basis points: below `10000` the account is liquidatable.
+   *
+   * @example `12500` for a health factor of 1.25
+   **/
+  healthFactor: Bps;
+  /**
+   * Net rate the whole position earns, collateral yield minus borrow cost.
+   **/
+  overallApy: Bps;
+  /**
+   * Cost of the debt, broken down by source.
+   **/
+  borrowRate: BorrowRateBreakdown;
+  /**
+   * Estimated milliseconds until the health factor decays to `10000` under
+   * the current borrow rate, or `null` when the debt carries no rate (or the
+   * account is already liquidatable).
+   **/
+  timeToLiquidation: bigint | null;
+  /**
+   * Price of the single non-underlying collateral at which the account
+   * becomes liquidatable, in the oracle's 8-decimal fixed point, or `null`
+   * when the account holds zero or several non-underlying assets.
+   **/
+  liquidationPrice: bigint | null;
+  /**
+   * Total-value leverage: `totalValue / (totalValue − totalDebt)`. `1` =
+   * unleveraged; `0` if underwater.
+   **/
+  leverage: Leverage;
   /**
    * Credit manager the account is opened in
    */
   creditManager: Address;
+  /**
+   * Human-readable credit manager name
+   */
+  name: string;
   /**
    * Target token of strategy: the first quoted token, with its balance taken
    * from `assets`. Undefined when nothing is quoted.
    */
-  target?: Asset;
+  target?: TokenAmount;
   /**
    * Tokens that were added as collateral during account opening.
    *
@@ -109,24 +189,34 @@ interface OpenCreditAccountPreview extends PositionMetrics {
    * `NATIVE_ADDRESS` entry, with the wrapped native token amount reduced
    * accordingly (omitted entirely when it reaches zero).
    */
-  collateral: Asset[];
+  collateral: TokenAmount[];
   /**
    * Sum of collateral tokens in underlying
    */
   collateralValue: bigint;
+  /**
+   * Total account value after opening: collateral plus borrowed amount, in
+   * underlying.
+   */
+  totalValue: bigint;
   /**
    * Borrowed amount in underlying
    */
   debt: bigint;
   /**
+   * WARNING: unlike every other `TokenAmount` in this model, `value` is
+   * denominated in the market underlying, NOT in `token`. `token` only
+   * identifies which collateral the quota applies to; `valueUsd` prices the
+   * underlying amount.
+   *
    * Desired quotas
    */
-  quotas: Asset[];
+  quotas: TokenAmount[];
   /**
    * Minimum amount of assets on credit account after it's opened,
    * as estimated by router
    */
-  assets: Asset[];
+  assets: TokenAmount[];
   /**
    * Set when preview encountered non-fatal errors, all fields are
    * still computed best-effort, but derived fields (`assets`, `target`,
@@ -134,12 +224,47 @@ interface OpenCreditAccountPreview extends PositionMetrics {
    */
   error?: OperationPreviewError;
 }
-interface AdjustCreditAccountPreview extends PositionMetrics {
+interface AdjustCreditAccountPreview {
   operation: "AdjustCreditAccount";
+  /**
+   * Health factor in basis points: below `10000` the account is liquidatable.
+   *
+   * @example `12500` for a health factor of 1.25
+   **/
+  healthFactor: Bps;
+  /**
+   * Net rate the whole position earns, collateral yield minus borrow cost.
+   **/
+  overallApy: Bps;
+  /**
+   * Cost of the debt, broken down by source.
+   **/
+  borrowRate: BorrowRateBreakdown;
+  /**
+   * Estimated milliseconds until the health factor decays to `10000` under
+   * the current borrow rate, or `null` when the debt carries no rate (or the
+   * account is already liquidatable).
+   **/
+  timeToLiquidation: bigint | null;
+  /**
+   * Price of the single non-underlying collateral at which the account
+   * becomes liquidatable, in the oracle's 8-decimal fixed point, or `null`
+   * when the account holds zero or several non-underlying assets.
+   **/
+  liquidationPrice: bigint | null;
+  /**
+   * Total-value leverage: `totalValue / (totalValue − totalDebt)`. `1` =
+   * unleveraged; `0` if underwater.
+   **/
+  leverage: Leverage;
   /**
    * Credit manager the account is opened in
    */
   creditManager: Address;
+  /**
+   * Human-readable credit manager name
+   */
+  name: string;
   /**
    * Credit account that is being adjusted
    */
@@ -151,40 +276,54 @@ interface AdjustCreditAccountPreview extends PositionMetrics {
    * `NATIVE_ADDRESS` entry, with the wrapped native token amount reduced
    * accordingly (omitted entirely when it reaches zero).
    */
-  collateralAdded: Asset[];
+  collateralAdded: TokenAmount[];
   /**
    * Tokens that were withdrawn as collateral during account adjustment.
    */
-  collateralWithdrawn: Asset[];
+  collateralWithdrawn: TokenAmount[];
   /**
    * Sum of collateral tokens in underlying
    */
   totalValue: bigint;
   /**
-   * Borrowed amount in underlying
+   * What the account owes in underlying once the operation lands: principal
+   * plus accrued interest and fees, which is the amount it would take to
+   * settle the loan — the same quantity `prepare` projects as `accountDebt`.
    */
   debt: bigint;
   /**
-   * Debt after minus debt before
+   * 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.
    */
   debtChange: bigint;
   /**
+   * WARNING: unlike every other `TokenAmount` in this model, `value` is
+   * denominated in the market underlying, NOT in `token`. `token` only
+   * identifies which collateral the quota applies to; `valueUsd` prices the
+   * underlying amount.
+   *
    * Desired quotas
    */
-  quotas: Asset[];
+  quotas: TokenAmount[];
   /**
+   * WARNING: unlike every other `TokenAmount` in this model, `value` is
+   * denominated in the market underlying, NOT in `token`. `token` only
+   * identifies which collateral the quota applies to; `valueUsd` prices the
+   * underlying amount.
+   *
    * Quotas after minus quotas before
    */
-  quotasChange: Asset[];
+  quotasChange: TokenAmount[];
   /**
    * Minimum amount of assets on credit account after the operation,
    * as estimated by router
    */
-  assets: Asset[];
+  assets: TokenAmount[];
   /**
    * Assets after minus assets before
    */
-  assetsChange: Asset[];
+  assetsChange: TokenAmount[];
   /**
    * Intent of the delayed withdrawal this transaction claims; set when the
    * multicall claims a delayed withdrawal
@@ -209,6 +348,10 @@ interface CloseCreditAccountPreview {
    * Credit manager the account belongs to
    */
   creditManager: Address;
+  /**
+   * Human-readable credit manager name
+   */
+  name: string;
   /**
    * Credit account that is being closed
    */
@@ -220,7 +363,7 @@ interface CloseCreditAccountPreview {
    * markets, the unwrapped RWA underlying (the ERC4626 vault asset the
    * underlying share converts 1:1 into)
    */
-  receivedAmount: Asset;
+  receivedAmount: TokenAmount;
   /**
    * Intent of the delayed withdrawal this transaction claims; set when the
    * multicall claims a delayed withdrawal
@@ -245,6 +388,10 @@ interface RepayCreditAccountPreview {
    * Credit manager the account belongs to
    */
   creditManager: Address;
+  /**
+   * Human-readable credit manager name
+   */
+  name: string;
   /**
    * Credit account that is being repaid
    */
@@ -256,12 +403,12 @@ interface RepayCreditAccountPreview {
    * `NATIVE_ADDRESS` entry, with the wrapped native token amount reduced
    * accordingly (omitted entirely when it reaches zero).
    */
-  collateralAdded: Asset[];
+  collateralAdded: TokenAmount[];
   /**
    * Tokens returned to the user in-kind (`withdrawCollateral` calls, with the
    * MAX_UINT256 sentinel resolved against replayed balances)
    */
-  collateralWithdrawn: Asset[];
+  collateralWithdrawn: TokenAmount[];
   /**
    * Total debt repaid: principal + accrued interest + fees, in underlying
    */
@@ -300,6 +447,10 @@ interface DelayedCreditAccountOperationPreview {
    * 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)
@@ -324,4 +475,4 @@ interface DelayedCreditAccountOperationPreview {
  */
 type OperationPreview = PoolOperationPreview | OpenCreditAccountPreview | AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview | DelayedCreditAccountOperationPreview;
 //#endregion
-export { 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_UNPREVIEWABLE_RWA_WRAP_UNWRAP, ERROR_UNPRICEABLE_TOKEN, InstantOperationPreview, OpenCreditAccountPreview, OperationPreview, OperationPreviewError, PoolOperationPreview, RepayCreditAccountPreview };
+export { 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_UNPREVIEWABLE_RWA_WRAP_UNWRAP, ERROR_UNPRICEABLE_TOKEN, InstantOperationPreview, OpenCreditAccountPreview, OperationPreview, OperationPreviewError, PoolOperationPreview, PoolOperationType, PreviewOperationInput, PreviewOperationOptions, RepayCreditAccountPreview };

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

@@ -62,6 +62,20 @@ type AssetType = "Stable" | "ETH" | "BTC";
  * ```
  **/
 type Leverage = number;
+/**
+ * A token address paired with a balance, used throughout the SDK to
+ * represent holdings, collateral inputs, and leftover targets.
+ **/
+interface Asset {
+  /**
+   * ERC-20 token address.
+   **/
+  token: Address;
+  /**
+   * Token amount in the token's native decimals.
+   **/
+  balance: bigint;
+}
 /**
  * A token amount together with its USD valuation.
  *
@@ -168,4 +182,4 @@ interface TxCall {
   value?: bigint;
 }
 //#endregion
-export { Amount, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall };
+export { Amount, Asset, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmount, TxCall };

package/dist/types/new-sdk/GearboxSDK.d.ts

@@ -5,6 +5,8 @@ import { Opportunities } from "./opportunities/types.js";
 import "./opportunities/index.js";
 import { Positions } from "./positions/types.js";
 import "./positions/index.js";
+import { PreviewByMode } from "./preview/types.js";
+import "./preview/index.js";
 //#region src/new-sdk/GearboxSDK.d.ts
 /**
  * Default {@link GearboxSDKOptions.maxStateAgeSeconds}: the fastest poll an
@@ -48,6 +50,12 @@ declare class GearboxSDK<const M extends Mode = Mode> {
    * Namespace for the positions a wallet holds.
    **/
   readonly positions: Positions<M>;
+  /**
+   * Namespace for on-chain previews of raw operation calldata. Onchain-only,
+   * hence gated by mode like every other chain read: absent in `offchain`
+   * mode.
+   **/
+  readonly preview: PreviewByMode[M];
   /**
    * The banners the backend attaches to a pool opportunity or a strategy
    * position, see {@link Notice}. Top-level because the subject is either

package/dist/types/new-sdk/execute/ExecuteApi.d.ts

@@ -1,6 +1,6 @@
 import { ChainId } from "../../model/primitives.js";
-import { Asset } from "../../sdk/base/types.js";
 import "../../model/index.js";
+import { Asset } from "../../sdk/base/types.js";
 import { SecuritizeRegisterMessage } from "../../sdk/market/rwa/securitize/types.js";
 import { RawTx } from "../../sdk/types/transactions.js";
 import "../../sdk/index.js";