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

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

@@ -11,7 +11,7 @@ import { DelayedStart, OperationState, PreviewErrorReason, ResumableIntent, Rout
 import { AccountCalculatorOperation } from "../../sdk/accounts/intents/operations.js";
 import "../../sdk/index.js";
 import { Address } from "viem";
-//#region src/new-sdk/simulate/types.d.ts
+//#region src/new-sdk/prepare/types.d.ts
 /**
  * What a pool deposit or withdrawal would yield.
  *
@@ -105,8 +105,8 @@ type DelayedStrategySimulate = {
 };
 /**
  * What one of the two flows that sell a position asset —
- * {@link OpportunitiesSimulate.withdrawStrategy} and
- * {@link OpportunitiesSimulate.adjustLeverage} — would yield each way it can be
+ * {@link OpportunitiesPrepare.withdrawStrategy} and
+ * {@link OpportunitiesPrepare.adjustLeverage} — would yield each way it can be
  * served.
  *
  * Whether the account can sell that asset on the router, redeem it through its
@@ -126,9 +126,9 @@ type StrategyRoutesSimulate = {
   }> | undefined;
   /**
    * The request half of the redemption route, which
-   * {@link DelayedSimulate.finish} completes once it matures. `undefined`
-   * when the route does not exist — no redemption venue for the asset, or a
-   * request that settles at once anyway — see `refused.delayed`.
+   * {@link OpportunitiesPrepare.finalize} completes once it matures.
+   * `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, {
     ok: true;
@@ -165,7 +165,7 @@ type OpenStrategySimulate = {
 /**
  * Shared knobs. Both default to the SDK's own defaults when omitted.
  **/
-interface SimulateOptions {
+interface PrepareOptions {
   /** Router slippage in PERCENTAGE_FORMAT (100% = 10_000). */
   slippage?: number;
   /**
@@ -189,7 +189,7 @@ type PoolInput = PoolOpportunityKey;
  * `sdk.opportunities.list()` satisfies this, as does a bare key.
  **/
 type StrategyInput = StrategyOpportunityKey;
-interface DepositStrategyParams extends SimulateOptions {
+interface DepositStrategyParams extends PrepareOptions {
   /**
    * Collateral to add: the market underlying, or its unwrapped asset on an RWA
    * market (USDC rather than dcUSDC).
@@ -209,11 +209,11 @@ interface DepositStrategyParams extends SimulateOptions {
    **/
   targetLeverage?: bigint;
 }
-interface WithdrawStrategyParams extends SimulateOptions {
+interface WithdrawStrategyParams extends PrepareOptions {
   /**
    * Amount the wallet receives, denominated in `tokenOut`. `MAX_UINT256`, or
    * anything at or above the account's net value, turns the flow into an exit,
-   * see {@link OpportunitiesSimulate.withdrawStrategy}.
+   * see {@link OpportunitiesPrepare.withdrawStrategy}.
    **/
   amount: bigint;
   /** Wallet receiving the payout. */
@@ -229,7 +229,7 @@ interface WithdrawStrategyParams extends SimulateOptions {
    **/
   sourceToken?: Address;
 }
-interface RepayStrategyParams extends SimulateOptions {
+interface RepayStrategyParams extends PrepareOptions {
   /**
    * Funding token: the market underlying, which needs no conversion and is
    * repaid where it lands, or — on an RWA market — the unwrapped asset behind
@@ -240,14 +240,14 @@ interface RepayStrategyParams extends SimulateOptions {
    * Amount taken from the wallet. Anything above the outstanding debt settles
    * it in full and stays on the account as collateral, so a caller clearing the
    * account can add a buffer for the interest that accrues before the
-   * transaction lands, see {@link OpportunitiesSimulate.maxRepay}.
+   * transaction lands, see {@link OpportunitiesPrepare.maxRepay}.
    * `MAX_UINT256` settles the debt and sizes that buffer itself.
    **/
   amount: bigint;
   /** Native value to attach when paying a wrapped-native market in the coin. */
   value?: bigint;
 }
-interface AdjustLeverageParams extends SimulateOptions {
+interface AdjustLeverageParams extends PrepareOptions {
   /**
    * Target total leverage scaled by `LEVERAGE_DECIMALS` (300n = 3x); 100n means
    * no debt.
@@ -259,21 +259,21 @@ interface AdjustLeverageParams extends SimulateOptions {
    **/
   token?: Address;
 }
-interface AddCollateralParams extends SimulateOptions {
+interface AddCollateralParams extends PrepareOptions {
   /** Position token to deposit; nothing else is accepted. */
   token: Address;
   amount: bigint;
   /** Native value to attach when paying a wrapped-native market in the coin. */
   value?: bigint;
 }
-interface WithdrawCollateralParams extends SimulateOptions {
+interface WithdrawCollateralParams extends PrepareOptions {
   /** Token to move out; must already sit on the account. */
   token: Address;
   amount: bigint;
   /** Wallet receiving the tokens. */
   to: Address;
 }
-interface OpenStrategyParams extends SimulateOptions {
+interface OpenStrategyParams extends PrepareOptions {
   /** Collateral coming from the wallet, in their own tokens. */
   collateral: Asset[];
   /**
@@ -312,7 +312,7 @@ interface LpParams {
   tokenOut?: Address;
 }
 /**
- * Same shape as {@link LpParams}, but {@link OpportunitiesSimulate.redeem}
+ * Same shape as {@link LpParams}, but {@link OpportunitiesPrepare.redeem}
  * treats `amount` as the pool shares to burn rather than the underlying to
  * receive.
  **/
@@ -326,7 +326,7 @@ interface LpRedeemParams {
   tokenIn?: Address;
   tokenOut?: Address;
 }
-interface FinishDelayedParams extends SimulateOptions {
+interface FinalizeParams extends PrepareOptions {
   /**
    * The matured withdrawal to claim, from
    * `sdk.onchain.chain(chainId).withdrawalCompressor.getCurrentWithdrawals()`.
@@ -339,44 +339,6 @@ interface FinishDelayedParams extends SimulateOptions {
    **/
   intent?: ResumableIntent;
 }
-/**
- * The delayed route of the two operations that can take it: a source that only
- * redeems through its issuer — a Securitize dsToken, a Mellow share — instead of
- * through the router.
- *
- * Two transactions rather than one: the request, then the tail once the
- * redemption matures, which is days later. In between, nothing has to be kept on
- * the client — the request writes the operation into the withdrawal's
- * `extraData`, and reading the claimable decodes it back.
- **/
-interface DelayedSimulate {
-  /**
-   * The delayed counterpart of {@link OpportunitiesSimulate.withdrawStrategy},
-   * on its own: that flow already quotes this route alongside the instant one,
-   * so reach for this when the delayed route is the only one of interest.
-   *
-   * Reports `noDelayedRoute` when the account has no redemption venue for the
-   * source at all.
-   **/
-  withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<DelayedStrategySimulate>>;
-  /**
-   * The delayed counterpart of {@link OpportunitiesSimulate.adjustLeverage} on
-   * its own, which only deleveraging reaches: raising leverage buys the position
-   * token and never redeems it. That flow already quotes this route alongside
-   * the instant one, so reach for this when it is the only one of interest.
-   **/
-  adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<DelayedStrategySimulate>>;
-  /**
-   * The tail: claim the matured withdrawal, then whatever the recorded
-   * operation still owes — repaying debt and paying the wallet out for a
-   * withdrawal, repaying alone for a deleveraging, nothing beyond the claim for
-   * the rest.
-   *
-   * Answers like the instant flows, so both halves are consumed the same way.
-   * Reports `noRecordedIntent` when the claim names no operation to resume.
-   **/
-  finish(position: PositionInput, params: FinishDelayedParams): Promise<DataResponse<StrategySimulate>>;
-}
 /**
  * Simulations of everything a wallet can do to a pool or a credit account.
  *
@@ -387,7 +349,7 @@ interface DelayedSimulate {
  * 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.
  **/
-interface OpportunitiesSimulate {
+interface OpportunitiesPrepare {
   /**
    * Depositing into a pool: underlying in, shares out.
    *
@@ -499,10 +461,22 @@ interface OpportunitiesSimulate {
    **/
   withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * The same requests routed through a delayed redemption instead of the
-   * router, and the tail that finishes them, see {@link DelayedSimulate}.
+   * The tail of a delayed route: claim the matured withdrawal, then whatever the
+   * operation that requested it still owes — repaying debt and paying the wallet
+   * out for a withdrawal, repaying alone for a deleveraging, nothing beyond the
+   * claim for the rest.
+   *
+   * The route is requested by {@link withdrawStrategy} or
+   * {@link adjustLeverage}, whose `delayed` branch is the transaction that
+   * starts it; days later the redemption matures and this finishes it. Nothing
+   * has to be kept on the client in between: the request writes the operation
+   * into the withdrawal's `extraData`, and reading the claimable decodes it
+   * back.
+   *
+   * Answers like the instant flows, so both halves are consumed the same way.
+   * Reports `noRecordedIntent` when the claim names no operation to resume.
    **/
-  readonly delayed: DelayedSimulate;
+  finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
 }
 //#endregion
-export { AddCollateralParams, AdjustLeverageParams, DelayedSimulate, DelayedStrategySimulate, DepositStrategyParams, FinishDelayedParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesSimulate, PoolInput, PositionInput, RepayStrategyParams, SimulateOptions, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams };
+export { AddCollateralParams, AdjustLeverageParams, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams };

package/dist/types/sdk/accounts/intents/testing/sdk-mock.d.ts

@@ -105,7 +105,7 @@ interface BuildMockSdkArgs {
   delayed?: Record<Address, MockDelayedVenue[]>;
   /**
    * Accounts `accounts.getCreditAccountData` knows, keyed by address. What the
-   * simulate layer reads on its own instead of taking a slice from the caller;
+   * prepare layer reads on its own instead of taking a slice from the caller;
    * `accountDebt` lands as the principal with no interest or fees accrued.
    */
   creditAccounts?: CreditAccountSlice[];

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

@@ -40,7 +40,7 @@ interface OperationState extends PositionMetrics {
  *
  * Every member is thrown by the engine as an {@link IntentPreviewError}, with
  * the exception of `unsupportedTokenPair` and `noRecordedIntent`, which the
- * simulate namespace reports for a request it can refuse before planning: a
+ * prepare namespace reports for a request it can refuse before planning: a
  * route the market does not offer, a claim naming no operation.
  */
 type PreviewErrorReason = "debtOutOfRange" | "leverageOutOfRange" | "insufficientSourceBalance" |
@@ -98,8 +98,8 @@ type IntentPreviewResult = {
 interface DelayedStart {
   /**
    * The intent written into the request, and decoded back from the claimable
-   * withdrawal at claim time. Feed it to
-   * `CreditAccountOperationsService.finishIntent`.
+   * withdrawal at claim time. `prepare.finalize` picks it up from there, and
+   * `CreditAccountOperationsService.finishIntent` is what it feeds.
    */
   record: DelayedIntent;
   /** Unix seconds after which the delayed outputs can be claimed. */
@@ -172,16 +172,16 @@ type IntentRoutesResult = {
  * The intents the engine previews.
  *
  * Naming avoids the `withdrawCollateral` collision that exists elsewhere in the
- * repo. Mapping to the public simulate API:
+ * repo. Mapping to the public prepare API:
  *
- * | Intent type        | Public name                | Debt    |
- * | ------------------ | -------------------------- | ------- |
- * | `ADD_COLLATERAL`   | `simulate.addCollateral`    | fixed   |
- * | `WITHDRAW_ASSET`   | `simulate.withdrawCollateral` | fixed |
- * | `ADJUST_LEVERAGE`  | `simulate.adjustLeverage`   | changes |
- * | `DEPOSIT`          | `simulate.depositStrategy`  | grows   |
- * | `WITHDRAW`         | `simulate.withdrawStrategy` | shrinks |
- * | `REPAY`            | `simulate.repayStrategy`    | shrinks |
+ * | Intent type        | Public name                  | Debt    |
+ * | ------------------ | ---------------------------- | ------- |
+ * | `ADD_COLLATERAL`   | `prepare.addCollateral`      | fixed   |
+ * | `WITHDRAW_ASSET`   | `prepare.withdrawCollateral` | fixed   |
+ * | `ADJUST_LEVERAGE`  | `prepare.adjustLeverage`     | changes |
+ * | `DEPOSIT`          | `prepare.depositStrategy`    | grows   |
+ * | `WITHDRAW`         | `prepare.withdrawStrategy`   | shrinks |
+ * | `REPAY`            | `prepare.repayStrategy`      | shrinks |
  */
 /** Shared inputs for every start intent. */
 type StartIntentProps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "15.1.0-next.11",
+  "version": "15.1.0-next.13",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

package/dist/cjs/dev/compareOpportunities.js

@@ -1,137 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_model_opportunities = require("../model/opportunities.js");
-require("../model/index.js");
-const require_dev_fieldDiff = require("./fieldDiff.js");
-//#region src/dev/compareOpportunities.ts
-/**
-* Matches two opportunity listings by {@link opportunityId} and reports every
-* field the two sources disagree on.
-*
-* Nothing is filtered out. A field only the backend can fill, or a USD value
-* that drifted within snapshot-lag noise, is still reported — tagged
-* {@link FieldDiff.expected} so that {@link CompareCounts.clean} can ignore it
-* while {@link CompareCounts.identical} stays strict.
-**/
-function compareOpportunities(input) {
-	const onchainRows = indexById(input.onchain.data);
-	const offchainRows = indexById(input.offchain.data);
-	const onlyOnchain = [];
-	const onlyOffchain = [];
-	const matched = [];
-	for (const [id, row] of onchainRows) {
-		const counterpart = offchainRows.get(id);
-		if (!counterpart) {
-			onlyOnchain.push(toRef(row));
-			continue;
-		}
-		const diffs = diffOpportunity(row, counterpart);
-		matched.push({
-			id,
-			kind: row.kind,
-			chainId: row.chainId,
-			onchainName: row.name,
-			offchainName: counterpart.name,
-			identical: diffs.length === 0,
-			clean: diffs.every((diff) => diff.expected),
-			diffs
-		});
-	}
-	for (const [id, row] of offchainRows) if (!onchainRows.has(id)) onlyOffchain.push(toRef(row));
-	byId(onlyOnchain);
-	byId(onlyOffchain);
-	matched.sort((a, b) => a.id.localeCompare(b.id));
-	return {
-		generatedAt: input.generatedAt ?? (/* @__PURE__ */ new Date()).toISOString(),
-		backendUrl: input.backendUrl,
-		networks: [...input.networks],
-		onchainChains: input.onchain.meta.chains,
-		offchainChains: input.offchain.meta.chains,
-		summary: summarize(input.onchain.data, input.offchain.data, onlyOnchain, onlyOffchain, matched),
-		onlyOnchain,
-		onlyOffchain,
-		matched
-	};
-}
-function indexById(rows) {
-	return new Map(rows.map((row) => [require_model_opportunities.opportunityId(row), row]));
-}
-function byId(refs) {
-	refs.sort((a, b) => a.id.localeCompare(b.id));
-}
-function toRef(row) {
-	const base = {
-		id: require_model_opportunities.opportunityId(row),
-		kind: row.kind,
-		chainId: row.chainId,
-		name: row.name
-	};
-	return row.kind === "pool" ? {
-		...base,
-		pool: row.pool
-	} : {
-		...base,
-		creditManager: row.creditManager,
-		targetCollateral: row.targetCollateral.address
-	};
-}
-/**
-* Every field two versions of one opportunity disagree on.
-**/
-function diffOpportunity(onchain, offchain) {
-	return require_dev_fieldDiff.diffObjects(onchain, offchain).map((diff) => tagDiff(diff, onchain.kind));
-}
-/**
-* Paths whose values are basis-point rates that routinely differ by ±1 from
-* truncation vs rounding, plus pool `utilization` for the same reason.
-**/
-const BPS_RATE_PATHS = /* @__PURE__ */ new Set([
-	"borrowApy",
-	"supplyApy.organicApy",
-	"additionalBorrowApy",
-	"utilization"
-]);
-/**
-* Amount fields whose bigint `value` moves with expected-liquidity accrual
-* between the backend's last sync and the current block. Strategy
-* `totalBorrow.value` and `maxBorrowAmount.value` are not in this set: those
-* disagreements are formula bugs, not lag.
-**/
-const LAG_AMOUNT_PATHS = /* @__PURE__ */ new Set(["totalSupply.value", "availableLiquidity.value"]);
-/**
-* Fields documented `@mode offchain` in the model: the chain has nothing to
-* put there, so a presence (or nested) mismatch is expected. Strategy
-* `utilization` is in this set; pool `utilization` is not.
-**/
-function isModeScoped(path, kind) {
-	if (path === "curator.url") return true;
-	if (path === "totalApy" || path.endsWith(".totalApy")) return true;
-	if (path === "rewards" || path.startsWith("rewards[") || path.includes(".rewards[") || path.endsWith(".rewards")) return true;
-	if (kind !== "strategy") return false;
-	return path === "utilization" || path === "collateralApy" || path.startsWith("collateralApy.") || path === "maxLeverageApy" || path.startsWith("maxLeverageApy.") || path === "totalValue" || path.startsWith("totalValue.");
-}
-function tagDiff(diff, kind) {
-	if (isModeScoped(diff.path, kind)) return require_dev_fieldDiff.withExpected(diff, "mode-scoped");
-	if (withinTolerance(diff)) return require_dev_fieldDiff.withExpected(diff, "tolerance");
-	return diff;
-}
-function withinTolerance(diff) {
-	if (diff.kind === "usd") return require_dev_fieldDiff.isUsdWithinTolerance(diff.onchain, diff.offchain);
-	if (diff.kind !== "numeric") return false;
-	if (BPS_RATE_PATHS.has(diff.path)) return require_dev_fieldDiff.isBpsWithinTolerance(diff.onchain, diff.offchain);
-	if (LAG_AMOUNT_PATHS.has(diff.path)) return require_dev_fieldDiff.isAmountWithinTolerance(diff.onchain, diff.offchain);
-	return false;
-}
-function summarize(onchain, offchain, onlyOnchain, onlyOffchain, matched) {
-	const byChain = require_dev_fieldDiff.union(onchain.map((row) => String(row.chainId)), offchain.map((row) => String(row.chainId))).map((chainId) => ({
-		chainId: Number(chainId),
-		...require_dev_fieldDiff.toCompareCounts(onchain.filter((row) => String(row.chainId) === chainId).length, offchain.filter((row) => String(row.chainId) === chainId).length, onlyOnchain.filter((ref) => String(ref.chainId) === chainId).length, onlyOffchain.filter((ref) => String(ref.chainId) === chainId).length, matched.filter((match) => String(match.chainId) === chainId))
-	})).sort((a, b) => a.chainId - b.chainId);
-	return {
-		...require_dev_fieldDiff.toCompareCounts(onchain.length, offchain.length, onlyOnchain.length, onlyOffchain.length, matched),
-		byChain,
-		diffsByPath: require_dev_fieldDiff.countPaths(matched.flatMap((match) => match.diffs))
-	};
-}
-//#endregion
-exports.compareOpportunities = compareOpportunities;
-exports.diffOpportunity = diffOpportunity;

package/dist/cjs/new-sdk/simulate/index.js

@@ -1,4 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_new_sdk_simulate_SimulateApi = require("./SimulateApi.js");
-require("./types.js");
-exports.SimulateApi = require_new_sdk_simulate_SimulateApi.SimulateApi;

package/dist/esm/new-sdk/simulate/index.js

@@ -1,3 +0,0 @@
-import { SimulateApi } from "./SimulateApi.js";
-import "./types.js";
-export { SimulateApi };

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

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