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 and node layer specifications
- indexing/ - Indexing pipeline specifications
- database/ - Database architecture specifications
- api/ - API layer specifications
- mempool/ - Mempool and real-time specifications
- multichain/ - Multi-chain architecture specifications
- ccip/ - CCIP integration specifications
- actions/ - Action layer specifications
- banking/ - Banking layer specifications
- vtm/ - Virtual Teller Machine specifications
- frontend/ - Frontend architecture specifications
- xr/ - XR experience specifications
- security/ - Security and privacy specifications
- observability/ - Observability specifications
- deployment/ - Deployment and operations specifications
Documentation Standards
Each specification document follows a standard structure:
- Overview: High-level description
- Architecture: System design with diagrams
- Data Models: Schemas and interfaces
- API Contracts: Request/response formats
- Algorithms: Key algorithms and data structures
- Integration Points: How components integrate
- Security Considerations: Security requirements
- Performance Requirements: Latency, throughput, scalability targets
- Implementation Guidelines: Code structure and patterns
- Testing Strategy: How to test the component
- Monitoring & Observability: What to monitor
Quick Links
Phase 0 (Foundations)
Phase 1 (Blockscout+ Parity)
Phase 2-6 (Advanced Features)
- See respective directories for multi-chain, CCIP, actions, banking, VTM, and XR specifications
References
- Platform Plan - High-level platform plan
- Existing Blockscout Integration: See
../../docs/BLOCKSCOUT_COMPLETE_SUMMARY.md