scuriolus 0.3.0

Scuriolus is a modular trading bot platform.
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
use anyhow::Error;
use chrono::{DateTime, Utc};
use futures::{FutureExt as _, select};
use linregress::{FormulaRegressionBuilder, RegressionDataBuilder};
use rust_decimal::{Decimal, prelude::FromPrimitive};
use std::{
    future::Future,
    pin::Pin,
    sync::{Arc, atomic::Ordering},
};
use tokio::sync::{
    Notify,
    watch::{Receiver, Sender, channel},
};

use crate::{
    clock::Clock,
    core::{Core, CoreError, CoreResult, market::Market},
    generics::order::{Crypto, OrderDraft, OrderSide, OrderType},
    provider::{
        DataQuery, Interval, ProviderTrait, Source,
        kline::{BaseKline, Kline, KlineSpecifier},
    },
};

use super::{AtomicState, ErrorInStrat, State, StratStat, Strategy, StrategyFactory};

/// A [`StrategyFactory`] for [`TrendTunnel`].
pub struct TrendTunnelFactory<
    C: Clock,
    M: Market<_Clock = C>,
    S: Source<_Data = Kline>,
    P: ProviderTrait<_Source = S>,
> {
    quote: Crypto,
    amount: Decimal,
    asset: Crypto,
    core: Option<Core<C, M>>,
    provider: Option<P>,
    run_date: DateTime<Utc>,
    interval: Interval,
    sensibility_percentage: u16,
}

impl<C: Clock, M: Market<_Clock = C>, S: Source<_Data = Kline>, P: ProviderTrait<_Source = S>>
    TrendTunnelFactory<C, M, S, P>
{
    pub fn new(
        quote: Crypto,
        amount: Decimal,
        asset: Crypto,
        run_date: DateTime<Utc>,
        interval: Interval,
        sensibility_percentage: u16,
    ) -> Self {
        Self {
            quote,
            amount,
            asset,
            core: None,
            provider: None,
            run_date,
            interval,
            sensibility_percentage,
        }
    }

    pub fn with_provider(self, provider: P) -> Self {
        Self {
            provider: Some(provider),
            ..self
        }
    }
}

impl<C: Clock, M: Market<_Clock = C>, S: Source<_Data = Kline>, P: ProviderTrait<_Source = S>>
    StrategyFactory for TrendTunnelFactory<C, M, S, P>
{
    type _Strategy = TrendTunnel<C, M, S, P>;
    fn build(mut self) -> TrendTunnel<C, M, S, P> {
        let core = self.core.take().expect("Core not set");
        let provider = self.provider.take().expect("Provider not set");
        let future_state = Arc::new(AtomicState::new(START_STATE));
        let notify = Arc::new(Notify::new());

        let (tx, rx) = channel(Err(ErrorInStrat::new(
            "Not initialized".to_string(),
            core.clock().now(),
        )));

        TrendTunnel {
            core,
            provider,
            future_state,
            state: START_STATE,
            notify,
            asset: self.asset,
            quote: self.quote,
            run_date: self.run_date,
            interval: self.interval,
            invested_status: false,
            sensibility_percentage: self.sensibility_percentage,
            tx,
            rx,
            avail_asset: Decimal::ZERO,
            avail_quote: self.amount,
        }
    }

    fn with_core(self, core: Core<C, M>) -> Self {
        Self {
            core: Some(core),
            ..self
        }
    }
}

/// A [`Strategy`] that buys when prices are considered low from a linear regression from previous times, and the opposite to sell.
///
pub struct TrendTunnel<
    C: Clock,
    M: Market<_Clock = C>,
    S: Source<_Data = Kline>,
    P: ProviderTrait<_Source = S>,
> {
    core: Core<C, M>,
    provider: P,

    /// external state
    future_state: Arc<AtomicState>,
    state: State,
    notify: Arc<Notify>,
    tx: Sender<Result<StratStat, ErrorInStrat>>,
    rx: Receiver<Result<StratStat, ErrorInStrat>>,

    /// internal state
    avail_asset: Decimal,
    avail_quote: Decimal,
    run_date: DateTime<Utc>,
    invested_status: bool,

    /// settings
    quote: Crypto,
    asset: Crypto,
    interval: Interval,
    sensibility_percentage: u16,
}

const START_STATE: State = State::Paused;
/// Number of previous klines to base the linear regression on
const SIZE_KLINES_VEC: i32 = 100;

impl<C: Clock, M: Market<_Clock = C>, S: Source<_Data = Kline>, P: ProviderTrait<_Source = S>>
    TrendTunnel<C, M, S, P>
{
    async fn get_stats(&self) -> Result<StratStat, Error> {
        let asset = self.core.get_balance(self.asset).await?;
        let quote = self.core.get_balance(self.quote).await?;

        Ok(StratStat {
            asset,
            quote,
            time: self.core.clock().now(),
        })
    }

    async fn send_stats(&self) {
        let stat = self
            .get_stats()
            .await
            .map_err(|err| ErrorInStrat::new(err.to_string(), self.core.clock().now()));

        if let Err(err) = self.tx.send(stat) {
            tracing::error!("Failed to send stat: {}", err);
        }
    }

    async fn await_date_or_state_change(&mut self, optional_date: Option<DateTime<Utc>>) {
        let actual_future_state = self.future_state.load(Ordering::Relaxed);
        if actual_future_state != self.state {
            self.state = actual_future_state;
            return;
        }

        if let Some(date) = optional_date {
            select! {
            _ = self.core.clock().sleep_until(date).fuse() => {},
            _ = self.notify.notified().fuse() => {
                self.core.clock().synchronize();
            }
            }
        } else {
            self.notify.notified().await;
            self.core.clock().synchronize();
        }
        self.state = self.future_state.load(Ordering::Relaxed);
    }

    async fn latest_basekline(&self, now: DateTime<Utc>) -> CoreResult<BaseKline> {
        let mut interval = Interval::OneHour; // TODO less too much askings

        loop {
            tracing::trace!("Getting smallest kline with interval: {}", interval);

            let maybe_kline = self
                .provider
                .provide_or_empty(&DataQuery::new(
                    KlineSpecifier::new(self.asset, self.quote),
                    interval,
                    now - interval.time_delta(),
                    now,
                ))
                .await?
                .pop();

            if let Some(kline) = maybe_kline
                && let Some(base) = kline.content.clone()
            {
                tracing::trace!(
                    "Latest kline is : {:#?} with interval {}",
                    kline.basics.begin,
                    interval
                );
                return Ok(base);
            }

            interval = interval
                .next_interval_to_zoom_out()
                .ok_or(CoreError::comput_error("No interval found"))?;
        }
    }

    async fn decide(&mut self) -> CoreResult<()> {
        let now = self.core.clock().now();

        tracing::trace!(
            "Getting klines from {} to {}",
            now - (self
                .interval
                .time_delta()
                .checked_mul(SIZE_KLINES_VEC)
                .ok_or(CoreError::comput_error("todo"))?),
            now
        );
        let klines = self
            .provider
            .provide(&DataQuery::new(
                KlineSpecifier::new(self.asset, self.quote),
                self.interval,
                now - (self
                    .interval
                    .time_delta()
                    .checked_mul(SIZE_KLINES_VEC)
                    .ok_or(CoreError::comput_error("todo"))?),
                now,
            ))
            .await?;
        let len = klines.len();
        tracing::trace!("Got {} klines", len);

        let (highs, lows) = klines
            .iter()
            .fold((vec![], vec![]), |(mut highs, mut lows), kline| {
                if let Some(kline) = &kline.content {
                    highs.push(kline.high.try_into().unwrap());
                    lows.push(kline.low.try_into().unwrap());
                } else {
                    tracing::error!("Missing kline {}", kline.basics.begin);
                }
                (highs, lows)
            });
        let x: Vec<f64> = (1..=len).map(|n| f64::from_usize(n).unwrap()).collect();

        let data_highs = vec![("x", x.clone()), ("y", highs)];
        let data_lows = vec![("x", x), ("y", lows)];

        let reg_data_highs = RegressionDataBuilder::new()
            .build_from(data_highs)
            .map_err(|_| CoreError::comput_error("todo"))?;
        let reg_data_lows = RegressionDataBuilder::new()
            .build_from(data_lows)
            .map_err(|_| CoreError::comput_error("todo"))?;

        let formula = "y ~ x";
        let model_highs = FormulaRegressionBuilder::new()
            .data(&reg_data_highs)
            .formula(formula)
            .fit()
            .unwrap();
        let model_lows = FormulaRegressionBuilder::new()
            .data(&reg_data_lows)
            .formula(formula)
            .fit()
            .unwrap();

        let next_high_vec = model_highs
            .predict(vec![("x", vec![f64::from_usize(len).unwrap() + 1.])])
            .unwrap();
        let next_low_vec = model_lows
            .predict(vec![("x", vec![f64::from_usize(len).unwrap() + 1.])])
            .unwrap();

        let next_high = next_high_vec[0];
        let next_low = next_low_vec[0];

        let level_high =
            next_high - (next_high - next_low) * self.sensibility_percentage as f64 / 100.0;
        let level_low =
            next_low + (next_high - next_low) * self.sensibility_percentage as f64 / 100.0;

        tracing::trace!("Getting kline to evaluate now ({}) cost", now);

        let now_kline = self.latest_basekline(now).await?;

        let double_price: f64 = (now_kline.open + now_kline.close).try_into().unwrap();
        let avg_price: f64 = double_price / 2.0;

        match self.invested_status {
            true => {
                if avg_price > level_high {
                    tracing::debug!("About to buy");
                    self.core
                        .send_order(OrderDraft {
                            asset: self.asset,
                            quote: self.quote,
                            side: OrderSide::Sell,
                            order_type: OrderType::Market,
                            qty_asset: Some(self.avail_asset),
                            qty_quote: None,
                            price: None,
                        })
                        .await?;

                    self.avail_quote = self.core.get_balance(self.quote).await?.free;
                    self.avail_asset = Decimal::ZERO;

                    self.invested_status = false;
                }
            }
            false => {
                if avg_price < level_low {
                    tracing::debug!("About to sell");
                    self.core
                        .send_order(OrderDraft {
                            asset: self.asset,
                            quote: self.quote,
                            side: OrderSide::Buy,
                            order_type: OrderType::Market,
                            qty_asset: None,
                            qty_quote: Some(self.avail_quote),
                            price: None,
                        })
                        .await?;

                    self.avail_asset = self.core.get_balance(self.asset).await?.free;
                    self.avail_quote = Decimal::ZERO;

                    self.invested_status = true;
                }
            }
        }
        Ok(())
    }
}

impl<C: Clock, M: Market<_Clock = C>, S: Source<_Data = Kline>, P: ProviderTrait<_Source = S>>
    Strategy for TrendTunnel<C, M, S, P>
{
    type _Clock = C;
    type _Market = M;

    fn state(&self) -> &Arc<AtomicState> {
        &self.future_state
    }

    fn notify(&self) -> &Arc<Notify> {
        &self.notify
    }

    fn stat_channel(&self) -> Receiver<Result<StratStat, ErrorInStrat>> {
        self.rx.clone()
    }

    fn run(&mut self) -> Pin<Box<dyn Future<Output = ()> + Send + '_>> {
        Box::pin(async move {
            tracing::info!("Trend tunnel in place");

            let mut stop_date = None;

            loop {
                let last_state = self.state;
                self.await_date_or_state_change(stop_date).await;

                tracing::trace!("State : {}", self.state);
                match self.state {
                    State::Starting => {
                        self.future_state.store(State::Running, Ordering::Relaxed);
                        stop_date = Some(self.run_date);
                    }
                    State::Running => {
                        if let Some(last_date) = stop_date {
                            tracing::trace!("Running date : {}", last_date);
                            stop_date = Some(last_date + self.interval.time_delta());
                        } else {
                            tracing::error!("Running without stop date");
                            return;
                        }
                        if let Err(e) = self.decide().await {
                            tracing::error!("Error in decide: {}", e);
                            return;
                        };
                    }
                    State::Stats => {
                        self.send_stats().await;
                        self.state = last_state;
                    }
                    State::Stopped => unimplemented!(),
                    State::Paused => {
                        stop_date = None;
                        tracing::info!("Trend tunnel is paused");
                    }
                    State::Terminated => {
                        tracing::info!("Trend tunnel terminating");

                        let asset_balance = self.core.get_balance(self.asset).await.unwrap();

                        self.core
                            .send_order(OrderDraft {
                                asset: self.asset,
                                quote: self.quote,
                                side: OrderSide::Sell,
                                order_type: OrderType::Market,
                                qty_asset: Some(asset_balance.free),
                                qty_quote: None,
                                price: None,
                            })
                            .await
                            .unwrap();

                        self.send_stats().await;

                        break;
                    }
                    State::Killed => {
                        break;
                    }
                };
            }
            self.send_stats().await;
        })
    }
}