Quick Reference#
One-page lookup for the TetraFi protocol. Every table links to the full reference page.
API Endpoints#
Base URL: https://api.tetrafi.io/api/v1
| Method | Path | Auth | Description |
|---|---|---|---|
GET | /health | Public | Service liveness probe |
POST | /quotes | Public | Submit RFQ, receive competing quotes |
GET | /quotes/{quoteId} | Public | Quote status and details |
POST | /orders | Optional | Accept quote, trigger settlement |
GET | /orders/{orderId} | Public | Order status and tx hashes |
GET | /corridors | Public | Available trading corridors |
GET | /workspaces/{id}/settlements/{orderId} | Required | Settlement timeline and evidence hash |
POST | /solvers/register | Required | Register solver, get WS credentials |
POST | /webhooks | Required | Register webhook endpoint |
Full details: REST API Reference
SDK Methods#
Full reference: SDK Client · TypeScript · Python
Settlement State Machine#
On-Chain Escrow States
initial
normal
success
error
Hover a state to explore| State | Transition | Trigger |
|---|---|---|
| None → Deposited | open() | Taker signs + deposits |
| Deposited → Claimed | finalise() | Oracle attests solver fill |
| Deposited → Refunded | refund() | Fill deadline expires |
Full lifecycle: Settlement Flows
Key Constants#
| Constant | Value | Notes |
|---|---|---|
| All-in cost target | < 3 bps | $1M–$10M stablecoin orders |
| TetraFi take rate | 0.15–0.20 bps | ~15–30% of execution fee |
| Solver share | 70–85% | Remainder after platform fee |
| Settlement time | < 10 min | End-to-end including oracle attestation |
| Quote timeout | 500ms | Solver response window |
| Fill deadline | 10–60 min | Configurable per corridor |
| Rate limit (standard) | 100 req/min | Per API key |
| Rate limit (solver WS) | 1000 msg/min | Per WebSocket connection |
WebSocket Events#
text
1wss://api.tetrafi.io/api/v1/ws?token=tfk_live_...1 linestext
| Channel | Fires when |
|---|---|
rfq.created | RFQ broadcast to solvers |
quote.received | Solver returned a quote |
quote.accepted | Quote accepted |
settlement.pending | Escrow locking |
settlement.complete | Both legs settled |
settlement.failed | Reverted, refund issued |
rfq.* / settlement.* | Wildcard |
Supported Networks#
| Chain | Chain ID | Oracle | Status |
|---|---|---|---|
| Ethereum | 1 | Hyperlane | Live |
| Optimism | 10 | Hyperlane | Live |
| Base | 8453 | Hyperlane | Live |
| Arbitrum | 42161 | Hyperlane | Live |
| Sepolia | 11155111 | Hyperlane | Testnet |
Top 10 Glossary Terms#
| Term | Definition |
|---|---|
| RFQ | Taker broadcasts request; solvers respond with firm quotes |
| DvP | Delivery vs Payment - both legs settle or neither does |
| StandardOrder | ERC-7683 typed struct: inputs, outputs, deadlines, oracle refs |
| Solver | Liquidity provider competing to fill orders |
| Taker | Institutional client initiating trades |
| Escrow | Smart contract holding funds during settlement window |
| ResourceLock | Output-first lock via The Compact (0xff) |
| Permit2Escrow | Input-first lock via Permit2 (0x00) |
| UCCP | Uniform Corridor Clearing Price - same rate for all batch orders |
| ComplianceRegistry | On-chain KYC attestation contract |
Full glossary: Glossary (50+ terms)