Welcome to the comprehensive documentation for the Open Intent Framework (OIF) Aggregator. This documentation provides everything you need to understand, configure, deploy, and integrate with the OIF Aggregator.
- Quick Start Guide - Step-by-step setup with working examples
- Configuration Guide - Complete configuration reference
- API Documentation - Interactive API reference with Swagger UI
- Testing UI - Modern React-based UI for visual testing and exploration
- Quotes & Aggregation Guide - How quote aggregation works
- Circuit Breaker Implementation Guide - Automatic failure protection system
- Docker Guide - Container deployment and development workflows
- Security Guide - Security best practices and considerations
- Maintenance Guide - System maintenance and monitoring
- Custom Adapter Guide - How to implement and register custom solver adapters
- OIF Adapter Guide - Complete guide for OIF adapter with JWT authentication
- Across Adapter Guide - Complete guide for Across Protocol integration
- Interactive API Docs - Live Swagger UI
- GitHub Repository - Source code and issues
docs/
├── README.md # This overview page
├── quick-start.md # Step-by-step setup guide
├── configuration.md # Complete configuration reference
├── quotes-and-aggregation.md # Quote system and aggregation logic
├── custom-adapters.md # Custom adapter implementation guide
├── oif-adapter.md # OIF adapter guide with JWT authentication
├── across-adapter.md # Across Protocol adapter guide
├── docker.md # Docker deployment and development
├── security.md # Security guidelines and best practices
├── maintenance.md # System maintenance and monitoring
└── api/ # API documentation
├── README.md # API documentation guide
├── index.html # Interactive Swagger UI
└── openapi.json # OpenAPI 3.1 specification
- Step-by-step setup from zero to running server
- Basic configuration examples that work
- API testing with real requests
- Programmatic usage examples
- Troubleshooting common setup issues
- Modern React + TypeScript interface for aggregator testing
- Visual quote comparison and solver exploration
- Order submission with EIP-712 signing support
- Real-time health monitoring and solver status
- Light/dark themes and responsive design
- Environment variables and their usage
- JSON configuration file structure
- Server, security, and solver settings
- Timeout and rate limiting configuration
- Storage backend configuration
- Complete quotes endpoint documentation
- How aggregation logic works step-by-step
- Solver selection and ranking algorithms
- Integration examples and best practices
- Error handling and monitoring
- Interactive Swagger UI for testing endpoints
- Complete OpenAPI 3.1 specification
- Request/response schemas and examples
- Authentication and error handling
- HMAC integrity verification configuration
- Integrity secret setup and best practices
- Secure secret generation methods
- Production security checklist
- SolverAdapter trait implementation
- Registration and configuration
- Error handling and testing
- Best practices for custom integrations
- JWT authentication configuration with
adapter_metadata - Token management and automatic refresh
- HTTP client caching with authentication support
- Across Protocol integration with dynamic query parameters
- Cross-chain bridge configuration through
requestParamsmetadata - Request parameter reference
- Container deployment and development workflows
- Environment variable configuration
- Production and development Docker setups
- Health monitoring and metrics
- Log management and debugging
- Performance tuning
- Troubleshooting common issues
Documentation improvements are always welcome! Here's how to contribute:
- API Documentation - Auto-generated from code annotations using
utoipa - Configuration - Update when adding new configuration options
- Security - Add new security considerations or best practices
- Maintenance - Include new operational procedures or troubleshooting
# Regenerate OpenAPI specification
./scripts/generate-openapi.sh
# The API docs are automatically deployed to GitHub Pages
# when changes are pushed to the main branch- Issues: GitHub Issues
- API Testing: Interactive Swagger UI
📝 Last Updated: Documentation is kept up-to-date with each release. API documentation is automatically regenerated from code annotations.