62 lines
2.6 KiB
Markdown
62 lines
2.6 KiB
Markdown
# Technical Specifications Index
|
|
|
|
This directory contains comprehensive technical specifications for all major components of the ChainID 138 Explorer+ and Virtual Banking VTM Platform.
|
|
|
|
## Directory Structure
|
|
|
|
- [infrastructure/](./infrastructure/) - Infrastructure and node layer specifications
|
|
- [indexing/](./indexing/) - Indexing pipeline specifications
|
|
- [database/](./database/) - Database architecture specifications
|
|
- [api/](./api/) - API layer specifications
|
|
- [mempool/](./mempool/) - Mempool and real-time specifications
|
|
- [multichain/](./multichain/) - Multi-chain architecture specifications
|
|
- [ccip/](./ccip/) - CCIP integration specifications
|
|
- [actions/](./actions/) - Action layer specifications
|
|
- [banking/](./banking/) - Banking layer specifications
|
|
- [vtm/](./vtm/) - Virtual Teller Machine specifications
|
|
- [frontend/](./frontend/) - Frontend architecture specifications
|
|
- [xr/](./xr/) - XR experience specifications
|
|
- [security/](./security/) - Security and privacy specifications
|
|
- [observability/](./observability/) - Observability specifications
|
|
- [deployment/](./deployment/) - Deployment and operations specifications
|
|
|
|
## Documentation Standards
|
|
|
|
Each specification document follows a standard structure:
|
|
|
|
1. **Overview**: High-level description
|
|
2. **Architecture**: System design with diagrams
|
|
3. **Data Models**: Schemas and interfaces
|
|
4. **API Contracts**: Request/response formats
|
|
5. **Algorithms**: Key algorithms and data structures
|
|
6. **Integration Points**: How components integrate
|
|
7. **Security Considerations**: Security requirements
|
|
8. **Performance Requirements**: Latency, throughput, scalability targets
|
|
9. **Implementation Guidelines**: Code structure and patterns
|
|
10. **Testing Strategy**: How to test the component
|
|
11. **Monitoring & Observability**: What to monitor
|
|
|
|
## Quick Links
|
|
|
|
### Phase 0 (Foundations)
|
|
- [Infrastructure Specifications](./infrastructure/)
|
|
- [Indexing Pipeline](./indexing/)
|
|
- [Database Schema](./database/)
|
|
- [API Gateway](./api/api-gateway.md)
|
|
- [REST API](./api/rest-api.md)
|
|
|
|
### Phase 1 (Blockscout+ Parity)
|
|
- [Contract Verification](./indexing/verification-pipeline.md)
|
|
- [Search Index](./database/search-index-schema.md)
|
|
- [GraphQL API](./api/graphql-api.md)
|
|
- [WebSocket API](./api/websocket-api.md)
|
|
|
|
### Phase 2-6 (Advanced Features)
|
|
- See respective directories for multi-chain, CCIP, actions, banking, VTM, and XR specifications
|
|
|
|
## References
|
|
|
|
- [Platform Plan](../../chain_id_138_explorer_virtual_banking_vtm_platform_plan.md) - High-level platform plan
|
|
- Existing Blockscout Integration: See `../../docs/BLOCKSCOUT_COMPLETE_SUMMARY.md`
|
|
|