# Developer Integration ## ABI Locations After building with `forge build`, full ABIs are emitted to: ``` contracts/out/.sol/.json ``` Extract the `abi` field for use in frontends or scripts: ```bash jq '.abi' contracts/out/MarketFactory.sol/MarketFactory.json > abi/MarketFactory.json ``` Pre-extracted frontend ABIs are available in `frontend/src/lib/contracts/abis/`. ## Contract Addresses Deploy scripts print all addresses as JSON to stdout. After deployment, save this output and use it to configure your application. See [Deployments](/smart-contracts/deployments.md) for currently deployed addresses. ## Interacting with Contracts ### Using wagmi/viem (TypeScript) ```typescript import { readContract, writeContract } from '@wagmi/core'; import { parseEther } from 'viem'; import MarketFactoryABI from './abis/MarketFactory.json'; import VaultABI from './abis/Vault.json'; import OrderBookABI from './abis/OrderBook.json'; // Read market metadata const meta = await readContract({ address: MARKET_FACTORY_ADDRESS, abi: MarketFactoryABI, functionName: 'marketMeta', args: [factoryMarketId], }); // Approve Vault for USDT (one-time) await writeContract({ address: USDT_ADDRESS, abi: erc20ABI, functionName: 'approve', args: [VAULT_ADDRESS, parseEther('1000')], }); ``` ### Using ethers.js (v6) ```typescript import { Contract, parseEther } from 'ethers'; // Approve Vault for USDT (one-time) const usdt = new Contract(USDT_ADDRESS, erc20ABI, signer); await usdt.approve(VAULT_ADDRESS, parseEther('1000')); const orderBook = new Contract(ORDERBOOK_ADDRESS, OrderBookABI, signer); const tx = await orderBook.placeOrder( orderBookMarketId, 0, // Side.Bid 1, // OrderType.GoodTilCancel 60, // tick 10 // lots ); ``` ## Market ID Types Strike uses two distinct market ID systems. Understanding the difference is critical. | ID | Source | Used By | | ------------------- | ------------------------------------- | ------------------------------------------------- | | `factoryMarketId` | Sequential counter in `MarketFactory` | MarketFactory, PythResolver, Redemption, frontend | | `orderBookMarketId` | Sequential counter in `OrderBook` | OrderBook, BatchAuction, Vault, OutcomeToken | The mapping is stored in `MarketFactory.marketMeta[factoryMarketId].orderBookMarketId`. **When to use which:** * **User-facing / API:** Always use `factoryMarketId`. It is the canonical market identifier for resolution, redemption, and display. * **Trading operations:** `OrderBook.placeOrder` and `BatchAuction.clearBatch` use `orderBookMarketId`. * **Token IDs:** `OutcomeToken` derives UP/DOWN token IDs from `orderBookMarketId` (`marketId*2` = UP, `marketId*2+1` = DOWN). ## Key Flows ### 1. Approve Vault for USDT ```solidity usdt.approve(address(vault), type(uint256).max); ``` One-time approval. The Vault uses `safeTransferFrom` to pull USDT when orders are placed. ### 2. Place an Order ```solidity uint256 orderId = orderBook.placeOrder( orderBookMarketId, // from marketMeta Side.Bid, // 0 = Bid (UP), 1 = Ask (DOWN) OrderType.GoodTilCancel, // 0 = GoodTilBatch, 1 = GoodTilCancel 60, // tick (1-99, price = tick/100) 10 // lots (each = $0.01) ); ``` Collateral is locked in the Vault automatically: * Bid: `lots * LOT_SIZE * tick / 100` * Ask: `lots * LOT_SIZE * (100 - tick) / 100` Where `LOT_SIZE = 1e16 = $0.01`. ### 3. Batch Clearing (Atomic Settlement) ```solidity // Anyone can trigger (keepers do this automatically) batchAuction.clearBatch(orderBookMarketId); ``` Finds the clearing tick via the segment tree, records the `BatchResult`, and **settles all orders atomically** in the same transaction: * Filled collateral (at clearing price) moves to the market's redemption pool * Excess refund (order tick vs clearing tick difference) returned to owner * Uniform fee (20 bps) deducted and sent to `protocolFeeCollector` * Unfilled collateral returned (GoodTilBatch) or rolled to next batch (GoodTilCancel) * Positions credited: Bid fills receive UP positions, Ask fills receive DOWN positions No separate claim step is needed — settlement happens inline. ### 4. Redeem After Resolution ```solidity redemption.redeem(factoryMarketId, tokenAmount); ``` Burns `tokenAmount` winning outcome tokens and pays out `tokenAmount * LOT_SIZE` ($0.01 per lot) USDT from the market's redemption pool. ### 5. AI-Resolved and Flap Token Pool Markets AI-resolved markets are now exposed through multiple market families. The public creator flow is **Flap Token Pools**, where creators choose a BEP20 collateral token, define 2–8 outcomes, and store an on-chain prompt. Strike's hosted flow uploads hash-checked metadata before the on-chain create transaction so the pool can be listed in the app. For the public Flap Token Pool flow: * creators do **not** choose the AI model, * Strike covers the AI fee, * the creator posts the configured `0.05 BNB` creator bond, * the prompt should be a token-data question resolvable from Ave-supported data. The older `MarketFactory.createAIMarket(...)` orderbook path is an admin/protocol integration surface, not the recommended public creator flow. Public integrations should use the current app flow and indexer/API surfaces until a dedicated Flap Token Pool SDK is published. See: * [Flap Token Pools](/getting-started/flap-token-pools.md) * [AI Markets](/protocol/ai-markets.md) * ## Collateral Formulas All values in wei. `LOT_SIZE = 1e16` ($0.01). | Side | Collateral Required | | ---------- | -------------------------------------- | | Bid (UP) | `lots * LOT_SIZE * tick / 100` | | Ask (DOWN) | `lots * LOT_SIZE * (100 - tick) / 100` | Tick represents implied probability (1--99%). A bid at tick 60 means "willing to pay 60% of LOT\_SIZE per lot for UP exposure." ## Reading Market State ```solidity // Get full market metadata (factoryMarketId) (bytes32 priceId, int64 strikePrice, uint256 expiryTime, uint256 creationBond, address creator, MarketState state, bool outcomeYes, int64 settlementPrice, uint256 orderBookMarketId) = factory.marketMeta(factoryMarketId); // Get batch result (orderBookMarketId) BatchResult memory result = batchAuction.getBatchResult(orderBookMarketId, batchId); ``` ## Getting Price Data from Pyth Hermes API PythResolver requires Pyth price update data. Fetch it from the Hermes REST API: ```bash # Get price update for BTC/USD curl "https://hermes.pyth.network/v2/updates/price/latest?ids[]=0xe62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43" ``` In TypeScript: ```typescript const HERMES_URL = 'https://hermes.pyth.network'; async function getPriceUpdate(priceId: string): Promise { const resp = await fetch( `${HERMES_URL}/v2/updates/price/latest?ids[]=${priceId}` ); const data = await resp.json(); return data.binary.data.map((d: string) => '0x' + d); } // Use with PythResolver const priceUpdateData = await getPriceUpdate(priceId); const fee = await pythResolver.read.getPythUpdateFee([priceUpdateData]); await pythResolver.write.resolveMarket( [factoryMarketId, priceUpdateData], { value: fee } ); ``` ### Common Pyth Price Feed IDs | Asset | Price Feed ID | | ------- | -------------------------------------------------------------------- | | BTC/USD | `0xe62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43` | | BNB/USD | `0x2f95862b045670cd22bee3114c39763a4a08beeb663b145d283c31d7d1101c4f` | ## Indexer REST API The Strike indexer provides a REST API under the `/v1/` prefix (legacy unprefixed routes remain for backward compatibility). ### Key Endpoints | Endpoint | Description | | ------------------------------- | ----------------------------------------------------------------- | | `GET /v1/markets` | List markets (supports `?status=active&limit=50&offset=0&since=`) | | `GET /v1/markets/:id/orderbook` | Aggregated bid/ask levels | | `GET /v1/markets/:id/trades` | Cleared batches (empty batches filtered by default) | | `GET /v1/positions/:address` | Open orders and filled positions for a wallet | | `GET /v1/stats` | Aggregate protocol statistics (volume, active markets) | All list endpoints return paginated responses: ```json { "data": [...], "meta": { "total": 42, "limit": 50, "offset": 0 } } ``` ### WebSocket Real-time order book updates and batch clearing events are available via WebSocket. See the [SDK Events](/sdk/events.md) page or the strike-infra documentation for details. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.strike.pm/guides/developer-integration.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.