@oddmaki-protocol/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 oddmaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,106 @@
+# OddMaki SDK
+
+TypeScript SDK for the [OddMaki Protocol](https://github.com/oddmaki/oddmaki-core) — a fully on-chain prediction market factory on Base. Built on [viem](https://viem.sh/).
+
+## Install
+
+```bash
+pnpm add @oddmaki/sdk viem
+```
+
+## Quick Start
+
+```typescript
+import { createOddMakiClient } from "@oddmaki/sdk";
+
+const client = createOddMakiClient({
+  walletClient, // viem WalletClient
+});
+
+// Read markets
+const markets = await client.public.getMarkets(venueId);
+
+// Place a limit order — buy YES at $0.65, 100 USDC, expires in 24h
+await client.trade.placeOrderSimple(marketId, outcomeId, "buy", "0.65", "100", "24h");
+
+// Place a market order (Fill-or-Kill)
+await client.trade.placeMarketOrderSimple(marketId, outcomeId, "50", "0.70", 0);
+```
+
+## Modules
+
+The client exposes functional modules covering the full protocol:
+
+| Module | Purpose |
+|---|---|
+| `venue` | Create and configure venues (fee structure, access control, oracle params) |
+| `market` | Create markets and market groups, read pricing and positions |
+| `trade` | Limit orders, market orders (FOK/FAK), batch operations, split/merge |
+| `public` | Subgraph queries — markets, trades, orderbook, analytics, leaderboards |
+| `token` | ERC20 approvals and balance checks |
+| `uma` | UMA oracle lifecycle — assert, settle, report, redeem |
+| `accessControl` | Deploy and manage access control contracts (whitelist, NFT-gated, token-gated) |
+| `priceMarket` | Pyth-powered price markets with automatic resolution |
+
+## Trade API
+
+Both raw and simplified interfaces are available. The simple API accepts human-readable strings:
+
+```typescript
+// Limit order
+await client.trade.placeOrderSimple(marketId, outcomeId, "buy", "0.65", "100", "24h");
+
+// Market order: spend 50 USDC, max price $0.70, Fill-or-Kill
+await client.trade.placeMarketOrderSimple(marketId, outcomeId, "50", "0.70", 0);
+
+// Batch: place up to 20 orders atomically
+await client.trade.batchPlaceOrdersSimple(marketId, orders);
+
+// Cancel and replace in a single transaction
+await client.trade.cancelAndReplace(cancelIds, marketId, newOrders);
+```
+
+## Subgraph Queries
+
+The `public` module provides indexed reads:
+
+```typescript
+// Unified feed (standalone markets + groups)
+const feed = await client.public.getUnifiedMarketFeed(venueId);
+
+// Trader profile and positions
+const profile = await client.public.getTraderProfile(address);
+const positions = await client.public.getTraderPositions(address);
+
+// Leaderboard
+const leaders = await client.public.getLeaderboard("totalVolume", "desc");
+```
+
+## Utilities
+
+```typescript
+import { priceToTick, tickToPrice, parseAmount } from "@oddmaki/sdk";
+
+priceToTick("0.80");    // 80n
+tickToPrice(80n);        // "0.80"
+parseAmount("10.5");     // 10500000n (6 decimals)
+```
+
+## Development
+
+```bash
+pnpm install
+pnpm run build
+pnpm run test
+pnpm run lint
+```
+
+## Related
+
+- [oddmaki-core](https://github.com/oddmaki/oddmaki-core) — Smart contracts
+- [oddmaki-subgraph](https://github.com/oddmaki/oddmaki-subgraph) — Subgraph
+- [oddmaki-venue-starter](https://github.com/oddmaki/oddmaki-venue-starter) — Venue starter template
+
+## License
+
+[MIT](./LICENSE)