Docs status#
A corpus-wide view of every doc page grouped by lifecycle status frontmatter. Use this to audit roadmap pages, spot what just shipped, and find what's still experimental.
- Shipped pages are production-stable - breaking changes follow a deprecation window.
- Beta and Testnet pages are integration-ready but subject to tightening.
- Planned and Experimental pages are roadmap artefacts - don't wire CI against them.
Planned
(5)On the roadmap - design complete, not yet building.
Architecture
Data Layer & Evidence
WORM evidence ledger, hash-chained audit trail, credit system, workspace model, and data archival.
Integration
Python SDK
Complete reference for the tetrafi Python package - installation, initialization, methods, async support.
Integration
React Components
Premade React components for embedding TetraFi functionality - SwapWidget, PriceStream, SettlementStatus.
Integration
SDK Client
TetraFi SDK reference - TypeScript and Python. Installation, initialization, core methods, types, and error handling.
Integration
TypeScript SDK
Complete reference for the @tetrafi/sdk TypeScript package - installation, initialization, methods, types.
Testnet
(1)Running on public testnets - exercise, don't rely on it yet.
Shipped
(33)Stable - production traffic, breaking changes follow deprecation windows.
Expand to browse all 33 stable pages →
Shipped
(33)Stable - production traffic, breaking changes follow deprecation windows.
Architecture
Architecture
How the TetraFi settlement protocol is built - contracts, oracles, compliance, data, and the quote pipeline.
Architecture
Architecture Comparisons
Side-by-side deep dives on the most-asked TetraFi architecture decisions.
Architecture
Architecture Explorer
Stage-by-stage traversal of the protocol - pick a phase to see just the components active in it, and click any node to open its reference doc.
Architecture
Architecture Overview
Understand the TetraFi settlement protocol end-to-end: watch a full settlement, walk the 5-phase flow, and read the compliance, cross-chain, and security model.
Architecture
Compliance Architecture
ComplianceRegistry attestation model, settlement path routing, KYC/KYB onboarding, Travel Rule, and WORM evidence ledger.
Architecture
Intent Netting & Batch Auction
Batch auction mechanics, CIP-67 fair winner selection, UCCP pricing, and four intent netting modes.
Architecture
Oracle Network
7 cross-chain oracle implementations, relay mechanisms, attestation verification, and oracle selection per corridor.
Architecture
Quote Pipeline & Auction
RFQ auction mechanics, quote preferences, swap types, selection strategies, batch auctions, and intent netting.
Architecture
ResourceLock vs Permit2Escrow
Output-first versus input-first settlement locks - when to choose each and why.
Architecture
RFQ vs Dutch Auction
Quote-first competition versus time-decaying price - price discovery trade-offs for cross-chain intents.
Architecture
Settlement Flows
Lock types, escrow models, settlement path routing, equivocation protection, and the fill/claim lifecycle.
Architecture
TetraFi vs Bridge + Swap
Single-signature intent-based settlement versus multi-tx bridge-then-swap paths.
Integration
All SDK Methods
Unified index of every method across TypeScript and Python SDKs. Filter by language, namespace, and status; sort by name, namespace, or version.
Integration
API Changelog
Version-by-version feed of SDK method additions and deprecations, auto-compiled from every <MethodIndex> block across the SDK docs.
Integration
Authentication
API key management, authentication headers, environments, rate limits, error handling, and pagination.
Integration
Compare SDK Methods
Side-by-side comparison of SDK methods. Pick 2-4 methods to see namespaces, return types, versions, and deprecation status in one matrix.
Integration
Custody & Signing
Fireblocks, AWS KMS, and hardware wallet integration for EIP-712 order signing and settlement.
Integration
Docs Changelog
When TetraFi documentation pages were last reviewed or materially updated.
Integration
Error Code Registry
Canonical reference for every API error code. Entries here mirror the inline tables in authentication, api-reference, and events - keep these synchronised.
Integration
Integration
Connect to TetraFi - authentication, REST API, webhooks, SDK clients, and end-to-end guides for Takers and Solvers.
Integration
LLM-Ready Docs
Plain-text index and raw-markdown routes for AI tools, LLM-aware IDEs, and code assistants ingesting TetraFi docs.
Integration
MCP (Model Context Protocol)
Connect Claude Desktop, Cursor, Windsurf, or any MCP-aware agent to the TetraFi docs corpus in one click.
Integration
REST API Reference
Complete endpoint reference for quotes, orders, settlements, workspaces, solvers, and webhooks.
Integration
SDK
Typed TypeScript and Python client libraries - core concepts, per-language references, and a unified method index.
Integration
SDK Version History
Version-grouped roll-up of every SDK method - what was added, deprecated, and changed per release.
Integration
Solver Integration Guide
Step-by-step guide for solvers (market makers) to connect, price, and fill orders on TetraFi.
Integration
Taker Integration Guide
Step-by-step guide for institutional takers to submit orders, receive quotes, and execute settlement.
Integration
Webhooks & Events
Real-time WebSocket events, webhook configuration, signature verification, and retry logic.
Overview
Core Concepts
Key terminology, the Intent Execution Stack, and a high-level overview of how a TetraFi trade works.
Overview
Quick Reference
One-page jump table: API endpoints, supported networks, and glossary pointers. Each row links to its canonical reference page.
Platform
Discovery & Corridors
Network discovery, corridor configuration, member onboarding, and workspace management.
Platform
Platform Personas
Four participant types: Direct Users, Companies, Brokers, and LPs - onboarding, workspace, and data visibility.
Platform
Protocol Economics
Fee structure, solver incentives, target order economics, and comparison with traditional OTC settlement.
How status is assigned#
Each page declares status: in its frontmatter:
1---2title: "Taker end-to-end"3status: "Shipped"4---Pages without a status field default to Shipped. The page-level status is reflected in:
- The sidebar (a coloured dot next to non-Shipped entries)
- The page header (a badge next to the interaction-type pill)
- Search results and command-palette rows
- Prev / Next navigation