@nradko/metric-omm-sdk-v1

TypeScript SDK for v1 Metric OMM contracts: Swapper, LiquidityAdder, pool addLiquidity / removeLiquidity, and factory-backed reads.

Pinned to the same commits as dev_metric-deploy/versions.env.

Installation

npm install @nradko/metric-omm-sdk-v1 viem

Or via the combined package:

import { v1 } from "@nradko/metric-omm-sdk";

Ethereum mainnet addresses

| Contract | Address | | -------- | ------- | | MetricOmmPoolFactory | 0xf98aD80FE666B9a23075CdF64aF5971802844Fd8 | | MetricOmmPoolDeployer | 0xf93e1ea4516E99A4Ee81D4979C8D3C8Ab636e397 | | MetricOmmPoolLiquidityAdder | 0x05632ffd8D4a22ac6f925B9fc7b60390d436467D | | MetricOmmPoolDataProvider | 0xAce0Ec0040e81eE3496EeE768db8F453f2f0B9Bb | | DepositAllowlist | 0x497B15B9640eCbfFB96C1CFF7e6A3D8Ec5C6dAE2 | | SwapAllowlist | 0x657f8CAC2066481b3Cd421781410e383f173433D | | MetricOmmPoolSwapper | 0x377421359e849cc44da76b18511f6A5Dd5abFc23 | | WETH | 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2 |

MetricOmmPoolDataProvider is the deployed lens: pool reads (slot0, binStates, positionBinShares, …) plus swap depth and revert-based quotes. Pass addresses.dataProvider to read helpers and liquidity builders (dataProviderAddress param).

import { getAddressesOrThrow, ChainId, isChainSupported } from "@nradko/metric-omm-sdk-v1";

const a = getAddressesOrThrow(ChainId.ETHEREUM);
// isChainSupported(ChainId.BASE) === false — use DeployedChainId / getSupportedChainIds() for bundled addresses

ChainId lists future chain IDs for typing; only Ethereum mainnet has entries in ADDRESSES for this release. Use getSupportedChainIds(), isChainSupported(), or DeployedChainId when you need compile-time guarantees.

Swaps (Swapper)

import {
  buildArgsAndExpectedAmountsForSwapExactInput,
  getAddressesOrThrow,
  ChainId,
} from "@nradko/metric-omm-sdk-v1";
import { MetricOmmPoolSwapperAbi } from "@nradko/metric-omm-sdk-v1/abis";

const addresses = getAddressesOrThrow(ChainId.ETHEREUM);

const { args, expectedInput, expectedOutput } =
  await buildArgsAndExpectedAmountsForSwapExactInput({
    publicClient,
    factoryAddress: addresses.factory,
    swapperAddress: addresses.swapper,
    pool: poolAddress,
    recipient: account,
    zeroForOne: true,
    amountIn: 1_000_000_000_000_000_000n,
    slippagePercent: 0.5,
    deadline: BigInt(Math.floor(Date.now() / 1000) + 1200),
  });

await walletClient.writeContract({
  address: addresses.swapper,
  abi: MetricOmmPoolSwapperAbi,
  functionName: "swapExactInput",
  args,
  account,
});

Quote without building tx args: quoteSwap (read-only pool quote), quoteExpectedAmountsForSwapExactInput / quoteExpectedAmountsForSwapExactOutput (Swapper-aligned estimates for slippage math).

Liquidity

• Add (EOA): approve LiquidityAdder, then addLiquidityExactShares / addLiquidityWeighted on the adder (see encodeAddLiquidity* helpers).
• Remove: removeLiquidity on the pool — build deltas with buildModifyLiquidityArgsForRemoval / encodeRemoveLiquidityCalldata.

SDK builders still use internal names like buildModifyLiquidityArgsForUniformAddition where the math is shared; encoders target v1 pool/adder ABIs.

Pool reads

import { getPoolImmutables, getPoolState, getSlot0, getAddressesOrThrow, ChainId } from "@nradko/metric-omm-sdk-v1";

const addresses = getAddressesOrThrow(ChainId.ETHEREUM);
const imm = await getPoolImmutables(publicClient, addresses.factory, poolAddress);
const state = await getPoolState(publicClient, addresses.dataProvider, poolAddress);
const slot0 = await getSlot0(publicClient, addresses.dataProvider, poolAddress);

ABIs

import {
  MetricOmmPoolAbi,
  MetricOmmPoolDataProviderAbi,
  MetricOmmPoolSwapperAbi,
  MetricOmmPoolLiquidityAdderAbi,
} from "@nradko/metric-omm-sdk-v1/abis";

Regenerate from pinned contracts:

npm run setup:contracts    # init submodules, hardhat build, sync ABIs

All pinned contracts (including MetricOmmPoolDataProvider) are compiled by Hardhat from the pinned @metric/core and @metric/periphery git dependencies (periphery remappings use core's libs via lib/metric-core).

Development

npm run build              # tsc only (default prepare)
npm run setup:contracts    # refresh ABIs from pinned git deps (maintainers)
npm test                   # Hardhat tests (needs matching @metric/* in node_modules)

In the monorepo, run v1 tests with an isolated install (same pattern as v0):

# from dev_sdk/
cd v1
npm ci
npm run sync:contracts   # required before first test run
npm test

Tests

npm run sync:contracts && npm test

Fork tests: set ETHEREUM_RPC_URL (optional ETHEREUM_FORK_BLOCK_NUMBER).