@gearbox-protocol/sdk 16.0.0-next.9 → 16.0.0

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

@@ -1,6 +1,10 @@
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
+import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import "../../onchain/index.js";
 import { Operation } from "./types.js";
+import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "./errors.js";
 import { PreviewOperationInput } from "../types.js";
 //#region src/preview/parse/parseOperationCalldata.d.ts
 /**
@@ -9,6 +13,6 @@ import { PreviewOperationInput } from "../types.js";
  * Support parsing of pool operations (including via zappers),
  * credit facade operations and RWA factory operations.
  */
-declare function parseOperationCalldata<P extends PluginsMap>(input: PreviewOperationInput<P>): Operation;
+declare function parseOperationCalldata<P extends PluginsMap>(input: PreviewOperationInput<P>): SDKReturn<Operation, UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError>;
 //#endregion
 export { parseOperationCalldata };

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

@@ -1,8 +1,11 @@
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
 import { PoolV310Contract } from "../../onchain/market/pool/PoolV310Contract.js";
 import { OnchainSDK } from "../../onchain/OnchainSDK.js";
 import "../../onchain/index.js";
 import { PoolOperation } from "./types-pools.js";
 import "./types.js";
+import { UnsupportedPoolFunctionError } from "./errors.js";
 import { Hex } from "viem";
 //#region src/preview/parse/parsePoolOperationCalldata.d.ts
 /**
@@ -11,8 +14,8 @@ import { Hex } from "viem";
  * @param sdk - The SDK instance.
  * @param pool - The pool contract.
  * @param calldata - The calldata to parse.
- * @returns The parsed operation.
+ * @returns The parsed operation behind `ok`, or the refusal.
  */
-declare function parsePoolOperationCalldata(sdk: OnchainSDK, pool: PoolV310Contract, calldata: Hex): PoolOperation;
+declare function parsePoolOperationCalldata(sdk: OnchainSDK, pool: PoolV310Contract, calldata: Hex): SDKReturn<PoolOperation, UnsupportedPoolFunctionError>;
 //#endregion
 export { parsePoolOperationCalldata };

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

@@ -1,6 +1,11 @@
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
+import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import "../../onchain/index.js";
+import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "../parse/errors.js";
 import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
+import "../parse/index.js";
 import { PrerequisiteResult } from "./types.js";
 //#region src/preview/prerequisites/checkPrerequisites.d.ts
 /**
@@ -18,6 +23,6 @@ import { PrerequisiteResult } from "./types.js";
  * (e.g. pool is paused) is intentionally out of scope, since the user cannot
  * resolve it.
  */
-declare function checkPrerequisites<P extends PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<PrerequisiteResult[]>;
+declare function checkPrerequisites<P extends PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<SDKReturn<PrerequisiteResult[], UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError>>;
 //#endregion
 export { checkPrerequisites };

package/dist/types/preview/preview/{buildDelayedPreview.d.ts → buildDelayedStrategyPositionOperationPreview.d.ts}

@@ -1,26 +1,22 @@
-import { InstantOperationPreview } from "../../model/previews.js";
+import { InstantStrategyPositionOperationPreview } from "../../model/previews.js";
 import "../../model/index.js";
 import { OnchainSDK } from "../../onchain/OnchainSDK.js";
 import "../../onchain/index.js";
 import { CreditAccountState } from "./CreditAccountState.js";
 import { DetectedDelayedOperation } from "./detectDelayedOperation.js";
 import { Address } from "viem";
-//#region src/preview/preview/buildDelayedPreview.d.ts
-/**
- * Oracle conversion, injected so unit tests don't need a market
- */
-type ConvertFn = (token: Address, to: Address, amount: bigint) => bigint;
+//#region src/preview/preview/buildDelayedStrategyPositionOperationPreview.d.ts
 /**
  * Builds the best-effort preview of the account state after the detected
  * delayed withdrawal is claimed and its intent (if any) is resumed:
  * the claim itself followed by the intent-specific tail
  *
  * Pure function: the input states are never mutated and no network access is performed.
- * Swaps are estimated with the injected conversion; tokens it cannot price contribute
- * nothing and set a non-fatal `ERROR_UNPRICEABLE_TOKEN` error on the
- * preview.
+ * Swaps and remaining holdings are priced by the market oracle. Tokens that
+ * cannot be priced contribute nothing and set a non-fatal `unpriceableToken`
+ * warning on the preview.
  *
- * The changes (e.g. `debtChange`) are reported relative to the account
+ * The changes (e.g. `totalDebtChange`) are reported relative to the account
  * state before the whole transaction.
  *
  * @param afterInstant - Account state after the instant part of the
@@ -32,6 +28,6 @@ type ConvertFn = (token: Address, to: Address, amount: bigint) => bigint;
  * @param sdk - Market data source for the position metrics of the resulting
  * state; read synchronously, no network access.
  */
-declare function buildDelayedPreview(afterInstant: CreditAccountState, before: CreditAccountState, detected: DetectedDelayedOperation, convert: ConvertFn, receivedToken: Address, sdk: OnchainSDK): InstantOperationPreview;
+declare function buildDelayedStrategyPositionOperationPreview(afterInstant: CreditAccountState, before: CreditAccountState, detected: DetectedDelayedOperation, receivedToken: Address, sdk: OnchainSDK): InstantStrategyPositionOperationPreview;
 //#endregion
-export { ConvertFn, buildDelayedPreview };
+export { buildDelayedStrategyPositionOperationPreview };

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

@@ -1,5 +1,7 @@
 import { DelayedIntent } from "../../model/delayed-intents.js";
+import { SDKReturn } from "../../model/result.js";
 import "../../model/index.js";
+import { InvalidDelayedIntentError } from "../../onchain/accounts/withdrawal-compressor/errors.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import { OnchainSDK } from "../../onchain/OnchainSDK.js";
 import "../../onchain/index.js";
@@ -41,12 +43,11 @@ declare function detectDelayedClaim<P extends PluginsMap>(sdk: OnchainSDK<P>, mu
  * @param sdk - Attached SDK.
  * @param multicall - Parsed inner operations of the multicall.
  * @param blockNumber - Optional block number to read the log at.
- * @returns The decoded intent, or `undefined` when the multicall claims
- * nothing, the redemption logger is not deployed, or the log carries no
- * intent.
- * @throws InvalidDelayedIntentError when the logged `extraData` is non-empty
- * but cannot be decoded as a `DelayedIntent`.
+ * @returns The decoded intent behind `ok` (`undefined` when the multicall
+ * claims nothing, the redemption logger is not deployed, or the log carries
+ * no intent), or the `invalidDelayedIntent` refusal when the logged
+ * `extraData` is non-empty but cannot be decoded as a `DelayedIntent`.
  */
-declare function resolveDelayedClaimIntent<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], blockNumber?: bigint): Promise<DelayedIntent | undefined>;
+declare function resolveDelayedClaimIntent<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], blockNumber?: bigint): Promise<SDKReturn<DelayedIntent | undefined, InvalidDelayedIntentError>>;
 //#endregion
 export { DetectedDelayedClaim, detectDelayedClaim, resolveDelayedClaimIntent };

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

@@ -1,5 +1,7 @@
 import { DelayedIntent } from "../../model/delayed-intents.js";
+import { SDKReturn } from "../../model/result.js";
 import "../../model/index.js";
+import { InvalidDelayedIntentError } from "../../onchain/accounts/withdrawal-compressor/errors.js";
 import { DelayedWithdrawalRequest } from "../../onchain/market/adapters/types.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import { OnchainSDK } from "../../onchain/OnchainSDK.js";
@@ -32,6 +34,6 @@ interface DetectedDelayedOperation {
  * @throws InvalidDelayedIntentError when a request carries non-empty
  * `extraData` that cannot be decoded as a `DelayedIntent`.
  */
-declare function detectDelayedOperation<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[]): DetectedDelayedOperation | undefined;
+declare function detectDelayedOperation<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[]): SDKReturn<DetectedDelayedOperation | undefined, InvalidDelayedIntentError>;
 //#endregion
 export { DetectedDelayedOperation, detectDelayedOperation };

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

@@ -1,12 +1,44 @@
+import { IGearboxError } from "../../model/errors.js";
+import { AdapterCallOutsideBracketError, InvalidTransactionValueError, MalformedBracketError, MalformedBracketKind, NonAdapterCallInBracketError, UnpreviewableAdapterCallError, UnsupportedOutOfBracketCallError } from "../../model/previews.js";
+import "../../model/index.js";
+import { Address } from "viem";
 //#region src/preview/preview/errors.d.ts
 /**
- * Thrown by `previewOperation` for parsed operations it cannot preview yet.
- * Currently only pool operations and credit account opening are supported.
+ * Refusal answered by `previewOperation` for parsed operations it cannot
+ * preview yet. A plain returned object per the SDK's refusal vocabulary —
+ * not a thrown `Error`.
  */
-declare class UnsupportedOperationError extends Error {
+interface UnsupportedOperationError extends IGearboxError {
+  code: "unsupportedOperation";
   /** The parsed operation kind (the `operation` discriminant). */
-  readonly operation: string;
-  constructor(operation: string);
+  operation: string;
 }
+/**
+ * Builds a {@link MalformedBracketError} for the given bracket invariant.
+ **/
+declare function malformedBracketError(kind: MalformedBracketKind): MalformedBracketError;
+/**
+ * Builds an {@link AdapterCallOutsideBracketError} for `adapter`.
+ **/
+declare function adapterCallOutsideBracketError(adapter: Address): AdapterCallOutsideBracketError;
+/**
+ * Builds a {@link NonAdapterCallInBracketError} for `target`.
+ **/
+declare function nonAdapterCallInBracketError(target: Address): NonAdapterCallInBracketError;
+/**
+ * Builds an {@link UnpreviewableAdapterCallError} for a bracketed adapter
+ * call that could not be replayed.
+ **/
+declare function unpreviewableAdapterCallError(adapter: Address, cause: unknown): UnpreviewableAdapterCallError;
+/**
+ * Builds an {@link UnsupportedOutOfBracketCallError} for an allowed
+ * out-of-bracket adapter call that could not be replayed.
+ **/
+declare function unsupportedOutOfBracketCallError(adapter: Address, cause: unknown): UnsupportedOutOfBracketCallError;
+/**
+ * Builds an {@link InvalidTransactionValueError} when `msg.value` does not
+ * fit into the declared WETH collateral.
+ **/
+declare function invalidTransactionValueError(value: bigint, wethCollateral: bigint): InvalidTransactionValueError;
 //#endregion
-export { UnsupportedOperationError };
+export { UnsupportedOperationError, adapterCallOutsideBracketError, invalidTransactionValueError, malformedBracketError, nonAdapterCallInBracketError, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError };

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

@@ -0,0 +1,19 @@
+import { Timestamp } from "../../model/primitives.js";
+import "../../model/index.js";
+import { PluginsMap } from "../../onchain/plugins/types.js";
+import { OnchainSDK } from "../../onchain/OnchainSDK.js";
+import "../../onchain/index.js";
+import { Address } from "viem";
+//#region src/preview/preview/estimateClaimableAt.d.ts
+/**
+ * Estimates when a newly requested delayed withdrawal becomes claimable:
+ * `now + withdrawalLength` of the cached withdrawable asset whose phantom
+ * token matches `phantomToken`. Same formula as
+ * `getWithdrawalRequestResult().claimableAt`.
+ *
+ * Returns `undefined` when the withdrawal compressor is missing, its assets
+ * cache is not loaded, or no asset matches the phantom token.
+ */
+declare function estimateClaimableAt<P extends PluginsMap>(sdk: OnchainSDK<P>, phantomToken: Address): Timestamp | undefined;
+//#endregion
+export { estimateClaimableAt };

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

@@ -1,12 +1,13 @@
 import { CreditAccountState, CreditAccountStateProps } from "./CreditAccountState.js";
 import { DetectedDelayedOperation, detectDelayedOperation } from "./detectDelayedOperation.js";
-import { ConvertFn, buildDelayedPreview } from "./buildDelayedPreview.js";
+import { buildDelayedStrategyPositionOperationPreview } from "./buildDelayedStrategyPositionOperationPreview.js";
 import { classifyCloseOrRepay, isCloseOrRepay } from "./detectCloseOrRepay.js";
 import { DetectedDelayedClaim, detectDelayedClaim, resolveDelayedClaimIntent } from "./detectDelayedClaim.js";
-import { UnsupportedOperationError } from "./errors.js";
-import { previewAdjustCreditAccount } from "./previewAdjustCreditAccount.js";
-import { CloseOrRepayOperation, previewCloseOrRepayCreditAccount } from "./previewCloseOrRepayCreditAccount.js";
-import { previewOperation } from "./previewOperation.js";
+import { UnsupportedOperationError, adapterCallOutsideBracketError, invalidTransactionValueError, malformedBracketError, nonAdapterCallInBracketError, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError } from "./errors.js";
+import { estimateClaimableAt } from "./estimateClaimableAt.js";
+import { previewAdjustStrategyPosition } from "./previewAdjustStrategyPosition.js";
+import { CloseOrRepayOperation, previewExitOrRepayStrategyPosition } from "./previewExitOrRepayStrategyPosition.js";
+import { PreviewOperationError, previewOperation } from "./previewOperation.js";
 import { ReplayState, makeReplayState, replayInnerOperations } from "./replayInnerOperations.js";
 import { ReplayMulticallResult, ReplayableOperation, replayMulticall } from "./replayMulticall.js";
-export { CloseOrRepayOperation, ConvertFn, CreditAccountState, CreditAccountStateProps, DetectedDelayedClaim, DetectedDelayedOperation, ReplayMulticallResult, ReplayState, ReplayableOperation, UnsupportedOperationError, buildDelayedPreview, classifyCloseOrRepay, detectDelayedClaim, detectDelayedOperation, isCloseOrRepay, makeReplayState, previewAdjustCreditAccount, previewCloseOrRepayCreditAccount, previewOperation, replayInnerOperations, replayMulticall, resolveDelayedClaimIntent };
+export { CloseOrRepayOperation, CreditAccountState, CreditAccountStateProps, DetectedDelayedClaim, DetectedDelayedOperation, PreviewOperationError, ReplayMulticallResult, ReplayState, ReplayableOperation, UnsupportedOperationError, adapterCallOutsideBracketError, buildDelayedStrategyPositionOperationPreview, classifyCloseOrRepay, detectDelayedClaim, detectDelayedOperation, estimateClaimableAt, invalidTransactionValueError, isCloseOrRepay, makeReplayState, malformedBracketError, nonAdapterCallInBracketError, previewAdjustStrategyPosition, previewExitOrRepayStrategyPosition, previewOperation, replayInnerOperations, replayMulticall, resolveDelayedClaimIntent, unpreviewableAdapterCallError, unsupportedOutOfBracketCallError };

package/dist/types/preview/preview/{previewAdjustCreditAccount.d.ts → previewAdjustStrategyPosition.d.ts}

@@ -1,4 +1,4 @@
-import { AdjustCreditAccountPreview } from "../../model/previews.js";
+import { AdjustStrategyPositionPreview } from "../../model/previews.js";
 import "../../model/index.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import "../../onchain/index.js";
@@ -6,7 +6,7 @@ import { MulticallOperation } from "../parse/types-facades.js";
 import { RWAMulticallOperation } from "../parse/types-rwa.js";
 import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
 import "../parse/index.js";
-//#region src/preview/preview/previewAdjustCreditAccount.d.ts
+//#region src/preview/preview/previewAdjustStrategyPosition.d.ts
 /**
  * Previews a `multicall`/`botMulticall` operation on an existing credit
  * account: threads the multicall through {@link replayMulticall} over the
@@ -14,6 +14,6 @@ import "../parse/index.js";
  * minimal guaranteed post-state alongside the changes relative to the
  * pre-state.
  */
-declare function previewAdjustCreditAccount<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: MulticallOperation | RWAMulticallOperation, options: PreviewOperationOptions<true>): Promise<AdjustCreditAccountPreview>;
+declare function previewAdjustStrategyPosition<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: MulticallOperation | RWAMulticallOperation, options: PreviewOperationOptions<true>): AdjustStrategyPositionPreview;
 //#endregion
-export { previewAdjustCreditAccount };
+export { previewAdjustStrategyPosition };

package/dist/types/preview/preview/{previewCloseOrRepayCreditAccount.d.ts → previewExitOrRepayStrategyPosition.d.ts}

@@ -1,4 +1,4 @@
-import { CloseCreditAccountPreview, RepayCreditAccountPreview } from "../../model/previews.js";
+import { ExitStrategyPositionPreview, RepayStrategyPositionPreview } from "../../model/previews.js";
 import "../../model/index.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import "../../onchain/index.js";
@@ -6,13 +6,13 @@ import { CloseCreditAccountOperation, MulticallOperation } from "../parse/types-
 import { RWAMulticallOperation } from "../parse/types-rwa.js";
 import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
 import "../parse/index.js";
-//#region src/preview/preview/previewCloseOrRepayCreditAccount.d.ts
+//#region src/preview/preview/previewExitOrRepayStrategyPosition.d.ts
 /**
  * Any parsed operation that fully closes or repays a credit account: the
  * facade `closeCreditAccount` entry point (permanent closure) or a plain
  * multicall detected by `isCloseOrRepay` (`decreaseDebt(MAX)`).
  */
 type CloseOrRepayOperation = CloseCreditAccountOperation | MulticallOperation | RWAMulticallOperation;
-declare function previewCloseOrRepayCreditAccount<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: CloseOrRepayOperation, permanent: boolean, options: PreviewOperationOptions<true>): Promise<CloseCreditAccountPreview | RepayCreditAccountPreview>;
+declare function previewExitOrRepayStrategyPosition<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: CloseOrRepayOperation, permanent: boolean, options: PreviewOperationOptions<true>): ExitStrategyPositionPreview | RepayStrategyPositionPreview;
 //#endregion
-export { CloseOrRepayOperation, previewCloseOrRepayCreditAccount };
+export { CloseOrRepayOperation, previewExitOrRepayStrategyPosition };

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

@@ -0,0 +1,12 @@
+import { OpenStrategyPositionPreview } from "../../model/previews.js";
+import "../../model/index.js";
+import { PluginsMap } from "../../onchain/plugins/types.js";
+import "../../onchain/index.js";
+import { OpenCreditAccountOperation } from "../parse/types-facades.js";
+import { RWAOpenCreditAccountOperation } from "../parse/types-rwa.js";
+import { PreviewOperationInput } from "../types.js";
+import "../parse/index.js";
+//#region src/preview/preview/previewOpenStrategyPosition.d.ts
+declare function previewOpenStrategyPosition<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: OpenCreditAccountOperation | RWAOpenCreditAccountOperation): OpenStrategyPositionPreview;
+//#endregion
+export { previewOpenStrategyPosition };

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

@@ -1,13 +1,32 @@
 import { OperationPreview } from "../../model/previews.js";
+import { SDKReturn } from "../../model/result.js";
 import "../../model/index.js";
+import { InvalidDelayedIntentError } from "../../onchain/accounts/withdrawal-compressor/errors.js";
+import { UnsupportedZapperFunctionError } from "../../onchain/market/zapper/errors.js";
 import { PluginsMap } from "../../onchain/plugins/types.js";
 import "../../onchain/index.js";
+import { UnsupportedPoolFunctionError, UnsupportedTargetError } from "../parse/errors.js";
 import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
+import "../parse/index.js";
+import { UnsupportedOperationError } from "./errors.js";
+import { PreviewSimulationError } from "../simulate/errors.js";
 //#region src/preview/preview/previewOperation.d.ts
+/**
+ * Everything {@link previewOperation} can refuse with: the refusal errors
+ * its pipeline raises, discriminated by `code`. Each is a plain object —
+ * never a thrown `Error` — per the SDK's refusal vocabulary.
+ */
+type PreviewOperationError = UnsupportedTargetError | UnsupportedPoolFunctionError | UnsupportedZapperFunctionError | UnsupportedOperationError | InvalidDelayedIntentError | PreviewSimulationError;
 /**
  * Previews a raw operation calldata: decodes it into a typed operation and
  * assembles an operation-specific, human-displayable preview.
+ *
+ * Answers an {@link SDKReturn} envelope: the preview behind `ok: true`, or —
+ * when the transaction is one the previewer refuses to read — a
+ * {@link PreviewOperationError} behind `ok: false`. A thrown exception
+ * still means the SDK could not do its job (a read failed, the targeted
+ * credit account could not be resolved), not a refusal of the transaction.
  */
-declare function previewOperation<P extends PluginsMap = PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<OperationPreview>;
+declare function previewOperation<P extends PluginsMap = PluginsMap>(input: PreviewOperationInput<P>, options?: PreviewOperationOptions): Promise<SDKReturn<OperationPreview, PreviewOperationError>>;
 //#endregion
-export { previewOperation };
+export { PreviewOperationError, previewOperation };

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

@@ -0,0 +1,13 @@
+import { PoolPositionOperationPreview } from "../../model/previews.js";
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
+import { PluginsMap } from "../../onchain/plugins/types.js";
+import "../../onchain/index.js";
+import { PoolOperation } from "../parse/types-pools.js";
+import { PreviewOperationInput, PreviewOperationOptions } from "../types.js";
+import "../parse/index.js";
+import { PreviewSimulationError } from "../simulate/errors.js";
+//#region src/preview/preview/previewPoolPositionOperation.d.ts
+declare function previewPoolPositionOperation<P extends PluginsMap>(input: PreviewOperationInput<P>, operation: PoolOperation, options?: PreviewOperationOptions): Promise<SDKReturn<PoolPositionOperationPreview, PreviewSimulationError>>;
+//#endregion
+export { previewPoolPositionOperation };

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

@@ -41,11 +41,11 @@ declare function makeReplayState(account: CreditAccountState): ReplayState;
  * 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
+ * router/withdrawal compressor, otherwise it returns a warning, but still
  * proceeds best-effort.
  *
- * @returns `undefined` on success, the error on a malformed multicall.
+ * @returns `undefined` on success, the warning on a malformed multicall.
  */
-declare function replayInnerOperations<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], state: ReplayState): Promise<OperationPreviewError | undefined>;
+declare function replayInnerOperations<P extends PluginsMap>(sdk: OnchainSDK<P>, multicall: InnerOperation[], state: ReplayState): OperationPreviewError | undefined;
 //#endregion
 export { ReplayState, makeReplayState, replayInnerOperations };

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

@@ -33,12 +33,12 @@ interface ReplayMulticallResult {
    * replay in facade execution order
    */
   after: ReplayState;
-  error?: OperationPreviewError;
+  warning?: OperationPreviewError;
 }
 /**
  * Replays the operation's multicall over the account's pre-resolved
  * pre-state (`options.creditAccount`) via {@link replayInnerOperations}.
  */
-declare function replayMulticall<P extends PluginsMap>(sdk: OnchainSDK<P>, operation: ReplayableOperation, options: PreviewOperationOptions<true>): Promise<ReplayMulticallResult>;
+declare function replayMulticall<P extends PluginsMap>(sdk: OnchainSDK<P>, operation: ReplayableOperation, options: PreviewOperationOptions<true>): ReplayMulticallResult;
 //#endregion
 export { ReplayMulticallResult, ReplayableOperation, replayMulticall };

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

@@ -10,9 +10,9 @@ interface UnwrapNativeCollateralResult {
    */
   assets: Asset[];
   /**
-   * Error set when the transaction value is malformed.
+   * Warning set when the transaction value is malformed.
    */
-  error?: OperationPreviewError;
+  warning?: OperationPreviewError;
 }
 /**
  * Represents the transaction's attached native value as a `NATIVE_ADDRESS`
@@ -26,14 +26,13 @@ interface UnwrapNativeCollateralResult {
  *
  * When `nativeAmount` is positive but the WETH collateral is missing or
  * smaller than it, the transaction is malformed: the collateral is returned
- * as-is (no unwrapping) together with an `ERROR_INVALID_TRANSACTION_VALUE`
- * error.
+ * as-is (no unwrapping) together with an `invalidTransactionValue` warning.
  *
  * @param collateral - Collateral assets as declared by the multicall.
  * @param nativeAmount - Transaction `msg.value`.
  * @param wethToken - Wrapped native token address.
  * @returns Collateral with the native amount unwrapped from the WETH entry,
- * plus the error on a malformed transaction value.
+ * plus the warning on a malformed transaction value.
  */
 declare function unwrapNativeCollateral(collateral: Asset[], nativeAmount: bigint, wethToken: Address): UnwrapNativeCollateralResult;
 //#endregion

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

@@ -1,4 +1,6 @@
-import { BaseError, Hex } from "viem";
+import { IGearboxError } from "../../model/errors.js";
+import "../../model/index.js";
+import { Hex } from "viem";
 //#region src/preview/simulate/errors.d.ts
 /** Which simulation flow produced a failure. */
 type SimulationFlowSource = "multicall" | "unknown";
@@ -8,14 +10,16 @@ interface SimulationFlowFailure {
   detail: SimulationError;
 }
 /**
- * Error returned by the pool simulation when it fails. It wraps the flow's
- * decoded revert reason (see {@link failures}).
+ * Refusal answered when the pool simulation fails. It wraps each flow's
+ * decoded revert reason (see {@link failures}). A plain returned object per
+ * the SDK's refusal vocabulary — not a thrown `Error`.
  */
-declare class PreviewSimulationError extends BaseError {
-  name: string;
-  /** Per-flow decoded failures behind this error. */
-  readonly failures: SimulationFlowFailure[];
-  constructor(failures: SimulationFlowFailure[]);
+interface PreviewSimulationError extends IGearboxError {
+  code: "previewSimulationFailed";
+  /** Per-flow decoded failures behind this refusal. */
+  failures: SimulationFlowFailure[];
+  /** First flow failure that was itself an `Error`, kept for debugging. */
+  cause?: Error;
 }
 /**
  * Normalises an unknown rejection reason into a {@link PreviewSimulationError}.

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

@@ -1,7 +1,7 @@
-import { PreviewSimulationError, SimulationError, SimulationFlowFailure, SimulationFlowSource } from "./errors.js";
+import { PreviewSimulationError, SimulationError, SimulationFlowFailure, SimulationFlowSource, asPreviewSimulationError } from "./errors.js";
 import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
 import { simulateFacadeOperation } from "./simulateFacadeOperation.js";
 import { simulateOperation } from "./simulateOperation.js";
 import { simulatePoolOperation } from "./simulatePoolOperation.js";
 import { simulateRWAOperation } from "./simulateRWAOperation.js";
-export { type PoolOperationSimulationResult, PreviewSimulationError, type SimulationError, type SimulationFlowFailure, type SimulationFlowSource, type SimulationInput, simulateFacadeOperation, simulateOperation, simulatePoolOperation, simulateRWAOperation };
+export { type PoolOperationSimulationResult, type PreviewSimulationError, type SimulationError, type SimulationFlowFailure, type SimulationFlowSource, type SimulationInput, asPreviewSimulationError, simulateFacadeOperation, simulateOperation, simulatePoolOperation, simulateRWAOperation };

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

@@ -1,9 +1,12 @@
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
 import { PreviewOperationOptions } from "../types.js";
+import { PreviewSimulationError } from "./errors.js";
 import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
 //#region src/preview/simulate/simulateOperation.d.ts
 /**
  * Simulates a parsed pool or credit account operation
  */
-declare function simulateOperation(input: SimulationInput, options?: PreviewOperationOptions): Promise<PoolOperationSimulationResult>;
+declare function simulateOperation(input: SimulationInput, options?: PreviewOperationOptions): Promise<SDKReturn<PoolOperationSimulationResult, PreviewSimulationError>>;
 //#endregion
 export { simulateOperation };

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

@@ -1,8 +1,28 @@
+import { SDKReturn } from "../../model/result.js";
+import "../../model/index.js";
 import { PoolOperation } from "../parse/types-pools.js";
 import { PreviewOperationOptions } from "../types.js";
 import "../parse/index.js";
+import { PreviewSimulationError } from "./errors.js";
 import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
+import { ContractFunctionParameters } from "viem";
 //#region src/preview/simulate/simulatePoolOperation.d.ts
+/**
+ * Builds the preview read that converts the operation's known amount into its
+ * counterpart. Direct operations read the pool's ERC4626 preview; zapper-routed
+ * operations (only ever `Deposit`/`Redeem`) read the zapper's
+ * `previewDeposit`/`previewRedeem`, which account for the zapper's own
+ * conversion in addition to the pool's.
+ */
+declare function previewContract(operation: PoolOperation): ContractFunctionParameters;
+/**
+ * Maps a pool operation and its preview result to the amounts of tokens going
+ * in (user -> pool) and out (pool -> user). `previewAmount` is the counterpart
+ * amount returned by the matching preview read (shares for deposit/withdraw,
+ * assets for mint/redeem, and the zapper's converted amount for zapper-routed
+ * deposit/redeem).
+ */
+declare function amountsInOut(operation: PoolOperation, previewAmount: bigint): PoolOperationSimulationResult;
 /**
  * Simulates a pool deposit/mint/withdraw/redeem (direct or zapper-routed) and
  * returns the resulting token amounts going in and out. Throws a
@@ -17,6 +37,6 @@ import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
  * It does not execute the calldata, so it ignores balance/allowance
  * prerequisites (preview reads succeed regardless).
  */
-declare function simulatePoolOperation(input: SimulationInput<PoolOperation>, options?: PreviewOperationOptions): Promise<PoolOperationSimulationResult>;
+declare function simulatePoolOperation(input: SimulationInput<PoolOperation>, options?: PreviewOperationOptions): Promise<SDKReturn<PoolOperationSimulationResult, PreviewSimulationError>>;
 //#endregion
-export { simulatePoolOperation };
+export { amountsInOut, previewContract, simulatePoolOperation };

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

@@ -26,13 +26,21 @@ interface SimulationInput<Op extends Operation = Operation> {
  */
 interface PoolOperationSimulationResult {
   /**
-   * Amount of tokens going from the user to the pool (underlying or zapper
-   * input token for deposit/mint, pool shares for withdraw/redeem).
+   * User -> pool.
+   *
+   * Deposit/mint: underlying (or zapper input); `withdrawFee` does not apply.
+   *
+   * Withdraw/redeem: shares burned. On withdraw, `previewWithdraw` inflates
+   * that burn for `withdrawFee`; on redeem, the shares from calldata.
    **/
   amountIn: bigint;
   /**
-   * Amount of tokens going from the pool to the user (pool shares or zapper
-   * output token for deposit/mint, underlying for withdraw/redeem).
+   * Pool -> user.
+   *
+   * Deposit/mint: shares minted (or zapper output); `withdrawFee` does not apply.
+   *
+   * Withdraw/redeem: underlying paid out. On withdraw, the requested amount;
+   * on redeem, `previewRedeem` after `withdrawFee`.
    **/
   amountOut: bigint;
 }

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

@@ -1,4 +1,4 @@
-import { CallTrace } from "../../common-utils/utils/trace.js";
+import { CallTrace } from "../../onchain/utils/trace.js";
 //#region src/preview/trace/extractAdapterCallTraces.d.ts
 /**
  * Extracts the user multicall's adapter-level call traces from a single facade

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

@@ -1,4 +1,4 @@
-import { CallTrace } from "../../common-utils/utils/trace.js";
+import { CallTrace } from "../../onchain/utils/trace.js";
 import { ChainContractsRegister } from "../../onchain/base/ChainContractsRegister.js";
 import "../../onchain/index.js";
 import { FacadeParsedCall } from "./types.js";

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

@@ -1,5 +1,5 @@
 import { ParsedCallV2 } from "../../onchain/base/types.js";
-import { CallTrace } from "../../common-utils/utils/trace.js";
+import { CallTrace } from "../../onchain/utils/trace.js";
 import "../../onchain/index.js";
 import { Address } from "viem";
 //#region src/preview/trace/types.d.ts