@nradko/metric-omm-sdk-v1 0.0.16

package/src/abis/PriceProviderUi.ts

@@ -0,0 +1,317 @@
+export const PriceProviderUiAbi = [
+  {
+    type: "constructor",
+    inputs: [
+      { name: "_factory", type: "address", internalType: "address" },
+      { name: "_oracle", type: "address", internalType: "address" },
+      { name: "_offchainFeedId", type: "bytes32", internalType: "bytes32" },
+      { name: "_cexStep", type: "int256", internalType: "int256" },
+      { name: "_maxTimeDelta", type: "uint256", internalType: "uint256" },
+      { name: "_maxClDeviation", type: "uint16", internalType: "uint16" },
+      { name: "_baseTokenOverride", type: "address", internalType: "address" },
+      { name: "_quoteTokenOverride", type: "address", internalType: "address" },
+    ],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "BPS_BASE",
+    inputs: [],
+    outputs: [{ name: "", type: "int256", internalType: "int256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "BPS_BASE_U",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "MAGIC_COOLDOWN",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "MAGIC_MAX",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "MAX_TIME_DELTA",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "baseToken",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "cexStep",
+    inputs: [],
+    outputs: [{ name: "", type: "int256", internalType: "int256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "factory",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getAskPrice",
+    inputs: [],
+    outputs: [{ name: "askPrice", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getAskPriceUi",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getBidAndAskPrice",
+    inputs: [],
+    outputs: [
+      { name: "bid", type: "uint128", internalType: "uint128" },
+      { name: "ask", type: "uint128", internalType: "uint128" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getBidAndAskPriceUi",
+    inputs: [],
+    outputs: [
+      { name: "bid", type: "uint128", internalType: "uint128" },
+      { name: "ask", type: "uint128", internalType: "uint128" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getBidPrice",
+    inputs: [],
+    outputs: [{ name: "bidPrice", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getBidPriceUi",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "getTokens",
+    inputs: [],
+    outputs: [
+      { name: "", type: "address", internalType: "address" },
+      { name: "", type: "address", internalType: "address" },
+    ],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "lastMagicUpdate",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "magicNumber",
+    inputs: [],
+    outputs: [{ name: "", type: "uint256", internalType: "uint256" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "maxClDeviation",
+    inputs: [],
+    outputs: [{ name: "", type: "uint16", internalType: "uint16" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "offchainFeedId",
+    inputs: [],
+    outputs: [{ name: "", type: "bytes32", internalType: "bytes32" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "offchainOracle",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "contract IOffchainOracle" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "quoteToken",
+    inputs: [],
+    outputs: [{ name: "", type: "address", internalType: "address" }],
+    stateMutability: "view",
+  },
+  {
+    type: "function",
+    name: "removeClOracle",
+    inputs: [{ name: "token", type: "address", internalType: "address" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "setCexStep",
+    inputs: [{ name: "_cexStep", type: "int256", internalType: "int256" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "setClOracle",
+    inputs: [
+      { name: "token", type: "address", internalType: "address" },
+      { name: "oracle", type: "address", internalType: "address" },
+      { name: "heartbeat", type: "uint32", internalType: "uint32" },
+    ],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "setMagicNumber",
+    inputs: [{ name: "newMagic", type: "uint256", internalType: "uint256" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "function",
+    name: "setMaxClDeviation",
+    inputs: [{ name: "newMaxDeviation", type: "uint16", internalType: "uint16" }],
+    outputs: [],
+    stateMutability: "nonpayable",
+  },
+  {
+    type: "event",
+    name: "CexStepUpdated",
+    inputs: [
+      {
+        name: "newCexStep",
+        type: "int256",
+        indexed: true,
+        internalType: "int256",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "ClOracleRemoved",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "ClOracleSet",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "oracle",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "heartbeat",
+        type: "uint32",
+        indexed: false,
+        internalType: "uint32",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "ClOracleStateSet",
+    inputs: [
+      {
+        name: "token",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+      {
+        name: "oracle",
+        type: "address",
+        indexed: true,
+        internalType: "address",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "MagicNumberSet",
+    inputs: [
+      {
+        name: "newMagic",
+        type: "uint256",
+        indexed: true,
+        internalType: "uint256",
+      },
+    ],
+    anonymous: false,
+  },
+  {
+    type: "event",
+    name: "MaxClDeviationUpdated",
+    inputs: [
+      {
+        name: "newMaxClDeviation",
+        type: "uint16",
+        indexed: true,
+        internalType: "uint16",
+      },
+    ],
+    anonymous: false,
+  },
+  { type: "error", name: "BadCreationRequest", inputs: [] },
+  { type: "error", name: "CexStepOutOfBounds", inputs: [] },
+  { type: "error", name: "ClOracleNotFound", inputs: [] },
+  { type: "error", name: "CooldownNotElapsed", inputs: [] },
+  { type: "error", name: "FeedStalled", inputs: [] },
+  { type: "error", name: "MagicNumberOutOfBounds", inputs: [] },
+  { type: "error", name: "MaxClDeviationOutOfBounds", inputs: [] },
+  { type: "error", name: "MaxTimeDeltaOutOfBounds", inputs: [] },
+  { type: "error", name: "OnlyFactory", inputs: [] },
+  { type: "error", name: "Pow10ExponentTooLarge", inputs: [] },
+] as const;

package/src/abis/index.ts

@@ -0,0 +1,11 @@
+/**
+ * MetricAMM Contract ABIs (v1)
+ */
+
+export { MetricOmmPoolAbi } from "./MetricOmmPool.js";
+export { MetricOmmPoolStateViewAbi } from "./MetricOmmPoolStateView.js";
+export { MetricOmmPoolSwapperAbi } from "./MetricOmmPoolSwapper.js";
+export { MetricOmmPoolLiquidityAdderAbi } from "./MetricOmmPoolLiquidityAdder.js";
+export { MetricOmmPoolFactoryAbi } from "./MetricOmmPoolFactory.js";
+export { PriceProviderAbi } from "./PriceProvider.js";
+export { PriceProviderUiAbi } from "./PriceProviderUi.js";

package/src/addresses.ts

@@ -0,0 +1,100 @@
+/**
+ * MetricAMM SDK — v1 deployed addresses.
+ *
+ * Only Ethereum mainnet is configured (no other chain deployments for this release).
+ * State view (`test/MetricOmmPoolStateView.sol` in core) is not part of the periphery bundle;
+ * set `stateView` on the returned object when you deploy it, or pass its address into read helpers directly.
+ */
+
+import type { Address } from "viem";
+
+// ============ Chain IDs ============
+
+export const ChainId = {
+  ETHEREUM: 1,
+  BASE: 8453,
+  ARBITRUM: 42161,
+  AVALANCHE: 43114,
+  BNB: 56,
+  POLYGON: 137,
+  MEGAETH: 4326,
+  HYPEREVM: 999,
+  MONAD: 143,
+} as const;
+
+export type ChainId = (typeof ChainId)[keyof typeof ChainId];
+
+/** Chains that have entries in `ADDRESSES` for this SDK release. */
+export type DeployedChainId = typeof ChainId.ETHEREUM;
+
+// ============ Contract Address Types ============
+
+export interface ChainAddresses {
+  /** MetricOmmPoolFactory */
+  factory: Address;
+  /** MetricOmmPoolDeployer */
+  poolDeployer: Address;
+  /** MetricOmmPoolLiquidityAdder */
+  liquidityAdder: Address;
+  /** MetricOmmPoolSwapDataProvider */
+  swapDataProvider: Address;
+  /** DepositAllowlist */
+  depositAllowlist: Address;
+  /** SwapAllowlist */
+  swapAllowlist: Address;
+  /** MetricOmmPoolSwapper */
+  swapper: Address;
+  /** Wrapped native (WETH on Ethereum) */
+  wrappedNative: Address;
+  /**
+   * Optional `MetricOmmPoolStateView` used by batch read helpers.
+   * Not included in the v1 Ethereum deploy manifest; wire when you deploy the state view.
+   */
+  stateView?: Address;
+}
+
+// ============ Deployed addresses ============
+
+export const ADDRESSES: Record<DeployedChainId, ChainAddresses> = {
+  [ChainId.ETHEREUM]: {
+    factory: "0x93e314a9a65a15f3c3bc039bb4261dbbbc343fba",
+    poolDeployer: "0xe56e89c4faeec39364b5a2cbde13c572a876afb6",
+    liquidityAdder: "0x1f2a03dc43947c6bdebb2e6136222997e49fa3e9",
+    swapDataProvider: "0x404bdb6d2b9ed34a5637211a8d52177c38c39d02",
+    depositAllowlist: "0xea700fcd860533474e1ff920b76914113ae56681",
+    swapAllowlist: "0x5269d78af4a288e1649be6bf169a51bb94b6eb78",
+    swapper: "0x85e4ff47427f1a62ed19a3abf97b80c333da266c",
+    wrappedNative: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+  },
+} as const;
+
+// ============ Helper Functions ============
+
+export function getAddresses(chainId: number): ChainAddresses | undefined {
+  if (chainId !== ChainId.ETHEREUM) return undefined;
+  return ADDRESSES[ChainId.ETHEREUM];
+}
+
+export function getAddressesOrThrow(chainId: number): ChainAddresses {
+  const addresses = getAddresses(chainId);
+  if (!addresses) {
+    throw new Error(
+      `Chain ${chainId} has no v1 deployment in this SDK (only Ethereum mainnet is configured)`,
+    );
+  }
+  return addresses;
+}
+
+export function isChainSupported(chainId: number): chainId is DeployedChainId {
+  return chainId === ChainId.ETHEREUM;
+}
+
+export function getSupportedChainIds(): DeployedChainId[] {
+  return [ChainId.ETHEREUM];
+}
+
+export function isChainDeployed(chainId: number): boolean {
+  const addresses = getAddresses(chainId);
+  if (!addresses) return false;
+  return addresses.factory !== "0x0000000000000000000000000000000000000000";
+}

package/src/constants.ts

@@ -0,0 +1,35 @@
+/**
+ * MetricAMM SDK Constants (v1)
+ */
+
+import type { Abi } from "viem";
+import { MetricOmmPoolAbi } from "./abis/MetricOmmPool.js";
+import { MetricOmmPoolStateViewAbi } from "./abis/MetricOmmPoolStateView.js";
+import { MetricOmmPoolSwapperAbi } from "./abis/MetricOmmPoolSwapper.js";
+import { MetricOmmPoolLiquidityAdderAbi } from "./abis/MetricOmmPoolLiquidityAdder.js";
+import { MetricOmmPoolFactoryAbi } from "./abis/MetricOmmPoolFactory.js";
+
+// ============ Numeric Constants ============
+
+/** Q64 format multiplier (2^64) */
+export const Q64 = 2n ** 64n;
+
+/** Max uint128 value for no price limit */
+export const MAX_UINT128 = 2n ** 128n - 1n;
+
+/** Max int128 value for no slippage limit */
+export const MAX_INT128 = 2n ** 127n - 1n;
+
+/** Max position in bin */
+export const MAX_UINT104 = 2n ** 104n - 1n;
+
+/** Max int104 value */
+export const MAX_INT104 = 2n ** 103n - 1n;
+
+// ============ Internal ABI References ============
+
+export const POOL_ABI = MetricOmmPoolAbi as Abi;
+export const STATE_VIEW_ABI = MetricOmmPoolStateViewAbi as Abi;
+export const SWAPPER_ABI = MetricOmmPoolSwapperAbi as Abi;
+export const LIQUIDITY_ADDER_ABI = MetricOmmPoolLiquidityAdderAbi as Abi;
+export const POOL_FACTORY_ABI = MetricOmmPoolFactoryAbi as Abi;

package/src/factory/collectFees.ts

@@ -0,0 +1,197 @@
+/**
+ * MetricAMM SDK - Factory Fee Collection
+ */
+
+import {
+  erc20Abi,
+  zeroAddress,
+  type Address,
+  type Hex,
+  type PublicClient,
+  type TransactionReceipt,
+  type WalletClient,
+} from "viem";
+import { POOL_FACTORY_ABI } from "../constants.js";
+
+export interface FactoryAssetBalance {
+  asset: Address;
+  amount: bigint;
+  isNative: boolean;
+}
+
+export interface CollectFactoryFeesParams {
+  publicClient: PublicClient;
+  walletClient: WalletClient;
+  factoryAddress: Address;
+  target: Address;
+  assets: Address[];
+  account: Address;
+  awaitReceipts?: boolean;
+}
+
+export interface CollectedFactoryFeeTx {
+  asset: Address;
+  amount: bigint;
+  isNative: boolean;
+  hash: Hex;
+  receipt?: TransactionReceipt;
+}
+
+export interface CollectFactoryFeesResult {
+  balances: FactoryAssetBalance[];
+  collected: CollectedFactoryFeeTx[];
+}
+
+/**
+ * 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: PublicClient,
+  factoryAddress: Address,
+  assets: Address[],
+): Promise<FactoryAssetBalance[]> {
+  const uniqueAssets = dedupeAssets(assets);
+  const nativeAsset = zeroAddress.toLowerCase();
+
+  const erc20Assets = uniqueAssets.filter((asset) => asset.toLowerCase() !== nativeAsset);
+
+  const erc20Balances = new Map<string, bigint>();
+
+  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: Address[] = [];
+
+    results.forEach((result, index) => {
+      const asset = erc20Assets[index];
+      if (result.status === "success") {
+        erc20Balances.set(asset.toLowerCase(), result.result as bigint);
+        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: CollectFactoryFeesParams,
+): Promise<CollectFactoryFeesResult> {
+  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: CollectedFactoryFeeTx[] = [];
+
+  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: CollectedFactoryFeeTx = {
+        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: CollectedFactoryFeeTx = {
+      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: Address[]): Address[] {
+  const deduped: Address[] = [];
+  const seen = new Set<string>();
+
+  for (const asset of assets) {
+    const key = asset.toLowerCase();
+    if (seen.has(key)) {
+      continue;
+    }
+    seen.add(key);
+    deduped.push(asset);
+  }
+
+  return deduped;
+}

package/src/factory/index.ts

@@ -0,0 +1,12 @@
+/**
+ * MetricAMM SDK - Factory Functions
+ */
+
+export {
+  getFactoryAssetBalances,
+  collectFactoryFees,
+  type FactoryAssetBalance,
+  type CollectFactoryFeesParams,
+  type CollectedFactoryFeeTx,
+  type CollectFactoryFeesResult,
+} from "./collectFees.js";