@gearbox-protocol/sdk 16.0.0-next.30 → 16.0.0-next.31

package/dist/cjs/onchain/accounts/intents/utils/credit-account-slice.js

@@ -30,7 +30,7 @@ function toCreditAccountSlice(ca) {
 * Reads an account by address and narrows it to {@link CreditAccountSlice}.
 *
 * The shared read model's `StrategyPosition` carries neither `tokens` nor
-* `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so simulating against
+* `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so preparing against
 * an existing position costs one account read.
 *
 * @throws When the account is not found in the connected markets.

package/dist/cjs/onchain/accounts/intents/utils/quotas-for-update.js

@@ -124,7 +124,7 @@ function collectQuotaChange(assetsBefore, assetsAfter) {
 }
 /**
 * SDK `getSingleQuotaChange` requires `assetAfter` to emit quota decreases.
-* Simulation drops zero balances, so fully spent collaterals (e.g. claim
+* The ledger drops zero balances, so fully spent collaterals (e.g. claim
 * phantom) vanish — reinsert them with balance 0 when they still have
 * initial quota so `calcQuotaUpdate` can zero / remove that quota.
 */

package/dist/cjs/sdk/execute/ExecuteApi.js

@@ -12,7 +12,7 @@ var ExecuteApi = class {
 	* {@inheritDoc IOpportunitiesExecute.buildTx}
 	**/
 	async buildTx(request) {
-		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} simulation`);
+		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} preparation`);
 		const sdk = this.#chainOf(request.chainId);
 		switch (request.kind) {
 			case "pool": return poolTx(sdk, request);
@@ -86,10 +86,10 @@ async function accountTx(sdk, request) {
 	return sdk.accounts.executeCaUpdate(account, request.sim.calls, { ethAmount: nativeValue(request.sim.operations) });
 }
 /**
-* The coin the simulation asked the wallet for, which the facade wraps out of
+* The coin the preparation asked the wallet for, which the facade wraps out of
 * `msg.value` before running the multicall. Taken off the collateral step that
 * recorded it rather than from the caller, so it cannot disagree with what was
-* simulated.
+* prepared.
 **/
 function nativeValue(operations) {
 	return operations.reduce((total, op) => total + (op.type === "addCollateral" ? op.value ?? 0n : 0n), 0n);

package/dist/cjs/sdk/prepare/PrepareApi.js

@@ -16,7 +16,7 @@ const require_sdk_prepare_withdrawable_collaterals = require("./withdrawable-col
 * protocol knowledge stays in `CreditAccountOperationsService` and
 * `PoolService`.
 *
-* A simulation names one chain, so it reads through
+* A prepared operation names one chain, so it reads through
 * {@link MultichainConstruct.queryChain}: there is no second source to fall back
 * to, hence a chain the SDK does not cover, or one that fails the read, throws
 * rather than answering with empty metadata.

package/dist/esm/onchain/accounts/intents/utils/credit-account-slice.js

@@ -29,7 +29,7 @@ function toCreditAccountSlice(ca) {
 * Reads an account by address and narrows it to {@link CreditAccountSlice}.
 *
 * The shared read model's `StrategyPosition` carries neither `tokens` nor
-* `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so simulating against
+* `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so preparing against
 * an existing position costs one account read.
 *
 * @throws When the account is not found in the connected markets.

package/dist/esm/onchain/accounts/intents/utils/quotas-for-update.js

@@ -123,7 +123,7 @@ function collectQuotaChange(assetsBefore, assetsAfter) {
 }
 /**
 * SDK `getSingleQuotaChange` requires `assetAfter` to emit quota decreases.
-* Simulation drops zero balances, so fully spent collaterals (e.g. claim
+* The ledger drops zero balances, so fully spent collaterals (e.g. claim
 * phantom) vanish — reinsert them with balance 0 when they still have
 * initial quota so `calcQuotaUpdate` can zero / remove that quota.
 */

package/dist/esm/sdk/execute/ExecuteApi.js

@@ -11,7 +11,7 @@ var ExecuteApi = class {
 	* {@inheritDoc IOpportunitiesExecute.buildTx}
 	**/
 	async buildTx(request) {
-		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} simulation`);
+		if (!request.sim.ok) throw new Error(`cannot build a transaction from a failed ${request.kind} preparation`);
 		const sdk = this.#chainOf(request.chainId);
 		switch (request.kind) {
 			case "pool": return poolTx(sdk, request);
@@ -85,10 +85,10 @@ async function accountTx(sdk, request) {
 	return sdk.accounts.executeCaUpdate(account, request.sim.calls, { ethAmount: nativeValue(request.sim.operations) });
 }
 /**
-* The coin the simulation asked the wallet for, which the facade wraps out of
+* The coin the preparation asked the wallet for, which the facade wraps out of
 * `msg.value` before running the multicall. Taken off the collateral step that
 * recorded it rather than from the caller, so it cannot disagree with what was
-* simulated.
+* prepared.
 **/
 function nativeValue(operations) {
 	return operations.reduce((total, op) => total + (op.type === "addCollateral" ? op.value ?? 0n : 0n), 0n);

package/dist/esm/sdk/prepare/PrepareApi.js

@@ -15,7 +15,7 @@ import { withdrawableCollaterals } from "./withdrawable-collaterals.js";
 * protocol knowledge stays in `CreditAccountOperationsService` and
 * `PoolService`.
 *
-* A simulation names one chain, so it reads through
+* A prepared operation names one chain, so it reads through
 * {@link MultichainConstruct.queryChain}: there is no second source to fall back
 * to, hence a chain the SDK does not cover, or one that fails the read, throws
 * rather than answering with empty metadata.

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

@@ -4,7 +4,7 @@ import "../../../model/index.js";
 import { Asset } from "../../base/types.js";
 import { MultiCall } from "../../types/transactions.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
-import { SimulationPrices } from "./types.js";
+import { PreparedPrices } from "./types.js";
 import "../../index.js";
 import { Address } from "viem";
 //#region src/onchain/accounts/intents/open-strategy.d.ts
@@ -32,7 +32,7 @@ interface OpenStrategyProps {
  * hands back expected and floor balances from a single call, and `openCA` wants
  * both `minQuota` and `averageQuota`, so there is nothing to gain by dropping one.
  */
-interface OpenStrategyState extends Omit<AccountProjection, "assets" | "quotas">, SimulationPrices {
+interface OpenStrategyState extends Omit<AccountProjection, "assets" | "quotas">, PreparedPrices {
   /** Expected post-open balances. */
   averageAssets: TokenAmount[];
   /** Floor post-open balances after slippage. */

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

@@ -31,14 +31,14 @@ interface PathLossRate {
   totalValuePriceImpact: bigint;
 }
 /**
- * The two prices only a planned walk can quote, carried by every simulation
+ * The two prices only a planned walk can quote, carried by every `prepare`
  * result beside its projection.
  *
  * A calldata preview is asked for neither: it reads a transaction that already
  * names its amounts, and it reports what that transaction does rather than what
  * the market charges while a form is open.
  */
-interface SimulationPrices {
+interface PreparedPrices {
   /**
    * What the routed legs lost to market depth. `undefined` where nothing was
    * routed or nothing could be measured — never a manufactured zero.
@@ -60,7 +60,7 @@ interface SimulationPrices {
  * {@link AccountProjection} vocabulary, plus the prices only a routed walk can
  * report.
  */
-interface OperationState extends AccountProjection, SimulationPrices {}
+interface OperationState extends AccountProjection, PreparedPrices {}
 /**
  * What a preview yields: the operation chain, the state it projects, and the
  * calldata that realises it — or the reason the request is not viable.
@@ -395,4 +395,4 @@ type FinishIntentProps = StartIntentProps & {
   claimable: ClaimableWithdrawal;
 };
 //#endregion
-export { AddCollateralIntent, AdjustLeverageIntent, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, RepayStrategyIntent, ResumableIntent, RouteRefusals, SimulationPrices, StartIntent, StartIntentProps, WithdrawAssetIntent, WithdrawStrategyIntent };
+export { AddCollateralIntent, AdjustLeverageIntent, CreditAccountSlice, DelayableIntent, DelayedRoute, DelayedStart, DelayedStartResult, DepositStrategyIntent, FinishIntentProps, InstantRoute, IntentPreviewResult, IntentRoutesResult, OperationState, PathLossRate, PreparedPrices, RepayStrategyIntent, ResumableIntent, RouteRefusals, StartIntent, StartIntentProps, WithdrawAssetIntent, WithdrawStrategyIntent };

package/dist/types/onchain/accounts/intents/utils/credit-account-slice.d.ts

@@ -19,7 +19,7 @@ declare function toCreditAccountSlice(ca: CreditAccountDataPayload): CreditAccou
  * Reads an account by address and narrows it to {@link CreditAccountSlice}.
  *
  * The shared read model's `StrategyPosition` carries neither `tokens` nor
- * `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so simulating against
+ * `enabledTokensMask` / `creditFacade` / `totalDebtUSD`, so preparing against
  * an existing position costs one account read.
  *
  * @throws When the account is not found in the connected markets.

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

@@ -4,15 +4,15 @@ import { Asset } from "../../onchain/base/types.js";
 import { SecuritizeRegisterMessage } from "../../onchain/market/rwa/securitize/types.js";
 import { RawTx } from "../../onchain/types/transactions.js";
 import "../../onchain/index.js";
-import { LpSimulate, OpenStrategySimulate, StrategySimulate } from "../prepare/types.js";
+import { LpPrepare, OpenStrategyPrepare, StrategyPrepare } from "../prepare/types.js";
 import "../prepare/index.js";
 import { Address } from "viem";
 //#region src/sdk/execute/types.d.ts
 /**
  * A pool deposit, withdrawal or redemption, as
  * {@link IOpportunitiesPrepare.deposit} / {@link IOpportunitiesPrepare.withdraw}
- * / {@link IOpportunitiesPrepare.redeem} priced it. The simulation carries the
- * tokens on both sides and the zapper, so nothing else is needed to encode
+ * / {@link IOpportunitiesPrepare.redeem} priced it. The prepared state carries
+ * the tokens on both sides and the zapper, so nothing else is needed to encode
  * the call.
  **/
 interface PoolPrepareRequest {
@@ -21,13 +21,13 @@ interface PoolPrepareRequest {
   pool: Address;
   wallet: Address;
   op: "deposit" | "withdraw" | "redeem";
-  sim: Extract<LpSimulate, {
+  sim: Extract<LpPrepare, {
     ok: true;
   }>;
 }
 /**
  * Opening a new position, from a viable
- * {@link IOpportunitiesPrepare.openNewStrategy} result. The simulated state
+ * {@link IOpportunitiesPrepare.openNewStrategy} result. The prepared state
  * values collateral in underlying only, so the wallet's actual collateral
  * assets and the native value to attach come from the caller.
  **/
@@ -36,7 +36,7 @@ interface OpenPrepareRequest {
   chainId: ChainId;
   creditManager: Address;
   wallet: Address;
-  sim: Extract<OpenStrategySimulate, {
+  sim: Extract<OpenStrategyPrepare, {
     ok: true;
   }>;
   /** What leaves the wallet, token by token. */
@@ -56,20 +56,20 @@ interface OpenPrepareRequest {
 }
 /**
  * Any of the five operations on an existing account, from a viable
- * {@link StrategySimulate}: the facade multicall is the simulation's `calls`.
+ * {@link StrategyPrepare}: the facade multicall is the result's `calls`.
  **/
 interface AccountPrepareRequest {
   kind: "account";
   chainId: ChainId;
   creditAccount: Address;
   wallet: Address;
-  sim: Extract<StrategySimulate, {
+  sim: Extract<StrategyPrepare, {
     ok: true;
   }>;
 }
 /**
  * What {@link IOpportunitiesExecute.buildTx} turns into a transaction: a
- * `prepare` result plus the few facts about the wallet the simulation does not
+ * `prepare` result plus the few facts about the wallet the preparation does not
  * carry.
  **/
 type PrepareRequest = PoolPrepareRequest | OpenPrepareRequest | AccountPrepareRequest;
@@ -82,11 +82,11 @@ type PrepareRequest = PoolPrepareRequest | OpenPrepareRequest | AccountPrepareRe
 interface IOpportunitiesExecute {
   /**
    * The transaction to sign, from a `prepare` result. No second round of math:
-   * `account` requests submit the simulation's own multicall, `open` requests
-   * hand the state's router path and quotas to `openCA`, `pool` requests
-   * encode the deposit / redeem the simulation priced.
+   * `account` requests submit the result's own multicall, `open` requests hand
+   * the state's router path and quotas to `openCA`, `pool` requests encode the
+   * deposit / redeem the result priced.
    *
-   * @throws on a simulation that is not `ok`; when a `pool` request names a
+   * @throws on a `prepare` result that is not `ok`; when a `pool` request names a
    * route the pool has no metadata for, or one the pool does not accept a
    * transaction for (RWA on-demand deposits)
    **/

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

@@ -2,7 +2,7 @@ import { BorrowLimitBinding, IntentPreviewError, PreviewErrorDetails, PreviewErr
 import { LeverageBand } from "../onchain/accounts/intents/leverage-band.js";
 import { OperationState, PathLossRate } from "../onchain/accounts/intents/types.js";
 import { ILiquidations, ILiquidationsByMode } from "./liquidations/types.js";
-import { AddCollateralParams, AdjustLeverageParams, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
+import { AddCollateralParams, AdjustLeverageParams, DelayedStrategyPrepare, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpPrepare, LpRedeemParams, OpenStrategyParams, OpenStrategyPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
 import { ChainOf, PrepareApi } from "./prepare/PrepareApi.js";
 import "./prepare/index.js";
 import { AccountPrepareRequest, IOpportunitiesExecute, OpenPrepareRequest, PoolPrepareRequest, PrepareRequest } from "./execute/types.js";
@@ -34,4 +34,4 @@ import { SourceUnavailableError } from "./errors/SourceUnavailableError.js";
 import { assertSameChains } from "./errors/assertSameChains.js";
 import { everyChainFailed } from "./errors/everyChainFailed.js";
 import "./errors/index.js";
-export { AbstractNamespace, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, BorrowLimitBinding, ChainOf, ChainRef, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DelayedStrategySimulate, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, GearboxSDK, GearboxSDKOptions, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, IntentPreviewError, type LeverageBand, LiquidationsNamespace, type ListMerger, LpParams, LpRedeemParams, LpSimulate, type MergeListResult, MergedQuery, MissingSourceError, Mode, NamespaceOptions, NoSourceServedError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenPrepareRequest, OpenStrategyParams, OpenStrategySimulate, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewNamespace, PreviewRefusal, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, assertSameChains, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, raise, refuse };
+export { AbstractNamespace, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, BorrowLimitBinding, ChainOf, ChainRef, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DelayedStrategyPrepare, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, GearboxSDK, GearboxSDKOptions, IGearboxSDK, ILiquidations, ILiquidationsByMode, INotices, INoticesByMode, IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesExecute, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunitiesPrepare, IOpportunityMergers, IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, IPreview, IPreviewByMode, IntentPreviewError, type LeverageBand, LiquidationsNamespace, type ListMerger, LpParams, LpPrepare, LpRedeemParams, type MergeListResult, MergedQuery, MissingSourceError, Mode, NamespaceOptions, NoSourceServedError, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenPrepareRequest, OpenStrategyParams, OpenStrategyPrepare, type OperationState, OpportunitiesNamespace, type PathLossRate, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PositionInput, PositionsNamespace, PrepareApi, PrepareOptions, PrepareRequest, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewNamespace, PreviewRefusal, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams, assertSameChains, everyChainFailed, filterResponse, mergeChainList, mergeChainOne, raise, refuse };

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

@@ -72,7 +72,8 @@ interface IOpportunitiesOffchainOnly {
  **/
 interface IOpportunitiesOnchainOnly {
   /**
-   * Simulations of what a deposit, withdrawal or leverage change would do.
+   * What a deposit, withdrawal or leverage change would do, and the calldata
+   * that does it.
    *
    * Absent in `offchain` mode: every one of them reads live account and pool
    * state, and the strategy flows additionally need the pathfinder for real swap

package/dist/types/sdk/prepare/PrepareApi.d.ts

@@ -8,14 +8,14 @@ import { MultichainSDK } from "../../onchain/MultichainSDK.js";
 import { ChainQueryOneProps, MultichainConstruct } from "../../onchain/base/MultichainConstruct.js";
 import { LeverageBand } from "../../onchain/accounts/intents/leverage-band.js";
 import "../../onchain/index.js";
-import { AddCollateralParams, AdjustLeverageParams, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+import { AddCollateralParams, AdjustLeverageParams, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpPrepare, LpRedeemParams, OpenStrategyParams, OpenStrategyPrepare, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
 import { EnsureFreshChains } from "../types.js";
 import { Address } from "viem";
 //#region src/sdk/prepare/PrepareApi.d.ts
 /**
  * The chain's SDK, resolved on the spot.
  *
- * The LP simulations need it synchronously, because they only do arithmetic on
+ * The LP methods need it synchronously, because they only do arithmetic on
  * loaded state and have nothing to await; the execute namespace resolves its
  * chain the same way.
  **/
@@ -28,7 +28,7 @@ type ChainOf = (chainId: ChainId) => OnchainSDK;
  * protocol knowledge stays in `CreditAccountOperationsService` and
  * `PoolService`.
  *
- * A simulation names one chain, so it reads through
+ * A prepared operation names one chain, so it reads through
  * {@link MultichainConstruct.queryChain}: there is no second source to fall back
  * to, hence a chain the SDK does not cover, or one that fails the read, throws
  * rather than answering with empty metadata.
@@ -40,31 +40,31 @@ declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPr
   /**
    * {@inheritDoc IOpportunitiesPrepare.finalize}
    **/
-  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
+  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.deposit}
    **/
-  deposit(pool: PoolInput, params: LpParams): LpSimulate;
+  deposit(pool: PoolInput, params: LpParams): LpPrepare;
   /**
    * {@inheritDoc IOpportunitiesPrepare.withdraw}
    **/
-  withdraw(pool: PoolInput, params: LpParams): LpSimulate;
+  withdraw(pool: PoolInput, params: LpParams): LpPrepare;
   /**
    * {@inheritDoc IOpportunitiesPrepare.redeem}
    **/
-  redeem(pool: PoolInput, params: LpRedeemParams): LpSimulate;
+  redeem(pool: PoolInput, params: LpRedeemParams): LpPrepare;
   /**
    * {@inheritDoc IOpportunitiesPrepare.openNewStrategy}
    **/
-  openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategySimulate>>;
+  openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.depositStrategy}
    **/
-  depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategySimulate>>;
+  depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.withdrawStrategy}
    **/
-  withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesSimulate>>;
+  withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.maxWithdraw}
    **/
@@ -72,7 +72,7 @@ declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPr
   /**
    * {@inheritDoc IOpportunitiesPrepare.repayStrategy}
    **/
-  repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategySimulate>>;
+  repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.maxRepay}
    **/
@@ -80,15 +80,15 @@ declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPr
   /**
    * {@inheritDoc IOpportunitiesPrepare.adjustLeverage}
    **/
-  adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesSimulate>>;
+  adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.addCollateral}
    **/
-  addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategySimulate>>;
+  addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.withdrawCollateral}
    **/
-  withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategySimulate>>;
+  withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * {@inheritDoc IOpportunitiesPrepare.leverageBand}
    **/

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

@@ -1,6 +1,6 @@
 import { BorrowLimitBinding, IntentPreviewError, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, raise, refuse } from "../../onchain/validation/refusal.js";
 import { LeverageBand } from "../../onchain/accounts/intents/leverage-band.js";
 import { OperationState, PathLossRate } from "../../onchain/accounts/intents/types.js";
-import { AddCollateralParams, AdjustLeverageParams, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+import { AddCollateralParams, AdjustLeverageParams, DelayedStrategyPrepare, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, LpParams, LpPrepare, LpRedeemParams, OpenStrategyParams, OpenStrategyPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
 import { ChainOf, PrepareApi } from "./PrepareApi.js";
-export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, ChainOf, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, IntentPreviewError, type LeverageBand, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, type OperationState, type PathLossRate, PoolInput, PositionInput, PrepareApi, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };
+export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, ChainOf, DelayedStrategyPrepare, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, IntentPreviewError, type LeverageBand, LpParams, LpPrepare, LpRedeemParams, OpenStrategyParams, OpenStrategyPrepare, type OperationState, type PathLossRate, PoolInput, PositionInput, PrepareApi, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };

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

@@ -18,17 +18,17 @@ import { Address } from "viem";
 /**
  * What a pool deposit or withdrawal would yield.
  *
- * Shaped like {@link StrategySimulate} so both kinds of simulation are consumed
- * the same way, with the pool's own numbers as the state: the ERC-4626
+ * Shaped like {@link StrategyPrepare} so both kinds of result are consumed the
+ * same way, with the pool's own numbers as the state: the ERC-4626
  * conversion applied to the amount, at the rate of the block the market was
  * loaded at.
  **/
-type LpSimulate = {
+type LpPrepare = {
   ok: true;
   /**
    * Always empty: a pool operation is a single transaction, so there is no
-   * chain of steps to show. Present so callers can treat both simulations
-   * alike.
+   * chain of steps to show. Present so callers can treat both kinds of
+   * result alike.
    **/
   operations: [];
   /**
@@ -49,7 +49,7 @@ type LpSimulate = {
  * so the reason is a value rather than an exception: too much leverage, too
  * little of the source token, a token the flow does not accept.
  **/
-type StrategySimulate = {
+type StrategyPrepare = {
   ok: true;
   /**
    * The logical steps, each carrying the amounts it was computed from.
@@ -72,15 +72,15 @@ type StrategySimulate = {
  * What the leading half of a delayed operation would yield: the request
  * transaction, plus what it recorded for the tail and where that tail leads.
  *
- * Shaped like {@link StrategySimulate} with one field more, so the instant and
+ * Shaped like {@link StrategyPrepare} with one field more, so the instant and
  * the delayed route of the same request are compared side by side — and they
  * are meant to be compared on the same footing, so `state` is the end of the
  * operation in both, not the end of the transaction.
  **/
-type DelayedStrategySimulate = {
+type DelayedStrategyPrepare = {
   ok: true;
   /**
-   * {@inheritDoc StrategySimulate.operations}
+   * {@inheritDoc StrategyPrepare.operations}
    **/
   operations: AccountCalculatorOperation[];
   /**
@@ -95,7 +95,7 @@ type DelayedStrategySimulate = {
    **/
   state: OperationState;
   /**
-   * {@inheritDoc StrategySimulate.calls}
+   * {@inheritDoc StrategyPrepare.calls}
    **/
   calls: MultiCall[];
   /**
@@ -116,13 +116,13 @@ type DelayedStrategySimulate = {
  * with its refusal in `refused`, which is what lets a form offer exactly the
  * routes that exist; `ok: false` means neither does.
  **/
-type StrategyRoutesSimulate = {
+type StrategyRoutesPrepare = {
   ok: true;
   /**
    * The router route: one transaction, settled on the spot. `undefined`
    * when the asset cannot be sold, see `refused.instant`.
    **/
-  instant: Extract<StrategySimulate, {
+  instant: Extract<StrategyPrepare, {
     ok: true;
   }> | undefined;
   /**
@@ -131,7 +131,7 @@ type StrategyRoutesSimulate = {
    * `undefined` when the route does not exist — no redemption venue for the
    * asset, or a request that settles at once anyway — see `refused.delayed`.
    **/
-  delayed: Extract<DelayedStrategySimulate, {
+  delayed: Extract<DelayedStrategyPrepare, {
     ok: true;
   }> | undefined;
   /**
@@ -145,17 +145,17 @@ type StrategyRoutesSimulate = {
  **/
 (PreviewRefusal & {
   /**
-   * {@inheritDoc StrategyRoutesSimulate.refused}
+   * {@inheritDoc StrategyRoutesPrepare.refused}
    **/
   refused: RouteRefusals;
 });
 /**
  * What opening a new leveraged position would yield.
  *
- * The only simulation that reports both an expected and a floor branch: opening
+ * The only result that reports both an expected and a floor branch: opening
  * takes both from a single pathfinder call, and `openCA` consumes both.
  **/
-type OpenStrategySimulate = {
+type OpenStrategyPrepare = {
   ok: true;
   state: OpenStrategyState;
 } | PreviewRefusal;
@@ -167,17 +167,17 @@ interface PrepareOptions {
   slippage?: number;
   /**
    * Extra quota headroom in PERCENTAGE_FORMAT, to survive price drift between
-   * the simulation and execution.
+   * the preparation and execution.
    **/
   quotaReserve?: number;
 }
 /**
- * Position to simulate against. A `StrategyPosition` from
+ * Position to prepare against. A `StrategyPosition` from
  * `sdk.positions.list()` satisfies this, as does a bare key.
  **/
 type PositionInput = StrategyPositionKey;
 /**
- * Pool to simulate against. A `PoolOpportunity` from
+ * Pool to prepare against. A `PoolOpportunity` from
  * `sdk.opportunities.list()` satisfies this, as does a bare key.
  **/
 type PoolInput = PoolOpportunityKey;
@@ -303,8 +303,8 @@ interface LpParams {
   tokenIn?: Address;
   /**
    * Token the user receives. Defaults to the only route available for `tokenIn`;
-   * required when the pool offers several, otherwise the simulation reports
-   * `unsupportedTokenPair`.
+   * required when the pool offers several, otherwise the preparation is refused
+   * with `unsupportedTokenPair`.
    **/
   tokenOut?: Address;
 }
@@ -337,23 +337,23 @@ interface FinalizeParams extends PrepareOptions {
   intent?: ResumableIntent;
 }
 /**
- * Simulations of everything a wallet can do to a pool or a credit account.
+ * Everything a wallet can do to a pool or a credit account, prepared.
  *
  * On-chain only: every method reads live state and, for strategies, asks the
  * pathfinder for real swap paths. Nothing is executed and nothing is signed —
  * the result is the numbers plus the calldata that would produce them.
  *
- * Not to be confused with `src/preview/simulate`, which goes the other way: it
- * takes calldata that already exists and reports what it would do.
+ * Not to be confused with `src/preview`, which goes the other way: it takes
+ * calldata that already exists and reports what it would do.
  **/
 interface IOpportunitiesPrepare {
   /**
    * Depositing into a pool: underlying in, shares out.
    *
-   * Synchronous, unlike every strategy simulation below: the answer is the
-   * pool's share rate applied to the amount, and that rate is already loaded.
+   * Synchronous, unlike every strategy method below: the answer is the pool's
+   * share rate applied to the amount, and that rate is already loaded.
    **/
-  deposit(pool: PoolInput, params: LpParams): LpSimulate;
+  deposit(pool: PoolInput, params: LpParams): LpPrepare;
   /**
    * Taking underlying out of a pool: `amount` is the `tokenOut` the wallet
    * wants back, and the pool burns whatever shares that costs.
@@ -361,26 +361,26 @@ interface IOpportunitiesPrepare {
    * The LP counterpart of {@link withdrawStrategy} / {@link withdrawCollateral},
    * which act on credit accounts.
    **/
-  withdraw(pool: PoolInput, params: LpParams): LpSimulate;
+  withdraw(pool: PoolInput, params: LpParams): LpPrepare;
   /**
    * Redeeming pool shares: `amount` is the `tokenIn` the wallet parts with,
    * and the reported state is the underlying it converts to.
    **/
-  redeem(pool: PoolInput, params: LpRedeemParams): LpSimulate;
+  redeem(pool: PoolInput, params: LpRedeemParams): LpPrepare;
   /**
    * Opening a leveraged position from wallet collateral.
    *
    * The one flow with no account yet, so the result carries no operation list —
    * it feeds `sdk.accounts.openCA` instead.
    **/
-  openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategySimulate>>;
+  openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategyPrepare>>;
   /**
    * Growing a position: collateral in, debt drawn on top, both converted into
    * the position token.
    *
    * Leverage stays put unless `targetLeverage` asks for more.
    **/
-  depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategySimulate>>;
+  depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * Shrinking a position: part of its net value goes to the wallet and debt is
    * repaid in the same proportion, so leverage is unchanged.
@@ -388,7 +388,7 @@ interface IOpportunitiesPrepare {
    * Answers with both routes the withdrawal can take — sold through the router
    * now, or redeemed through the source's issuer and finished days later — since
    * the source token decides which of them exist, see
-   * {@link StrategyRoutesSimulate}.
+   * {@link StrategyRoutesPrepare}.
    *
    * `MAX_UINT256` — or any amount at or above the account's net value — is an
    * exit instead: the quotas are dropped, the position is sold whole in one
@@ -406,7 +406,7 @@ interface IOpportunitiesPrepare {
    * @see withdrawCollateral to move an asset out without touching debt, which
    * raises leverage instead.
    **/
-  withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesSimulate>>;
+  withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesPrepare>>;
   /**
    * Largest partial withdrawal {@link withdrawStrategy} accepts, in underlying
    * units: the amount whose proportional repayment leaves the debt at the
@@ -429,12 +429,12 @@ interface IOpportunitiesPrepare {
    * A repayment that covers the whole debt clears the account's quotas with it,
    * which the facade requires of a loan going to zero, and asks for the full
    * outstanding amount, so nothing is left owing because interest moved between
-   * this simulation and the transaction. `MAX_UINT256` is how to ask for that
+   * this preparation and the transaction. `MAX_UINT256` is how to ask for that
    * settlement without naming a figure: the wallet is charged the debt plus a
    * 10bps margin for the interest still to come, and whatever the facade does
    * not take stays on the account.
    **/
-  repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategySimulate>>;
+  repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * Debt {@link repayStrategy} would have to cover to clear the account, in
    * underlying units: principal, interest and fees as of this read. Interest
@@ -449,12 +449,12 @@ interface IOpportunitiesPrepare {
    * buys instead, so there the delayed route is always absent with
    * `refused.delayed: "noDelayedRoute"`.
    **/
-  adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesSimulate>>;
+  adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesPrepare>>;
   /**
    * Putting the position token onto the account at fixed debt, which lowers
    * leverage and raises the health factor.
    **/
-  addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategySimulate>>;
+  addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * Moving one asset that already sits on the account out to the wallet, at
    * fixed debt — so TVL falls and leverage rises.
@@ -462,7 +462,7 @@ interface IOpportunitiesPrepare {
    * @see withdrawStrategy for the deleveraging withdrawal, which repays debt in
    * proportion and leaves leverage unchanged.
    **/
-  withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategySimulate>>;
+  withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategyPrepare>>;
   /**
    * The leverages a deposit of a given size can reach in this market: the
    * range a leverage slider should mark as available.
@@ -499,7 +499,7 @@ interface IOpportunitiesPrepare {
    * Synchronous, like {@link leverageBand}: it reads loaded token metadata and
    * the position it was handed, so a form can ask on every render. Nothing is
    * quoted here — which of these the router can sell is a different question,
-   * and the answer to it is a simulation.
+   * and the answer to it is a prepared operation.
    **/
   withdrawableCollaterals(position: StrategyPosition): PositionCollateral[];
   /**
@@ -531,7 +531,7 @@ interface IOpportunitiesPrepare {
    * Answers like the instant flows, so both halves are consumed the same way.
    * Reports `noRecordedIntent` when the claim names no operation to resume.
    **/
-  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
+  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategyPrepare>>;
 }
 //#endregion
-export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, IntentPreviewError, type LeverageBand, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, type OperationState, type PathLossRate, PoolInput, PositionInput, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };
+export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, DelayedStrategyPrepare, DepositStrategyParams, FinalizeParams, IOpportunitiesPrepare, IntentPreviewError, type LeverageBand, LpParams, LpPrepare, LpRedeemParams, OpenStrategyParams, OpenStrategyPrepare, type OperationState, type PathLossRate, PoolInput, PositionInput, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyPrepare, StrategyRoutesPrepare, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };

package/package.json

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