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

package/src/router/swapPath.ts

@@ -1,6 +1,10 @@
 /**
- * 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";
 import { encodeFunctionData } from "viem";
 import { quoteLiveExactIn, quoteLiveExactOut } from "../quoter/quotePath.js";
@@ -10,10 +14,18 @@ import { ceilDiv, toSlippageBps } from "./swap.js";
 
 const BPS_BASE = 10_000n;
 
+/**
+ * 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;
@@ -21,6 +33,7 @@ export type ExactInputParams = {
   deadline: bigint;
 };
 
+/** Arguments for `MetricOmmSimpleRouter.exactOutput` (multihop exact output). */
 export type ExactOutputParams = {
   tokens: Address[];
   pools: Address[];
@@ -32,10 +45,12 @@ export type ExactOutputParams = {
   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;
@@ -43,8 +58,10 @@ export interface BuildExactInputParams {
   slippagePercent: number;
   deadline: bigint;
   quoterAddress?: Address;
+  wrappedNative?: Address;
 }
 
+/** Inputs for {@link buildExactOutputParams}. */
 export interface BuildExactOutputParams {
   publicClient: PublicClient;
   tokenIn: Address;
@@ -56,6 +73,7 @@ export interface BuildExactOutputParams {
   slippagePercent: number;
   deadline: bigint;
   quoterAddress?: Address;
+  wrappedNative?: Address;
 }
 
 function toExactInputStruct(params: ExactInputParams) {
@@ -84,6 +102,29 @@ function toExactOutputStruct(params: ExactOutputParams) {
   };
 }
 
+/**
+ * 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: BuildExactInputParams,
 ): Promise<ExactInputParams> {
@@ -121,6 +162,7 @@ export async function buildExactInputParams(
   };
 }
 
+/** Build multihop exact-output params with live quote and slippage on `amountInMaximum`. */
 export async function buildExactOutputParams(
   params: BuildExactOutputParams,
 ): Promise<ExactOutputParams> {
@@ -158,6 +200,7 @@ export async function buildExactOutputParams(
   };
 }
 
+/** Encode `exactInput` multihop calldata. */
 export function encodeExactInputCalldata(params: ExactInputParams): Hex {
   return encodeFunctionData({
     abi: SIMPLE_ROUTER_ABI,
@@ -166,8 +209,10 @@ export function encodeExactInputCalldata(params: ExactInputParams): Hex {
   });
 }
 
+/** Alias for {@link encodeExactInputCalldata}. */
 export const prepareExactInputCalldata = encodeExactInputCalldata;
 
+/** Encode `exactOutput` multihop calldata. */
 export function encodeExactOutputCalldata(params: ExactOutputParams): Hex {
   return encodeFunctionData({
     abi: SIMPLE_ROUTER_ABI,
@@ -176,6 +221,7 @@ export function encodeExactOutputCalldata(params: ExactOutputParams): Hex {
   });
 }
 
+/** Alias for {@link encodeExactOutputCalldata}. */
 export const prepareExactOutputCalldata = encodeExactOutputCalldata;
 
 export { encodeZeroForOneBitMap } from "../swap/path.js";

package/src/router/utils.ts

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

package/dist/abis/MetricOmmPoolStateView.d.ts

@@ -1,238 +0,0 @@
-export declare const MetricOmmPoolStateViewAbi: readonly [{
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "factory";
-        readonly type: "address";
-    }];
-    readonly stateMutability: "nonpayable";
-    readonly type: "constructor";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "uint8";
-        readonly name: "bits";
-        readonly type: "uint8";
-    }, {
-        readonly internalType: "uint256";
-        readonly name: "value";
-        readonly type: "uint256";
-    }];
-    readonly name: "SafeCastOverflowedUintDowncast";
-    readonly type: "error";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "int8";
-        readonly name: "binIdx";
-        readonly type: "int8";
-    }];
-    readonly name: "binState";
-    readonly outputs: readonly [{
-        readonly internalType: "uint104";
-        readonly name: "token0BalanceScaled";
-        readonly type: "uint104";
-    }, {
-        readonly internalType: "uint104";
-        readonly name: "token1BalanceScaled";
-        readonly type: "uint104";
-    }, {
-        readonly internalType: "uint16";
-        readonly name: "lengthE6";
-        readonly type: "uint16";
-    }, {
-        readonly internalType: "uint16";
-        readonly name: "addFeeBuyE6";
-        readonly type: "uint16";
-    }, {
-        readonly internalType: "uint16";
-        readonly name: "addFeeSellE6";
-        readonly type: "uint16";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "int8[]";
-        readonly name: "binIdxs";
-        readonly type: "int8[]";
-    }];
-    readonly name: "binStates";
-    readonly outputs: readonly [{
-        readonly internalType: "bytes32[]";
-        readonly name: "";
-        readonly type: "bytes32[]";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "int8";
-        readonly name: "binIdx";
-        readonly type: "int8";
-    }];
-    readonly name: "binTotalShares";
-    readonly outputs: readonly [{
-        readonly internalType: "uint256";
-        readonly name: "";
-        readonly type: "uint256";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "int8[]";
-        readonly name: "binIdxs";
-        readonly type: "int8[]";
-    }];
-    readonly name: "binTotalShares";
-    readonly outputs: readonly [{
-        readonly internalType: "bytes32[]";
-        readonly name: "";
-        readonly type: "bytes32[]";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "bytes32";
-        readonly name: "positionBinKey";
-        readonly type: "bytes32";
-    }];
-    readonly name: "positionBinShares";
-    readonly outputs: readonly [{
-        readonly internalType: "uint104";
-        readonly name: "";
-        readonly type: "uint104";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }, {
-        readonly internalType: "address";
-        readonly name: "owner";
-        readonly type: "address";
-    }, {
-        readonly internalType: "uint80";
-        readonly name: "salt";
-        readonly type: "uint80";
-    }, {
-        readonly internalType: "int8";
-        readonly name: "bin";
-        readonly type: "int8";
-    }];
-    readonly name: "positionBinShares";
-    readonly outputs: readonly [{
-        readonly internalType: "uint104";
-        readonly name: "";
-        readonly type: "uint104";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }];
-    readonly name: "priceProvider";
-    readonly outputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "";
-        readonly type: "address";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }];
-    readonly name: "slot0";
-    readonly outputs: readonly [{
-        readonly internalType: "uint8";
-        readonly name: "_pauseLevel";
-        readonly type: "uint8";
-    }, {
-        readonly internalType: "int8";
-        readonly name: "_curBinIdx";
-        readonly type: "int8";
-    }, {
-        readonly internalType: "uint104";
-        readonly name: "_curPosInBin";
-        readonly type: "uint104";
-    }, {
-        readonly internalType: "int24";
-        readonly name: "_curBinDistFromProvidedPrice";
-        readonly type: "int24";
-    }, {
-        readonly internalType: "uint24";
-        readonly name: "_spreadFeeE6";
-        readonly type: "uint24";
-    }, {
-        readonly internalType: "uint24";
-        readonly name: "_notionalFeeE8";
-        readonly type: "uint24";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }];
-    readonly name: "slot1";
-    readonly outputs: readonly [{
-        readonly internalType: "uint128";
-        readonly name: "totalScaledToken0InBins";
-        readonly type: "uint128";
-    }, {
-        readonly internalType: "uint128";
-        readonly name: "totalScaledToken1InBins";
-        readonly type: "uint128";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}, {
-    readonly inputs: readonly [{
-        readonly internalType: "address";
-        readonly name: "pool";
-        readonly type: "address";
-    }];
-    readonly name: "slot2";
-    readonly outputs: readonly [{
-        readonly internalType: "uint128";
-        readonly name: "notionalFeeToken0Scaled";
-        readonly type: "uint128";
-    }, {
-        readonly internalType: "uint128";
-        readonly name: "notionalFeeToken1Scaled";
-        readonly type: "uint128";
-    }];
-    readonly stateMutability: "view";
-    readonly type: "function";
-}];
-//# sourceMappingURL=MetricOmmPoolStateView.d.ts.map

package/dist/abis/MetricOmmPoolStateView.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"MetricOmmPoolStateView.d.ts","sourceRoot":"","sources":["../../src/abis/MetricOmmPoolStateView.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAyT5B,CAAC"}