bat-markets-core 0.3.2

Core domain contracts and in-memory state engine for bat-markets
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

use serde::{Deserialize, Serialize};

use crate::types::{Product, Venue};

/// How the engine loads credentials when private APIs are enabled later.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub enum AuthConfig {
    None,
    Env {
        api_key_var: Box<str>,
        api_secret_var: Box<str>,
    },
    Inline {
        api_key: Box<str>,
        api_secret: Box<str>,
    },
}

/// Network endpoints for the selected venue/product.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct EndpointConfig {
    pub rest_base: Box<str>,
    pub public_ws_base: Box<str>,
    pub private_ws_base: Box<str>,
    pub command_ws_base: Box<str>,
    pub sandbox: bool,
}

/// Health-related thresholds.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct HealthPolicy {
    pub clock_skew_threshold_ms: u64,
    pub snapshot_stale_after_ms: u64,
    pub health_check_interval_ms: u64,
    pub periodic_private_reconcile_ms: Option<u64>,
    pub periodic_metadata_refresh_ms: Option<u64>,
}

/// Request and socket timeout policy.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct TimeoutPolicy {
    pub connect_ms: u64,
    pub request_ms: u64,
    pub command_ms: u64,
    pub ws_handshake_ms: u64,
    pub ws_idle_ms: u64,
}

/// Coarse command-lane rate limit policy.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct RateLimitPolicy {
    pub command_burst: u32,
    pub command_refill_per_second: u32,
}

/// Coarse retry policy for transport operations.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct RetryPolicy {
    pub rest_retries: u32,
    pub rest_initial_backoff_ms: u64,
    pub rest_max_backoff_ms: u64,
}

/// Reconnect policy for websocket lanes.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct ReconnectPolicy {
    pub ws_initial_backoff_ms: u64,
    pub ws_max_backoff_ms: u64,
    pub max_reconnect_attempts: Option<u32>,
    pub refresh_metadata_on_reconnect: bool,
    pub reconcile_private_on_reconnect: bool,
}

/// In-memory state sizing and retention policy.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct StatePolicy {
    pub recent_trade_capacity: usize,
    pub execution_capacity: usize,
}

/// Top-level configuration for a single engine instance.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct BatMarketsConfig {
    pub venue: Venue,
    pub product: Product,
    pub auth: AuthConfig,
    pub endpoints: EndpointConfig,
    pub health: HealthPolicy,
    pub timeouts: TimeoutPolicy,
    pub rate_limits: RateLimitPolicy,
    pub retry: RetryPolicy,
    pub reconnect: ReconnectPolicy,
    pub state: StatePolicy,
}

impl BatMarketsConfig {
    #[must_use]
    pub fn new(venue: Venue, product: Product) -> Self {
        Self {
            venue,
            product,
            auth: AuthConfig::None,
            endpoints: EndpointConfig::sandbox_defaults(venue),
            health: HealthPolicy {
                clock_skew_threshold_ms: 250,
                snapshot_stale_after_ms: 5_000,
                health_check_interval_ms: 1_000,
                periodic_private_reconcile_ms: Some(15_000),
                periodic_metadata_refresh_ms: Some(300_000),
            },
            timeouts: TimeoutPolicy {
                connect_ms: 2_000,
                request_ms: 5_000,
                command_ms: 7_500,
                ws_handshake_ms: 10_000,
                ws_idle_ms: 30_000,
            },
            rate_limits: RateLimitPolicy {
                command_burst: 8,
                command_refill_per_second: 4,
            },
            retry: RetryPolicy {
                rest_retries: 2,
                rest_initial_backoff_ms: 100,
                rest_max_backoff_ms: 1_000,
            },
            reconnect: ReconnectPolicy {
                ws_initial_backoff_ms: 250,
                ws_max_backoff_ms: 5_000,
                max_reconnect_attempts: None,
                refresh_metadata_on_reconnect: true,
                reconcile_private_on_reconnect: true,
            },
            state: StatePolicy {
                recent_trade_capacity: 128,
                execution_capacity: 1_024,
            },
        }
    }
}

impl EndpointConfig {
    #[must_use]
    pub fn sandbox_defaults(venue: Venue) -> Self {
        match venue {
            Venue::Binance => Self {
                rest_base: "https://demo-fapi.binance.com".into(),
                public_ws_base: "wss://stream.binancefuture.com/ws".into(),
                private_ws_base: "wss://stream.binancefuture.com/ws".into(),
                command_ws_base: "wss://testnet.binancefuture.com/ws-fapi/v1".into(),
                sandbox: true,
            },
            Venue::Bybit => Self {
                rest_base: "https://api-testnet.bybit.com".into(),
                public_ws_base: "wss://stream-testnet.bybit.com/v5/public/linear".into(),
                private_ws_base: "wss://stream-testnet.bybit.com/v5/private".into(),
                command_ws_base: "wss://stream-testnet.bybit.com/v5/trade".into(),
                sandbox: true,
            },
        }
    }

    #[must_use]
    pub fn mainnet_defaults(venue: Venue) -> Self {
        match venue {
            Venue::Binance => Self {
                rest_base: "https://fapi.binance.com".into(),
                public_ws_base: "wss://fstream.binance.com/ws".into(),
                private_ws_base: "wss://fstream.binance.com/ws".into(),
                command_ws_base: "wss://ws-fapi.binance.com/ws-fapi/v1".into(),
                sandbox: false,
            },
            Venue::Bybit => Self {
                rest_base: "https://api.bybit.com".into(),
                public_ws_base: "wss://stream.bybit.com/v5/public/linear".into(),
                private_ws_base: "wss://stream.bybit.com/v5/private".into(),
                command_ws_base: "wss://stream.bybit.com/v5/trade".into(),
                sandbox: false,
            },
        }
    }
}