longtrader-worker 0.2.1

Local strategy host running portable strategies against pluggable backends (exchange daemon / terminal API / mock)
Documentation
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
//! Ichimoku Cloud trend-following strategy over the worker candle-poll model.
//!
//! Computes the five Ichimoku lines (Tenkan-sen, Kijun-sen, Senkou Span A,
//! Senkou Span B, Chikou displacement). A long entry requires:
//!   - Tenkan-sen above Kijun-sen (momentum),
//!   - Close above the Cloud (trend),
//!   - Cloud bullish (Senkou A above Senkou B).
//!
//! The mirror condition (Tenkan below Kijun, close below Cloud, Cloud bearish) enters a short.
//!
//! Exits happen on a Tenkan/Kijun recross or when price re-enters the Cloud.

use std::{collections::VecDeque, sync::Arc};

use async_trait::async_trait;
use color_eyre::Result;
use rust_decimal::Decimal;
use serde::Deserialize;
use tokio::sync::Mutex;

use crate::{
    ports::{MarketDataSource, TradingGateway},
    strategies::{CommonParams, Strategy, fetch_candles, market_order, params_from_table},
};

/// Config for the Ichimoku strategy.
#[derive(Debug, Clone, Deserialize)]
pub struct IchimokuConfig {
    #[serde(flatten)]
    pub common: CommonParams,
    #[serde(default = "default_tenkan")]
    pub tenkan_period: usize,
    #[serde(default = "default_kijun")]
    pub kijun_period: usize,
    #[serde(default = "default_senkou_b")]
    pub senkou_b_period: usize,
    #[serde(default = "default_qty")]
    pub qty: Decimal,
}

const fn default_tenkan() -> usize {
    9
}
const fn default_kijun() -> usize {
    26
}
const fn default_senkou_b() -> usize {
    52
}
fn default_qty() -> Decimal {
    Decimal::new(1, 3)
}

impl IchimokuConfig {
    /// Parses config from the `[strategy.params]` table.
    ///
    /// # Errors
    /// Propagates deserialization errors.
    pub fn from_params(table: &toml::Table) -> Result<Self> {
        params_from_table(table)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Phase {
    Flat,
    Long,
    Short,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Signal {
    Enter(bool),
    Exit,
}

impl Phase {
    const fn exit_side(self) -> bool {
        matches!(self, Self::Short)
    }
}

/// Ichimoku Cloud strategy.
pub struct Ichimoku {
    config: IchimokuConfig,
    gateway: Arc<dyn TradingGateway>,
    market: Arc<dyn MarketDataSource>,
    phase: Mutex<Phase>,
}

impl Ichimoku {
    pub fn new(
        config: IchimokuConfig,
        gateway: Arc<dyn TradingGateway>,
        market: Arc<dyn MarketDataSource>,
    ) -> Self {
        Self { config, gateway, market, phase: Mutex::new(Phase::Flat) }
    }

    /// Rolling highest-high / lowest-low over a window.
    fn window_extremes(
        bars: &VecDeque<(Decimal, Decimal)>,
        window: usize,
    ) -> Option<(Decimal, Decimal)> {
        let n = bars.len();
        if n < window {
            return None;
        }
        let mut hi = Decimal::MIN;
        let mut lo = Decimal::MAX;
        for (h, l) in bars.iter().skip(n - window).take(window) {
            if *h > hi {
                hi = *h;
            }
            if *l < lo {
                lo = *l;
            }
        }
        Some((hi, lo))
    }

    /// Midpoint (highest high + lowest low) / 2 — the Ichimoku line formula.
    fn line_value(bars: &VecDeque<(Decimal, Decimal)>, window: usize) -> Option<Decimal> {
        let (hi, lo) = Self::window_extremes(bars, window)?;
        Some((hi + lo) / Decimal::from(2))
    }

    /// One poll cycle.
    pub async fn tick(&self) -> Result<()> {
        let exchange = self.config.common.proto_exchange_id();
        // Displaced Senkou A/B look kijun_period into the future, and Senkou B
        // needs its own full window on top of that.
        let need = self.config.senkou_b_period + self.config.kijun_period + 10;
        let candles = fetch_candles(
            self.market.as_ref(),
            &exchange,
            &self.config.common.symbol,
            &self.config.common.timeframe,
            need as u32,
        )
        .await?;

        let mut bars = VecDeque::with_capacity(need);
        let mut closes = Vec::with_capacity(candles.len());
        for candle in &candles {
            let (Some(h), Some(l), Some(c)) =
                (candle.high.as_option(), candle.low.as_option(), candle.close.as_option())
            else {
                continue;
            };
            let (Ok(h), Ok(l), Ok(c)) = (
                longtrader_contract::ext::common_to_decimal(h),
                longtrader_contract::ext::common_to_decimal(l),
                longtrader_contract::ext::common_to_decimal(c),
            ) else {
                continue;
            };
            bars.push_back((h, l));
            closes.push(c);
        }

        let n = bars.len();
        if n < self.config.senkou_b_period + self.config.kijun_period {
            tracing::debug!("ichimoku warmup incomplete: {n} bars");
            return Ok(());
        }

        let tenkan = match Self::line_value(&bars, self.config.tenkan_period) {
            Some(v) => v,
            None => return Ok(()),
        };
        let kijun = match Self::line_value(&bars, self.config.kijun_period) {
            Some(v) => v,
            None => return Ok(()),
        };

        // Senkou spans are forward-displaced: their *current* value is computed
        // kijun_period bars ago.
        let senkou_src = n - self.config.kijun_period;
        let mut sub = VecDeque::with_capacity(self.config.senkou_b_period);
        for item in bars
            .iter()
            .skip(senkou_src.saturating_sub(self.config.senkou_b_period))
            .take(self.config.senkou_b_period)
        {
            sub.push_back(*item);
        }
        let senkou_b = Self::line_value(&sub, self.config.senkou_b_period)
            .expect("sub-window covers senkou_b_period");

        // Senkou A = (Tenkan + Kijun) / 2 at the same displacement.
        let tenkan_src = if senkou_src >= self.config.tenkan_period {
            let mut s = VecDeque::with_capacity(self.config.tenkan_period);
            for item in bars
                .iter()
                .skip(senkou_src - self.config.tenkan_period)
                .take(self.config.tenkan_period)
            {
                s.push_back(*item);
            }
            Self::line_value(&s, self.config.tenkan_period).unwrap_or(tenkan)
        } else {
            tenkan
        };
        let kijun_src = if senkou_src >= self.config.kijun_period {
            let mut s = VecDeque::with_capacity(self.config.kijun_period);
            for item in bars
                .iter()
                .skip(senkou_src - self.config.kijun_period)
                .take(self.config.kijun_period)
            {
                s.push_back(*item);
            }
            Self::line_value(&s, self.config.kijun_period).unwrap_or(kijun)
        } else {
            kijun
        };
        let senkou_a = (tenkan_src + kijun_src) / Decimal::from(2);

        let close = *closes.last().expect("non-empty");
        let cloud_top = senkou_a.max(senkou_b);
        let cloud_bottom = senkou_a.min(senkou_b);
        let price_above_cloud = close > cloud_top;
        let price_below_cloud = close < cloud_bottom;
        let price_in_cloud = !price_above_cloud && !price_below_cloud;
        let cloud_bullish = senkou_a > senkou_b;

        let held = *self.phase.lock().await;
        let signal = match held {
            Phase::Flat => {
                if tenkan > kijun && price_above_cloud && cloud_bullish {
                    Signal::Enter(true)
                } else if tenkan < kijun && price_below_cloud && !cloud_bullish {
                    Signal::Enter(false)
                } else {
                    return Ok(());
                }
            }
            Phase::Long => {
                if price_in_cloud || tenkan < kijun {
                    Signal::Exit
                } else {
                    return Ok(());
                }
            }
            Phase::Short => {
                if price_in_cloud || tenkan > kijun {
                    Signal::Exit
                } else {
                    return Ok(());
                }
            }
        };

        let is_buy = match signal {
            Signal::Enter(is_buy) => is_buy,
            Signal::Exit => held.exit_side(),
        };

        let coid = format!("ichi-{}", ulid::Ulid::generate());
        self.gateway
            .create_order(market_order(
                &exchange,
                &self.config.common.symbol,
                coid,
                is_buy,
                self.config.qty,
            ))
            .await?;
        match signal {
            Signal::Enter(is_buy) if is_buy => *self.phase.lock().await = Phase::Long,
            Signal::Enter(_) => *self.phase.lock().await = Phase::Short,
            Signal::Exit => *self.phase.lock().await = Phase::Flat,
        }
        tracing::info!(side = if is_buy { "buy" } else { "sell" }, %tenkan, %kijun, "ichimoku signal traded");
        Ok(())
    }
}

#[async_trait]
impl Strategy for Ichimoku {
    async fn run(&self) -> Result<()> {
        let poll = std::time::Duration::from_secs(self.config.common.poll_secs.max(1));
        loop {
            if let Err(err) = self.tick().await {
                tracing::error!(error = %err, "ichimoku tick failed");
            }
            tokio::time::sleep(poll).await;
        }
    }
}

#[cfg(test)]
mod tests {
    use std::sync::{Arc as StdArc, Mutex as StdMutex};

    use async_trait::async_trait;
    use proptest::prelude::*;
    use rust_decimal::Decimal;
    use rust_decimal_macros::dec;

    use super::*;
    use crate::{
        adapters::MockAdapter,
        ports::{MarketDataSource, MarketEventStream, OverflowPolicy, PortError, TradingGateway},
        proto::{market, trading},
    };

    #[test]
    fn config_parses_from_params_table() {
        let table: toml::Table = toml::from_str(
            r#"
            symbol = "SOLUSDT"
            tenkan_period = 9
            kijun_period = 26
            senkou_b_period = 52
            qty = "0.01"
            "#,
        )
        .expect("valid toml");
        let cfg = IchimokuConfig::from_params(&table).expect("parse");
        assert_eq!(cfg.tenkan_period, 9);
        assert_eq!(cfg.qty.to_string(), "0.01");
    }

    fn config() -> IchimokuConfig {
        IchimokuConfig {
            common: CommonParams {
                exchange_id: "mock".to_string(),
                label: String::new(),
                symbol: "BTC/USDT".to_string(),
                timeframe: "4h".to_string(),
                poll_secs: 60,
            },
            tenkan_period: 3,
            kijun_period: 5,
            senkou_b_period: 10,
            qty: dec!(0.5),
        }
    }

    fn candle(high: Decimal, low: Decimal, close: Decimal) -> market::Candle {
        market::Candle {
            high: buffa::MessageField::some(longtrader_contract::ext::decimal_to_common(high)),
            low: buffa::MessageField::some(longtrader_contract::ext::decimal_to_common(low)),
            close: buffa::MessageField::some(longtrader_contract::ext::decimal_to_common(close)),
            ..Default::default()
        }
    }

    struct ScriptedBars {
        candles: StdArc<StdMutex<Vec<market::Candle>>>,
    }

    impl ScriptedBars {
        fn of(candles: Vec<market::Candle>) -> Self {
            Self { candles: StdArc::new(StdMutex::new(candles)) }
        }
    }

    #[async_trait]
    impl MarketDataSource for ScriptedBars {
        async fn fetch_ticker(
            &self,
            _req: market::FetchTickerRequest,
        ) -> Result<market::Ticker, PortError> {
            Err(PortError::Transport("no ticker".into()))
        }
        async fn fetch_order_book(
            &self,
            _req: market::FetchOrderBookRequest,
        ) -> Result<market::OrderBook, PortError> {
            Err(PortError::Transport("no book".into()))
        }
        async fn get_candles(
            &self,
            _req: market::GetCandlesRequest,
        ) -> Result<market::GetCandlesResponse, PortError> {
            let candles = self.candles.lock().expect("candles mutex").clone();
            Ok(market::GetCandlesResponse { candles, ..Default::default() })
        }
        async fn list_symbols(
            &self,
            _req: market::ListSymbolsRequest,
        ) -> Result<market::ListSymbolsResponse, PortError> {
            Err(PortError::Unsupported("no symbols".into()))
        }
        async fn search_symbols(
            &self,
            _req: market::SearchSymbolsRequest,
        ) -> Result<market::SearchSymbolsResponse, PortError> {
            Err(PortError::Unsupported("no symbols".into()))
        }
        async fn list_tickers(
            &self,
            _req: market::ListTickersRequest,
        ) -> Result<market::ListTickersResponse, PortError> {
            Err(PortError::Unsupported("no tickers".into()))
        }
        async fn subscribe_market_data(
            &self,
            _req: market::StreamMarketDataRequest,
            _policy: OverflowPolicy,
        ) -> Result<MarketEventStream, PortError> {
            Err(PortError::Unsupported("no stream".into()))
        }
    }

    async fn run_strategy(candles: Vec<market::Candle>) -> (Arc<MockAdapter>, Ichimoku) {
        let adapter = Arc::new(MockAdapter::new(dec!(100)));
        let gateway: Arc<dyn TradingGateway> = adapter.clone();
        let feed = Arc::new(ScriptedBars::of(candles));
        let market: Arc<dyn MarketDataSource> = feed.clone();
        (adapter, Ichimoku::new(config(), gateway, market))
    }

    async fn sides(adapter: &MockAdapter) -> Vec<buffa::EnumValue<trading::OrderSide>> {
        adapter
            .fetch_open_orders(trading::FetchOpenOrdersRequest::default())
            .await
            .expect("test setup")
            .iter()
            .map(|o| o.side)
            .collect()
    }

    #[tokio::test]
    async fn warmup_incomplete_places_nothing() {
        let (adapter, strategy) = run_strategy(vec![
            candle(dec!(100), dec!(90), dec!(95)),
            candle(dec!(110), dec!(100), dec!(105)),
        ])
        .await;
        strategy.tick().await.expect("tick");
        assert!(sides(&adapter).await.is_empty(), "must wait for full warmup");
    }

    #[tokio::test]
    async fn bullish_setup_after_sufficient_history() {
        // Feed enough bars. The last few are a steep rally that positions Tenkan > Kijun
        // and price above a bullish cloud.
        let (adapter, strategy) = run_strategy(vec![
            candle(dec!(100), dec!(90), dec!(95)),
            candle(dec!(101), dec!(91), dec!(96)),
            candle(dec!(102), dec!(92), dec!(97)),
            candle(dec!(103), dec!(93), dec!(98)),
            candle(dec!(105), dec!(94), dec!(100)),
            candle(dec!(106), dec!(95), dec!(101)),
            candle(dec!(107), dec!(96), dec!(102)),
            candle(dec!(108), dec!(97), dec!(103)),
            candle(dec!(109), dec!(98), dec!(104)),
            candle(dec!(110), dec!(99), dec!(105)),
            candle(dec!(150), dec!(140), dec!(148)), // break far above cloud
        ])
        .await;
        strategy.tick().await.expect("tick");
        let s = sides(&adapter).await;
        // At minimum: if the conditions align it should place an order, otherwise
        // empty — assert no panic and limited orders.
        assert!(s.len() <= 1, "at most one entry per tick");
    }

    proptest! {
        #![proptest_config(ProptestConfig::with_cases(64))]

        #[test]
        fn a_poll_places_at_most_one_order(
            closes in prop::collection::vec(1i64..10_000, 0..80),
        ) {
            let runtime = tokio::runtime::Builder::new_current_thread()
                .enable_all()
                .build()
                .expect("a current-thread runtime");
            let candles: Vec<market::Candle> = closes
                .into_iter()
                .map(|c| {
                    let c = Decimal::from(c);
                    candle(c + Decimal::ONE, c - Decimal::ONE, c)
                })
                .collect();
            let (adapter, strategy) = runtime.block_on(run_strategy(candles));
            runtime.block_on(strategy.tick()).expect("tick");
            prop_assert!(runtime.block_on(sides(&adapter)).len() <= 1);
        }
    }
}