This directory is the documentation hub for StellarRoute. It organizes design, deployment, API, SDK, contract, and development content so contributors can find the right guide quickly.
- Architecture overview — entry point for architecture and operational design.
- Diagrams — system, data flow, and deployment diagrams.
- Database schema — normalized liquidity model and ERD.
- Performance notes — performance guidance and optimization notes.
- Worker pool — indexer worker architecture and ingestion design.
- Reconciliation — data consistency and recovery strategy.
- Multi-region architecture — geo-distributed system design.
- Multi-region runbook — operational runbook for multi-region deployments.
- API overview — entry point for API reference.
- Routes endpoint — quote, orderbook, and route REST endpoints.
- WebSocket API — real-time quote stream API.
- Versioning — API versioning strategy.
- Versioning policy — lifecycle policy for API changes.
- Error taxonomy — standardized API error responses.
- Canonical pair ordering — rules for normalizing asset pair order.
- v1 migration guide — compatibility and migration advice.
- OpenAPI spec — machine-readable REST API schema.
- Integrator guide — quick-start and integration patterns for external API consumers.
- Integrator error guide — error handling and retry guidance for integrators.
- Contracts overview — entry point for Soroban contract docs.
- Router interface — public contract interface and event schema.
- Contract deployment runbook — Soroban contract lifecycle.
- Gas benchmarks — gas cost and performance benchmarks.
- Gas optimization — WASM and gas optimization guidance.
- Signed-live Stellar → Sepolia proof — testnet destination mint milestone (
0x713cc8b1…bed6). - Signed-live Sepolia → Stellar proof — reverse corridor signed-live (MetaMask + Freighter; Fast).
- CCTP staging enablement checklist — flip
CCTP_ENABLEDafter reverse proof. - Attestation verification — Iris + on-chain attester trust model.
- Stellar verifier status — burn/approval/mint verifier readiness.
- CCTP v2 API contract —
/api/v2/bridge/cctp/*HTTP contract.
- Deployment overview — deployment and production guides.
- Gradual rollout plan — limited pairs → full markets, metric gates, rollback, status-page templates.
- DB pool tuning — PostgreSQL pool sizing and tuning.
- Database timeout guardrails — runtime timeout strategies.
- Tracing troubleshooting — observability and tracing guidance.
- Setup guide — local environment setup and tooling.
- Indexer guide — indexer runbook, configuration, and troubleshooting.
- Testing guide — project test strategies and commands.
- Wallet integration — frontend wallet integration patterns.
- Frontend developer guide — frontend setup, workflow, and contribution patterns.
- TypeScript SDK documentation — TypeScript SDK guides and API docs.
- Rust SDK documentation — Rust SDK usage and examples.
- Kill switch runbook — emergency kill-switch activation and recovery procedure.
- Swap submitting sender-lock recovery — reconcile bound tx hash / guarded release after timebounds (classic PathPayment only; Soroban unsupported).
- Live swap testnet checklist — E2E classic prepare/sign/submit on testnet.
- CCTP signed-live evidence (forward) — Stellar → Sepolia USDC mint proof + evidence JSON.
- CCTP signed-live evidence (reverse) — Sepolia → Stellar burn/mint hashes + evidence JSON.
- Quote purger runbook — quote purger operation, scheduling, and troubleshooting.
- Routing canary — canary routing configuration, promotion, and rollback.
- Indexer lag monitoring — indexer lag alerting thresholds and remediation steps.
- Cache hierarchical invalidation — cache invalidation strategy and failure modes.
- Swap end-to-end flow — walkthrough of a complete swap from quote to on-chain settlement.
- Incident replay workflow — replay and recovery workflow.
- Audit log retention — audit log retention policy.
- Monitoring — monitoring and metrics guidance.
- Consistency strategy — data consistency guarantees and trade-offs.
- Hybrid optimizer — optimizer architecture and behavior.
- Key rotation — credential and key rotation procedures.
- Performance budget — frontend and API performance targets.
- Readiness — readiness and runbook content.
- First live swap — wallet, trustline, slippage, and confirm for non-developer traders (also
/guidein the app).
- Information architecture — sitemap, navigation hierarchy, and UX structure.
- Empty states spec — design specification for empty and error states (links the first-swap guide from swap empty state).
- Accessibility contrast audit — WCAG colour contrast audit results.
These docs live under frontend/docs/ and cover frontend-specific contributor topics.
- Motion design guidelines — animation principles and approved motion patterns.
- Telemetry schema — frontend event tracking schema and naming conventions.
- Trader error copy style guide — tone, phrasing, and copy standards for error messages.
- Debug overlay — developer debug panel usage and extension guide.
- Iconography system — icon library conventions and usage rules.
- Wallet onboarding wireframes — wireframes for the wallet connection onboarding flow.
- Quote refresh screen reader testing — accessibility testing guide for live-region quote announcements.
- Swap i18n audit — internationalisation coverage audit for swap UI strings.
- Swap visual regression — visual regression test setup and baseline management.
- Price history sparkline — implementation notes for the 24-hour price sparkline.
- Orderbook highlighting — feature spec for orderbook row highlighting.
- Hero CTA feature — implementation spec for the hero call-to-action component.
- Relative time feature — design and implementation of the relative timestamp component.
- Status page feature — feature spec for the system status page.
- Feature flags — runtime feature flag reference and usage guide.
- Storybook guide — Storybook setup, story conventions, and CI snapshot workflow.
See the main project README for an overview of StellarRoute.