@nradko/metric-omm-sdk-v1 0.0.16

package/dist/factory/collectFees.js

@@ -0,0 +1,120 @@
+/**
+ * MetricAMM SDK - Factory Fee Collection
+ */
+import { erc20Abi, zeroAddress, } from "viem";
+import { POOL_FACTORY_ABI } from "../constants.js";
+/**
+ * Read balances for the provided asset list on the factory.
+ * For ERC20 assets this uses multicall(balanceOf(factory)).
+ * For native ETH (zero address), this uses getBalance(factory).
+ */
+export async function getFactoryAssetBalances(publicClient, factoryAddress, assets) {
+    const uniqueAssets = dedupeAssets(assets);
+    const nativeAsset = zeroAddress.toLowerCase();
+    const erc20Assets = uniqueAssets.filter((asset) => asset.toLowerCase() !== nativeAsset);
+    const erc20Balances = new Map();
+    if (erc20Assets.length > 0) {
+        const results = await publicClient.multicall({
+            contracts: erc20Assets.map((asset) => ({
+                address: asset,
+                abi: erc20Abi,
+                functionName: "balanceOf",
+                args: [factoryAddress],
+            })),
+            allowFailure: true,
+        });
+        const failedAssets = [];
+        results.forEach((result, index) => {
+            const asset = erc20Assets[index];
+            if (result.status === "success") {
+                erc20Balances.set(asset.toLowerCase(), result.result);
+                return;
+            }
+            failedAssets.push(asset);
+        });
+        if (failedAssets.length > 0) {
+            throw new Error(`Failed to read ERC20 balances for: ${failedAssets.join(", ")}`);
+        }
+    }
+    const nativeIncluded = uniqueAssets.some((asset) => asset.toLowerCase() === nativeAsset);
+    const nativeBalance = nativeIncluded
+        ? await publicClient.getBalance({ address: factoryAddress })
+        : undefined;
+    return uniqueAssets.map((asset) => {
+        const isNative = asset.toLowerCase() === nativeAsset;
+        return {
+            asset,
+            isNative,
+            amount: isNative ? (nativeBalance ?? 0n) : (erc20Balances.get(asset.toLowerCase()) ?? 0n),
+        };
+    });
+}
+/**
+ * Collect all non-zero balances for the provided assets from the factory,
+ * sending each asset in a separate transaction.
+ */
+export async function collectFactoryFees(params) {
+    const { publicClient, walletClient, factoryAddress, target, assets, account, awaitReceipts = true, } = params;
+    const balances = await getFactoryAssetBalances(publicClient, factoryAddress, assets);
+    const toCollect = balances.filter((item) => item.amount > 0n);
+    const collected = [];
+    for (const item of toCollect) {
+        if (item.isNative) {
+            const { request } = await publicClient.simulateContract({
+                address: factoryAddress,
+                abi: POOL_FACTORY_ABI,
+                functionName: "collectETH",
+                args: [target, item.amount],
+                account,
+            });
+            const hash = await walletClient.writeContract(request);
+            const tx = {
+                asset: item.asset,
+                amount: item.amount,
+                isNative: true,
+                hash,
+            };
+            if (awaitReceipts) {
+                tx.receipt = await publicClient.waitForTransactionReceipt({ hash });
+            }
+            collected.push(tx);
+            continue;
+        }
+        const { request } = await publicClient.simulateContract({
+            address: factoryAddress,
+            abi: POOL_FACTORY_ABI,
+            functionName: "collectTokens",
+            args: [item.asset, target, item.amount],
+            account,
+        });
+        const hash = await walletClient.writeContract(request);
+        const tx = {
+            asset: item.asset,
+            amount: item.amount,
+            isNative: false,
+            hash,
+        };
+        if (awaitReceipts) {
+            tx.receipt = await publicClient.waitForTransactionReceipt({ hash });
+        }
+        collected.push(tx);
+    }
+    return {
+        balances,
+        collected,
+    };
+}
+function dedupeAssets(assets) {
+    const deduped = [];
+    const seen = new Set();
+    for (const asset of assets) {
+        const key = asset.toLowerCase();
+        if (seen.has(key)) {
+            continue;
+        }
+        seen.add(key);
+        deduped.push(asset);
+    }
+    return deduped;
+}
+//# sourceMappingURL=collectFees.js.map

package/dist/factory/collectFees.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectFees.js","sourceRoot":"","sources":["../../src/factory/collectFees.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,QAAQ,EACR,WAAW,GAMZ,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AA+BnD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAC3C,YAA0B,EAC1B,cAAuB,EACvB,MAAiB;IAEjB,MAAM,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IAE9C,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,CAAC;IAExF,MAAM,aAAa,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEhD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,SAAS,CAAC;YAC3C,SAAS,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBACrC,OAAO,EAAE,KAAK;gBACd,GAAG,EAAE,QAAQ;gBACb,YAAY,EAAE,WAAW;gBACzB,IAAI,EAAE,CAAC,cAAc,CAAC;aACvB,CAAC,CAAC;YACH,YAAY,EAAE,IAAI;SACnB,CAAC,CAAC;QAEH,MAAM,YAAY,GAAc,EAAE,CAAC;QAEnC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YACjC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBAChC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,MAAM,CAAC,MAAgB,CAAC,CAAC;gBAChE,OAAO;YACT,CAAC;YACD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,sCAAsC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC;IACH,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC,CAAC;IAEzF,MAAM,aAAa,GAAG,cAAc;QAClC,CAAC,CAAC,MAAM,YAAY,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;QAC5D,CAAC,CAAC,SAAS,CAAC;IAEd,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,KAAK,WAAW,CAAC;QAErD,OAAO;YACL,KAAK;YACL,QAAQ;YACR,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;SAC1F,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAgC;IAEhC,MAAM,EACJ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,MAAM,EACN,MAAM,EACN,OAAO,EACP,aAAa,GAAG,IAAI,GACrB,GAAG,MAAM,CAAC;IAEX,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,YAAY,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC;IAErF,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IAC9D,MAAM,SAAS,GAA4B,EAAE,CAAC;IAE9C,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;QAC7B,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC;gBACtD,OAAO,EAAE,cAAc;gBACvB,GAAG,EAAE,gBAAgB;gBACrB,YAAY,EAAE,YAAY;gBAC1B,IAAI,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;gBAC3B,OAAO;aACR,CAAC,CAAC;YAEH,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;YACvD,MAAM,EAAE,GAA0B;gBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,QAAQ,EAAE,IAAI;gBACd,IAAI;aACL,CAAC;YAEF,IAAI,aAAa,EAAE,CAAC;gBAClB,EAAE,CAAC,OAAO,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;YACtE,CAAC;YAED,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnB,SAAS;QACX,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC;YACtD,OAAO,EAAE,cAAc;YACvB,GAAG,EAAE,gBAAgB;YACrB,YAAY,EAAE,eAAe;YAC7B,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;YACvC,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QACvD,MAAM,EAAE,GAA0B;YAChC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,KAAK;YACf,IAAI;SACL,CAAC;QAEF,IAAI,aAAa,EAAE,CAAC;YAClB,EAAE,CAAC,OAAO,GAAG,MAAM,YAAY,CAAC,yBAAyB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,CAAC;QAED,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrB,CAAC;IAED,OAAO;QACL,QAAQ;QACR,SAAS;KACV,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,MAAiB;IACrC,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAChC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAClB,SAAS;QACX,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACd,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtB,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/factory/index.d.ts

@@ -0,0 +1,5 @@
+/**
+ * MetricAMM SDK - Factory Functions
+ */
+export { getFactoryAssetBalances, collectFactoryFees, type FactoryAssetBalance, type CollectFactoryFeesParams, type CollectedFactoryFeeTx, type CollectFactoryFeesResult, } from "./collectFees.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/factory/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,GAC9B,MAAM,kBAAkB,CAAC"}

package/dist/factory/index.js

@@ -0,0 +1,5 @@
+/**
+ * MetricAMM SDK - Factory Functions
+ */
+export { getFactoryAssetBalances, collectFactoryFees, } from "./collectFees.js";
+//# sourceMappingURL=index.js.map

package/dist/factory/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/factory/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GAKnB,MAAM,kBAAkB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * MetricAMM SDK (v1 contracts: Swapper, LiquidityAdder, add/removeLiquidity).
+ *
+ * @packageDocumentation
+ */
+export type { LiquidityDelta, PoolLiquidityDelta, BinData, PoolImmutables, PoolState, BinState, BinStateExternal, BinStatesExternal, BinStatesScaled, Slot0, Slot1, FeeConfig, PositionBinSharesResult, CalculateUniformLiquidityParams, LiquidityBinValueInput as AnyLiquidityBinInput, CalculateAnyLiquidityParams, PreparedLiquidityDistribution, CalculatedLiquidityDistribution, } from "./types.js";
+export { Q64, MAX_UINT128, MAX_INT128, MAX_UINT104, MAX_INT104 } from "./constants.js";
+export { ChainId, ADDRESSES, getAddresses, getAddressesOrThrow, isChainSupported, getSupportedChainIds, isChainDeployed, type ChainAddresses, type DeployedChainId, } from "./addresses.js";
+export { MetricOmmPoolAbi, MetricOmmPoolStateViewAbi, MetricOmmPoolSwapperAbi, MetricOmmPoolLiquidityAdderAbi, MetricOmmPoolFactoryAbi, } from "./abis/index.js";
+export { packBinData, packBins5, packBinDataArray, unpackBinData, createBins, createUniformBins, priceToQ64, q64ToPrice, } from "./utils/index.js";
+export { createPool, prepareFactoryCreatePoolParams, encodeCreatePoolCalldata, preparePoolBinData, type CreatePoolFactoryParams, type CreatePoolParams, getPoolImmutables, getPoolState, getBinState, getPositionBinShares, } from "./pool/index.js";
+export { getSlot0, getSlot1, getBinStateExternal, getBinStatesExternal, getBinStatesScaled, getBinTotalShares, getPositionBinSharesFromStateView, toPositionBinKey, getPositionBinSharesRange, getFeeConfig, getPriceProvider, getLastTradeTimestamp, } from "./stateView/index.js";
+export { buildModifyLiquidityArgsForAddition, buildModifyLiquidityArgsForUniformAddition, buildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmount, buildModifyLiquidityArgsForPercentageRemoval, buildModifyLiquidityArgsForRemoval, buildAddLiquidityExactSharesParamsFromBinTargets, buildRemoveLiquidityPoolDelta, additionPlanToPoolLiquidityDelta, removalPlanToPoolLiquidityDelta, scaleWeightedPoolDeltasToFitCaps, encodeAddLiquidityExactSharesSelfCalldata, encodeAddLiquidityExactSharesWithOwnerCalldata, encodeAddLiquidityWeightedSelfCalldata, encodeAddLiquidityWeightedWithOwnerCalldata, encodeRemoveLiquidityCalldata, getPositionShares, getPositionSharesForBins, NO_SLIPPAGE_LIMIT, type ModifyLiquidityArgs, type BuildModifyLiquidityArgsBase, type BuildModifyLiquidityArgsForAdditionParams, type BuildModifyLiquidityArgsForUniformAdditionParams, type BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams, type BuildModifyLiquidityArgsForPercentageRemovalParams, type BuildModifyLiquidityArgsForRemovalParams, type RemoveLiquidityParams, type BinRemovalSpec, } from "./pool/liquidity.js";
+export { buildArgsForSwapExactInput, buildArgsAndExpectedAmountsForSwapExactInput, quoteExpectedAmountsForSwapExactInput, buildArgsForSwapExactOutput, buildArgsAndExpectedAmountsForSwapExactOutput, quoteExpectedAmountsForSwapExactOutput, prepareSwapExactInputCalldata, prepareSwapExactOutputCalldata, prepareSwapExactInputNativeForTokensCalldata, type PreparedSwapTransaction, type BuildSwapExactInputParams, type QuoteExpectedAmountsForSwapExactInputParams, type BuildSwapExactOutputParams, type QuoteExpectedAmountsForSwapExactOutputParams, type SwapExactInputParams, type SwapExactOutputParams, type SwapExactInputArgs, type SwapExactOutputArgs, } from "./router/index.js";
+export { getFactoryAssetBalances, collectFactoryFees, type FactoryAssetBalance, type CollectFactoryFeesParams, type CollectedFactoryFeeTx, type CollectFactoryFeesResult, } from "./factory/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,YAAY,EACV,cAAc,EACd,kBAAkB,EAClB,OAAO,EACP,cAAc,EACd,SAAS,EACT,QAAQ,EACR,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,KAAK,EACL,KAAK,EACL,SAAS,EACT,uBAAuB,EACvB,+BAA+B,EAC/B,sBAAsB,IAAI,oBAAoB,EAC9C,2BAA2B,EAC3B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAGvF,OAAO,EACL,OAAO,EACP,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,8BAA8B,EAC9B,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,WAAW,EACX,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,iBAAiB,EACjB,UAAU,EACV,UAAU,GACX,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EACL,UAAU,EACV,8BAA8B,EAC9B,wBAAwB,EACxB,kBAAkB,EAClB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,EACrB,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,iCAAiC,EACjC,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAG9B,OAAO,EACL,mCAAmC,EACnC,0CAA0C,EAC1C,8DAA8D,EAC9D,4CAA4C,EAC5C,kCAAkC,EAClC,gDAAgD,EAChD,6BAA6B,EAC7B,gCAAgC,EAChC,+BAA+B,EAC/B,gCAAgC,EAChC,yCAAyC,EACzC,8CAA8C,EAC9C,sCAAsC,EACtC,2CAA2C,EAC3C,6BAA6B,EAC7B,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,yCAAyC,EAC9C,KAAK,gDAAgD,EACrD,KAAK,oEAAoE,EACzE,KAAK,kDAAkD,EACvD,KAAK,wCAAwC,EAC7C,KAAK,qBAAqB,EAC1B,KAAK,cAAc,GACpB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EACL,0BAA0B,EAC1B,4CAA4C,EAC5C,qCAAqC,EACrC,2BAA2B,EAC3B,6CAA6C,EAC7C,sCAAsC,EACtC,6BAA6B,EAC7B,8BAA8B,EAC9B,4CAA4C,EAC5C,KAAK,uBAAuB,EAC5B,KAAK,yBAAyB,EAC9B,KAAK,2CAA2C,EAChD,KAAK,0BAA0B,EAC/B,KAAK,4CAA4C,EACjD,KAAK,oBAAoB,EACzB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,GACzB,MAAM,mBAAmB,CAAC;AAG3B,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,KAAK,mBAAmB,EACxB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,GAC9B,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -0,0 +1,24 @@
+/**
+ * MetricAMM SDK (v1 contracts: Swapper, LiquidityAdder, add/removeLiquidity).
+ *
+ * @packageDocumentation
+ */
+// ============ Constants ============
+export { Q64, MAX_UINT128, MAX_INT128, MAX_UINT104, MAX_INT104 } from "./constants.js";
+// ============ Addresses ============
+export { ChainId, ADDRESSES, getAddresses, getAddressesOrThrow, isChainSupported, getSupportedChainIds, isChainDeployed, } from "./addresses.js";
+// ============ ABIs ============
+export { MetricOmmPoolAbi, MetricOmmPoolStateViewAbi, MetricOmmPoolSwapperAbi, MetricOmmPoolLiquidityAdderAbi, MetricOmmPoolFactoryAbi, } from "./abis/index.js";
+// ============ Utils ============
+export { packBinData, packBins5, packBinDataArray, unpackBinData, createBins, createUniformBins, priceToQ64, q64ToPrice, } from "./utils/index.js";
+// ============ Pool Functions ============
+export { createPool, prepareFactoryCreatePoolParams, encodeCreatePoolCalldata, preparePoolBinData, getPoolImmutables, getPoolState, getBinState, getPositionBinShares, } from "./pool/index.js";
+// ============ StateView Functions ============
+export { getSlot0, getSlot1, getBinStateExternal, getBinStatesExternal, getBinStatesScaled, getBinTotalShares, getPositionBinSharesFromStateView, toPositionBinKey, getPositionBinSharesRange, getFeeConfig, getPriceProvider, getLastTradeTimestamp, } from "./stateView/index.js";
+// ============ Liquidity Functions ============
+export { buildModifyLiquidityArgsForAddition, buildModifyLiquidityArgsForUniformAddition, buildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmount, buildModifyLiquidityArgsForPercentageRemoval, buildModifyLiquidityArgsForRemoval, buildAddLiquidityExactSharesParamsFromBinTargets, buildRemoveLiquidityPoolDelta, additionPlanToPoolLiquidityDelta, removalPlanToPoolLiquidityDelta, scaleWeightedPoolDeltasToFitCaps, encodeAddLiquidityExactSharesSelfCalldata, encodeAddLiquidityExactSharesWithOwnerCalldata, encodeAddLiquidityWeightedSelfCalldata, encodeAddLiquidityWeightedWithOwnerCalldata, encodeRemoveLiquidityCalldata, getPositionShares, getPositionSharesForBins, NO_SLIPPAGE_LIMIT, } from "./pool/liquidity.js";
+// ============ Swapper Functions ============
+export { buildArgsForSwapExactInput, buildArgsAndExpectedAmountsForSwapExactInput, quoteExpectedAmountsForSwapExactInput, buildArgsForSwapExactOutput, buildArgsAndExpectedAmountsForSwapExactOutput, quoteExpectedAmountsForSwapExactOutput, prepareSwapExactInputCalldata, prepareSwapExactOutputCalldata, prepareSwapExactInputNativeForTokensCalldata, } from "./router/index.js";
+// ============ Factory Functions ============
+export { getFactoryAssetBalances, collectFactoryFees, } from "./factory/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAwBH,sCAAsC;AACtC,OAAO,EAAE,GAAG,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAEvF,sCAAsC;AACtC,OAAO,EACL,OAAO,EACP,SAAS,EACT,YAAY,EACZ,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,GAGhB,MAAM,gBAAgB,CAAC;AAExB,iCAAiC;AACjC,OAAO,EACL,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,8BAA8B,EAC9B,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AAEzB,kCAAkC;AAClC,OAAO,EACL,WAAW,EACX,SAAS,EACT,gBAAgB,EAChB,aAAa,EACb,UAAU,EACV,iBAAiB,EACjB,UAAU,EACV,UAAU,GACX,MAAM,kBAAkB,CAAC;AAE1B,2CAA2C;AAC3C,OAAO,EACL,UAAU,EACV,8BAA8B,EAC9B,wBAAwB,EACxB,kBAAkB,EAGlB,iBAAiB,EACjB,YAAY,EACZ,WAAW,EACX,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AAEzB,gDAAgD;AAChD,OAAO,EACL,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,iCAAiC,EACjC,gBAAgB,EAChB,yBAAyB,EACzB,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAE9B,gDAAgD;AAChD,OAAO,EACL,mCAAmC,EACnC,0CAA0C,EAC1C,8DAA8D,EAC9D,4CAA4C,EAC5C,kCAAkC,EAClC,gDAAgD,EAChD,6BAA6B,EAC7B,gCAAgC,EAChC,+BAA+B,EAC/B,gCAAgC,EAChC,yCAAyC,EACzC,8CAA8C,EAC9C,sCAAsC,EACtC,2CAA2C,EAC3C,6BAA6B,EAC7B,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAUlB,MAAM,qBAAqB,CAAC;AAE7B,8CAA8C;AAC9C,OAAO,EACL,0BAA0B,EAC1B,4CAA4C,EAC5C,qCAAqC,EACrC,2BAA2B,EAC3B,6CAA6C,EAC7C,sCAAsC,EACtC,6BAA6B,EAC7B,8BAA8B,EAC9B,4CAA4C,GAU7C,MAAM,mBAAmB,CAAC;AAE3B,8CAA8C;AAC9C,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GAKnB,MAAM,oBAAoB,CAAC"}

package/dist/pool/create.d.ts

@@ -0,0 +1,80 @@
+/**
+ * MetricAMM SDK - Pool creation (v1 factory `PoolParameters`).
+ */
+import type { Address, PublicClient, WalletClient, Hex } from "viem";
+/**
+ * Parameters for creating a new pool via the v1 factory.
+ */
+export interface CreatePoolFactoryParams {
+    token0: Address;
+    token1: Address;
+    priceProvider: Address;
+    admin: Address;
+    /** Defaults to zero address (no allowlist). */
+    depositAllowlistProvider?: Address;
+    /** Defaults to zero address (no allowlist). */
+    swapAllowlistProvider?: Address;
+    /** Defaults to 0. */
+    priceProviderTimelock?: bigint;
+    nonNegativeBins: bigint[];
+    negativeBins: bigint[];
+    initialScaledToken0PerShareE18: bigint;
+    initialScaledToken1PerShareE18: bigint;
+    minimalMintableLiquidity: bigint;
+    reportSwapToPriceProvider: boolean;
+    /** Admin spread fee in E6 units (same convention as on-chain pool fees). */
+    adminSpreadFeeE6: number;
+    /** Admin notional fee in E8 units. */
+    adminNotionalFeeE8: number;
+    adminFeeDestination: Address;
+    /** Distance from oracle price to bin anchor, in pool E6 units (same scaling as v0 helper). */
+    curBinDistFromProvidedPricePercent: number;
+    salt?: Hex;
+}
+/**
+ * @deprecated Use CreatePoolFactoryParams instead
+ */
+export interface CreatePoolParams {
+    token0: Address;
+    token1: Address;
+    priceProvider: Address;
+    numBins: number;
+    binLengthE6: number;
+    baseFeeE6: number;
+    protocolFeeE6: number;
+    maxDriftE8: bigint;
+    maxDriftDecayPerSecondE8: bigint;
+}
+export declare function prepareFactoryCreatePoolParams(params: CreatePoolFactoryParams): {
+    token0: `0x${string}`;
+    token1: `0x${string}`;
+    priceProvider: `0x${string}`;
+    depositAllowlistProvider: `0x${string}`;
+    swapAllowlistProvider: `0x${string}`;
+    priceProviderTimelock: bigint;
+    admin: `0x${string}`;
+    initialAmount0PerShareE18: bigint;
+    initialAmount1PerShareE18: bigint;
+    minimalMintableLiquidity: bigint;
+    reportSwapToPriceProvider: boolean;
+    adminSpreadFeeE6: number;
+    adminNotionalFeeE8: number;
+    adminFeeDestination: `0x${string}`;
+    curBinDistFromProvidedPriceE6: number;
+    nonNegativeBinDataArray: bigint[];
+    negativeBinDataArray: bigint[];
+    salt: `0x${string}`;
+};
+export declare function createPool(publicClient: PublicClient, walletClient: WalletClient, factoryAddress: Address, params: CreatePoolFactoryParams, account: Address): Promise<{
+    hash: Hex;
+    poolAddress?: Address;
+}>;
+export declare function encodeCreatePoolCalldata(params: CreatePoolFactoryParams): Hex;
+/**
+ * @deprecated Use prepareFactoryCreatePoolParams instead
+ */
+export declare function preparePoolBinData(params: CreatePoolParams): {
+    positiveBinData: bigint[];
+    negativeBinData: bigint[];
+};
+//# sourceMappingURL=create.d.ts.map

package/dist/pool/create.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../src/pool/create.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAOrE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,+CAA+C;IAC/C,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,+CAA+C;IAC/C,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,qBAAqB;IACrB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,8BAA8B,EAAE,MAAM,CAAC;IACvC,8BAA8B,EAAE,MAAM,CAAC;IACvC,wBAAwB,EAAE,MAAM,CAAC;IACjC,yBAAyB,EAAE,OAAO,CAAC;IACnC,4EAA4E;IAC5E,gBAAgB,EAAE,MAAM,CAAC;IACzB,sCAAsC;IACtC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,OAAO,CAAC;IAC7B,8FAA8F;IAC9F,kCAAkC,EAAE,MAAM,CAAC;IAC3C,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;IAChB,aAAa,EAAE,OAAO,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED,wBAAgB,8BAA8B,CAAC,MAAM,EAAE,uBAAuB;;;;;;;;;;;;;;;;;;;EAgC7E;AAED,wBAAsB,UAAU,CAC9B,YAAY,EAAE,YAAY,EAC1B,YAAY,EAAE,YAAY,EAC1B,cAAc,EAAE,OAAO,EACvB,MAAM,EAAE,uBAAuB,EAC/B,OAAO,EAAE,OAAO,GACf,OAAO,CAAC;IAAE,IAAI,EAAE,GAAG,CAAC;IAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAkB/C;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,uBAAuB,GAAG,GAAG,CAS7E;AAgBD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,gBAAgB,GAAG;IAC5D,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B,CAUA"}

package/dist/pool/create.js

@@ -0,0 +1,80 @@
+/**
+ * MetricAMM SDK - Pool creation (v1 factory `PoolParameters`).
+ */
+import { encodeFunctionData, zeroAddress } from "viem";
+import { POOL_FACTORY_ABI } from "../constants.js";
+import { createUniformBins } from "../utils/binData.js";
+export function prepareFactoryCreatePoolParams(params) {
+    const curBinDistFromProvidedPriceE6 = Math.round(params.curBinDistFromProvidedPricePercent * 10_000);
+    if (curBinDistFromProvidedPriceE6 < -(2 ** 23) || curBinDistFromProvidedPriceE6 > 2 ** 23 - 1) {
+        throw new Error("curBinDistFromProvidedPricePercent maps to int24 out of range");
+    }
+    const salt = params.salt ??
+        `0x${[...Array(64)].map(() => Math.floor(Math.random() * 16).toString(16)).join("")}`;
+    return {
+        token0: params.token0,
+        token1: params.token1,
+        priceProvider: params.priceProvider,
+        depositAllowlistProvider: params.depositAllowlistProvider ?? zeroAddress,
+        swapAllowlistProvider: params.swapAllowlistProvider ?? zeroAddress,
+        priceProviderTimelock: params.priceProviderTimelock ?? 0n,
+        admin: params.admin,
+        initialAmount0PerShareE18: params.initialScaledToken0PerShareE18,
+        initialAmount1PerShareE18: params.initialScaledToken1PerShareE18,
+        minimalMintableLiquidity: params.minimalMintableLiquidity,
+        reportSwapToPriceProvider: params.reportSwapToPriceProvider,
+        adminSpreadFeeE6: params.adminSpreadFeeE6,
+        adminNotionalFeeE8: params.adminNotionalFeeE8,
+        adminFeeDestination: params.adminFeeDestination,
+        curBinDistFromProvidedPriceE6: curBinDistFromProvidedPriceE6,
+        nonNegativeBinDataArray: params.nonNegativeBins,
+        negativeBinDataArray: params.negativeBins,
+        salt,
+    };
+}
+export async function createPool(publicClient, walletClient, factoryAddress, params, account) {
+    const factoryParams = prepareFactoryCreatePoolParams(params);
+    const args = buildCreatePoolArgs(factoryParams);
+    const { request, result } = await publicClient.simulateContract({
+        address: factoryAddress,
+        abi: POOL_FACTORY_ABI,
+        functionName: "createPool",
+        args,
+        account,
+    });
+    const hash = await walletClient.writeContract(request);
+    return {
+        hash,
+        poolAddress: result,
+    };
+}
+export function encodeCreatePoolCalldata(params) {
+    const factoryParams = prepareFactoryCreatePoolParams(params);
+    const args = buildCreatePoolArgs(factoryParams);
+    return encodeFunctionData({
+        abi: POOL_FACTORY_ABI,
+        functionName: "createPool",
+        args,
+    });
+}
+function buildCreatePoolArgs(factoryParams) {
+    const createPoolAbi = POOL_FACTORY_ABI.find((item) => item?.type === "function" && item?.name === "createPool");
+    const inputCount = createPoolAbi?.inputs?.length ?? 1;
+    if (inputCount === 1) {
+        return [factoryParams];
+    }
+    throw new Error("Unsupported createPool ABI shape");
+}
+/**
+ * @deprecated Use prepareFactoryCreatePoolParams instead
+ */
+export function preparePoolBinData(params) {
+    const halfBins = Math.floor(params.numBins / 2);
+    const positiveBinData = createUniformBins(halfBins, params.binLengthE6);
+    const negativeBinData = createUniformBins(halfBins, params.binLengthE6);
+    return {
+        positiveBinData,
+        negativeBinData,
+    };
+}
+//# sourceMappingURL=create.js.map

package/dist/pool/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../../src/pool/create.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAiDxD,MAAM,UAAU,8BAA8B,CAAC,MAA+B;IAC5E,MAAM,6BAA6B,GAAG,IAAI,CAAC,KAAK,CAC9C,MAAM,CAAC,kCAAkC,GAAG,MAAM,CACnD,CAAC;IACF,IAAI,6BAA6B,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,6BAA6B,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9F,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,MAAM,IAAI,GACR,MAAM,CAAC,IAAI;QACV,KAAK,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAU,CAAC;IAEjG,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,wBAAwB,EAAE,MAAM,CAAC,wBAAwB,IAAI,WAAW;QACxE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,IAAI,WAAW;QAClE,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,IAAI,EAAE;QACzD,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,yBAAyB,EAAE,MAAM,CAAC,8BAA8B;QAChE,yBAAyB,EAAE,MAAM,CAAC,8BAA8B;QAChE,wBAAwB,EAAE,MAAM,CAAC,wBAAwB;QACzD,yBAAyB,EAAE,MAAM,CAAC,yBAAyB;QAC3D,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;QACzC,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;QAC7C,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;QAC/C,6BAA6B,EAAE,6BAA6B;QAC5D,uBAAuB,EAAE,MAAM,CAAC,eAAe;QAC/C,oBAAoB,EAAE,MAAM,CAAC,YAAY;QACzC,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,YAA0B,EAC1B,YAA0B,EAC1B,cAAuB,EACvB,MAA+B,EAC/B,OAAgB;IAEhB,MAAM,aAAa,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAEhD,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAAC;QAC9D,OAAO,EAAE,cAAc;QACvB,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,YAAY;QAC1B,IAAI;QACJ,OAAO;KACR,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAEvD,OAAO;QACL,IAAI;QACJ,WAAW,EAAE,MAAiB;KAC/B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAA+B;IACtE,MAAM,aAAa,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;IAEhD,OAAO,kBAAkB,CAAC;QACxB,GAAG,EAAE,gBAAgB;QACrB,YAAY,EAAE,YAAY;QAC1B,IAAI;KACL,CAAC,CAAC;AACL,CAAC;AAED,SAAS,mBAAmB,CAAC,aAAsB;IACjD,MAAM,aAAa,GAAI,gBAAmC,CAAC,IAAI,CAC7D,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,UAAU,IAAI,IAAI,EAAE,IAAI,KAAK,YAAY,CACnE,CAAC;IAEF,MAAM,UAAU,GAAG,aAAa,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC;IAEtD,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,aAAa,CAAC,CAAC;IACzB,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAwB;IAIzD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC;IAEhD,MAAM,eAAe,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IACxE,MAAM,eAAe,GAAG,iBAAiB,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;IAExE,OAAO;QACL,eAAe;QACf,eAAe;KAChB,CAAC;AACJ,CAAC"}

package/dist/pool/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * MetricAMM SDK - Pool Functions
+ */
+export { createPool, prepareFactoryCreatePoolParams, encodeCreatePoolCalldata, preparePoolBinData, type CreatePoolFactoryParams, type CreatePoolParams, } from "./create.js";
+export { getPoolImmutables, getPoolState, getBinState, getPositionBinShares } from "./read.js";
+export { buildModifyLiquidityArgsForAddition, buildModifyLiquidityArgsForUniformAddition, buildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmount, buildModifyLiquidityArgsForPercentageRemoval, buildModifyLiquidityArgsForRemoval, buildAddLiquidityExactSharesParamsFromBinTargets, buildRemoveLiquidityPoolDelta, additionPlanToPoolLiquidityDelta, removalPlanToPoolLiquidityDelta, scaleWeightedPoolDeltasToFitCaps, encodeAddLiquidityExactSharesSelfCalldata, encodeAddLiquidityExactSharesWithOwnerCalldata, encodeAddLiquidityWeightedSelfCalldata, encodeAddLiquidityWeightedWithOwnerCalldata, encodeRemoveLiquidityCalldata, getPositionShares, getPositionSharesForBins, NO_SLIPPAGE_LIMIT, type ModifyLiquidityArgs, type BuildModifyLiquidityArgsBase, type BuildModifyLiquidityArgsForAdditionParams, type BuildModifyLiquidityArgsForUniformAdditionParams, type BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams, type BuildModifyLiquidityArgsForPercentageRemovalParams, type BuildModifyLiquidityArgsForRemovalParams, type RemoveLiquidityParams, type BinRemovalSpec, } from "./liquidity.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/pool/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pool/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EACL,UAAU,EACV,8BAA8B,EAC9B,wBAAwB,EACxB,kBAAkB,EAClB,KAAK,uBAAuB,EAC5B,KAAK,gBAAgB,GACtB,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAG/F,OAAO,EACL,mCAAmC,EACnC,0CAA0C,EAC1C,8DAA8D,EAC9D,4CAA4C,EAC5C,kCAAkC,EAClC,gDAAgD,EAChD,6BAA6B,EAC7B,gCAAgC,EAChC,+BAA+B,EAC/B,gCAAgC,EAChC,yCAAyC,EACzC,8CAA8C,EAC9C,sCAAsC,EACtC,2CAA2C,EAC3C,6BAA6B,EAC7B,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,KAAK,mBAAmB,EACxB,KAAK,4BAA4B,EACjC,KAAK,yCAAyC,EAC9C,KAAK,gDAAgD,EACrD,KAAK,oEAAoE,EACzE,KAAK,kDAAkD,EACvD,KAAK,wCAAwC,EAC7C,KAAK,qBAAqB,EAC1B,KAAK,cAAc,GACpB,MAAM,gBAAgB,CAAC"}

package/dist/pool/index.js

@@ -0,0 +1,10 @@
+/**
+ * MetricAMM SDK - Pool Functions
+ */
+// Pool creation
+export { createPool, prepareFactoryCreatePoolParams, encodeCreatePoolCalldata, preparePoolBinData, } from "./create.js";
+// Pool read functions
+export { getPoolImmutables, getPoolState, getBinState, getPositionBinShares } from "./read.js";
+// Liquidity calculations and position operations
+export { buildModifyLiquidityArgsForAddition, buildModifyLiquidityArgsForUniformAddition, buildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmount, buildModifyLiquidityArgsForPercentageRemoval, buildModifyLiquidityArgsForRemoval, buildAddLiquidityExactSharesParamsFromBinTargets, buildRemoveLiquidityPoolDelta, additionPlanToPoolLiquidityDelta, removalPlanToPoolLiquidityDelta, scaleWeightedPoolDeltasToFitCaps, encodeAddLiquidityExactSharesSelfCalldata, encodeAddLiquidityExactSharesWithOwnerCalldata, encodeAddLiquidityWeightedSelfCalldata, encodeAddLiquidityWeightedWithOwnerCalldata, encodeRemoveLiquidityCalldata, getPositionShares, getPositionSharesForBins, NO_SLIPPAGE_LIMIT, } from "./liquidity.js";
+//# sourceMappingURL=index.js.map

package/dist/pool/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pool/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,gBAAgB;AAChB,OAAO,EACL,UAAU,EACV,8BAA8B,EAC9B,wBAAwB,EACxB,kBAAkB,GAGnB,MAAM,aAAa,CAAC;AAErB,sBAAsB;AACtB,OAAO,EAAE,iBAAiB,EAAE,YAAY,EAAE,WAAW,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAE/F,iDAAiD;AACjD,OAAO,EACL,mCAAmC,EACnC,0CAA0C,EAC1C,8DAA8D,EAC9D,4CAA4C,EAC5C,kCAAkC,EAClC,gDAAgD,EAChD,6BAA6B,EAC7B,gCAAgC,EAChC,+BAA+B,EAC/B,gCAAgC,EAChC,yCAAyC,EACzC,8CAA8C,EAC9C,sCAAsC,EACtC,2CAA2C,EAC3C,6BAA6B,EAC7B,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,GAUlB,MAAM,gBAAgB,CAAC"}

package/dist/pool/liquidity.d.ts

@@ -0,0 +1,165 @@
+/**
+ * MetricAMM SDK - Liquidity
+ * Unified liquidity calculations and position operations.
+ */
+import type { Address, PublicClient, Hex } from "viem";
+import type { LiquidityDelta, LiquidityBinValueInput, PoolLiquidityDelta } from "../types.js";
+import { getPositionBinSharesRange, getPositionBinSharesForBins } from "../stateView/read.js";
+import { convertToken0ToToken1, convertToken1ToToken0 } from "../utils/liquidityMath.js";
+export { convertToken0ToToken1, convertToken1ToToken0 };
+export declare const getPositionShares: typeof getPositionBinSharesRange;
+export declare const getPositionSharesForBins: typeof getPositionBinSharesForBins;
+export interface RemoveLiquidityParams {
+    percentageToRemove: number;
+    bins?: number[];
+    lowerBin?: number;
+    upperBin?: number;
+}
+export interface BinRemovalSpec {
+    bin: number;
+    percentageToRemove?: number;
+    sharesToRemove?: bigint;
+}
+export declare const NO_SLIPPAGE_LIMIT: bigint;
+export type ModifyLiquidityArgs = readonly [bigint, LiquidityDelta[], bigint, bigint];
+export interface BuildModifyLiquidityArgsBase {
+    publicClient: PublicClient;
+    /** Factory that deployed the pool (used to read `poolImmutables`). */
+    factoryAddress: Address;
+    stateViewAddress: Address;
+    poolAddress: Address;
+    specAmountBufferPercent?: number;
+}
+export interface BuildModifyLiquidityArgsForAdditionParams extends BuildModifyLiquidityArgsBase {
+    bins: LiquidityBinValueInput[];
+    currentPrice: number;
+    salt?: bigint;
+}
+export interface BuildModifyLiquidityArgsForUniformAdditionParams extends BuildModifyLiquidityArgsBase {
+    amountInTokensPerBin: bigint;
+    amountIsInToken0: boolean;
+    currentPrice: number;
+    lowerBin: number;
+    upperBin: number;
+    salt?: bigint;
+}
+export interface BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams extends BuildModifyLiquidityArgsBase {
+    bins: number[];
+    weights?: number[];
+    totalValueToAddInToken: bigint;
+    totalValueInToken0: boolean;
+    currentPriceX64: bigint;
+    salt?: bigint;
+}
+export interface BuildModifyLiquidityArgsForPercentageRemovalParams extends BuildModifyLiquidityArgsBase {
+    owner: Address;
+    salt: bigint;
+    percentageToRemove: number;
+    bins?: number[];
+    lowerBin?: number;
+    upperBin?: number;
+}
+export interface BuildModifyLiquidityArgsForRemovalParams extends BuildModifyLiquidityArgsBase {
+    owner: Address;
+    salt: bigint;
+    specs: BinRemovalSpec[];
+}
+/**
+ * Prepare uniform liquidity distribution across a bin range.
+ */
+export declare function buildModifyLiquidityArgsForUniformAddition({ publicClient, factoryAddress, stateViewAddress, poolAddress, amountInTokensPerBin, amountIsInToken0, currentPrice, lowerBin, upperBin, salt, specAmountBufferPercent, }: BuildModifyLiquidityArgsForUniformAdditionParams): Promise<ModifyLiquidityArgs>;
+/**
+ * Prepare uniform liquidity across arbitrary bins from a TOTAL value budget.
+ *
+ * Algorithm:
+ * 1. Calibrate by assigning weighted 1e18 targets per bin with zero buffer.
+ * 2. Compute linear scale so selected specAmount token matches totalValueToAddInToken.
+ * 3. Rebuild with scaled per-bin value and caller-provided specAmountBufferPercent.
+ */
+export declare function buildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmount({ publicClient, factoryAddress, stateViewAddress, poolAddress, bins, weights, totalValueToAddInToken, totalValueInToken0, currentPriceX64, salt, specAmountBufferPercent, }: BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams): Promise<ModifyLiquidityArgs>;
+/**
+ * Prepare per-bin liquidity distribution from arbitrary per-bin amounts.
+ *
+ * Each input entry defines a single bin and a value expressed in token0 or token1.
+ * The function computes `deltaShares` for every bin and totals `specAmount0/specAmount1`
+ * needed to execute `modifyLiquidity` safely.
+ *
+ * ## Algorithm Overview
+ *
+ * This is the core distribution engine used by both:
+ * - direct per-bin plans (computeModifyLiquidityForAddition)
+ * - uniform plans via adapter (computeModifyLiquidityForUniformAddition)
+ *
+ * ## Steps
+ *
+ * 1. Validate inputs, price, bin range, and reject duplicate bins.
+ * 2. Convert each bin target into both token0/token1 amounts using current price.
+ * 3. Fetch slot0 and bin states, then classify each bin as below/current/above.
+ * 4. Compute shares to add using ceiling division to avoid under-provisioning:
+ *    - Existing bins: proportional to current scaled balances and total shares.
+ *    - Empty bins: derived from initial scaled per-share constants.
+ * 5. Convert scaled amounts back to external token amounts and accumulate
+ *    `specAmount0/specAmount1` with overflow checks.
+ */
+export declare function buildModifyLiquidityArgsForAddition({ publicClient, factoryAddress, stateViewAddress, poolAddress, bins, currentPrice, salt, specAmountBufferPercent, }: BuildModifyLiquidityArgsForAdditionParams): Promise<ModifyLiquidityArgs>;
+export declare function buildModifyLiquidityArgsForRemoval(params: BuildModifyLiquidityArgsForRemovalParams): Promise<ModifyLiquidityArgs>;
+export declare function buildModifyLiquidityArgsForPercentageRemoval({ publicClient, factoryAddress, stateViewAddress, poolAddress, owner, salt, percentageToRemove, bins, lowerBin, upperBin, specAmountBufferPercent, }: BuildModifyLiquidityArgsForPercentageRemovalParams): Promise<ModifyLiquidityArgs>;
+export declare function additionPlanToPoolLiquidityDelta(deltas: readonly LiquidityDelta[]): PoolLiquidityDelta;
+export declare function removalPlanToPoolLiquidityDelta(deltas: readonly LiquidityDelta[]): PoolLiquidityDelta;
+/**
+ * Matches `MetricOmmPoolLiquidityAdder._scaleWeightsToShares`: given probe token needs from a weighted
+ * probe with the same weight vector, scale integer shares so neither token exceeds the caller caps.
+ */
+export declare function scaleWeightedPoolDeltasToFitCaps(params: {
+    weights: PoolLiquidityDelta;
+    probeNeed0: bigint;
+    probeNeed1: bigint;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}): PoolLiquidityDelta;
+export declare function buildAddLiquidityExactSharesParamsFromBinTargets(params: BuildModifyLiquidityArgsForAdditionParams): Promise<{
+    salt: bigint;
+    poolLiquidityDelta: PoolLiquidityDelta;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}>;
+export declare function encodeAddLiquidityExactSharesSelfCalldata(params: {
+    pool: Address;
+    salt: bigint;
+    deltas: PoolLiquidityDelta;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}): Hex;
+export declare function encodeAddLiquidityExactSharesWithOwnerCalldata(params: {
+    pool: Address;
+    owner: Address;
+    salt: bigint;
+    deltas: PoolLiquidityDelta;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}): Hex;
+export declare function encodeAddLiquidityWeightedSelfCalldata(params: {
+    pool: Address;
+    salt: bigint;
+    weightDeltas: PoolLiquidityDelta;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}): Hex;
+export declare function encodeAddLiquidityWeightedWithOwnerCalldata(params: {
+    pool: Address;
+    owner: Address;
+    salt: bigint;
+    weightDeltas: PoolLiquidityDelta;
+    maxAmountToken0: bigint;
+    maxAmountToken1: bigint;
+}): Hex;
+export declare function encodeRemoveLiquidityCalldata(params: {
+    owner: Address;
+    salt: bigint;
+    deltas: PoolLiquidityDelta;
+}): Hex;
+export declare function buildRemoveLiquidityPoolDelta(params: BuildModifyLiquidityArgsForRemovalParams): Promise<{
+    salt: bigint;
+    poolLiquidityDelta: PoolLiquidityDelta;
+}>;
+//# sourceMappingURL=liquidity.d.ts.map

package/dist/pool/liquidity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquidity.d.ts","sourceRoot":"","sources":["../../src/pool/liquidity.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAIvD,OAAO,KAAK,EAAE,cAAc,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE9F,OAAO,EAGL,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAIL,qBAAqB,EACrB,qBAAqB,EAEtB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,CAAC;AACxD,eAAO,MAAM,iBAAiB,kCAA4B,CAAC;AAC3D,eAAO,MAAM,wBAAwB,oCAA8B,CAAC;AAEpE,MAAM,WAAW,qBAAqB;IACpC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,eAAO,MAAM,iBAAiB,QAAa,CAAC;AAS5C,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;AAEtF,MAAM,WAAW,4BAA4B;IAC3C,YAAY,EAAE,YAAY,CAAC;IAC3B,sEAAsE;IACtE,cAAc,EAAE,OAAO,CAAC;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,yCAA0C,SAAQ,4BAA4B;IAC7F,IAAI,EAAE,sBAAsB,EAAE,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gDAAiD,SAAQ,4BAA4B;IACpG,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,oEAAqE,SAAQ,4BAA4B;IACxH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kDAAmD,SAAQ,4BAA4B;IACtG,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wCAAyC,SAAQ,4BAA4B;IAC5F,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,cAAc,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,wBAAsB,0CAA0C,CAAC,EAC/D,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,IAAS,EACT,uBAA2B,GAC5B,EAAE,gDAAgD,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAwBjF;AAED;;;;;;;GAOG;AACH,wBAAsB,8DAA8D,CAAC,EACnF,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,IAAI,EACJ,OAAO,EACP,sBAAsB,EACtB,kBAAkB,EAClB,eAAe,EACf,IAAS,EACT,uBAA2B,GAC5B,EAAE,oEAAoE,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA0ErG;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,mCAAmC,CAAC,EACxD,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,IAAI,EACJ,YAAY,EACZ,IAAS,EACT,uBAA2B,GAC5B,EAAE,yCAAyC,GAAG,OAAO,CAAC,mBAAmB,CAAC,CA4N1E;AAED,wBAAsB,kCAAkC,CACtD,MAAM,EAAE,wCAAwC,GAC/C,OAAO,CAAC,mBAAmB,CAAC,CA6E9B;AAED,wBAAsB,4CAA4C,CAAC,EACjE,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,KAAK,EACL,IAAI,EACJ,kBAAkB,EAClB,IAAI,EACJ,QAAc,EACd,QAAa,EACb,uBAA2B,GAC5B,EAAE,kDAAkD,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAwCnF;AAED,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,SAAS,cAAc,EAAE,GAChC,kBAAkB,CAMpB;AAED,wBAAgB,+BAA+B,CAC7C,MAAM,EAAE,SAAS,cAAc,EAAE,GAChC,kBAAkB,CAMpB;AAID;;;GAGG;AACH,wBAAgB,gCAAgC,CAAC,MAAM,EAAE;IACvD,OAAO,EAAE,kBAAkB,CAAC;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,kBAAkB,CAcrB;AAED,wBAAsB,gDAAgD,CACpE,MAAM,EAAE,yCAAyC,GAChD,OAAO,CAAC;IACT,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC,CAQD;AAED,wBAAgB,yCAAyC,CAAC,MAAM,EAAE;IAChE,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,kBAAkB,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,GAAG,CAYN;AAED,wBAAgB,8CAA8C,CAAC,MAAM,EAAE;IACrE,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,kBAAkB,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,GAAG,CAaN;AAED,wBAAgB,sCAAsC,CAAC,MAAM,EAAE;IAC7D,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,kBAAkB,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,GAAG,CAYN;AAED,wBAAgB,2CAA2C,CAAC,MAAM,EAAE;IAClE,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,kBAAkB,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;CACzB,GAAG,GAAG,CAaN;AAED,wBAAgB,6BAA6B,CAAC,MAAM,EAAE;IACpD,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,kBAAkB,CAAC;CAC5B,GAAG,GAAG,CAUN;AAED,wBAAsB,6BAA6B,CACjD,MAAM,EAAE,wCAAwC,GAC/C,OAAO,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,kBAAkB,CAAA;CAAE,CAAC,CAGnE"}