quantoxide 0.5.5

Rust framework for developing, backtesting, and deploying Bitcoin futures trading strategies.
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

#![doc = include_str!("../README.md")]

mod db;
mod shared;
/// Exports [`SignalEvaluator`] and other types related to signal evaluation.
///
/// [`SignalEvaluator`]: crate::signal::SignalEvaluator
pub mod signal;
/// Exports [`SyncEngine`] and other types related to price data synchronization.
///
/// [`SyncEngine`]: crate::sync::SyncEngine
pub mod sync;
/// Exports [`BacktestEngine`], [`LiveTradeEngine`], [`LiveTradeExecutor`], and other types related
/// to trading execution.
///
/// [`BacktestEngine`]: crate::trade::BacktestEngine
/// [`LiveTradeEngine`]: crate::trade::LiveTradeEngine
/// [`LiveTradeExecutor`]: crate::trade::LiveTradeExecutor
pub mod trade;
/// Exports [`SyncTui`], [`BacktestTui`], [`LiveTui`], and other types related to Terminal User
/// Interfaces (TUIs).
///
/// [`SyncTui`]: crate::tui::SyncTui
/// [`BacktestTui`]: crate::tui::BacktestTui
/// [`LiveTui`]: crate::tui::LiveTui
pub mod tui;
mod util;

pub use db::Database;

/// Error types returned by `quantoxide`.
pub mod error {
    pub use super::db::error::DbError;
    pub use super::shared::error::{
        LookbackValidationError, MinIterationIntervalValidationError, PeriodValidationError,
    };
    pub use super::signal::{
        error::{SignalError, SignalEvaluatorError, SignalOperatorError},
        process::error::{
            SignalProcessError, SignalProcessFatalError, SignalProcessRecoverableError,
        },
    };
    pub use super::sync::{
        error::SyncError,
        process::{
            error::{SyncProcessFatalError, SyncProcessRecoverableError},
            real_time_collection_task::error::RealTimeCollectionError,
            sync_funding_settlements_task::error::{
                SyncFundingSettlementsError, SyncFundingSettlementsFatalError,
                SyncFundingSettlementsRecoverableError,
            },
            sync_price_history_task::error::{
                SyncPriceHistoryError, SyncPriceHistoryFatalError, SyncPriceHistoryRecoverableError,
            },
        },
    };
    pub use super::trade::{
        backtest::error::BacktestError,
        error::{TradeCoreError, TradeExecutorError},
        live::{
            error::LiveError,
            executor::error::{
                ExecutorActionError, ExecutorProcessFatalError, ExecutorProcessRecoverableError,
                LiveTradeExecutorError,
            },
            process::error::{
                LiveProcessError, LiveProcessFatalError, LiveProcessRecoverableError,
            },
        },
    };
    pub use super::tui::error::TuiError;
    pub use super::util::PanicPayload;

    // Re-export selected `lnm-sdk::api_v3` errors for convenience
    pub use lnm_sdk::api_v3::error::{
        FuturesIsolatedTradeRequestValidationError, LeverageValidationError, MarginValidationError,
        PercentageCappedValidationError, PercentageValidationError, PriceValidationError,
        QuantityValidationError, RestApiError, RestApiV3Error, TradeValidationError,
    };

    /// Convenience general-purpose Result type alias.
    pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
}

/// Exports database models, shared configuration types, and selected `lnm-sdk` models.
pub mod models {
    pub use super::db::models::{FundingSettlementRow, OhlcCandleRow, PriceTickRow};
    pub use super::shared::{Lookback, MinIterationInterval, OhlcResolution, Period};

    // Re-export selected `lnm-sdk::api_v3` models and utils for convenience
    pub use lnm_sdk::api_v3::models::{
        ClientId, Leverage, Margin, Percentage, PercentageCapped, Price, Quantity, SATS_PER_BTC,
        Trade, TradeExecution, TradeExecutionType, TradeSide, TradeSize, TradeStatus, Uuid,
        trade_util,
    };
}

mod sealed {
    pub trait Sealed {}
}