8bb5f28fd2
- Introduced a modular architecture for data processing, including common utilities for validation, transformation, and aggregation. - Implemented `StandardizedTrade`, `OHLCVCandle`, and `TimeframeBucket` classes for unified data handling across exchanges. - Developed `OKXDataProcessor` for OKX-specific data validation and processing, leveraging the new common framework. - Enhanced `OKXCollector` to utilize the common data processing utilities, improving modularity and maintainability. - Updated documentation to reflect the new architecture and provide guidance on the data processing framework. - Created comprehensive tests for the new data processing components to ensure reliability and functionality.
44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
# Architecture & Design Documentation
|
|
|
|
This section contains high-level system architecture documentation and design decisions for the TCP Trading Platform.
|
|
|
|
## Documents
|
|
|
|
### [Architecture Overview](architecture.md)
|
|
Comprehensive overview of the system architecture, including:
|
|
- Component relationships and data flow
|
|
- Technology stack and infrastructure decisions
|
|
- Scalability and performance considerations
|
|
- Security architecture and best practices
|
|
|
|
### [Data Processing Refactor](data-processing-refactor.md)
|
|
Documentation of the major refactoring of the data processing system:
|
|
- Migration from monolithic to modular architecture
|
|
- Common utilities framework for all exchanges
|
|
- Right-aligned timestamp aggregation strategy
|
|
- Future leakage prevention mechanisms
|
|
- Exchange-specific component design patterns
|
|
|
|
### [Crypto Bot PRD](crypto-bot-prd.md)
|
|
Product Requirements Document defining:
|
|
- Platform objectives and scope
|
|
- Functional and non-functional requirements
|
|
- User stories and acceptance criteria
|
|
- Technical constraints and assumptions
|
|
|
|
## Quick Navigation
|
|
|
|
- **New to the platform?** Start with [Architecture Overview](architecture.md)
|
|
- **Understanding data processing?** See [Data Processing Refactor](data-processing-refactor.md)
|
|
- **Product requirements?** Check [Crypto Bot PRD](crypto-bot-prd.md)
|
|
- **Implementation details?** See [Technical Reference](../reference/)
|
|
|
|
## Related Documentation
|
|
|
|
- [Technical Reference](../reference/) - Detailed specifications and API documentation
|
|
- [Core Components](../components/) - Implementation details for system components
|
|
- [Exchange Integrations](../exchanges/) - Exchange-specific documentation
|
|
|
|
---
|
|
|
|
*For the complete documentation index, see the [main documentation README](../README.md).* |