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

package/src/pool/liquidity.ts

@@ -4,9 +4,15 @@
  * **Add liquidity (recommended path):**
  * 1. `buildModifyLiquidityArgsForAddition` / `ForUniformAddition` / `ForUniformAdditionWithTotalTokenAmount`
  * 2. `buildAddLiquidityExactSharesParamsFromBinTargets` (optional convenience)
- * 3. `encodeAddLiquidityExactSharesSelfCalldata` — target `addresses.liquidityAdder`
+ * 3. `encodeAddLiquidityExactSharesSelfCalldata` or `encodeAddLiquidityExactSharesWithOwnerCalldata`
+ *    — target `addresses.liquidityAdder`
  * 4. Approve token0 and token1 on the LiquidityAdder for `maxAmountToken0` / `maxAmountToken1`
  *
+ * **Self vs WithOwner encoders:**
+ * - `*SelfCalldata` — credits liquidity to **`msg.sender`** (the transaction sender owns the position).
+ * - `*WithOwnerCalldata` — credits liquidity to **`owner`** (e.g. router, vault, or relayer paying on behalf of a user).
+ *   The caller still supplies tokens and must approve the LiquidityAdder; only the position owner differs.
+ *
  * **Remove liquidity:** `buildModifyLiquidityArgsForRemoval` → `buildRemoveLiquidityPoolDelta`
  * → `encodeRemoveLiquidityCalldata` — call the **pool** directly (no adder approval).
  *
@@ -772,10 +778,26 @@ export async function buildAddLiquidityExactSharesParamsFromBinTargets(
   };
 }
 
+/** Cursor bounds that disable weighted-add cursor checks (matches on-chain test helpers). */
+export const UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS = {
+  minimalCurBin: -128,
+  minimalPosition: 0n,
+  maximalCurBin: 127,
+  maximalPosition: MAX_UINT104,
+} as const;
+
+export type LiquidityCursorBounds = {
+  minimalCurBin: number;
+  minimalPosition: bigint;
+  maximalCurBin: number;
+  maximalPosition: bigint;
+};
+
 /**
- * Encode `LiquidityAdder.addLiquidityExactShares(pool, salt, deltas, max0, max1, ext)`
- * for `msg.sender` as position owner.
- * Approve both pool tokens on the LiquidityAdder before sending.
+ * Encode `LiquidityAdder.addLiquidityExactShares` for the transaction sender.
+ *
+ * Creates or increases the position `(msg.sender, salt)` — liquidity is credited to whoever
+ * sends the transaction. Approve both pool tokens on the LiquidityAdder before sending.
  */
 export function encodeAddLiquidityExactSharesSelfCalldata(params: {
   pool: Address;
@@ -800,8 +822,11 @@ export function encodeAddLiquidityExactSharesSelfCalldata(params: {
 }
 
 /**
- * Same as {@link encodeAddLiquidityExactSharesSelfCalldata} but credits liquidity to `owner`
- * (e.g. router or vault acting on behalf of a user).
+ * Encode `LiquidityAdder.addLiquidityExactShares` for an explicit position owner.
+ *
+ * Creates or increases the position `(owner, salt)` while `msg.sender` pays for the deposit
+ * (e.g. router, vault, or meta-transaction relayer acting on behalf of `owner`).
+ * Approve both pool tokens on the LiquidityAdder before sending.
  */
 export function encodeAddLiquidityExactSharesWithOwnerCalldata(params: {
   pool: Address;
@@ -828,8 +853,11 @@ export function encodeAddLiquidityExactSharesWithOwnerCalldata(params: {
 }
 
 /**
- * Encode weighted add: `weightDeltas` are relative share weights; the adder scales to fit
+ * Encode weighted add for the transaction sender.
+ *
+ * `weightDeltas` are relative share weights; the adder scales to fit
  * `maxAmountToken0` / `maxAmountToken1`. Use {@link scaleWeightedPoolDeltasToFitCaps} to pre-scale.
+ * Creates or increases the position `(msg.sender, salt)`.
  */
 export function encodeAddLiquidityWeightedSelfCalldata(params: {
   pool: Address;
@@ -852,16 +880,21 @@ export function encodeAddLiquidityWeightedSelfCalldata(params: {
       { binIdxs: [...params.weightDeltas.binIdxs], shares: [...params.weightDeltas.shares] },
       params.maxAmountToken0,
       params.maxAmountToken1,
-      params.minimalCurBin ?? -128,
-      params.minimalPosition ?? 0n,
-      params.maximalCurBin ?? 127,
-      params.maximalPosition ?? MAX_UINT104,
+      params.minimalCurBin ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.minimalCurBin,
+      params.minimalPosition ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.minimalPosition,
+      params.maximalCurBin ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.maximalCurBin,
+      params.maximalPosition ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.maximalPosition,
       params.extensionData ?? EMPTY_EXTENSION_DATA,
     ],
   });
 }
 
-/** Weighted add with explicit `owner` (7-arg overload on LiquidityAdder). */
+/**
+ * Encode weighted add for an explicit position owner.
+ *
+ * Same as {@link encodeAddLiquidityWeightedSelfCalldata} but credits liquidity to `(owner, salt)`
+ * while `msg.sender` pays for the deposit.
+ */
 export function encodeAddLiquidityWeightedWithOwnerCalldata(params: {
   pool: Address;
   owner: Address;
@@ -885,10 +918,10 @@ export function encodeAddLiquidityWeightedWithOwnerCalldata(params: {
       { binIdxs: [...params.weightDeltas.binIdxs], shares: [...params.weightDeltas.shares] },
       params.maxAmountToken0,
       params.maxAmountToken1,
-      params.minimalCurBin ?? -128,
-      params.minimalPosition ?? 0n,
-      params.maximalCurBin ?? 127,
-      params.maximalPosition ?? MAX_UINT104,
+      params.minimalCurBin ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.minimalCurBin,
+      params.minimalPosition ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.minimalPosition,
+      params.maximalCurBin ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.maximalCurBin,
+      params.maximalPosition ?? UNCONSTRAINED_LIQUIDITY_CURSOR_BOUNDS.maximalPosition,
       params.extensionData ?? EMPTY_EXTENSION_DATA,
     ],
   });

package/src/pool/nativeLiquidity.ts

@@ -0,0 +1,71 @@
+import type { Hex } from "viem";
+import {
+  encodeAddLiquidityExactSharesSelfCalldata,
+  encodeAddLiquidityExactSharesWithOwnerCalldata,
+  encodeAddLiquidityWeightedSelfCalldata,
+  encodeAddLiquidityWeightedWithOwnerCalldata,
+} from "./liquidity.js";
+import { encodeMulticallCalldata, encodeRefundETHCalldata } from "../peripheryPayments/index.js";
+
+type ExactSharesSelfParams = Parameters<typeof encodeAddLiquidityExactSharesSelfCalldata>[0];
+type ExactSharesWithOwnerParams = Parameters<
+  typeof encodeAddLiquidityExactSharesWithOwnerCalldata
+>[0];
+type WeightedSelfParams = Parameters<typeof encodeAddLiquidityWeightedSelfCalldata>[0];
+type WeightedWithOwnerParams = Parameters<typeof encodeAddLiquidityWeightedWithOwnerCalldata>[0];
+
+/**
+ * Exact-shares add with native ETH for the pool WETH leg.
+ * Credits liquidity to `(msg.sender, salt)`. Set `msg.value` on the transaction;
+ * unused ETH is refunded to the caller.
+ */
+export function prepareAddLiquidityExactSharesSelfSupportingNativePaymentCalldata(
+  params: ExactSharesSelfParams,
+): Hex {
+  return encodeMulticallCalldata([
+    encodeAddLiquidityExactSharesSelfCalldata(params),
+    encodeRefundETHCalldata(),
+  ]);
+}
+
+/**
+ * Exact-shares add with native ETH for the pool WETH leg.
+ * Credits liquidity to `(owner, salt)` while `msg.sender` pays. Set `msg.value` on the
+ * transaction; unused ETH is refunded to the caller.
+ */
+export function prepareAddLiquidityExactSharesWithOwnerSupportingNativePaymentCalldata(
+  params: ExactSharesWithOwnerParams,
+): Hex {
+  return encodeMulticallCalldata([
+    encodeAddLiquidityExactSharesWithOwnerCalldata(params),
+    encodeRefundETHCalldata(),
+  ]);
+}
+
+/**
+ * Weighted add with native ETH for the pool WETH leg.
+ * Credits liquidity to `(msg.sender, salt)`. Set `msg.value` on the transaction;
+ * unused ETH is refunded to the caller.
+ */
+export function prepareAddLiquidityWeightedSelfSupportingNativePaymentCalldata(
+  params: WeightedSelfParams,
+): Hex {
+  return encodeMulticallCalldata([
+    encodeAddLiquidityWeightedSelfCalldata(params),
+    encodeRefundETHCalldata(),
+  ]);
+}
+
+/**
+ * Weighted add with native ETH for the pool WETH leg.
+ * Credits liquidity to `(owner, salt)` while `msg.sender` pays. Set `msg.value` on the
+ * transaction; unused ETH is refunded to the caller.
+ */
+export function prepareAddLiquidityWeightedWithOwnerSupportingNativePaymentCalldata(
+  params: WeightedWithOwnerParams,
+): Hex {
+  return encodeMulticallCalldata([
+    encodeAddLiquidityWeightedWithOwnerCalldata(params),
+    encodeRefundETHCalldata(),
+  ]);
+}

package/src/router/index.ts

@@ -51,7 +51,7 @@ export {
   encodeMulticallCalldata,
   encodeRefundETHCalldata,
   encodeUnwrapWETH9Calldata,
-} from "./utils.js";
+} from "../peripheryPayments/index.js";
 
 export {
   prepareExactInputSingleAndUnwrapCalldata,

package/src/router/nativeSwap.ts

@@ -7,7 +7,7 @@ import {
   encodeMulticallCalldata,
   encodeRefundETHCalldata,
   encodeUnwrapWETH9Calldata,
-} from "./utils.js";
+} from "../peripheryPayments/index.js";
 
 function withRouterRecipient<T extends { recipient: Address }>(
   params: T,

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

@@ -1 +0,0 @@
-{"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.map

@@ -1 +0,0 @@
-{"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"}