@nradko/metric-omm-sdk-v1 0.0.16

package/src/index.ts

@@ -0,0 +1,157 @@
+/**
+ * MetricAMM SDK (v1 contracts: Swapper, LiquidityAdder, add/removeLiquidity).
+ *
+ * @packageDocumentation
+ */
+
+// ============ Types ============
+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";
+
+// ============ Constants ============
+export { Q64, MAX_UINT128, MAX_INT128, MAX_UINT104, MAX_INT104 } from "./constants.js";
+
+// ============ Addresses ============
+export {
+  ChainId,
+  ADDRESSES,
+  getAddresses,
+  getAddressesOrThrow,
+  isChainSupported,
+  getSupportedChainIds,
+  isChainDeployed,
+  type ChainAddresses,
+  type DeployedChainId,
+} 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,
+  type CreatePoolFactoryParams,
+  type CreatePoolParams,
+  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,
+  type ModifyLiquidityArgs,
+  type BuildModifyLiquidityArgsBase,
+  type BuildModifyLiquidityArgsForAdditionParams,
+  type BuildModifyLiquidityArgsForUniformAdditionParams,
+  type BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams,
+  type BuildModifyLiquidityArgsForPercentageRemovalParams,
+  type BuildModifyLiquidityArgsForRemovalParams,
+  type RemoveLiquidityParams,
+  type BinRemovalSpec,
+} from "./pool/liquidity.js";
+
+// ============ Swapper Functions ============
+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";
+
+// ============ Factory Functions ============
+export {
+  getFactoryAssetBalances,
+  collectFactoryFees,
+  type FactoryAssetBalance,
+  type CollectFactoryFeesParams,
+  type CollectedFactoryFeeTx,
+  type CollectFactoryFeesResult,
+} from "./factory/index.js";

package/src/pool/create.ts

@@ -0,0 +1,158 @@
+/**
+ * MetricAMM SDK - Pool creation (v1 factory `PoolParameters`).
+ */
+
+import type { Address, PublicClient, WalletClient, Hex } from "viem";
+import { encodeFunctionData, zeroAddress } from "viem";
+import { POOL_FACTORY_ABI } from "../constants.js";
+import { createUniformBins } from "../utils/binData.js";
+
+// ============ Types ============
+
+/**
+ * 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 function prepareFactoryCreatePoolParams(params: CreatePoolFactoryParams) {
+  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("")}` as Hex);
+
+  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: PublicClient,
+  walletClient: WalletClient,
+  factoryAddress: Address,
+  params: CreatePoolFactoryParams,
+  account: Address,
+): Promise<{ hash: Hex; poolAddress?: Address }> {
+  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 as Address,
+  };
+}
+
+export function encodeCreatePoolCalldata(params: CreatePoolFactoryParams): Hex {
+  const factoryParams = prepareFactoryCreatePoolParams(params);
+  const args = buildCreatePoolArgs(factoryParams);
+
+  return encodeFunctionData({
+    abi: POOL_FACTORY_ABI,
+    functionName: "createPool",
+    args,
+  });
+}
+
+function buildCreatePoolArgs(factoryParams: unknown): unknown[] {
+  const createPoolAbi = (POOL_FACTORY_ABI as readonly any[]).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: CreatePoolParams): {
+  positiveBinData: bigint[];
+  negativeBinData: bigint[];
+} {
+  const halfBins = Math.floor(params.numBins / 2);
+
+  const positiveBinData = createUniformBins(halfBins, params.binLengthE6);
+  const negativeBinData = createUniformBins(halfBins, params.binLengthE6);
+
+  return {
+    positiveBinData,
+    negativeBinData,
+  };
+}

package/src/pool/index.ts

@@ -0,0 +1,47 @@
+/**
+ * MetricAMM SDK - Pool Functions
+ */
+
+// Pool creation
+export {
+  createPool,
+  prepareFactoryCreatePoolParams,
+  encodeCreatePoolCalldata,
+  preparePoolBinData,
+  type CreatePoolFactoryParams,
+  type CreatePoolParams,
+} 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,
+  type ModifyLiquidityArgs,
+  type BuildModifyLiquidityArgsBase,
+  type BuildModifyLiquidityArgsForAdditionParams,
+  type BuildModifyLiquidityArgsForUniformAdditionParams,
+  type BuildModifyLiquidityArgsForUniformAdditionWithTotalTokenAmountParams,
+  type BuildModifyLiquidityArgsForPercentageRemovalParams,
+  type BuildModifyLiquidityArgsForRemovalParams,
+  type RemoveLiquidityParams,
+  type BinRemovalSpec,
+} from "./liquidity.js";