b57df47ddc
Create 8 missing READMEs (config, ctrader-openapi, market-data, ml-data, model_loader, risk-data, trading-data, training_uploader). Update 9 existing READMEs to standard template format. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
25 lines
738 B
Markdown
25 lines
738 B
Markdown
# common
|
|
|
|
Shared types, error handling, and utilities for the Foxhunt HFT ecosystem.
|
|
|
|
## Key Types
|
|
|
|
- `FoxhuntError` — unified error enum with `Result` alias
|
|
- `ModelType` — canonical ML model enum (10 primary variants)
|
|
- `CircuitBreakerTrait` — async circuit breaker interface
|
|
- `TlsProtocolVersion`, `ClientIdentity` — TLS configuration types
|
|
- Market data types (`Tick`, `OrderBook`) and order types (`LimitOrder`, `MarketOrder`)
|
|
|
|
## Modules
|
|
|
|
- `model_types` — canonical `ModelType` enum re-exported by ml/ and model_loader/
|
|
- `resilience` — `CircuitBreakerTrait` async trait
|
|
- `tls` — TLS types and configuration
|
|
- `questdb` — QuestDB client configuration
|
|
|
|
## Usage
|
|
|
|
```rust
|
|
use common::{FoxhuntError, ModelType};
|
|
```
|