@nradko/metric-omm-sdk-v1 0.4.1 → 0.4.3

package/dist/router/swap.d.ts

@@ -1,45 +1,80 @@
 /**
- * MetricAMM SDK - SimpleRouter single-hop swap helpers.
+ * SimpleRouter single-hop swap helpers.
+ *
+ * Typical ERC-20 flow:
+ * 1. `buildExactInputSingleParams` / `buildExactOutputSingleParams` — quote + slippage
+ * 2. `encodeExactInputSingleCalldata` — calldata for `walletClient.writeContract` or `sendTransaction`
+ * 3. Approve `tokenIn` on the SimpleRouter before sending (not needed for native ETH; see `nativeSwap.ts`)
  */
 import type { Address, Hex } from "viem";
 import type { PublicClient } from "viem";
+/**
+ * Arguments for `MetricOmmSimpleRouter.exactInputSingle`.
+ * Pass to `encodeExactInputSingleCalldata` or native prepare helpers when `tokenIn` is WETH.
+ */
 export type ExactInputSingleParams = {
+    /** Pool to swap through. */
     pool: Address;
+    /** Input token (`addresses.wrappedNative` when swapping from native ETH). */
     tokenIn: Address;
+    /** Output token (`addresses.wrappedNative` when unwrapping to ETH in a follow-up call). */
     tokenOut: Address;
+    /** `true` when swapping token0 → token1 for this pool. */
     zeroForOne: boolean;
+    /** Exact input amount in `tokenIn` native decimals. */
     amountIn: bigint;
+    /** Minimum acceptable output; reverts if less is received. */
     amountOutMinimum: bigint;
+    /** Address that receives output tokens. */
     recipient: Address;
+    /** Unix timestamp after which the swap reverts. */
     deadline: bigint;
+    /** Q64.64 price bound; use `0` / `MAX_UINT128` defaults from builders when unsure. */
     priceLimitX64: bigint;
+    /** Per-pool extension calldata; omit for pools without extensions. */
     extensionData?: Hex;
 };
+/**
+ * Arguments for `MetricOmmSimpleRouter.exactOutputSingle`.
+ */
 export type ExactOutputSingleParams = {
     pool: Address;
     tokenIn: Address;
     tokenOut: Address;
     zeroForOne: boolean;
+    /** Exact output amount in `tokenOut` native decimals. */
     amountOut: bigint;
+    /** Maximum input willing to spend (slippage cap). */
     amountInMaximum: bigint;
     recipient: Address;
     deadline: bigint;
     priceLimitX64: bigint;
     extensionData?: Hex;
 };
+/**
+ * Inputs for {@link buildExactInputSingleParams}.
+ * Quotes live on-chain via the SwapQuoter and applies `slippagePercent` to derive `amountOutMinimum`.
+ */
 export interface BuildExactInputSingleParams {
     publicClient: PublicClient;
     pool: Address;
     tokenIn: Address;
     tokenOut: Address;
     recipient: Address;
+    /** Input amount in `tokenIn` decimals (wei for ETH / WETH). */
     amountIn: bigint;
+    /** Human-readable slippage tolerance, e.g. `0.5` = 0.5%. */
     slippagePercent: number;
+    /** Optional price bound; defaults from quoter direction when omitted. */
     priceLimitX64?: bigint;
     deadline: bigint;
     extensionData?: Hex;
+    /** Override when `addresses.quoter` is unset. */
     quoterAddress?: Address;
+    /** `addresses.wrappedNative` — required when `tokenIn` or `tokenOut` is native (zero address). */
+    wrappedNative?: Address;
 }
+/** Inputs for {@link buildExactOutputSingleParams}. */
 export interface BuildExactOutputSingleParams {
     publicClient: PublicClient;
     pool: Address;
@@ -52,13 +87,59 @@ export interface BuildExactOutputSingleParams {
     deadline: bigint;
     extensionData?: Hex;
     quoterAddress?: Address;
+    wrappedNative?: Address;
 }
+/**
+ * Convert a human slippage percent to basis points (1 bp = 0.01%).
+ * @example toSlippageBps(0.5) // 50n
+ */
 export declare function toSlippageBps(slippagePercent: number): bigint;
+/** Ceiling division for bigint values. Used when rounding slippage up on exact-output swaps. */
 export declare function ceilDiv(numerator: bigint, denominator: bigint): bigint;
+/**
+ * Build single-hop exact-input swap params with live quote and slippage.
+ *
+ * Resolves `zeroForOne`, quotes `amountOut`, and sets `amountOutMinimum`.
+ * For native ETH input, use `prepareExactInputSingleSupportingNativePaymentCalldata` and set `msg.value` on the transaction.
+ * (params will contain WETH as `tokenIn`).
+ *
+ * @example
+ * ```ts
+ * const params = await buildExactInputSingleParams({
+ *   publicClient,
+ *   pool,
+ *   tokenIn: usdc,
+ *   tokenOut: weth,
+ *   recipient: account,
+ *   amountIn: parseUnits("100", 6),
+ *   slippagePercent: 0.5,
+ *   deadline: BigInt(Math.floor(Date.now() / 1000) + 1200),
+ *   quoterAddress: addresses.quoter,
+ * });
+ * await walletClient.writeContract({
+ *   address: addresses.simpleRouter,
+ *   abi: MetricOmmSimpleRouterAbi,
+ *   functionName: "exactInputSingle",
+ *   args: [params],
+ *   account,
+ * });
+ * ```
+ */
 export declare function buildExactInputSingleParams(params: BuildExactInputSingleParams): Promise<ExactInputSingleParams>;
+/**
+ * Build single-hop exact-output swap params with live quote and slippage.
+ * Sets `amountInMaximum` from quoted input plus `slippagePercent`.
+ */
 export declare function buildExactOutputSingleParams(params: BuildExactOutputSingleParams): Promise<ExactOutputSingleParams>;
+/**
+ * Encode `exactInputSingle` calldata for `addresses.simpleRouter`.
+ * Approve `tokenIn` on the router before sending (unless using native ETH prepare helpers).
+ */
 export declare function encodeExactInputSingleCalldata(params: ExactInputSingleParams): Hex;
+/** Alias for {@link encodeExactInputSingleCalldata}. */
 export declare const prepareExactInputSingleCalldata: typeof encodeExactInputSingleCalldata;
+/** Encode `exactOutputSingle` calldata for `addresses.simpleRouter`. */
 export declare function encodeExactOutputSingleCalldata(params: ExactOutputSingleParams): Hex;
+/** Alias for {@link encodeExactOutputSingleCalldata}. */
 export declare const prepareExactOutputSingleCalldata: typeof encodeExactOutputSingleCalldata;
 //# sourceMappingURL=swap.d.ts.map

package/dist/router/swap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swap.d.ts","sourceRoot":"","sources":["../../src/router/swap.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAOzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzC,MAAM,MAAM,sBAAsB,GAAG;IACnC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,wBAAgB,aAAa,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAK7D;AAED,wBAAgB,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAKtE;AAoCD,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAsCjC;AAED,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,uBAAuB,CAAC,CAsClC;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,sBAAsB,GAAG,GAAG,CAMlF;AAED,eAAO,MAAM,+BAA+B,uCAAiC,CAAC;AAE9E,wBAAgB,+BAA+B,CAAC,MAAM,EAAE,uBAAuB,GAAG,GAAG,CAMpF;AAED,eAAO,MAAM,gCAAgC,wCAAkC,CAAC"}
+{"version":3,"file":"swap.d.ts","sourceRoot":"","sources":["../../src/router/swap.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAOzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAIzC;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC,4BAA4B;IAC5B,IAAI,EAAE,OAAO,CAAC;IACd,6EAA6E;IAC7E,OAAO,EAAE,OAAO,CAAC;IACjB,2FAA2F;IAC3F,QAAQ,EAAE,OAAO,CAAC;IAClB,0DAA0D;IAC1D,UAAU,EAAE,OAAO,CAAC;IACpB,uDAAuD;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,SAAS,EAAE,OAAO,CAAC;IACnB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,sFAAsF;IACtF,aAAa,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,aAAa,CAAC,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,GAAG,CAAC;CACrB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,yEAAyE;IACzE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,iDAAiD;IACjD,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kGAAkG;IAClG,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,uDAAuD;AACvD,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,YAAY,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,GAAG,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,eAAe,EAAE,MAAM,GAAG,MAAM,CAK7D;AAED,gGAAgG;AAChG,wBAAgB,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,CAKtE;AAoCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,wBAAsB,2BAA2B,CAC/C,MAAM,EAAE,2BAA2B,GAClC,OAAO,CAAC,sBAAsB,CAAC,CAsCjC;AAED;;;GAGG;AACH,wBAAsB,4BAA4B,CAChD,MAAM,EAAE,4BAA4B,GACnC,OAAO,CAAC,uBAAuB,CAAC,CAsClC;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,sBAAsB,GAAG,GAAG,CAMlF;AAED,wDAAwD;AACxD,eAAO,MAAM,+BAA+B,uCAAiC,CAAC;AAE9E,wEAAwE;AACxE,wBAAgB,+BAA+B,CAAC,MAAM,EAAE,uBAAuB,GAAG,GAAG,CAMpF;AAED,yDAAyD;AACzD,eAAO,MAAM,gCAAgC,wCAAkC,CAAC"}

package/dist/router/swap.js

@@ -1,5 +1,10 @@
 /**
- * MetricAMM SDK - SimpleRouter single-hop swap helpers.
+ * SimpleRouter single-hop swap helpers.
+ *
+ * Typical ERC-20 flow:
+ * 1. `buildExactInputSingleParams` / `buildExactOutputSingleParams` — quote + slippage
+ * 2. `encodeExactInputSingleCalldata` — calldata for `walletClient.writeContract` or `sendTransaction`
+ * 3. Approve `tokenIn` on the SimpleRouter before sending (not needed for native ETH; see `nativeSwap.ts`)
  */
 import { encodeFunctionData } from "viem";
 import { defaultPriceLimitX64 } from "../quoter/quotePath.js";
@@ -8,12 +13,17 @@ import { resolveSwapPath } from "../swap/path.js";
 import { SIMPLE_ROUTER_ABI } from "../constants.js";
 import { EMPTY_EXTENSION_DATA } from "../extensions/types.js";
 const BPS_BASE = 10000n;
+/**
+ * Convert a human slippage percent to basis points (1 bp = 0.01%).
+ * @example toSlippageBps(0.5) // 50n
+ */
 export function toSlippageBps(slippagePercent) {
     if (!Number.isFinite(slippagePercent) || slippagePercent < 0 || slippagePercent > 100) {
         throw new Error("slippagePercent must be a finite number between 0 and 100");
     }
     return BigInt(Math.round(slippagePercent * 100));
 }
+/** Ceiling division for bigint values. Used when rounding slippage up on exact-output swaps. */
 export function ceilDiv(numerator, denominator) {
     if (denominator <= 0n) {
         throw new Error("denominator must be > 0");
@@ -51,6 +61,35 @@ function toExactOutputSingleStruct(params) {
         extensionData: withExtensionData(params.extensionData),
     };
 }
+/**
+ * Build single-hop exact-input swap params with live quote and slippage.
+ *
+ * Resolves `zeroForOne`, quotes `amountOut`, and sets `amountOutMinimum`.
+ * For native ETH input, use `prepareExactInputSingleSupportingNativePaymentCalldata` and set `msg.value` on the transaction.
+ * (params will contain WETH as `tokenIn`).
+ *
+ * @example
+ * ```ts
+ * const params = await buildExactInputSingleParams({
+ *   publicClient,
+ *   pool,
+ *   tokenIn: usdc,
+ *   tokenOut: weth,
+ *   recipient: account,
+ *   amountIn: parseUnits("100", 6),
+ *   slippagePercent: 0.5,
+ *   deadline: BigInt(Math.floor(Date.now() / 1000) + 1200),
+ *   quoterAddress: addresses.quoter,
+ * });
+ * await walletClient.writeContract({
+ *   address: addresses.simpleRouter,
+ *   abi: MetricOmmSimpleRouterAbi,
+ *   functionName: "exactInputSingle",
+ *   args: [params],
+ *   account,
+ * });
+ * ```
+ */
 export async function buildExactInputSingleParams(params) {
     const slippageBps = toSlippageBps(params.slippagePercent);
     const { zeroForOnes } = await resolveSwapPath(params.publicClient, params.tokenIn, params.tokenOut, [params.pool], params.extensionData ? [params.extensionData] : undefined);
@@ -81,6 +120,10 @@ export async function buildExactInputSingleParams(params) {
         extensionData: params.extensionData,
     };
 }
+/**
+ * Build single-hop exact-output swap params with live quote and slippage.
+ * Sets `amountInMaximum` from quoted input plus `slippagePercent`.
+ */
 export async function buildExactOutputSingleParams(params) {
     const slippageBps = toSlippageBps(params.slippagePercent);
     const { zeroForOnes } = await resolveSwapPath(params.publicClient, params.tokenIn, params.tokenOut, [params.pool], params.extensionData ? [params.extensionData] : undefined);
@@ -111,6 +154,10 @@ export async function buildExactOutputSingleParams(params) {
         extensionData: params.extensionData,
     };
 }
+/**
+ * Encode `exactInputSingle` calldata for `addresses.simpleRouter`.
+ * Approve `tokenIn` on the router before sending (unless using native ETH prepare helpers).
+ */
 export function encodeExactInputSingleCalldata(params) {
     return encodeFunctionData({
         abi: SIMPLE_ROUTER_ABI,
@@ -118,7 +165,9 @@ export function encodeExactInputSingleCalldata(params) {
         args: [toExactInputSingleStruct(params)],
     });
 }
+/** Alias for {@link encodeExactInputSingleCalldata}. */
 export const prepareExactInputSingleCalldata = encodeExactInputSingleCalldata;
+/** Encode `exactOutputSingle` calldata for `addresses.simpleRouter`. */
 export function encodeExactOutputSingleCalldata(params) {
     return encodeFunctionData({
         abi: SIMPLE_ROUTER_ABI,
@@ -126,5 +175,6 @@ export function encodeExactOutputSingleCalldata(params) {
         args: [toExactOutputSingleStruct(params)],
     });
 }
+/** Alias for {@link encodeExactOutputSingleCalldata}. */
 export const prepareExactOutputSingleCalldata = encodeExactOutputSingleCalldata;
 //# sourceMappingURL=swap.js.map

package/dist/router/swap.js.map

@@ -1 +1 @@
-{"version":3,"file":"swap.js","sourceRoot":"","sources":["../../src/router/swap.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAG9D,MAAM,QAAQ,GAAG,MAAO,CAAC;AAwDzB,MAAM,UAAU,aAAa,CAAC,eAAuB;IACnD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,GAAG,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,SAAiB,EAAE,WAAmB;IAC5D,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,WAAW,GAAG,EAAE,CAAC,GAAG,WAAW,CAAC;AAC9E,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAmB;IAC5C,OAAO,aAAa,IAAI,oBAAoB,CAAC;AAC/C,CAAC;AAED,SAAS,wBAAwB,CAAC,MAA8B;IAC9D,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,MAA+B;IAChE,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,MAAmC;IAEnC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,eAAe,CAC3C,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,CAAC,MAAM,CAAC,IAAI,CAAC,EACb,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAC1D,CAAC;IACF,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAE/E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,sBAAsB,CAAC;QACjD,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,SAAS,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,GAAG,QAAQ,CAAC;IAE3E,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU;QACV,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,MAAoC;IAEpC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,eAAe,CAC3C,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,CAAC,MAAM,CAAC,IAAI,CAAC,EACb,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAC1D,CAAC;IACF,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAE/E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,uBAAuB,CAAC;QACjD,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU;QACV,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe;QACf,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,MAA8B;IAC3E,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,kBAAkB;QAChC,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;KACzC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,+BAA+B,GAAG,8BAA8B,CAAC;AAE9E,MAAM,UAAU,+BAA+B,CAAC,MAA+B;IAC7E,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,mBAAmB;QACjC,IAAI,EAAE,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;KAC1C,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,gCAAgC,GAAG,+BAA+B,CAAC"}
+{"version":3,"file":"swap.js","sourceRoot":"","sources":["../../src/router/swap.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAG9D,MAAM,QAAQ,GAAG,MAAO,CAAC;AAuFzB;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,eAAuB;IACnD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,eAAe,GAAG,CAAC,IAAI,eAAe,GAAG,GAAG,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,CAAC;AACnD,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,OAAO,CAAC,SAAiB,EAAE,WAAmB;IAC5D,IAAI,WAAW,IAAI,EAAE,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,WAAW,GAAG,EAAE,CAAC,GAAG,WAAW,CAAC;AAC9E,CAAC;AAED,SAAS,iBAAiB,CAAC,aAAmB;IAC5C,OAAO,aAAa,IAAI,oBAAoB,CAAC;AAC/C,CAAC;AAED,SAAS,wBAAwB,CAAC,MAA8B;IAC9D,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAAC,MAA+B;IAChE,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU,EAAE,MAAM,CAAC,UAAU;QAC7B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,iBAAiB,CAAC,MAAM,CAAC,aAAa,CAAC;KACvD,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,CAAC,KAAK,UAAU,2BAA2B,CAC/C,MAAmC;IAEnC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,eAAe,CAC3C,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,CAAC,MAAM,CAAC,IAAI,CAAC,EACb,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAC1D,CAAC;IACF,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAE/E,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,sBAAsB,CAAC;QACjD,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,SAAS,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,GAAG,QAAQ,CAAC;IAE3E,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU;QACV,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,MAAoC;IAEpC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,eAAe,CAC3C,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,CAAC,MAAM,CAAC,IAAI,CAAC,EACb,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS,CAC1D,CAAC;IACF,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAE,CAAC;IACnC,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,IAAI,oBAAoB,CAAC,UAAU,CAAC,CAAC;IAE/E,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,uBAAuB,CAAC;QACjD,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,UAAU;QACV,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe;QACf,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa;QACb,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAAC,MAA8B;IAC3E,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,kBAAkB;QAChC,IAAI,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;KACzC,CAAC,CAAC;AACL,CAAC;AAED,wDAAwD;AACxD,MAAM,CAAC,MAAM,+BAA+B,GAAG,8BAA8B,CAAC;AAE9E,wEAAwE;AACxE,MAAM,UAAU,+BAA+B,CAAC,MAA+B;IAC7E,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,mBAAmB;QACjC,IAAI,EAAE,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC;KAC1C,CAAC,CAAC;AACL,CAAC;AAED,yDAAyD;AACzD,MAAM,CAAC,MAAM,gCAAgC,GAAG,+BAA+B,CAAC"}

package/dist/router/swapPath.d.ts

@@ -1,17 +1,29 @@
 /**
- * MetricAMM SDK - SimpleRouter multihop swap helpers.
+ * SimpleRouter multihop swap helpers.
+ *
+ * Multihop swaps walk `pools` in order; intermediate tokens remain on the router between hops.
+ * For ERC-20 paths, approve the router for `tokenIn` once before sending the transaction.
  */
 import type { Address, Hex, PublicClient } from "viem";
+/**
+ * Arguments for `MetricOmmSimpleRouter.exactInput` (multihop exact input).
+ * `tokens` and `zeroForOneBitMap` are usually produced by {@link buildExactInputParams}.
+ */
 export type ExactInputParams = {
+    /** Path tokens, length `pools.length + 1`. */
     tokens: Address[];
+    /** One pool per hop, in swap order. */
     pools: Address[];
+    /** Extension calldata per hop; use `0x` when a pool has no extension. */
     extensionDatas: Hex[];
+    /** Bit `i` set when hop `i` is token0 → token1. */
     zeroForOneBitMap: bigint;
     amountIn: bigint;
     amountOutMinimum: bigint;
     recipient: Address;
     deadline: bigint;
 };
+/** Arguments for `MetricOmmSimpleRouter.exactOutput` (multihop exact output). */
 export type ExactOutputParams = {
     tokens: Address[];
     pools: Address[];
@@ -22,10 +34,12 @@ export type ExactOutputParams = {
     recipient: Address;
     deadline: bigint;
 };
+/** Inputs for {@link buildExactInputParams}. */
 export interface BuildExactInputParams {
     publicClient: PublicClient;
     tokenIn: Address;
     tokenOut: Address;
+    /** Ordered pool addresses connecting `tokenIn` → `tokenOut`. */
     pools: readonly Address[];
     extensionDatas?: readonly Hex[];
     recipient: Address;
@@ -33,7 +47,9 @@ export interface BuildExactInputParams {
     slippagePercent: number;
     deadline: bigint;
     quoterAddress?: Address;
+    wrappedNative?: Address;
 }
+/** Inputs for {@link buildExactOutputParams}. */
 export interface BuildExactOutputParams {
     publicClient: PublicClient;
     tokenIn: Address;
@@ -45,12 +61,41 @@ export interface BuildExactOutputParams {
     slippagePercent: number;
     deadline: bigint;
     quoterAddress?: Address;
+    wrappedNative?: Address;
 }
+/**
+ * Build multihop exact-input params: resolves path, quotes output, applies slippage.
+ *
+ * @example
+ * ```ts
+ * const pathParams = await buildExactInputParams({
+ *   publicClient,
+ *   tokenIn: tokenA,
+ *   tokenOut: tokenC,
+ *   pools: [poolAB, poolBC],
+ *   recipient: account,
+ *   amountIn: parseUnits("1", 18),
+ *   slippagePercent: 0.5,
+ *   deadline,
+ *   quoterAddress: addresses.quoter,
+ * });
+ * await walletClient.sendTransaction({
+ *   to: addresses.simpleRouter,
+ *   data: encodeExactInputCalldata(pathParams),
+ *   account,
+ * });
+ * ```
+ */
 export declare function buildExactInputParams(params: BuildExactInputParams): Promise<ExactInputParams>;
+/** Build multihop exact-output params with live quote and slippage on `amountInMaximum`. */
 export declare function buildExactOutputParams(params: BuildExactOutputParams): Promise<ExactOutputParams>;
+/** Encode `exactInput` multihop calldata. */
 export declare function encodeExactInputCalldata(params: ExactInputParams): Hex;
+/** Alias for {@link encodeExactInputCalldata}. */
 export declare const prepareExactInputCalldata: typeof encodeExactInputCalldata;
+/** Encode `exactOutput` multihop calldata. */
 export declare function encodeExactOutputCalldata(params: ExactOutputParams): Hex;
+/** Alias for {@link encodeExactOutputCalldata}. */
 export declare const prepareExactOutputCalldata: typeof encodeExactOutputCalldata;
 export { encodeZeroForOneBitMap } from "../swap/path.js";
 //# sourceMappingURL=swapPath.d.ts.map

package/dist/router/swapPath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swapPath.d.ts","sourceRoot":"","sources":["../../src/router/swapPath.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AASvD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,SAAS,GAAG,EAAE,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,SAAS,GAAG,EAAE,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AA4BD,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,CAiC3B;AAED,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,CAiC5B;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,GAAG,GAAG,CAMtE;AAED,eAAO,MAAM,yBAAyB,iCAA2B,CAAC;AAElE,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,GAAG,GAAG,CAMxE;AAED,eAAO,MAAM,0BAA0B,kCAA4B,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"swapPath.d.ts","sourceRoot":"","sources":["../../src/router/swapPath.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AASvD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,8CAA8C;IAC9C,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,uCAAuC;IACvC,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,yEAAyE;IACzE,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,iFAAiF;AACjF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,cAAc,EAAE,GAAG,EAAE,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,gDAAgD;AAChD,MAAM,WAAW,qBAAqB;IACpC,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,SAAS,GAAG,EAAE,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,iDAAiD;AACjD,MAAM,WAAW,sBAAsB;IACrC,YAAY,EAAE,YAAY,CAAC;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,SAAS,OAAO,EAAE,CAAC;IAC1B,cAAc,CAAC,EAAE,SAAS,GAAG,EAAE,CAAC;IAChC,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AA4BD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,qBAAqB,CACzC,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,gBAAgB,CAAC,CAiC3B;AAED,4FAA4F;AAC5F,wBAAsB,sBAAsB,CAC1C,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,CAiC5B;AAED,6CAA6C;AAC7C,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,GAAG,GAAG,CAMtE;AAED,kDAAkD;AAClD,eAAO,MAAM,yBAAyB,iCAA2B,CAAC;AAElE,8CAA8C;AAC9C,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,iBAAiB,GAAG,GAAG,CAMxE;AAED,mDAAmD;AACnD,eAAO,MAAM,0BAA0B,kCAA4B,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/router/swapPath.js

@@ -1,3 +1,9 @@
+/**
+ * SimpleRouter multihop swap helpers.
+ *
+ * Multihop swaps walk `pools` in order; intermediate tokens remain on the router between hops.
+ * For ERC-20 paths, approve the router for `tokenIn` once before sending the transaction.
+ */
 import { encodeFunctionData } from "viem";
 import { quoteLiveExactIn, quoteLiveExactOut } from "../quoter/quotePath.js";
 import { resolveSwapPath } from "../swap/path.js";
@@ -28,6 +34,29 @@ function toExactOutputStruct(params) {
         deadline: params.deadline,
     };
 }
+/**
+ * Build multihop exact-input params: resolves path, quotes output, applies slippage.
+ *
+ * @example
+ * ```ts
+ * const pathParams = await buildExactInputParams({
+ *   publicClient,
+ *   tokenIn: tokenA,
+ *   tokenOut: tokenC,
+ *   pools: [poolAB, poolBC],
+ *   recipient: account,
+ *   amountIn: parseUnits("1", 18),
+ *   slippagePercent: 0.5,
+ *   deadline,
+ *   quoterAddress: addresses.quoter,
+ * });
+ * await walletClient.sendTransaction({
+ *   to: addresses.simpleRouter,
+ *   data: encodeExactInputCalldata(pathParams),
+ *   account,
+ * });
+ * ```
+ */
 export async function buildExactInputParams(params) {
     const slippageBps = toSlippageBps(params.slippagePercent);
     const { tokens, extensionDatas, zeroForOneBitMap } = await resolveSwapPath(params.publicClient, params.tokenIn, params.tokenOut, params.pools, params.extensionDatas);
@@ -53,6 +82,7 @@ export async function buildExactInputParams(params) {
         deadline: params.deadline,
     };
 }
+/** Build multihop exact-output params with live quote and slippage on `amountInMaximum`. */
 export async function buildExactOutputParams(params) {
     const slippageBps = toSlippageBps(params.slippagePercent);
     const { tokens, extensionDatas, zeroForOneBitMap } = await resolveSwapPath(params.publicClient, params.tokenIn, params.tokenOut, params.pools, params.extensionDatas);
@@ -78,6 +108,7 @@ export async function buildExactOutputParams(params) {
         deadline: params.deadline,
     };
 }
+/** Encode `exactInput` multihop calldata. */
 export function encodeExactInputCalldata(params) {
     return encodeFunctionData({
         abi: SIMPLE_ROUTER_ABI,
@@ -85,7 +116,9 @@ export function encodeExactInputCalldata(params) {
         args: [toExactInputStruct(params)],
     });
 }
+/** Alias for {@link encodeExactInputCalldata}. */
 export const prepareExactInputCalldata = encodeExactInputCalldata;
+/** Encode `exactOutput` multihop calldata. */
 export function encodeExactOutputCalldata(params) {
     return encodeFunctionData({
         abi: SIMPLE_ROUTER_ABI,
@@ -93,6 +126,7 @@ export function encodeExactOutputCalldata(params) {
         args: [toExactOutputStruct(params)],
     });
 }
+/** Alias for {@link encodeExactOutputCalldata}. */
 export const prepareExactOutputCalldata = encodeExactOutputCalldata;
 export { encodeZeroForOneBitMap } from "../swap/path.js";
 //# sourceMappingURL=swapPath.js.map

package/dist/router/swapPath.js.map

@@ -1 +1 @@
-{"version":3,"file":"swapPath.js","sourceRoot":"","sources":["../../src/router/swapPath.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEnD,MAAM,QAAQ,GAAG,MAAO,CAAC;AAkDzB,SAAS,kBAAkB,CAAC,MAAwB;IAClD,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAyB;IACpD,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAA6B;IAE7B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAG,MAAM,eAAe,CACxE,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,cAAc,CACtB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,gBAAgB,CAAC;QAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,SAAS,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,GAAG,QAAQ,CAAC;IAE3E,OAAO;QACL,MAAM;QACN,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxB,cAAc;QACd,gBAAgB;QAChB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAA8B;IAE9B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAG,MAAM,eAAe,CACxE,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,cAAc,CACtB,CAAC;IAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,iBAAiB,CAAC;QAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E,OAAO;QACL,MAAM;QACN,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxB,cAAc;QACd,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe;QACf,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAwB;IAC/D,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;KACnC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,MAAM,UAAU,yBAAyB,CAAC,MAAyB;IACjE,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,aAAa;QAC3B,IAAI,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;KACpC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC"}
+{"version":3,"file":"swapPath.js","sourceRoot":"","sources":["../../src/router/swapPath.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC7E,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEnD,MAAM,QAAQ,GAAG,MAAO,CAAC;AAgEzB,SAAS,kBAAkB,CAAC,MAAwB;IAClD,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,MAAyB;IACpD,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe,EAAE,MAAM,CAAC,eAAe;QACvC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,MAA6B;IAE7B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAG,MAAM,eAAe,CACxE,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,cAAc,CACtB,CAAC;IAEF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,gBAAgB,CAAC;QAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,CAAC,SAAS,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,CAAC,GAAG,QAAQ,CAAC;IAE3E,OAAO;QACL,MAAM;QACN,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxB,cAAc;QACd,gBAAgB;QAChB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAC1C,MAA8B;IAE9B,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC1D,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAG,MAAM,eAAe,CACxE,MAAM,CAAC,YAAY,EACnB,MAAM,CAAC,OAAO,EACd,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,KAAK,EACZ,MAAM,CAAC,cAAc,CACtB,CAAC;IAEF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,iBAAiB,CAAC;QAC3C,YAAY,EAAE,MAAM,CAAC,YAAY;QACjC,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,cAAc,EAAE,MAAM,CAAC,cAAc;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;IAEH,MAAM,eAAe,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,QAAQ,GAAG,WAAW,CAAC,EAAE,QAAQ,CAAC,CAAC;IAE/E,OAAO;QACL,MAAM;QACN,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACxB,cAAc;QACd,gBAAgB;QAChB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,eAAe;QACf,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAC;AACJ,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,wBAAwB,CAAC,MAAwB;IAC/D,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,YAAY;QAC1B,IAAI,EAAE,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;KACnC,CAAC,CAAC;AACL,CAAC;AAED,kDAAkD;AAClD,MAAM,CAAC,MAAM,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,8CAA8C;AAC9C,MAAM,UAAU,yBAAyB,CAAC,MAAyB;IACjE,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,aAAa;QAC3B,IAAI,EAAE,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;KACpC,CAAC,CAAC;AACL,CAAC;AAED,mDAAmD;AACnD,MAAM,CAAC,MAAM,0BAA0B,GAAG,yBAAyB,CAAC;AAEpE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC"}

package/dist/router/utils.d.ts

@@ -0,0 +1,9 @@
+/** SimpleRouter multicall and PeripheryPayments calldata encoders. */
+import type { Address, Hex } from "viem";
+/** `multicall(bytes[])`. */
+export declare function encodeMulticallCalldata(calls: readonly Hex[]): Hex;
+/** `refundETH()` — unused native balance on the router back to caller. */
+export declare function encodeRefundETHCalldata(): Hex;
+/** `unwrapWETH9(amountMinimum, recipient)`. */
+export declare function encodeUnwrapWETH9Calldata(amountMinimum: bigint, recipient: Address): Hex;
+//# sourceMappingURL=utils.d.ts.map

package/dist/router/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/router/utils.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAEtE,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAIzC,4BAA4B;AAC5B,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,SAAS,GAAG,EAAE,GAAG,GAAG,CAMlE;AAED,0EAA0E;AAC1E,wBAAgB,uBAAuB,IAAI,GAAG,CAK7C;AAED,+CAA+C;AAC/C,wBAAgB,yBAAyB,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,GAAG,CAMxF"}

package/dist/router/utils.js

@@ -0,0 +1,27 @@
+/** SimpleRouter multicall and PeripheryPayments calldata encoders. */
+import { encodeFunctionData } from "viem";
+import { SIMPLE_ROUTER_ABI } from "../constants.js";
+/** `multicall(bytes[])`. */
+export function encodeMulticallCalldata(calls) {
+    return encodeFunctionData({
+        abi: SIMPLE_ROUTER_ABI,
+        functionName: "multicall",
+        args: [calls],
+    });
+}
+/** `refundETH()` — unused native balance on the router back to caller. */
+export function encodeRefundETHCalldata() {
+    return encodeFunctionData({
+        abi: SIMPLE_ROUTER_ABI,
+        functionName: "refundETH",
+    });
+}
+/** `unwrapWETH9(amountMinimum, recipient)`. */
+export function encodeUnwrapWETH9Calldata(amountMinimum, recipient) {
+    return encodeFunctionData({
+        abi: SIMPLE_ROUTER_ABI,
+        functionName: "unwrapWETH9",
+        args: [amountMinimum, recipient],
+    });
+}
+//# sourceMappingURL=utils.js.map

package/dist/router/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/router/utils.ts"],"names":[],"mappings":"AAAA,sEAAsE;AAGtE,OAAO,EAAE,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,4BAA4B;AAC5B,MAAM,UAAU,uBAAuB,CAAC,KAAqB;IAC3D,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE,CAAC,KAAK,CAAC;KACd,CAAC,CAAC;AACL,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,uBAAuB;IACrC,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,WAAW;KAC1B,CAAC,CAAC;AACL,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,yBAAyB,CAAC,aAAqB,EAAE,SAAkB;IACjF,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,iBAAiB;QACtB,YAAY,EAAE,aAAa;QAC3B,IAAI,EAAE,CAAC,aAAa,EAAE,SAAS,CAAC;KACjC,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nradko/metric-omm-sdk-v1",
-  "version": "0.4.1",
+  "version": "0.4.3",
   "description": "Metric AMM SDK — v1 contracts (SimpleRouter, SwapQuoter, LiquidityAdder, extensions, add/removeLiquidity)",
   "type": "module",
   "main": "dist/index.js",
@@ -54,7 +54,7 @@
     "type": "git",
     "url": "https://github.com/Metric-OMM/metric-sdk.git"
   },
-  "metricPeripheryRef": "dccbda7970da36d55a86108e3dbcce1e794c9634",
+  "metricPeripheryRef": "e161cb0b1b301395c631197f3c7d5c205a8b4d48",
   "dependencies": {
     "viem": "^2.x"
   },

package/src/abis/MetricOmmSimpleRouter.ts

@@ -6,6 +6,11 @@ export const MetricOmmSimpleRouterAbi = [
         name: "weth",
         type: "address",
       },
+      {
+        internalType: "address",
+        name: "factory",
+        type: "address",
+      },
     ],
     stateMutability: "nonpayable",
     type: "constructor",
@@ -32,6 +37,17 @@ export const MetricOmmSimpleRouterAbi = [
     name: "AmountTooLarge",
     type: "error",
   },
+  {
+    inputs: [
+      {
+        internalType: "uint128",
+        name: "amount",
+        type: "uint128",
+      },
+    ],
+    name: "AmountTooLarge",
+    type: "error",
+  },
   {
     inputs: [],
     name: "ETHTransferFailed",
@@ -127,6 +143,11 @@ export const MetricOmmSimpleRouterAbi = [
     name: "InvalidCallbackMode",
     type: "error",
   },
+  {
+    inputs: [],
+    name: "InvalidFactory",
+    type: "error",
+  },
   {
     inputs: [
       {
@@ -190,6 +211,17 @@ export const MetricOmmSimpleRouterAbi = [
     name: "InvalidPath",
     type: "error",
   },
+  {
+    inputs: [
+      {
+        internalType: "address",
+        name: "pool",
+        type: "address",
+      },
+    ],
+    name: "InvalidPool",
+    type: "error",
+  },
   {
     inputs: [
       {
@@ -206,6 +238,32 @@ export const MetricOmmSimpleRouterAbi = [
     name: "InvalidPriceLimitForDirection",
     type: "error",
   },
+  {
+    inputs: [
+      {
+        internalType: "bool",
+        name: "zeroForOne",
+        type: "bool",
+      },
+      {
+        internalType: "uint128",
+        name: "priceLimitX64",
+        type: "uint128",
+      },
+    ],
+    name: "InvalidPriceLimitForDirection",
+    type: "error",
+  },
+  {
+    inputs: [],
+    name: "InvalidSwapDeltas",
+    type: "error",
+  },
+  {
+    inputs: [],
+    name: "InvalidSwapDeltas",
+    type: "error",
+  },
   {
     inputs: [],
     name: "InvalidSwapDeltas",