SDK Reference

The @oddmaki-protocol/sdk provides a typed TypeScript client for interacting with the OddMaki protocol on Base. It wraps the Diamond ABIs, handles decimal/tick conversions, and exposes subgraph queries through a single ergonomic client.

Installation

Published on npm: npmjs.com/package/@oddmaki-protocol/sdk

pnpm add @oddmaki-protocol/sdk viem

Peer dependencies: viem. The SDK is built on viem clients — bring your own PublicClient and WalletClient.

Client Setup

import { createOddMakiClient } from '@oddmaki-protocol/sdk';
import { base } from 'viem/chains';
import { createPublicClient, createWalletClient, custom, http } from 'viem';

const publicClient = createPublicClient({
  chain: base,
  transport: http(),
});

const walletClient = createWalletClient({
  chain: base,
  transport: custom(window.ethereum!),
});

const client = createOddMakiClient({
  publicClient,
  walletClient,
  // chain defaults to base mainnet; pass `baseSepolia` to target the testnet
});

The client exposes eight modules: venue, market, trade, priceMarket, accessControl, public, token, and uma.

Raw vs. Simple API

Most trading and market methods come in two flavours:

• Raw — accepts bigint ticks and onchain units. Use for backend bots or when you've already done the math.
• Simple — accepts human strings like "0.80" for price, "100" for quantity, "24h" for expiry. The SDK parses them.

Prefer Simple variants when building UIs; prefer raw variants when precision matters and inputs are already canonical.

Modules

Venue

Market

Trade

PriceMarket

Pyth-powered price markets — create, query, resolve, and invalidate.

UMA

For discretionary binary and grouped markets.

AccessControl

Deploy pre-built access-control contracts and set per-venue or per-market overrides.

Factory methods return a tx hash — extract the deployed contract from the AccessControlDeployed event in the receipt.

Public

Read-only queries via the subgraph.

Token

ERC-20 helpers for the collateral token.

Conversion Utilities

import {
  priceToTick,
  tickToPrice,
  parseTokenAmount,
  formatAmount,
  createExpiry,
} from '@oddmaki-protocol/sdk';

priceToTick('0.75');                     // 75n (at 1% tick size)
tickToPrice(75n);                        // "0.75"
parseTokenAmount('100.5', 6);            // 100500000n (USDC, 6 decimals)
formatAmount(100500000n, 6);             // "100.5"
createExpiry('24h');                     // BigInt(now + 86400)
createExpiry('gtc');                     // 0n

Decimals are cached per chainId-tokenAddress, so conversions are cheap after the first call.

Approvals

Most write operations require prior token approvals:

Most Simple variants accept an autoApprove: true flag and handle approvals for you when the caller is EOA.

What's Next

• Access Control → — configure who can trade and create markets
• Creating Markets → — market creation examples (binary, grouped, price)
• Batch Operations → — batch place, cancel, and replace
• Resolution → — UMA and Pyth resolution flows
• Price Markets → — Pyth-fed auto-resolving markets