@gearbox-protocol/sdk 16.0.0-next.20 → 16.0.0-next.21

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

@@ -9,7 +9,7 @@ import "../../onchain/index.js";
  * On-chain discovery of liquidatable credit accounts and delayed-withdrawal
  * positions a liquidator wallet holds.
  **/
-interface Liquidations {
+interface ILiquidations {
   /**
    * All liquidatable credit accounts: health factor below 1 plus accounts of
    * expired credit managers with outstanding debt. Optionally narrowed.
@@ -34,13 +34,11 @@ interface Liquidations {
 /**
  * `sdk.liquidations` per mode: an on-chain read, absent when the SDK reads no
  * chain.
- *
- * @internal
  **/
-interface LiquidationsByMode {
-  onchain: Liquidations;
+interface ILiquidationsByMode {
+  onchain: ILiquidations;
   offchain: undefined;
-  both: Liquidations;
+  both: ILiquidations;
 }
 //#endregion
-export { Liquidations, LiquidationsByMode };
+export { ILiquidations, ILiquidationsByMode };

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

@@ -6,57 +6,57 @@ import { MultichainSDK } from "../../onchain/MultichainSDK.js";
 import "../../onchain/index.js";
 import { GearboxAPI } from "../../offchain/GearboxAPI.js";
 import "../../offchain/index.js";
-import { NamespaceOptions } from "../types.js";
+import { IOpportunitiesPrepare } from "../prepare/types.js";
+import "../prepare/index.js";
+import { IOpportunitiesExecute } from "../execute/types.js";
+import "../execute/index.js";
 import { FilterResult } from "../utils/types.js";
 import "../utils/index.js";
+import { IOpportunitiesBase, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers } from "./types.js";
+import { NamespaceOptions } from "../types.js";
 import { AbstractNamespace } from "../AbstractNamespace.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";
 //#region src/sdk/opportunities/OpportunitiesNamespace.d.ts
 /**
  * The `opportunities` namespace of a {@link GearboxSDK}, see
- * {@link OpportunitiesByMode} for what each mode offers.
+ * {@link IOpportunitiesByMode} for what each mode offers.
  **/
-declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["opportunities"], GearboxAPI["opportunities"]> implements OpportunitiesBase, OpportunitiesOffchainOnly, OpportunitiesOnchainOnly {
+declare class OpportunitiesNamespace extends AbstractNamespace<MultichainSDK["opportunities"], GearboxAPI["opportunities"]> implements IOpportunitiesBase, IOpportunitiesOffchainOnly, IOpportunitiesOnchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOffchainBranch {
   #private;
   /**
-   * {@inheritDoc OpportunitiesBase.merge}
+   * {@inheritDoc IOpportunitiesBase.merge}
    **/
-  readonly merge: OpportunityMergers;
+  readonly merge: IOpportunityMergers;
   constructor(onchain: MultichainSDK | undefined, offchain: GearboxAPI | undefined, options: NamespaceOptions);
   /**
-   * {@inheritDoc OpportunitiesOnchainOnly.prepare}
+   * {@inheritDoc IOpportunitiesOnchainOnly.prepare}
    **/
-  get prepare(): OpportunitiesPrepare;
+  get prepare(): IOpportunitiesPrepare;
   /**
-   * {@inheritDoc OpportunitiesOnchainOnly.execute}
+   * {@inheritDoc IOpportunitiesOnchainOnly.execute}
    **/
-  get execute(): OpportunitiesExecute;
+  get execute(): IOpportunitiesExecute;
   /**
-   * {@inheritDoc OpportunitiesBase.list}
+   * {@inheritDoc IOpportunitiesBase.list}
    **/
   list(filter?: OpportunityFilter): Promise<DataResponse<Opportunity[]>>;
   /**
-   * {@inheritDoc OpportunitiesBase.getPool}
+   * {@inheritDoc IOpportunitiesBase.getPool}
    **/
   getPool(key: PoolOpportunityKey): Promise<DataResponse<PoolOpportunityDetail>>;
   /**
-   * {@inheritDoc OpportunitiesBase.getStrategy}
+   * {@inheritDoc IOpportunitiesBase.getStrategy}
    **/
   getStrategy(key: StrategyOpportunityKey): Promise<DataResponse<StrategyOpportunityDetail>>;
   /**
-   * {@inheritDoc OpportunitiesBase.filter}
+   * {@inheritDoc IOpportunitiesBase.filter}
    **/
   filter<R extends DataResponse<Opportunity[]> | undefined>(response: R, filter?: OpportunityFilter): FilterResult<R, Opportunity>;
   /**
-   * {@inheritDoc OpportunitiesOffchainOnly.totals}
+   * {@inheritDoc IOpportunitiesOffchainOnly.totals}
    **/
   totals(): Promise<DataResponse<OpportunityTotals>>;
   /**
-   * {@inheritDoc OpportunitiesOffchainOnly.charts}
+   * {@inheritDoc IOpportunitiesOffchainOnly.charts}
    **/
   charts<const Metrics extends readonly PoolOpportunityChartMetric[]>(key: PoolOpportunityRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
   charts<const Metrics extends readonly StrategyOpportunityChartMetric[]>(key: StrategyOpportunityRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;

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

@@ -1,3 +1,3 @@
-import { Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunityMergers } from "./types.js";
+import { IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers } from "./types.js";
 import { OpportunitiesNamespace } from "./OpportunitiesNamespace.js";
-export { Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesNamespace, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunityMergers };
+export { IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers, OpportunitiesNamespace };

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

@@ -2,26 +2,26 @@ import { ChartBundle, ChartRange, PoolOpportunityChartMetric, StrategyOpportunit
 import { Opportunity, OpportunityFilter, OpportunityTotals, PoolOpportunityDetail, PoolOpportunityKey, PoolOpportunityRef, StrategyOpportunityDetail, StrategyOpportunityKey, StrategyOpportunityRef } from "../../model/opportunities.js";
 import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
-import { MultichainOpportunitiesService } from "../../onchain/opportunities/MultichainOpportunitiesService.js";
+import { IMultichainOpportunitiesService } from "../../onchain/opportunities/types.js";
 import "../../onchain/index.js";
-import { OffchainOpportunities } from "../../offchain/opportunities/OffchainOpportunities.js";
+import { IOffchainOpportunities } from "../../offchain/opportunities/types.js";
 import "../../offchain/index.js";
-import { Mode } from "../types.js";
-import { EntityMerger, FilterResult, ListMerger } from "../utils/types.js";
-import "../utils/index.js";
-import { OpportunitiesPrepare } from "../prepare/types.js";
+import { IOpportunitiesPrepare } from "../prepare/types.js";
 import "../prepare/index.js";
-import { OpportunitiesExecute } from "../execute/ExecuteApi.js";
+import { IOpportunitiesExecute } from "../execute/types.js";
 import "../execute/index.js";
+import { EntityMerger, FilterResult, ListMerger } from "../utils/types.js";
+import "../utils/index.js";
+import { Mode } from "../types.js";
 //#region src/sdk/opportunities/types.d.ts
 /**
  * What the `opportunities` namespace offers in every mode.
  **/
-interface OpportunitiesBase {
+interface IOpportunitiesBase {
   /**
    * All pool and strategy opportunities, optionally narrowed. In `both` mode
    * each chain is served by whichever source is fresh enough, see
-   * {@link OpportunityMergers}.
+   * {@link IOpportunityMergers}.
    **/
   list(filter?: OpportunityFilter): Promise<DataResponse<Opportunity[]>>;
   /**
@@ -38,26 +38,16 @@ interface OpportunitiesBase {
    * narrows to a list.
    **/
   filter<R extends DataResponse<Opportunity[]> | undefined>(response: R, filter?: OpportunityFilter): FilterResult<R, Opportunity>;
-  /**
-   * The chain on its own, for a consumer that shows each source as it arrives.
-   * Throws in `offchain` mode.
-   **/
-  readonly onchain: MultichainOpportunitiesService;
-  /**
-   * The backend on its own, see {@link OpportunitiesBase.onchain}. Throws in
-   * `onchain` mode.
-   **/
-  readonly offchain: OffchainOpportunities;
   /**
    * Merge policy of each read, for a consumer combining the two branches
-   * itself, see {@link OpportunityMergers}.
+   * itself, see {@link IOpportunityMergers}.
    **/
-  readonly merge: OpportunityMergers;
+  readonly merge: IOpportunityMergers;
 }
 /**
  * Reads only a backend can answer.
  **/
-interface OpportunitiesOffchainOnly {
+interface IOpportunitiesOffchainOnly {
   /**
    * Protocol-wide totals across every opportunity: the TVL, total borrowed and
    * total supplied the landing page shows.
@@ -80,7 +70,7 @@ interface OpportunitiesOffchainOnly {
 /**
  * Reads only the chain can answer.
  **/
-interface OpportunitiesOnchainOnly {
+interface IOpportunitiesOnchainOnly {
   /**
    * Simulations of what a deposit, withdrawal or leverage change would do.
    *
@@ -88,32 +78,33 @@ 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 prepare: OpportunitiesPrepare;
+  readonly prepare: IOpportunitiesPrepare;
   /**
    * The transaction a prepared operation stands for, see
-   * {@link OpportunitiesExecute.buildTx}. Absent in `offchain` mode for the
+   * {@link IOpportunitiesExecute.buildTx}. Absent in `offchain` mode for the
    * same reason as {@link prepare}: it encodes against live chain state.
    **/
-  readonly execute: OpportunitiesExecute;
+  readonly execute: IOpportunitiesExecute;
 }
 /**
- * Which reads the `opportunities` namespace has in each mode. A widened mode
- * offers what every mode has, i.e. {@link OpportunitiesBase} alone.
+ * The chain on its own, for a consumer that shows each source as it arrives.
+ * Absent in `offchain` mode.
  **/
-interface OpportunitiesOnchainBranch {
-  readonly onchain: MultichainOpportunitiesService;
+interface IOpportunitiesOnchainBranch {
+  readonly onchain: IMultichainOpportunitiesService;
 }
 /**
- * The backend on its own, see {@link OpportunitiesOnchainBranch}.
+ * The backend on its own, see {@link IOpportunitiesOnchainBranch}. Absent in
+ * `onchain` mode.
  **/
-interface OpportunitiesOffchainBranch {
-  readonly offchain: OffchainOpportunities;
+interface IOpportunitiesOffchainBranch {
+  readonly offchain: IOffchainOpportunities;
 }
 /**
  * Merge policy of each read, exposed so that a consumer reading the two
  * branches itself combines them exactly as `both` mode would.
  **/
-interface OpportunityMergers {
+interface IOpportunityMergers {
   list: ListMerger<Opportunity[]>;
   pool: EntityMerger<PoolOpportunityDetail>;
   strategy: EntityMerger<StrategyOpportunityDetail>;
@@ -121,14 +112,14 @@ interface OpportunityMergers {
 /**
  * Which methods the `opportunities` namespace has in each mode.
  **/
-interface OpportunitiesByMode {
-  onchain: OpportunitiesBase & OpportunitiesOnchainOnly & OpportunitiesOnchainBranch;
-  offchain: OpportunitiesBase & OpportunitiesOffchainOnly & OpportunitiesOffchainBranch;
-  both: OpportunitiesBase & OpportunitiesOnchainOnly & OpportunitiesOffchainOnly;
+interface IOpportunitiesByMode {
+  onchain: IOpportunitiesBase & IOpportunitiesOnchainOnly & IOpportunitiesOnchainBranch;
+  offchain: IOpportunitiesBase & IOpportunitiesOffchainOnly & IOpportunitiesOffchainBranch;
+  both: IOpportunitiesBase & IOpportunitiesOnchainOnly & IOpportunitiesOffchainOnly & IOpportunitiesOnchainBranch & IOpportunitiesOffchainBranch;
 }
 /**
  * The `opportunities` namespace of a {@link GearboxSDK} in mode `M`.
  **/
-type Opportunities<M extends Mode = Mode> = OpportunitiesByMode[M];
+type IOpportunities<M extends Mode = Mode> = IOpportunitiesByMode[M];
 //#endregion
-export { Opportunities, OpportunitiesBase, OpportunitiesByMode, OpportunitiesOffchainBranch, OpportunitiesOffchainOnly, OpportunitiesOnchainBranch, OpportunitiesOnchainOnly, OpportunityMergers };
+export { IOpportunities, IOpportunitiesBase, IOpportunitiesByMode, IOpportunitiesOffchainBranch, IOpportunitiesOffchainOnly, IOpportunitiesOnchainBranch, IOpportunitiesOnchainOnly, IOpportunityMergers };

package/dist/types/sdk/positions/PositionsNamespace.d.ts

@@ -6,37 +6,37 @@ import { MultichainSDK } from "../../onchain/MultichainSDK.js";
 import "../../onchain/index.js";
 import { GearboxAPI } from "../../offchain/GearboxAPI.js";
 import "../../offchain/index.js";
-import { NamespaceOptions } from "../types.js";
 import { FilterResult } from "../utils/types.js";
 import "../utils/index.js";
+import { IPositionMergers, IPositionsBase, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch } from "./types.js";
+import { NamespaceOptions } from "../types.js";
 import { AbstractNamespace } from "../AbstractNamespace.js";
-import { PositionMergers, PositionsBase, PositionsOffchainOnly } from "./types.js";
 import { Address } from "viem";
 //#region src/sdk/positions/PositionsNamespace.d.ts
 /**
  * The `positions` namespace of a {@link GearboxSDK}, see
- * {@link PositionsByMode} for what each mode offers.
+ * {@link IPositionsByMode} for what each mode offers.
  **/
-declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements PositionsBase, PositionsOffchainOnly {
+declare class PositionsNamespace extends AbstractNamespace<MultichainSDK["positions"], GearboxAPI["positions"]> implements IPositionsBase, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOffchainBranch {
   /**
-   * {@inheritDoc PositionsBase.merge}
+   * {@inheritDoc IPositionsBase.merge}
    **/
-  readonly merge: PositionMergers;
+  readonly merge: IPositionMergers;
   constructor(onchain: MultichainSDK | undefined, offchain: GearboxAPI | undefined, options: NamespaceOptions);
   /**
-   * {@inheritDoc PositionsBase.list}
+   * {@inheritDoc IPositionsBase.list}
    **/
   list(wallet: Address, filter?: PositionFilter): Promise<DataResponse<Position[]>>;
   /**
-   * {@inheritDoc PositionsBase.filter}
+   * {@inheritDoc IPositionsBase.filter}
    **/
   filter<R extends DataResponse<Position[]> | undefined>(response: R, filter?: PositionFilter): FilterResult<R, Position>;
   /**
-   * {@inheritDoc PositionsOffchainOnly.totals}
+   * {@inheritDoc IPositionsOffchainOnly.totals}
    **/
   totals(wallet: Address): Promise<DataResponse<PositionsTotals>>;
   /**
-   * {@inheritDoc PositionsOffchainOnly.charts}
+   * {@inheritDoc IPositionsOffchainOnly.charts}
    **/
   charts<const Metrics extends readonly PoolPositionChartMetric[]>(key: PoolPositionRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;
   charts<const Metrics extends readonly StrategyPositionChartMetric[]>(key: StrategyPositionRef, metrics: Metrics, range: ChartRange): Promise<DataResponse<ChartBundle<Metrics>>>;

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

@@ -1,3 +1,3 @@
-import { PositionMergers, Positions, PositionsBase, PositionsByMode, PositionsOffchainBranch, PositionsOffchainOnly, PositionsOnchainBranch, PositionsOnchainOnly } from "./types.js";
+import { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly } from "./types.js";
 import { PositionsNamespace } from "./PositionsNamespace.js";
-export { PositionMergers, Positions, PositionsBase, PositionsByMode, PositionsNamespace, PositionsOffchainBranch, PositionsOffchainOnly, PositionsOnchainBranch, PositionsOnchainOnly };
+export { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly, PositionsNamespace };

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

@@ -2,24 +2,24 @@ import { ChartBundle, ChartRange, PoolPositionChartMetric, StrategyPositionChart
 import { PoolPositionRef, Position, PositionFilter, PositionsTotals, StrategyPositionRef } from "../../model/positions.js";
 import { DataResponse } from "../../model/response.js";
 import "../../model/index.js";
-import { MultichainPositionsService } from "../../onchain/positions/MultichainPositionsService.js";
+import { IMultichainPositionsService } from "../../onchain/positions/types.js";
 import "../../onchain/index.js";
-import { OffchainPositions } from "../../offchain/positions/OffchainPositions.js";
+import { IOffchainPositions } from "../../offchain/positions/types.js";
 import "../../offchain/index.js";
-import { Mode } from "../types.js";
 import { FilterResult, ListMerger } from "../utils/types.js";
 import "../utils/index.js";
+import { Mode } from "../types.js";
 import { Address } from "viem";
 //#region src/sdk/positions/types.d.ts
 /**
  * What the `positions` namespace offers in every mode.
  **/
-interface PositionsBase {
+interface IPositionsBase {
   /**
    * Everything a wallet holds: its pool shares, its credit accounts and the
    * delayed withdrawals it took over by liquidating, optionally narrowed. In
    * `both` mode each chain is served by whichever source is fresh enough, see
-   * {@link PositionMergers}.
+   * {@link IPositionMergers}.
    **/
   list(wallet: Address, filter?: PositionFilter): Promise<DataResponse<Position[]>>;
   /**
@@ -28,26 +28,16 @@ interface PositionsBase {
    * narrows to a list.
    **/
   filter<R extends DataResponse<Position[]> | undefined>(response: R, filter?: PositionFilter): FilterResult<R, Position>;
-  /**
-   * The chain on its own, for a consumer that shows each source as it arrives.
-   * Throws in `offchain` mode.
-   **/
-  readonly onchain: MultichainPositionsService;
-  /**
-   * The backend on its own, see {@link PositionsBase.onchain}. Throws in
-   * `onchain` mode.
-   **/
-  readonly offchain: OffchainPositions;
   /**
    * Merge policy of each read, for a consumer combining the two branches
-   * itself, see {@link PositionMergers}.
+   * itself, see {@link IPositionMergers}.
    **/
-  readonly merge: PositionMergers;
+  readonly merge: IPositionMergers;
 }
 /**
  * Reads only a backend can answer.
  **/
-interface PositionsOffchainOnly {
+interface IPositionsOffchainOnly {
   /**
    * Aggregate over everything a wallet holds: the list screen's badges, see
    * {@link PositionsTotals}.
@@ -70,38 +60,39 @@ interface PositionsOffchainOnly {
 /**
  * Reads only the chain can answer. Empty for now.
  **/
-interface PositionsOnchainOnly {}
+interface IPositionsOnchainOnly {}
 /**
- * Which reads the `positions` namespace has in each mode. A widened mode offers
- * what every mode has, i.e. {@link PositionsBase} alone.
+ * The chain on its own, for a consumer that shows each source as it arrives.
+ * Absent in `offchain` mode.
  **/
-interface PositionsOnchainBranch {
-  readonly onchain: MultichainPositionsService;
+interface IPositionsOnchainBranch {
+  readonly onchain: IMultichainPositionsService;
 }
 /**
- * The backend on its own, see {@link PositionsOnchainBranch}.
+ * The backend on its own, see {@link IPositionsOnchainBranch}. Absent in
+ * `onchain` mode.
  **/
-interface PositionsOffchainBranch {
-  readonly offchain: OffchainPositions;
+interface IPositionsOffchainBranch {
+  readonly offchain: IOffchainPositions;
 }
 /**
  * Merge policy of each read, exposed so that a consumer reading the two
  * branches itself combines them exactly as `both` mode would.
  **/
-interface PositionMergers {
+interface IPositionMergers {
   list: ListMerger<Position[]>;
 }
 /**
  * Which methods the `positions` namespace has in each mode.
  **/
-interface PositionsByMode {
-  onchain: PositionsBase & PositionsOnchainOnly;
-  offchain: PositionsBase & PositionsOffchainOnly;
-  both: PositionsBase & PositionsOnchainOnly & PositionsOffchainOnly;
+interface IPositionsByMode {
+  onchain: IPositionsBase & IPositionsOnchainOnly & IPositionsOnchainBranch;
+  offchain: IPositionsBase & IPositionsOffchainOnly & IPositionsOffchainBranch;
+  both: IPositionsBase & IPositionsOnchainOnly & IPositionsOffchainOnly & IPositionsOnchainBranch & IPositionsOffchainBranch;
 }
 /**
  * The `positions` namespace of a {@link GearboxSDK} in mode `M`.
  **/
-type Positions<M extends Mode = Mode> = PositionsByMode[M];
+type IPositions<M extends Mode = Mode> = IPositionsByMode[M];
 //#endregion
-export { PositionMergers, Positions, PositionsBase, PositionsByMode, PositionsOffchainBranch, PositionsOffchainOnly, PositionsOnchainBranch, PositionsOnchainOnly };
+export { IPositionMergers, IPositions, IPositionsBase, IPositionsByMode, IPositionsOffchainBranch, IPositionsOffchainOnly, IPositionsOnchainBranch, IPositionsOnchainOnly };

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

@@ -7,8 +7,8 @@ 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 { EnsureFreshChains } from "../types.js";
-import { AddCollateralParams, AdjustLeverageParams, DepositStrategyParams, FinalizeParams, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./types.js";
 import { Address } from "viem";
 //#region src/sdk/prepare/PrepareApi.d.ts
 /**
@@ -20,7 +20,7 @@ import { Address } from "viem";
  **/
 type ChainOf = (chainId: ChainId) => OnchainSDK;
 /**
- * {@inheritDoc OpportunitiesPrepare}
+ * {@inheritDoc IOpportunitiesPrepare}
  *
  * 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
@@ -32,68 +32,68 @@ 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 PrepareApi extends MultichainConstruct implements OpportunitiesPrepare {
+declare class PrepareApi extends MultichainConstruct implements IOpportunitiesPrepare {
   #private;
   constructor(sdk: MultichainSDK, ensureFresh?: EnsureFreshChains);
   protected queryChain<T>(props: ChainQueryOneProps<T>): Promise<DataResponse<T>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.finalize}
+   * {@inheritDoc IOpportunitiesPrepare.finalize}
    **/
   finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.deposit}
+   * {@inheritDoc IOpportunitiesPrepare.deposit}
    **/
   deposit(pool: PoolInput, params: LpParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesPrepare.withdraw}
+   * {@inheritDoc IOpportunitiesPrepare.withdraw}
    **/
   withdraw(pool: PoolInput, params: LpParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesPrepare.redeem}
+   * {@inheritDoc IOpportunitiesPrepare.redeem}
    **/
   redeem(pool: PoolInput, params: LpRedeemParams): LpSimulate;
   /**
-   * {@inheritDoc OpportunitiesPrepare.openNewStrategy}
+   * {@inheritDoc IOpportunitiesPrepare.openNewStrategy}
    **/
   openNewStrategy(strategy: StrategyInput, params: OpenStrategyParams): Promise<DataResponse<OpenStrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.depositStrategy}
+   * {@inheritDoc IOpportunitiesPrepare.depositStrategy}
    **/
   depositStrategy(position: PositionInput, params: DepositStrategyParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.withdrawStrategy}
+   * {@inheritDoc IOpportunitiesPrepare.withdrawStrategy}
    **/
   withdrawStrategy(position: PositionInput, params: WithdrawStrategyParams): Promise<DataResponse<StrategyRoutesSimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.maxWithdraw}
+   * {@inheritDoc IOpportunitiesPrepare.maxWithdraw}
    **/
   maxWithdraw(position: PositionInput): Promise<DataResponse<bigint>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.repayStrategy}
+   * {@inheritDoc IOpportunitiesPrepare.repayStrategy}
    **/
   repayStrategy(position: PositionInput, params: RepayStrategyParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.maxRepay}
+   * {@inheritDoc IOpportunitiesPrepare.maxRepay}
    **/
   maxRepay(position: PositionInput): Promise<DataResponse<bigint>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.adjustLeverage}
+   * {@inheritDoc IOpportunitiesPrepare.adjustLeverage}
    **/
   adjustLeverage(position: PositionInput, params: AdjustLeverageParams): Promise<DataResponse<StrategyRoutesSimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.addCollateral}
+   * {@inheritDoc IOpportunitiesPrepare.addCollateral}
    **/
   addCollateral(position: PositionInput, params: AddCollateralParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.withdrawCollateral}
+   * {@inheritDoc IOpportunitiesPrepare.withdrawCollateral}
    **/
   withdrawCollateral(position: PositionInput, params: WithdrawCollateralParams): Promise<DataResponse<StrategySimulate>>;
   /**
-   * {@inheritDoc OpportunitiesPrepare.leverageBand}
+   * {@inheritDoc IOpportunitiesPrepare.leverageBand}
    **/
   leverageBand(strategy: StrategyInput, collateral: readonly Asset[], targetHF?: Bps): LeverageBand | undefined;
   /**
-   * {@inheritDoc OpportunitiesPrepare.maxWithdrawCollateral}
+   * {@inheritDoc IOpportunitiesPrepare.maxWithdrawCollateral}
    **/
   maxWithdrawCollateral(position: PositionInput, token: Address, targetHF?: bigint): Promise<DataResponse<bigint>>;
 }

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, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, OpportunitiesPrepare, PoolInput, PositionInput, PrepareOptions, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams } from "./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 { ChainOf, PrepareApi } from "./PrepareApi.js";
-export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, ChainOf, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IntentPreviewError, type LeverageBand, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, type OperationState, OpportunitiesPrepare, type PathLossRate, PoolInput, PositionInput, PrepareApi, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };
+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 };

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

@@ -106,8 +106,8 @@ type DelayedStrategySimulate = {
 } | PreviewRefusal;
 /**
  * What one of the two flows that sell a position asset —
- * {@link OpportunitiesPrepare.withdrawStrategy} and
- * {@link OpportunitiesPrepare.adjustLeverage} — would yield each way it can be
+ * {@link IOpportunitiesPrepare.withdrawStrategy} and
+ * {@link IOpportunitiesPrepare.adjustLeverage} — would yield each way it can be
  * served.
  *
  * Whether the account can sell that asset on the router, redeem it through its
@@ -127,7 +127,7 @@ type StrategyRoutesSimulate = {
   }> | undefined;
   /**
    * The request half of the redemption route, which
-   * {@link OpportunitiesPrepare.finalize} completes once it matures.
+   * {@link IOpportunitiesPrepare.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`.
    **/
@@ -210,7 +210,7 @@ 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 OpportunitiesPrepare.withdrawStrategy}.
+   * see {@link IOpportunitiesPrepare.withdrawStrategy}.
    **/
   amount: bigint;
   /** Wallet receiving the payout. */
@@ -237,7 +237,7 @@ interface RepayStrategyParams extends PrepareOptions {
    * 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 OpportunitiesPrepare.maxRepay}.
+   * transaction lands, see {@link IOpportunitiesPrepare.maxRepay}.
    * `MAX_UINT256` settles the debt and sizes that buffer itself.
    **/
   amount: bigint;
@@ -309,7 +309,7 @@ interface LpParams {
   tokenOut?: Address;
 }
 /**
- * Same shape as {@link LpParams}, but {@link OpportunitiesPrepare.redeem}
+ * Same shape as {@link LpParams}, but {@link IOpportunitiesPrepare.redeem}
  * treats `amount` as the pool shares to burn rather than the underlying to
  * receive.
  **/
@@ -346,7 +346,7 @@ interface FinalizeParams extends PrepareOptions {
  * 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 OpportunitiesPrepare {
+interface IOpportunitiesPrepare {
   /**
    * Depositing into a pool: underlying in, shares out.
    *
@@ -517,4 +517,4 @@ interface OpportunitiesPrepare {
   finalize(position: PositionInput, params: FinalizeParams): Promise<DataResponse<StrategySimulate>>;
 }
 //#endregion
-export { AddCollateralParams, AdjustLeverageParams, BorrowLimitBinding, DelayedStrategySimulate, DepositStrategyParams, FinalizeParams, IntentPreviewError, type LeverageBand, LpParams, LpRedeemParams, LpSimulate, OpenStrategyParams, OpenStrategySimulate, type OperationState, OpportunitiesPrepare, type PathLossRate, PoolInput, PositionInput, PrepareOptions, PreviewErrorDetails, PreviewErrorReason, PreviewIssue, PreviewRefusal, RepayStrategyParams, StrategyInput, StrategyRoutesSimulate, StrategySimulate, WithdrawCollateralParams, WithdrawStrategyParams, raise, refuse };
+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 };

package/dist/types/sdk/preview/PreviewNamespace.d.ts

@@ -2,17 +2,17 @@ import { OperationPreview, PreviewOperationInput, PreviewOperationOptions } from
 import "../../model/index.js";
 import { MultichainSDK } from "../../onchain/MultichainSDK.js";
 import "../../onchain/index.js";
+import { IPreview } from "./types.js";
 import { NamespaceOptions } from "../types.js";
-import { Preview } from "./types.js";
 //#region src/sdk/preview/PreviewNamespace.d.ts
 /**
- * {@inheritDoc Preview}
+ * {@inheritDoc IPreview}
  **/
-declare class PreviewNamespace implements Preview {
+declare class PreviewNamespace implements IPreview {
   #private;
   constructor(onchain: MultichainSDK, options: NamespaceOptions);
   /**
-   * {@inheritDoc Preview.previewOperation}
+   * {@inheritDoc IPreview.previewOperation}
    **/
   previewOperation(input: PreviewOperationInput, options?: PreviewOperationOptions): Promise<OperationPreview>;
 }

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

@@ -1,3 +1,3 @@
-import { Preview, PreviewByMode } from "./types.js";
+import { IPreview, IPreviewByMode } from "./types.js";
 import { PreviewNamespace } from "./PreviewNamespace.js";
-export { Preview, PreviewByMode, PreviewNamespace };
+export { IPreview, IPreviewByMode, PreviewNamespace };