chapaty 1.1.1

An event-driven Rust engine for building and evaluating quantitative trading agents. Features a Gym-style API for algorithmic backtesting and reinforcement learning.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use std::{fmt::Debug, hash::Hash};

use serde::{Deserialize, Serialize};

use crate::{
    data::{
        common::ProfileAggregation,
        domain::{
            CountryCode, DataBroker, EconomicCategory, EconomicDataSource, EconomicEventImpact,
            Exchange, Period, Symbol,
        },
        event::{EconomicCalendarId, OhlcvId, TpoId, TradesId, VolumeProfileId},
        indicator::{EmaWindow, RsiWindow, SmaWindow, TechnicalIndicator},
    },
    error::ChapatyResult,
};

// ================================================================================================
// OHLCV Configurations
// ================================================================================================

/// Configuration for retrieving OHLCV (Open, High, Low, Close, Volume) data from spot markets.
///
/// OHLCV data represents aggregated price and volume information over specified time periods,
/// commonly used for candlestick charts and technical analysis.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct OhlcvSpotConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// The timeframe for each OHLCV candle (e.g., "1m", "5m", "1h", "1d").
    pub period: Period,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,

    // Data configurations that support derived technical analysis.
    pub indicators: Vec<TechnicalIndicator>,
}

/// Configuration for retrieving OHLCV (Open, High, Low, Close, Volume) data from futures markets.
///
/// Similar to spot OHLCV data, but specifically for futures contracts which include
/// additional fields like open interest and funding rates.
#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct OhlcvFutureConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The futures contract symbol. Must be a valid futures symbol format.
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// The timeframe for each OHLCV candle (e.g., "1m", "5m", "1h", "1d").
    pub period: Period,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,

    // Data configurations that support derived technical analysis.
    pub indicators: Vec<TechnicalIndicator>,
}

// ================================================================================================
// Trade Data Configuration
// ================================================================================================

/// Configuration for retrieving trade-level spot market data.
///
/// Trade data represents individual trades or price updates at the finest granularity,
/// capturing every market transaction with microsecond precision.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TradeSpotConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    /// Consider larger batch sizes for trade data to optimize throughput.
    pub batch_size: i32,
}

// ================================================================================================
// TPO Configurations
// ================================================================================================

/// Configuration for retrieving Time Price Opportunity (TPO) data from spot markets.
///
/// TPO, also known as Market Profile, displays market activity organized by price level
/// and time, showing where trading activity has occurred and helping identify
/// key support/resistance levels.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TpoSpotConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

/// Configuration for retrieving Time Price Opportunity (TPO) data from futures markets.
///
/// TPO data for futures markets, providing Market Profile insights for futures contracts.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct TpoFutureConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The futures contract symbol.
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Volume Profile Configuration
// ================================================================================================

/// Configuration for retrieving Volume Profile data from spot markets.
///
/// Volume Profile shows the distribution of trading volume across different price levels,
/// helping identify high-volume nodes (HVN) and low-volume nodes (LVN) that often act
/// as support or resistance.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct VolumeProfileSpotConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// The trading pair symbol (e.g., "btc-usdt", "eth-usdt").
    pub symbol: Symbol,

    /// Optional exchange name. If `None`, defaults to the broker's primary exchange.
    pub exchange: Option<Exchange>,

    /// Optional aggregation parameters for profile construction.
    ///
    /// If `None`, uses default aggregation (1m timeframe, finest price granularity).
    pub aggregation: Option<ProfileAggregation>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Economic Calendar Configuration
// ================================================================================================

/// Configuration for retrieving economic calendar events.
///
/// Economic calendar data provides scheduled releases of economic indicators,
/// central bank announcements, and other market-moving events.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
pub struct EconomicCalendarConfig {
    /// The data broker to query from.
    pub broker: DataBroker,

    /// Optional filter by specific data source (e.g., "investingcom", "fred").
    ///
    /// If `None`, retrieves data from all available sources for the broker.
    pub data_source: Option<EconomicDataSource>,

    /// Optional filter by country using ISO 3166-1 alpha-2 code (e.g., "US", "GB", "JP").
    ///
    /// Special code "EZ" represents the Euro Zone. Country codes must be uppercase.
    /// If `None`, retrieves data for all countries.
    pub country_code: Option<CountryCode>,

    /// Optional filter by economic category.
    ///
    /// If `None`, retrieves events across all categories.
    pub category: Option<EconomicCategory>,

    /// Optional filter by economic importance.
    ///
    /// If `None`, retrieves any importance.
    pub importance: Option<EconomicEventImpact>,

    /// Number of records to stream per batch.
    ///
    /// Valid range: 100-10000. Defaults to 1000 if not specified.
    pub batch_size: i32,
}

// ================================================================================================
// Traits
// ================================================================================================

/// A trait for data configurations that support derived technical analysis.
///
/// This trait enables fluent, compile-time checked configuration of indicators
/// on OHLCV data streams.
pub trait TechnicalAnalysis {
    /// Adds a technical indicator to be computed for this data stream.
    fn add_indicator(&mut self, kind: TechnicalIndicator);

    /// Fluent builder version of `add_indicator`.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_indicator(TechnicalIndicator::Sma(SmaWindow(20)));
    /// ```
    fn with_indicator(mut self, kind: TechnicalIndicator) -> Self
    where
        Self: Sized,
    {
        self.add_indicator(kind);
        self
    }

    // === Ergonomic Sugar Helpers ===

    /// Adds a Simple Moving Average (SMA) indicator.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_sma(20);
    /// ```
    fn with_sma(self, window: u16) -> Self
    where
        Self: Sized,
    {
        self.with_indicator(TechnicalIndicator::Sma(SmaWindow(window)))
    }

    /// Adds an Exponential Moving Average (EMA) indicator.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_ema(12);
    /// ```
    fn with_ema(self, window: u16) -> Self
    where
        Self: Sized,
    {
        self.with_indicator(TechnicalIndicator::Ema(EmaWindow(window)))
    }

    /// Adds a Relative Strength Index (RSI) indicator.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_rsi(14);
    /// ```
    fn with_rsi(self, window: u16) -> Self
    where
        Self: Sized,
    {
        self.with_indicator(TechnicalIndicator::Rsi(RsiWindow(window)))
    }

    // === Multi-indicator Helpers ===

    /// Adds multiple indicators at once.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_indicators(vec![
    ///     TechnicalIndicator::Sma(SmaWindow(20)),
    ///     TechnicalIndicator::Ema(EmaWindow(12)),
    /// ]);
    /// ```
    fn with_indicators(mut self, kinds: Vec<TechnicalIndicator>) -> Self
    where
        Self: Sized,
    {
        for kind in kinds {
            self.add_indicator(kind);
        }
        self
    }

    /// Chainable helper to add multiple SMAs.
    ///
    /// # Example
    /// ```
    /// # use chapaty::prelude::*;
    /// let config = OhlcvSpotConfig {
    ///     broker: DataBroker::Binance,
    ///     symbol: Symbol::Spot(SpotPair::BtcUsdt),
    ///     exchange: None,
    ///     period: Period::Minute(1),
    ///     batch_size: 1000,
    ///     indicators: vec![],
    /// }
    /// .with_smas(&[20, 50, 200]);
    /// ```
    fn with_smas(mut self, windows: &[u16]) -> Self
    where
        Self: Sized,
    {
        for &window in windows {
            self.add_indicator(TechnicalIndicator::Sma(SmaWindow(window)));
        }
        self
    }

    /// Chainable helper to add multiple EMAs.
    fn with_emas(mut self, windows: &[u16]) -> Self
    where
        Self: Sized,
    {
        for &window in windows {
            self.add_indicator(TechnicalIndicator::Ema(EmaWindow(window)));
        }
        self
    }
}

impl TechnicalAnalysis for OhlcvSpotConfig {
    fn add_indicator(&mut self, kind: TechnicalIndicator) {
        self.indicators.push(kind);
    }
}

impl TechnicalAnalysis for OhlcvFutureConfig {
    fn add_indicator(&mut self, kind: TechnicalIndicator) {
        self.indicators.push(kind);
    }
}

/// Maps a configuration type to its corresponding stream identifier.
///
/// This trait enables type-safe conversion from user-facing configuration
/// (which includes wire protocol details like batch_size) to internal
/// domain identifiers used for stream management.
pub trait ConfigId {
    /// The unique identifier type for this configuration's data stream.
    type Id: Copy + PartialEq + Eq + Hash + PartialOrd + Ord + Debug + Send + Sync;

    /// Converts this configuration into its corresponding stream identifier.
    ///
    /// This method extracts only the fields that uniquely identify a data stream,
    /// omitting operational parameters like batch_size or indicators.
    ///
    /// # Errors
    ///
    /// Returns an error if the configuration contains invalid broker/exchange
    /// combinations or if required conversions fail.
    fn to_id(&self) -> ChapatyResult<Self::Id>;
}
impl ConfigId for OhlcvSpotConfig {
    type Id = OhlcvId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(OhlcvId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            period: self.period,
        })
    }
}

impl ConfigId for OhlcvFutureConfig {
    type Id = OhlcvId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(OhlcvId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            period: self.period,
        })
    }
}

impl ConfigId for TradeSpotConfig {
    type Id = TradesId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TradesId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
        })
    }
}

impl ConfigId for TpoSpotConfig {
    type Id = TpoId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TpoId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl ConfigId for TpoFutureConfig {
    type Id = TpoId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(TpoId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl ConfigId for VolumeProfileSpotConfig {
    type Id = VolumeProfileId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        let exchange = match self.exchange {
            Some(ex) => ex,
            None => self.broker.try_into()?,
        };

        Ok(VolumeProfileId {
            broker: self.broker,
            exchange,
            symbol: self.symbol,
            aggregation: self.aggregation.unwrap_or_default(),
        })
    }
}

impl ConfigId for EconomicCalendarConfig {
    type Id = EconomicCalendarId;

    fn to_id(&self) -> ChapatyResult<Self::Id> {
        Ok(EconomicCalendarId {
            broker: self.broker,
            data_source: self.data_source,
            country_code: self.country_code,
            category: self.category,
            importance: self.importance,
        })
    }
}