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

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.32",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {

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

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

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

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