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

//! Provides trait and implementations to track accounts performance

mod full_track;
mod no_track;

pub use full_track::{FullAccountTracker, ReturnsSource};
pub use no_track::NoAccountTracker;

use crate::prelude::{Currency, QuoteCurrency, Side};

/// Something that tracks the performance of the Account.
/// This allows for greated flexibility over using the FullAccountTracker
/// which can easily use more than 10GB of RAM due to storage of tick-by-tick
/// returns
pub trait AccountTracker<M>: Send
where M: Currency
{
    /// Update with each tick, using data provided in update_state method of
    /// Exchange.
    ///
    /// # Arguments:
    /// `timestamp`: timestamp of latest tick
    /// `price`: price of latest tick
    /// `upnl`: unrealized profit and loss of account in current tick
    fn update(&mut self, timestamp: u64, price: QuoteCurrency, upnl: M);

    /// Log a realized profit and loss event
    fn log_rpnl(&mut self, rpnl: M);

    /// Log a fee, measured in the margin currency
    fn log_fee(&mut self, fee_in_margin: M);

    /// Log a limit order submission event
    fn log_limit_order_submission(&mut self);

    /// Log a limit order cancellation event
    fn log_limit_order_cancellation(&mut self);

    /// Log a limit order fill event
    fn log_limit_order_fill(&mut self);

    /// Log a trade event where some order got filled and the position changed
    fn log_trade(&mut self, side: Side, price: QuoteCurrency, size: M::PairedCurrency);
}