@gearbox-protocol/sdk 14.12.0-next.29 → 14.12.0-next.30

package/dist/types/preview/preview/replayMulticall.d.ts

@@ -0,0 +1,38 @@
+import type { Address } from "viem";
+import type { SdkWithAdapters } from "../../plugins/adapters/index.js";
+import type { PluginsMap } from "../../sdk/index.js";
+import type { InnerOperation } from "../parse/index.js";
+import type { PreviewOperationOptions } from "../types.js";
+import { CreditAccountState } from "./CreditAccountState.js";
+import { type ReplayState } from "./replayInnerOperations.js";
+import type { OperationPreviewError } from "./types.js";
+/**
+ * Parsed operation on an existing credit account whose multicall can be
+ * replayed: the facade `closeCreditAccount` entry point and
+ * plain/bot/RWA multicalls all fit structurally.
+ */
+export interface ReplayableOperation {
+    creditAccount: Address;
+    multicall: InnerOperation[];
+}
+/**
+ * Result of {@link replayMulticall}: the account's pre-state and the replayed
+ * (minimal guaranteed) post-state.
+ */
+export interface ReplayMulticallResult {
+    /**
+     * Account state before the operation, dust-filtered
+     */
+    before: CreditAccountState;
+    /**
+     * Post-operation state and per-multicall bookkeeping, mutated by the
+     * replay in facade execution order
+     */
+    after: ReplayState;
+    error?: OperationPreviewError;
+}
+/**
+ * Replays the operation's multicall over the account's pre-resolved
+ * pre-state (`options.creditAccount`) via {@link replayInnerOperations}.
+ */
+export declare function replayMulticall<P extends PluginsMap>(sdk: SdkWithAdapters<P>, operation: ReplayableOperation, options: PreviewOperationOptions<true>): Promise<ReplayMulticallResult>;

package/dist/types/preview/preview/types.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../sdk/index.js";
+import type { Asset, DelayedIntent } from "../../sdk/index.js";
 import type { PoolOperationType } from "../parse/index.js";
 /**
  * Broken `storeExpectedBalances`/`compareBalances` bracket structure:
@@ -33,6 +33,21 @@ export declare const ERROR_UNPREVIEWABLE_RWA_WRAP_UNWRAP = 1005;
 export declare const ERROR_INVALID_TRANSACTION_VALUE = 1006;
 /** A token in the preview could not be priced by the oracle */
 export declare const ERROR_UNPRICEABLE_TOKEN = 2001;
+/**
+ * Dust threshold for replayed preview balances and balance changes.
+ *
+ * Multicalls assembled by `CreditAccountsServiceV310` subtract a 10-unit
+ * safety buffer from every expected output token in their
+ * `storeExpectedBalances` deltas (`amount - 10n` in
+ * `assembleStartDelayedWithdrawalCalls`/`assembleClaimDelayedCalls`), while
+ * subsequent calls in the same multicall spend exact on-chain amounts. A
+ * replay that credits only the min-guarantee can therefore be off by up to
+ * 10 units per token, including small negative residues that are impossible
+ * on-chain. Amounts within this threshold (in absolute value) are filtered
+ * from preview outputs; anything beyond it is a genuine discrepancy and is
+ * reported.
+ */
+export declare const PREVIEW_DUST = 10n;
 /**
  * Non-throwing preview failure. When set on a preview, all fields are still
  * computed best-effort, but some of them may be unreliable.
@@ -255,8 +270,48 @@ export interface RepayCreditAccountPreview {
      */
     error?: OperationPreviewError;
 }
+/**
+ * Preview of the "instant" part of an operation on an existing credit
+ * account: what the transaction does in the same block, before any delayed
+ * withdrawal is claimed.
+ */
+export type InstantOperationPreview = AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview;
+/**
+ * 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
+ */
+export interface DelayedCreditAccountOperationPreview {
+    operation: "DelayedCreditAccountOperation";
+    /**
+     * Credit account the operation is performed on
+     */
+    creditAccount: Address;
+    /**
+     * Credit manager the account belongs to
+     */
+    creditManager: Address;
+    /**
+     * Decoded from the withdrawal request's extraData; undefined when the
+     * request carries no intent (e.g. Mellow)
+     */
+    intent?: DelayedIntent;
+    /**
+     * What this transaction does right now: the delayed withdrawal is
+     * represented by the phantom token among the account's assets
+     */
+    instantPreview: InstantOperationPreview;
+    /**
+     * 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;
+}
 /**
  * Result of previewing a raw operation calldata: currently pool operations and
- * credit account opening, adjustment, closure and repayment are supported.
+ * credit account opening, adjustment, closure, repayment and delayed
+ * withdrawal operations are supported.
  */
-export type OperationPreview = PoolOperationPreview | OpenCreditAccountPreview | AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview;
+export type OperationPreview = PoolOperationPreview | OpenCreditAccountPreview | AdjustCreditAccountPreview | CloseCreditAccountPreview | RepayCreditAccountPreview | DelayedCreditAccountOperationPreview;

package/dist/types/preview/types.d.ts

@@ -30,11 +30,7 @@ export interface PreviewOperationInput<P extends PluginsMap = PluginsMap> {
      **/
     value?: bigint;
 }
-/**
- * Options shared by the preview, simulation and prerequisite-check flows.
- * Each flow uses the subset it needs and ignores the rest.
- */
-export interface PreviewOperationOptions {
+interface PreviewOperationOptionsBase {
     /**
      * Block to read/simulate at; defaults to latest. Only set for testnet
      * forks.
@@ -44,9 +40,24 @@ export interface PreviewOperationOptions {
      * Optional logger.
      **/
     logger?: ILogger;
+}
+/**
+ * Options shared by the preview, simulation and prerequisite-check flows.
+ * Each flow uses the subset it needs and ignores the rest.
+ *
+ * `WithAccount = true` marks options whose credit account state has already
+ * been resolved (internal preview paths on an existing credit account).
+ */
+export type PreviewOperationOptions<WithAccount extends boolean = false> = WithAccount extends true ? PreviewOperationOptionsBase & {
+    /**
+     * Pre-resolved state of the credit account the operation targets
+     */
+    creditAccount: CreditAccountData;
+} : PreviewOperationOptionsBase & {
     /**
      * @internal
      * Credit account state for testing purposes
      */
     creditAccount?: CreditAccountData;
-}
+};
+export {};

package/package.json

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

package/dist/esm/preview/preview/applyQuotaChanges.js

@@ -1,19 +0,0 @@
-import { MIN_INT96 } from "../../sdk/index.js";
-function applyQuotaChanges(initialQuotas, changes) {
-  const final = initialQuotas.clone();
-  for (const { token, balance: change } of changes) {
-    if (change === MIN_INT96) {
-      final.upsert(token, 0n);
-    } else {
-      const next = final.getOrZero(token) + change;
-      final.upsert(token, next > 0n ? next : 0n);
-    }
-  }
-  return {
-    quotas: final.toAssets(0n),
-    quotasChange: final.difference(initialQuotas).toAssets()
-  };
-}
-export {
-  applyQuotaChanges
-};

package/dist/types/preview/preview/applyInnerOperations.d.ts

@@ -1,59 +0,0 @@
-import { type SdkWithAdapters } from "../../plugins/adapters/index.js";
-import { type Asset, AssetsMap, type PluginsMap } from "../../sdk/index.js";
-import type { InnerOperation } from "../parse/index.js";
-import { type OperationPreviewError } from "./types.js";
-/**
- * Running state threaded through a credit-facade multicall by
- * {@link applyInnerOperations}. Seeded by the caller:
- * - account opening: everything zero/empty (the account doesn't exist yet);
- * - account adjustment: `balances` from the account's current token balances,
- *   `debt` from the principal, `totalDebt` from principal + accrued interest +
- *   accrued fees.
- */
-export interface InnerOperationsState {
-    /**
-     * Cumulative credit-account balances, mutated in facade execution order.
-     */
-    balances: AssetsMap;
-    /**
-     * Debt principal
-     */
-    debt: bigint;
-    /**
-     * Total debt: principal + accrued interest + accrued fees.
-     * `decreaseDebt` amounts operate on total debt (interest and fees are repaid
-     * before principal), so principal alone is not enough to resolve either the
-     * underlying balance decrement or the final principal.
-     */
-    totalDebt: bigint;
-    /**
-     * Cumulative amounts added via `addCollateral`.
-     */
-    collateralAdded: AssetsMap;
-    /**
-     * Cumulative amounts withdrawn via `withdrawCollateral`, with `MAX_UINT256`
-     * resolved against the running balance at the point of the call.
-     */
-    collateralWithdrawn: AssetsMap;
-    /**
-     * Raw `updateQuota` changes, one entry per op. Entries are relative signed
-     * changes (with the `MIN_INT96` "disable" sentinel kept as-is), not final
-     * quotas: folding them requires pre-state quotas, see `applyQuotaChanges`.
-     */
-    quotaChanges: Asset[];
-}
-/**
- * Creates an all-zero {@link InnerOperationsState} (the account-opening seed).
- */
-export declare function makeInnerOperationsState(): InnerOperationsState;
-/**
- * Replays a credit-facade multicall over `state`, mutating it in place in
- * facade execution order. The result is the *minimal guaranteed* post-state.
- *
- * The function assumes that the call was generated by our frontend using
- * router/withdrawal compressor, otherwise it returns an error, but still
- * proceeds best-effort.
- *
- * @returns `undefined` on success, the error on a malformed multicall.
- */
-export declare function applyInnerOperations<P extends PluginsMap>(sdk: SdkWithAdapters<P>, multicall: InnerOperation[], state: InnerOperationsState): Promise<OperationPreviewError | undefined>;

package/dist/types/preview/preview/applyQuotaChanges.d.ts

@@ -1,24 +0,0 @@
-import { type Asset, type AssetsMap } from "../../sdk/index.js";
-export interface ApplyQuotaChangesResult {
-    /**
-     * Final non-zero per-token quotas.
-     */
-    quotas: Asset[];
-    /**
-     * Applied (post-clamp) per-token deltas, non-zero entries only.
-     */
-    quotasChange: Asset[];
-}
-/**
- * Applies raw `updateQuota` changes to the account's initial quotas.
- *
- * Each change is applied sequentially: `MIN_INT96` disables the quota, other
- * changes are added to the running quota with the result clamped at zero
- * (quotas cannot go negative on-chain).
- *
- * @param initialQuotas - Per-token quotas before the operation.
- * @param changes - Raw changes recorded by `applyInnerOperations`.
- * @returns `quotas` - final non-zero per-token quotas; `quotasChange` -
- * applied (post-clamp) per-token deltas, non-zero entries only.
- */
-export declare function applyQuotaChanges(initialQuotas: AssetsMap, changes: Asset[]): ApplyQuotaChangesResult;