@gearbox-protocol/sdk 16.0.0-next.46 → 16.0.0-next.47

package/dist/types/preview/simulate/simulatePoolOperation.d.ts

@@ -5,7 +5,24 @@ import { PreviewOperationOptions } from "../types.js";
 import "../parse/index.js";
 import { PreviewSimulationError } from "./errors.js";
 import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
+import { ContractFunctionParameters } from "viem";
 //#region src/preview/simulate/simulatePoolOperation.d.ts
+/**
+ * Builds the preview read that converts the operation's known amount into its
+ * counterpart. Direct operations read the pool's ERC4626 preview; zapper-routed
+ * operations (only ever `Deposit`/`Redeem`) read the zapper's
+ * `previewDeposit`/`previewRedeem`, which account for the zapper's own
+ * conversion in addition to the pool's.
+ */
+declare function previewContract(operation: PoolOperation): ContractFunctionParameters;
+/**
+ * Maps a pool operation and its preview result to the amounts of tokens going
+ * in (user -> pool) and out (pool -> user). `previewAmount` is the counterpart
+ * amount returned by the matching preview read (shares for deposit/withdraw,
+ * assets for mint/redeem, and the zapper's converted amount for zapper-routed
+ * deposit/redeem).
+ */
+declare function amountsInOut(operation: PoolOperation, previewAmount: bigint): PoolOperationSimulationResult;
 /**
  * Simulates a pool deposit/mint/withdraw/redeem (direct or zapper-routed) and
  * returns the resulting token amounts going in and out. Throws a
@@ -22,4 +39,4 @@ import { PoolOperationSimulationResult, SimulationInput } from "./types.js";
  */
 declare function simulatePoolOperation(input: SimulationInput<PoolOperation>, options?: PreviewOperationOptions): Promise<SDKReturn<PoolOperationSimulationResult, PreviewSimulationError>>;
 //#endregion
-export { simulatePoolOperation };
+export { amountsInOut, previewContract, simulatePoolOperation };

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

@@ -26,13 +26,21 @@ interface SimulationInput<Op extends Operation = Operation> {
  */
 interface PoolOperationSimulationResult {
   /**
-   * Amount of tokens going from the user to the pool (underlying or zapper
-   * input token for deposit/mint, pool shares for withdraw/redeem).
+   * User -> pool.
+   *
+   * Deposit/mint: underlying (or zapper input); `withdrawFee` does not apply.
+   *
+   * Withdraw/redeem: shares burned. On withdraw, `previewWithdraw` inflates
+   * that burn for `withdrawFee`; on redeem, the shares from calldata.
    **/
   amountIn: bigint;
   /**
-   * Amount of tokens going from the pool to the user (pool shares or zapper
-   * output token for deposit/mint, underlying for withdraw/redeem).
+   * Pool -> user.
+   *
+   * Deposit/mint: shares minted (or zapper output); `withdrawFee` does not apply.
+   *
+   * Withdraw/redeem: underlying paid out. On withdraw, the requested amount;
+   * on redeem, `previewRedeem` after `withdrawFee`.
    **/
   amountOut: bigint;
 }

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

@@ -31,14 +31,16 @@ interface LpState extends PoolSimulation {
   curator: Curator;
   /**
    * The wallet's position in this pool once the operation has run, in the
-   * market's underlying: what it holds now, moved by what this operation mints
-   * or burns. A first deposit lands at the size of the deposit itself.
+   * market's underlying.
    *
    * Denominated like {@link PoolPosition.netValue}, so a screen showing both
    * reads one token: on an RWA market that is the unwrapped asset — USDC
    * rather than the dcUSDC the pool actually holds.
+   *
+   * Does not account for withdrawal fee: this is what the remaining shares
+   * are worth, not what leaving with them would pay.
    **/
-  positionAfter: TokenAmount;
+  netValue: TokenAmount;
 }
 /**
  * What a pool deposit or withdrawal comes to.
@@ -414,7 +416,7 @@ interface IOpportunitiesPrepare {
    *
    * The trade itself is the pool's share rate applied to the amount, which is
    * loaded already; the wait is for the one thing that is not, the shares the
-   * wallet holds, without which {@link LpState.positionAfter} cannot be said.
+   * wallet holds, without which {@link LpState.netValue} cannot be said.
    **/
   deposit(pool: PoolInput, params: LpParams): Promise<SDKReturn<LpResult, UnsupportedTokenPairError | UnexpectedFailureError>>;
   /**

package/package.json

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