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

package/dist/types/dev/{fieldDiff.d.ts → mode-parity/fieldDiff.d.ts}

@@ -1,6 +1,6 @@
-import { ChainId } from "../model/primitives.js";
-import "../model/index.js";
-//#region src/dev/fieldDiff.d.ts
+import { ChainId } from "../../model/primitives.js";
+import "../../model/index.js";
+//#region src/dev/mode-parity/fieldDiff.d.ts
 /**
  * What kind of disagreement a {@link FieldDiff} describes, so that a reader can
  * bucket the report without re-deriving it from the values.
@@ -45,6 +45,33 @@ interface FieldDiff {
   expected?: true;
   reason?: ExpectedDiffReason;
 }
+/**
+ * The largest numeric disagreement seen for one collapsed field path, on
+ * either the unexpected or the expected side.
+ **/
+interface WorstDiff {
+  /**
+   * Entity id (position/opportunity id) with the biggest relative difference.
+   **/
+  id: string;
+  /**
+   * Uncollapsed path, so the exact array element is named.
+   **/
+  path: string;
+  /**
+   * Relative difference in bps.
+   **/
+  bps: number;
+  onchain: unknown;
+  offchain: unknown;
+}
+/**
+ * One field disagreement together with the matched row it belongs to.
+ **/
+interface EntityFieldDiff {
+  id: string;
+  diff: FieldDiff;
+}
 /**
  * How often one field disagreed across all matched rows, with array keys
  * collapsed, e.g. `collateralTokens[].symbol`.
@@ -55,6 +82,15 @@ interface DiffPathCount {
   count: number;
   expected: number;
   unexpected: number;
+  /**
+   * Largest unexpected numeric disagreement, when any unexpected diff of this
+   * path yields a relative bps value.
+   **/
+  worstUnexpected?: WorstDiff;
+  /**
+   * Largest expected numeric disagreement, see {@link worstUnexpected}.
+   **/
+  worstExpected?: WorstDiff;
 }
 /**
  * Counts of one chain, one wallet, or of the whole report when those ids are
@@ -127,7 +163,7 @@ declare function withExpected(diff: FieldDiff, reason: ExpectedDiffReason): Fiel
  * field of a hundred collateral tokens counts as one path. Sorted so the
  * unexpected disagreements come first.
  **/
-declare function countPaths(diffs: Iterable<FieldDiff>): DiffPathCount[];
+declare function countPaths(diffs: Iterable<EntityFieldDiff>): DiffPathCount[];
 /**
  * Collapse `collateralTokens[0xa0b8...].symbol` to `collateralTokens[].symbol`.
  **/
@@ -161,7 +197,13 @@ declare function withinRelative(onchain: number | undefined, offchain: number |
  **/
 declare function withinRelativeBigint(onchain: bigint, offchain: bigint, epsilon: number): boolean;
 declare function asFiniteNumber(value: unknown): number | undefined;
+/**
+ * Relative difference of two numbers or bigints, in bps:
+ * `|a − b| / max(|a|, |b|) * 10_000`. `undefined` when the values are not
+ * a comparable pair of finite numbers or of bigints.
+ **/
+declare function relativeDiffBps(onchain: unknown, offchain: unknown): number | undefined;
 declare function union(left: string[], right: string[]): string[];
 declare function isRecord(value: unknown): value is Record<string, unknown>;
 //#endregion
-export { AMOUNT_RELATIVE_EPSILON, ArrayElementKey, BPS_ABSOLUTE_EPSILON, ChainCompareCounts, CompareCounts, DiffKind, DiffOptions, DiffPathCount, ExpectedDiffReason, FieldDiff, USD_RELATIVE_EPSILON, asFiniteNumber, collapseArrayKeys, countPaths, diffObjects, diffValue, isAmountWithinTolerance, isBpsWithinTolerance, isRecord, isUsdWithinTolerance, toCompareCounts, union, withExpected, withinRelative, withinRelativeBigint };
+export { AMOUNT_RELATIVE_EPSILON, ArrayElementKey, BPS_ABSOLUTE_EPSILON, ChainCompareCounts, CompareCounts, DiffKind, DiffOptions, DiffPathCount, EntityFieldDiff, ExpectedDiffReason, FieldDiff, USD_RELATIVE_EPSILON, WorstDiff, asFiniteNumber, collapseArrayKeys, countPaths, diffObjects, diffValue, isAmountWithinTolerance, isBpsWithinTolerance, isRecord, isUsdWithinTolerance, relativeDiffBps, toCompareCounts, union, withExpected, withinRelative, withinRelativeBigint };

package/dist/types/dev/mode-parity/scriptUtils.d.ts

@@ -0,0 +1,47 @@
+import { ChainMetadata } from "../../model/response.js";
+import "../../model/index.js";
+import { ChainCompareCounts, CompareCounts, DiffPathCount } from "./fieldDiff.js";
+import { Logger } from "pino";
+//#region src/dev/mode-parity/scriptUtils.d.ts
+/**
+ * Chains the compare scripts attach to.
+ **/
+type ComparedNetwork = "Mainnet" | "Monad" | "Plasma" | "Somnia" | "Etherlink";
+declare const NETWORKS: ComparedNetwork[];
+declare const BACKEND_URL: string;
+declare const TIMEOUT = 480000;
+/**
+ * Totals both compare reports print.
+ **/
+interface PrintableCompareSummary extends CompareCounts {
+  byChain: ChainCompareCounts[];
+  diffsByPath: DiffPathCount[];
+}
+/**
+ * Per-source chain metadata both compare reports carry.
+ **/
+interface PrintableCompareReport {
+  backendUrl: string;
+  summary: PrintableCompareSummary;
+  onchainChains: ChainMetadata[];
+  offchainChains: ChainMetadata[];
+}
+declare function requireEnv(name: string): string;
+declare function rpcUrls(): Record<ComparedNetwork, string>;
+declare function createLogger(): Logger;
+declare function errorMessage(error: unknown): string;
+/**
+ * Runs `fn` over `items` with at most `concurrency` in flight.
+ **/
+declare function mapPool<T>(items: readonly T[], concurrency: number, fn: (item: T) => Promise<void>): Promise<void>;
+/**
+ * Formats a relative difference in bps as a percent, e.g. 12.5 → `"0.125%"`.
+ **/
+declare function formatBpsAsPercent(bps: number): string;
+/**
+ * Prints the shared membership table, the fields that differed most often,
+ * and any chain that failed to answer.
+ **/
+declare function printCompareSummary(noun: string, report: PrintableCompareReport, extraLines?: string[]): void;
+//#endregion
+export { BACKEND_URL, ComparedNetwork, NETWORKS, PrintableCompareReport, PrintableCompareSummary, TIMEOUT, createLogger, errorMessage, formatBpsAsPercent, mapPool, printCompareSummary, requireEnv, rpcUrls };

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

@@ -0,0 +1,47 @@
+import { z } from "zod/v4";
+//#region src/model/compare.schema.d.ts
+/**
+ * How close two numeric values may be before a disagreement counts as real.
+ *
+ * The compare scripts pick a formula from this union; the schemas only name
+ * which formula a field uses.
+ *
+ * - `"amount"` — accrual lag on an {@link Amount.value} / {@link TokenAmount.value}.
+ * - `"bps"` — truncation vs rounding on a basis-point rate, ±1.
+ * - `"float"` — relative float drift within 0.1% (leverage).
+ * - `"usd"` — price-derived {@link Amount.valueUsd} / {@link TokenAmount.valueUsd}.
+ **/
+type CompareTolerance = "amount" | "bps" | "float" | "usd";
+/**
+ * A numeric field whose two sources may drift within {@link tolerance}.
+ **/
+interface ToleranceCompareTag {
+  tolerance: CompareTolerance;
+}
+/**
+ * Compare metadata a schema field may carry.
+ *
+ * - `"offchainOnly"` / `"onchainOnly"` — the other source typically leaves
+ *   the field empty, so a disagreement is expected.
+ * - {@link ToleranceCompareTag} — a numeric disagreement within the named
+ *   formula is expected snapshot noise.
+ **/
+type CompareTag = "offchainOnly" | "onchainOnly" | ToleranceCompareTag;
+/**
+ * Marks a field that only the backend fills.
+ **/
+declare function offchainOnly<S extends z.ZodType>(schema: S): S;
+/**
+ * Marks a field that only the chain fills.
+ **/
+declare function onchainOnly<S extends z.ZodType>(schema: S): S;
+/**
+ * Marks a numeric field whose two sources may drift within {@link kind}.
+ **/
+declare function tolerance<S extends z.ZodType>(schema: S, kind: CompareTolerance): S;
+/**
+ * The compare tag registered on a schema, if any.
+ **/
+declare function compareTagOf(schema: z.ZodType): CompareTag | undefined;
+//#endregion
+export { CompareTag, CompareTolerance, ToleranceCompareTag, compareTagOf, offchainOnly, onchainOnly, tolerance };

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

@@ -2,6 +2,7 @@ import { Amount, AssetType, Bps, ChainId, Leverage, Timestamp, Token, TokenAmoun
 import { Curator, CuratorName } from "./curators.js";
 import { CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, GridSampling, OpportunityChartMetric, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PoolOpportunityChartMetric, PoolPositionChartMetric, PositionChartMetric, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunityChartMetric, StrategyPositionChartMetric } from "./charts.js";
 import { chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, poolOpportunityChartMetricSchema, poolPositionChartMetricSchema, strategyOpportunityChartMetricSchema, strategyPositionChartMetricSchema } from "./charts.schema.js";
+import { CompareTag, CompareTolerance, ToleranceCompareTag, compareTagOf, offchainOnly, onchainOnly, tolerance } from "./compare.schema.js";
 import { curatorNameSchema, curatorSchema } from "./curators.schema.js";
 import { ChainScopedFilter, FILTER_ALL, FilterAll, Filterable, isFilterSet } from "./filters.js";
 import { booleanParamSchema, encodeFlag, filterAllSchema, filterable } from "./filters.schema.js";
@@ -16,4 +17,4 @@ import { borrowRateBreakdownSchema, pnlBreakdownSchema, pointsProgramPnLSchema,
 import { amountSchema, assetTypeSchema, bpsSchema, chainIdSchema, leverageSchema, timestampSchema, tokenAmountSchema, tokenSchema, txCallSchema } from "./primitives.schema.js";
 import { ChainFailed, ChainMetadata, ChainScoped, ChainSucceeded, DataResponse, DataSource, ResponseMetadata } from "./response.js";
 import { chainFailedSchema, chainMetadataSchema, chainSucceededSchema, dataSourceSchema, responseMetadataSchema, responseSchema } from "./response.schema.js";
-export { Amount, ApyBreakdown, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, Curator, CuratorName, DataResponse, DataSource, DelayedReceivedAsset, FILTER_ALL, FilterAll, Filterable, GridSampling, InstantReceivedAsset, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Notice, NoticeKind, NoticeSubject, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionRef, Position, PositionChartMetric, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionMetrics, PositionTransaction, PositionTransactionKind, PositionsTotals, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, ResponseMetadata, Rewards, RewardsPnL, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenRewards, TokenRewardsPnL, TxCall, amountSchema, apyBreakdownSchema, assetTypeSchema, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, txCallSchema };
+export { Amount, ApyBreakdown, AssetType, BorrowRateBreakdown, Bps, CHART_METRIC_UNITS, CHART_RANGES, CHART_UNAVAILABLE_CODES, ChainFailed, ChainId, ChainMetadata, ChainScoped, ChainScopedFilter, ChainSucceeded, ChartBundle, ChartDenomination, ChartMetric, ChartQuery, ChartRange, ChartSeries, ChartSeriesOk, ChartSeriesUnavailable, ChartUnavailableCode, ChartUnit, ChartValue, ChartWindow, CompareTag, CompareTolerance, Curator, CuratorName, DataResponse, DataSource, DelayedReceivedAsset, FILTER_ALL, FilterAll, Filterable, GridSampling, InstantReceivedAsset, Leverage, LiquidatableAccount, LiquidatableAccountFilter, LiquidationApproval, LiquidationDetails, LiquidationPosition, Notice, NoticeKind, NoticeSubject, Opportunity, OpportunityBase, OpportunityChartMetric, OpportunityDetail, OpportunityFilter, OpportunityId, OpportunityKey, OpportunityKind, POOL_OPPORTUNITY_CHART_METRICS, POOL_POSITION_CHART_METRICS, PnlBreakdown, PointRewards, PointsProgram, PointsProgramPnL, PointsRewardsPnL, PoolOpportunity, PoolOpportunityChartMetric, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, PoolPosition, PoolPositionChartMetric, PoolPositionKey, PoolPositionRef, Position, PositionChartMetric, PositionCollateral, PositionFilter, PositionId, PositionKey, PositionKind, PositionMetrics, PositionTransaction, PositionTransactionKind, PositionsTotals, PriceFeedData, PriceFeedSummary, QuotaAsset, RateCurve, RateCurvePoint, ReceivedAsset, ResponseMetadata, Rewards, RewardsPnL, STRATEGY_OPPORTUNITY_CHART_METRICS, STRATEGY_POSITION_CHART_METRICS, StrategyOpportunity, StrategyOpportunityChartMetric, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef, StrategyPosition, StrategyPositionChartMetric, StrategyPositionKey, StrategyPositionRef, Timestamp, Token, TokenAmount, TokenRewards, TokenRewardsPnL, ToleranceCompareTag, TxCall, amountSchema, apyBreakdownSchema, assetTypeSchema, booleanParamSchema, borrowRateBreakdownSchema, bpsSchema, chainFailedSchema, chainIdSchema, chainMetadataSchema, chainSucceededSchema, chartBundleSchemaFor, chartDenominationSchema, chartMetricSchema, chartQueryCodec, chartQueryParamsSchema, chartQuerySchema, chartRangeSchema, chartSeriesSchema, chartValueSchema, chartWindowSchema, compareTagOf, curatorNameSchema, curatorSchema, dataSourceSchema, delayedReceivedAssetSchema, encodeFlag, filterAllSchema, filterable, instantReceivedAssetSchema, isFilterSet, leverageSchema, liquidatableAccountFilterSchema, liquidatableAccountSchema, liquidationApprovalSchema, liquidationDetailsSchema, liquidationPositionId, liquidationPositionSchema, matchesLiquidatableAccountFilter, matchesOpportunityFilter, matchesPositionFilter, noticeKindSchema, noticeSchema, offchainOnly, onchainOnly, opportunityBaseSchema, opportunityDetailSchema, opportunityFilterQueryParamsSchema, opportunityFilterQuerySchema, opportunityFilterSchema, opportunityId, opportunityKeySchema, opportunityKindSchema, opportunitySchema, pnlBreakdownSchema, pointRewardsSchema, pointsProgramPnLSchema, pointsProgramSchema, pointsRewardsPnLSchema, poolOpportunityChartMetricSchema, poolOpportunityDetailSchema, poolOpportunityId, poolOpportunityKeySchema, poolOpportunitySchema, poolPositionChartMetricSchema, poolPositionId, poolPositionKeySchema, poolPositionSchema, positionCollateralSchema, positionFilterQueryParamsSchema, positionFilterQuerySchema, positionFilterSchema, positionId, positionKeySchema, positionKindSchema, positionSchema, positionTransactionKindSchema, positionTransactionSchema, positionsTotalsSchema, priceFeedDataSchema, priceFeedSummarySchema, quotaAssetSchema, rateCurvePointSchema, rateCurveSchema, receivedAssetSchema, responseMetadataSchema, responseSchema, rewardsPnLSchema, rewardsSchema, strategyOpportunityChartMetricSchema, strategyOpportunityDetailSchema, strategyOpportunityId, strategyOpportunityKeySchema, strategyOpportunitySchema, strategyPositionChartMetricSchema, strategyPositionId, strategyPositionKeySchema, strategyPositionSchema, timestampSchema, tokenAmountSchema, tokenRewardsPnLSchema, tokenRewardsSchema, tokenSchema, tolerance, txCallSchema };

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

@@ -4,15 +4,15 @@ import "../../model/index.js";
 import { SecuritizeRegisterMessage } from "../../sdk/market/rwa/securitize/types.js";
 import { RawTx } from "../../sdk/types/transactions.js";
 import "../../sdk/index.js";
-import { LpSimulate, OpenStrategySimulate, StrategySimulate } from "../simulate/types.js";
-import { ChainOf } from "../simulate/SimulateApi.js";
-import "../simulate/index.js";
+import { LpSimulate, OpenStrategySimulate, StrategySimulate } from "../prepare/types.js";
+import { ChainOf } from "../prepare/PrepareApi.js";
+import "../prepare/index.js";
 import { Address } from "viem";
 //#region src/new-sdk/execute/ExecuteApi.d.ts
 /**
  * A pool deposit, withdrawal or redemption, as
- * {@link OpportunitiesSimulate.deposit} / {@link OpportunitiesSimulate.withdraw}
- * / {@link OpportunitiesSimulate.redeem} priced it. The simulation carries the
+ * {@link OpportunitiesPrepare.deposit} / {@link OpportunitiesPrepare.withdraw}
+ * / {@link OpportunitiesPrepare.redeem} priced it. The simulation carries the
  * tokens on both sides and the zapper, so nothing else is needed to encode
  * the call.
  **/
@@ -28,7 +28,7 @@ interface PoolPrepareRequest {
 }
 /**
  * Opening a new position, from a viable
- * {@link OpportunitiesSimulate.openNewStrategy} result. The preview values
+ * {@link OpportunitiesPrepare.openNewStrategy} result. The preview values
  * collateral in underlying only, so the wallet's actual collateral assets and
  * the native value to attach come from the caller.
  **/
@@ -70,19 +70,19 @@ interface AccountPrepareRequest {
 }
 /**
  * What {@link OpportunitiesExecute.buildTx} turns into a transaction: a
- * simulate result plus the few facts about the wallet the simulation does not
+ * `prepare` result plus the few facts about the wallet the simulation does not
  * carry.
  **/
 type PrepareRequest = PoolPrepareRequest | OpenPrepareRequest | AccountPrepareRequest;
 /**
- * The write side of the opportunities namespace: turns what `simulate`
+ * The write side of the opportunities namespace: turns what `prepare`
  * answered into the transaction to sign. Sending, and whatever the wallet has
  * to do first (allowances, permits, RWA signatures), stays with the caller —
  * `checkPrerequisites` reports the former on the built transaction.
  **/
 interface OpportunitiesExecute {
   /**
-   * The transaction to sign, from a simulate result. No second round of math:
+   * 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 preview's router path and quotas to `openCA`, `pool` requests
    * encode the deposit / redeem the simulation priced.

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

@@ -4,9 +4,9 @@ import { filterResponse } from "./utils/filterResponse.js";
 import { DEFAULT_MAX_OFFCHAIN_LAG, mergeChainList, mergeChainOne } from "./utils/mergeChains.js";
 import "./utils/index.js";
 import { AbstractNamespace, MergedQuery } from "./AbstractNamespace.js";
-import { AddCollateralParams, AdjustLeverageParams, DelayedSimulate, DelayedStrategySimulate, DepositStrategyParams, FinishDelayedParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesSimulate, PoolInput, PositionInput, RepayStrategyParams, SimulateOptions, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./simulate/types.js";
-import { ChainOf, SimulateApi } from "./simulate/SimulateApi.js";
-import "./simulate/index.js";
+import { AddCollateralParams, AdjustLeverageParams, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./prepare/types.js";
+import { ChainOf, PrepareApi } from "./prepare/PrepareApi.js";
+import "./prepare/index.js";
 import { AccountPrepareRequest, ExecuteApi, OpenPrepareRequest, OpportunitiesExecute, PoolPrepareRequest, PrepareRequest } from "./execute/ExecuteApi.js";
 import "./execute/index.js";
 import { Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesMerged, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunityMergers } from "./opportunities/types.js";
@@ -24,4 +24,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, ChainOf, ChainRef, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DelayedSimulate, DelayedStrategySimulate, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinishDelayedParams, GearboxSDK, GearboxSDKOptions, type ListMerger, LpParams, LpRedeemParams, LpSimulate, type MergeListResult, MergedQuery, MissingSourceError, Mode, NamespaceOptions, NoSourceServedError, NoticesByMode, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenPrepareRequest, OpenStrategyParams, OpenStrategySimulate, Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesExecute, OpportunitiesMerged, OpportunitiesNamespace, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunitiesSimulate, OpportunityMergers, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PositionInput, PositionMergers, Positions, PositionsBase, PositionsByMode, PositionsMerged, PositionsNamespace, PositionsOffchainBranch, PositionsOffchainOnly, PositionsOnchainBranch, PositionsOnchainOnly, PrepareRequest, RepayStrategyParams, SimulateApi, SimulateOptions, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, assertSameChains, everyChainFailed, filterResponse, mergeChainList, mergeChainOne };
+export { AbstractNamespace, AccountPrepareRequest, AddCollateralParams, AdjustLeverageParams, AllSourcesFailedError, ChainOf, ChainRef, DEFAULT_MAX_OFFCHAIN_LAG, DEFAULT_MAX_STATE_AGE, DelayedStrategySimulate, DepositStrategyParams, EnsureFreshChains, type EntityMerger, ExecuteApi, type FilterResult, FinalizeParams, GearboxSDK, GearboxSDKOptions, type ListMerger, LpParams, LpRedeemParams, LpSimulate, type MergeListResult, MergedQuery, MissingSourceError, Mode, NamespaceOptions, NoSourceServedError, NoticesByMode, OffchainByMode, OffchainSource, OnchainByMode, OnchainSource, OpenPrepareRequest, OpenStrategyParams, OpenStrategySimulate, Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesExecute, OpportunitiesMerged, OpportunitiesNamespace, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunitiesPrepare, OpportunityMergers, PlainMultichainSDKOptions, PoolInput, PoolPrepareRequest, PositionInput, PositionMergers, Positions, PositionsBase, PositionsByMode, PositionsMerged, PositionsNamespace, PositionsOffchainBranch, PositionsOffchainOnly, PositionsOnchainBranch, PositionsOnchainOnly, PrepareApi, PrepareOptions, PrepareRequest, RepayStrategyParams, SourceChainMismatchError, SourceUnavailableError, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, assertSameChains, everyChainFailed, filterResponse, mergeChainList, mergeChainOne };

package/dist/types/new-sdk/opportunities/OpportunitiesNamespace.d.ts

@@ -10,8 +10,8 @@ import { NamespaceOptions } from "../types.js";
 import { FilterResult } from "../utils/types.js";
 import "../utils/index.js";
 import { AbstractNamespace } from "../AbstractNamespace.js";
-import { OpportunitiesSimulate } from "../simulate/types.js";
-import "../simulate/index.js";
+import { OpportunitiesPrepare } from "../prepare/types.js";
+import "../prepare/index.js";
 import { OpportunitiesExecute } from "../execute/ExecuteApi.js";
 import "../execute/index.js";
 import { OpportunitiesBase, OpportunitiesOffchainOnly, OpportunitiesOnchainOnly, OpportunityMergers } from "./types.js";
@@ -28,9 +28,9 @@ declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["op
   readonly merge: OpportunityMergers;
   constructor(onchain: MultichainSDK | undefined, offchain: GearboxAPI | undefined, options: NamespaceOptions);
   /**
-   * {@inheritDoc OpportunitiesOnchainOnly.simulate}
+   * {@inheritDoc OpportunitiesOnchainOnly.prepare}
    **/
-  get simulate(): OpportunitiesSimulate;
+  get prepare(): OpportunitiesPrepare;
   /**
    * {@inheritDoc OpportunitiesOnchainOnly.execute}
    **/

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

@@ -9,8 +9,8 @@ import "../../offchain/index.js";
 import { Mode } from "../types.js";
 import { EntityMerger, FilterResult, ListMerger } from "../utils/types.js";
 import "../utils/index.js";
-import { OpportunitiesSimulate } from "../simulate/types.js";
-import "../simulate/index.js";
+import { OpportunitiesPrepare } from "../prepare/types.js";
+import "../prepare/index.js";
 import { OpportunitiesExecute } from "../execute/ExecuteApi.js";
 import "../execute/index.js";
 //#region src/new-sdk/opportunities/types.d.ts
@@ -80,11 +80,11 @@ interface OpportunitiesOnchainOnly {
    * state, and the strategy flows additionally need the pathfinder for real swap
    * paths, so there is nothing the backend could answer with.
    **/
-  readonly simulate: OpportunitiesSimulate;
+  readonly prepare: OpportunitiesPrepare;
   /**
-   * The transaction a simulate result stands for, see
+   * The transaction a prepared operation stands for, see
    * {@link OpportunitiesExecute.buildTx}. Absent in `offchain` mode for the
-   * same reason as {@link simulate}: it encodes against live chain state.
+   * same reason as {@link prepare}: it encodes against live chain state.
    **/
   execute: OpportunitiesExecute;
 }

package/dist/types/new-sdk/{simulate/SimulateApi.d.ts → prepare/PrepareApi.d.ts}

@@ -6,8 +6,8 @@ import { MultichainSDK } from "../../sdk/MultichainSDK.js";
 import { ChainQueryOneProps, MultichainConstruct } from "../../sdk/base/MultichainConstruct.js";
 import "../../sdk/index.js";
 import { EnsureFreshChains } from "../types.js";
-import { AddCollateralParams, AdjustLeverageParams, DelayedSimulate, DepositStrategyParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesSimulate, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
-//#region src/new-sdk/simulate/SimulateApi.d.ts
+import { AddCollateralParams, AdjustLeverageParams, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+//#region src/new-sdk/prepare/PrepareApi.d.ts
 /**
  * The chain's SDK, resolved on the spot.
  *
@@ -17,7 +17,7 @@ import { AddCollateralParams, AdjustLeverageParams, DelayedSimulate, DepositStra
  **/
 type ChainOf = (chainId: ChainId) => OnchainSDK;
 /**
- * {@inheritDoc OpportunitiesSimulate}
+ * {@inheritDoc OpportunitiesPrepare}
  *
  * Holds no state of its own: it owns the mapping from the public,
  * read-model-shaped request to the engine's intent, and nothing else. All
@@ -29,62 +29,62 @@ type ChainOf = (chainId: ChainId) => OnchainSDK;
  * to, hence a chain the SDK does not cover, or one that fails the read, throws
  * rather than answering with empty metadata.
  **/
-declare class SimulateApi extends MultichainConstruct implements OpportunitiesSimulate {
+declare class PrepareApi extends MultichainConstruct implements OpportunitiesPrepare {
   #private;
   constructor(sdk: MultichainSDK, ensureFresh?: EnsureFreshChains);
   protected queryChain<T>(props: ChainQueryOneProps<T>): Promise<DataResponse<T>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.delayed}
+   * {@inheritDoc OpportunitiesPrepare.finalize}
    **/
-  readonly delayed: DelayedSimulate;
+  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.deposit}
+   * {@inheritDoc OpportunitiesPrepare.deposit}
    **/
   deposit(pool: PoolInput, params: LpParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesSimulate.withdraw}
+   * {@inheritDoc OpportunitiesPrepare.withdraw}
    **/
   withdraw(pool: PoolInput, params: LpParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesSimulate.redeem}
+   * {@inheritDoc OpportunitiesPrepare.redeem}
    **/
   redeem(pool: PoolInput, params: LpRedeemParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesSimulate.openNewStrategy}
+   * {@inheritDoc OpportunitiesPrepare.openNewStrategy}
    **/
   openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.depositStrategy}
+   * {@inheritDoc OpportunitiesPrepare.depositStrategy}
    **/
   depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.withdrawStrategy}
+   * {@inheritDoc OpportunitiesPrepare.withdrawStrategy}
    **/
   withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesSimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.maxWithdraw}
+   * {@inheritDoc OpportunitiesPrepare.maxWithdraw}
    **/
   maxWithdraw(position: PositionInput): Promise<DataResponse<bigint>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.repayStrategy}
+   * {@inheritDoc OpportunitiesPrepare.repayStrategy}
    **/
   repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.maxRepay}
+   * {@inheritDoc OpportunitiesPrepare.maxRepay}
    **/
   maxRepay(position: PositionInput): Promise<DataResponse<bigint>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.adjustLeverage}
+   * {@inheritDoc OpportunitiesPrepare.adjustLeverage}
    **/
   adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesSimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.addCollateral}
+   * {@inheritDoc OpportunitiesPrepare.addCollateral}
    **/
   addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesSimulate.withdrawCollateral}
+   * {@inheritDoc OpportunitiesPrepare.withdrawCollateral}
    **/
   withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategySimulate>>;
 }
 //#endregion
-export { ChainOf, SimulateApi };
+export { ChainOf, PrepareApi };

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

@@ -0,0 +1,3 @@
+import { AddCollateralParams, AdjustLeverageParams, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
+import { ChainOf, PrepareApi } from "./PrepareApi.js";
+export { AddCollateralParams, AdjustLeverageParams, ChainOf, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, PrepareApi, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams };