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.
- v1 migration guide — compatibility and migration advice.
- OpenAPI spec — machine-readable REST API schema.
- 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.
- Deployment overview — deployment and production guides.
- 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.
- Testing guide — project test strategies and commands.
- Wallet integration — frontend wallet integration patterns.
- TypeScript SDK documentation — TypeScript SDK guides and API docs.
- Rust SDK documentation — Rust SDK usage and examples.
- Monitoring — monitoring and metrics guidance.
- Readiness — readiness and runbook content.
- Audit log retention — audit log retention policy.
- Hybrid optimizer — optimizer architecture and behavior.
- Incident replay workflow — replay and recovery workflow.
See the main project README for an overview of StellarRoute.