1use std::{num::NonZeroU32, sync::LazyLock, time::Duration};
19
20use nautilus_model::identifiers::{ClientId, Venue};
21use nautilus_network::ratelimiter::quota::Quota;
22use ustr::Ustr;
23
24use super::enums::{BinanceRateLimitInterval, BinanceRateLimitType};
25
26pub const BINANCE: &str = "BINANCE";
28
29pub static BINANCE_VENUE: LazyLock<Venue> = LazyLock::new(|| Venue::new(Ustr::from(BINANCE)));
31
32pub static BINANCE_CLIENT_ID: LazyLock<ClientId> =
34 LazyLock::new(|| ClientId::new(Ustr::from(BINANCE)));
35
36pub const BINANCE_NAUTILUS_SPOT_BROKER_ID: &str = "TD67BGP9";
40
41pub const BINANCE_NAUTILUS_FUTURES_BROKER_ID: &str = "aHRE4BCj";
45
46pub const BINANCE_SPOT_HTTP_URL: &str = "https://api.binance.com";
48
49pub const BINANCE_US_SPOT_HTTP_URL: &str = "https://api.binance.us";
51
52pub const BINANCE_FUTURES_USD_HTTP_URL: &str = "https://fapi.binance.com";
54
55pub const BINANCE_FUTURES_COIN_HTTP_URL: &str = "https://dapi.binance.com";
57
58pub const BINANCE_WS_HEARTBEAT_SECS: u64 = 20;
63
64pub const BINANCE_OPTIONS_HTTP_URL: &str = "https://eapi.binance.com";
66
67pub const BINANCE_PAPI_HTTP_URL: &str = "https://papi.binance.com";
75
76pub const BINANCE_OPTIONS_TESTNET_HTTP_URL: &str = "https://testnet.binancefuture.com";
78
79pub const BINANCE_SPOT_TESTNET_HTTP_URL: &str = "https://testnet.binance.vision";
81
82pub const BINANCE_FUTURES_USD_TESTNET_HTTP_URL: &str = "https://testnet.binancefuture.com";
84
85pub const BINANCE_FUTURES_COIN_TESTNET_HTTP_URL: &str = "https://testnet.binancefuture.com";
87
88pub const BINANCE_SPOT_DEMO_HTTP_URL: &str = "https://demo-api.binance.com";
90
91pub const BINANCE_FUTURES_USD_DEMO_HTTP_URL: &str = "https://demo-fapi.binance.com";
93
94pub const BINANCE_FUTURES_COIN_DEMO_HTTP_URL: &str = "https://demo-dapi.binance.com";
96
97pub const BINANCE_SPOT_WS_URL: &str = "wss://stream.binance.com:9443/ws";
99
100pub const BINANCE_US_SPOT_WS_URL: &str = "wss://stream.binance.us:9443/ws";
102
103pub const BINANCE_US_SPOT_USER_WS_URL: &str = "wss://stream.binance.us:443";
105
106pub const BINANCE_FUTURES_USD_WS_URL: &str = "wss://fstream.binance.com/market/ws";
108
109pub const BINANCE_FUTURES_USD_WS_PUBLIC_URL: &str = "wss://fstream.binance.com/public/ws";
111
112pub const BINANCE_FUTURES_USD_WS_PRIVATE_URL: &str = "wss://fstream.binance.com/private/ws";
114
115pub const BINANCE_FUTURES_COIN_WS_URL: &str = "wss://dstream.binance.com/ws";
117
118pub const BINANCE_OPTIONS_WS_URL: &str = "wss://nbstream.binance.com/eoptions";
120
121pub const BINANCE_OPTIONS_TESTNET_WS_URL: &str = "wss://fstream.binancefuture.com/market/ws";
123
124pub const BINANCE_OPTIONS_TESTNET_WS_PUBLIC_URL: &str = "wss://fstream.binancefuture.com/public/ws";
126
127pub const BINANCE_OPTIONS_TESTNET_WS_PRIVATE_URL: &str =
129 "wss://fstream.binancefuture.com/private/ws";
130
131pub const BINANCE_SPOT_SBE_WS_URL: &str = "wss://stream-sbe.binance.com/ws";
133
134pub const BINANCE_SPOT_SBE_WS_API_URL: &str =
136 "wss://ws-api.binance.com:443/ws-api/v3?responseFormat=sbe&sbeSchemaId=3&sbeSchemaVersion=5";
137
138pub const BINANCE_FUTURES_USD_WS_API_URL: &str = "wss://ws-fapi.binance.com/ws-fapi/v1";
140
141pub const BINANCE_FUTURES_USD_WS_API_TESTNET_URL: &str =
143 "wss://testnet.binancefuture.com/ws-fapi/v1";
144
145pub const BINANCE_SPOT_SBE_WS_API_TESTNET_URL: &str = "wss://ws-api.testnet.binance.vision/ws-api/v3?responseFormat=sbe&sbeSchemaId=3&sbeSchemaVersion=5";
147
148pub const BINANCE_SPOT_SBE_WS_API_DEMO_URL: &str =
150 "wss://demo-ws-api.binance.com/ws-api/v3?responseFormat=sbe&sbeSchemaId=3&sbeSchemaVersion=5";
151
152pub const BINANCE_SPOT_TESTNET_WS_URL: &str = "wss://stream.testnet.binance.vision/ws";
154
155pub const BINANCE_SPOT_DEMO_WS_URL: &str = "wss://demo-stream.binance.com/ws";
157
158pub const BINANCE_FUTURES_USD_DEMO_WS_URL: &str = "wss://demo-fstream.binance.com/ws";
160
161pub const BINANCE_FUTURES_COIN_DEMO_WS_URL: &str = "wss://demo-dstream.binance.com/ws";
163
164pub const BINANCE_FUTURES_USD_TESTNET_WS_URL: &str = "wss://fstream.binancefuture.com/ws";
166
167pub const BINANCE_FUTURES_COIN_TESTNET_WS_URL: &str = "wss://dstream.binancefuture.com/ws";
169
170pub const BINANCE_API_KEY_HEADER: &str = "X-MBX-APIKEY";
172
173pub const BINANCE_RETRY_AFTER_HEADER: &str = "Retry-After";
175
176pub const BINANCE_SPOT_API_PATH: &str = "/api/v3";
178
179pub const BINANCE_FAPI_PATH: &str = "/fapi/v1";
181
182pub const BINANCE_DAPI_PATH: &str = "/dapi/v1";
184
185pub const BINANCE_EAPI_PATH: &str = "/eapi/v1";
187
188pub const BINANCE_SAPI_PATH: &str = "/sapi/v1";
190
191pub const BINANCE_PAPI_PATH: &str = "/papi/v1";
193
194#[derive(Clone, Copy, Debug)]
196pub struct BinanceRateLimitQuota {
197 pub rate_limit_type: BinanceRateLimitType,
199 pub interval: BinanceRateLimitInterval,
201 pub interval_num: u32,
203 pub limit: u32,
205}
206
207pub(crate) const BINANCE_SPOT_REQUEST_WEIGHT_PER_MINUTE: NonZeroU32 =
208 NonZeroU32::new(1_200).expect("non-zero");
209
210pub const BINANCE_SPOT_RATE_LIMITS: &[BinanceRateLimitQuota] = &[
215 BinanceRateLimitQuota {
216 rate_limit_type: BinanceRateLimitType::RequestWeight,
217 interval: BinanceRateLimitInterval::Minute,
218 interval_num: 1,
219 limit: BINANCE_SPOT_REQUEST_WEIGHT_PER_MINUTE.get(),
220 },
221 BinanceRateLimitQuota {
222 rate_limit_type: BinanceRateLimitType::Orders,
223 interval: BinanceRateLimitInterval::Second,
224 interval_num: 1,
225 limit: 10,
226 },
227 BinanceRateLimitQuota {
228 rate_limit_type: BinanceRateLimitType::Orders,
229 interval: BinanceRateLimitInterval::Day,
230 interval_num: 1,
231 limit: 100_000,
232 },
233];
234
235pub const BINANCE_FAPI_RATE_LIMITS: &[BinanceRateLimitQuota] = &[
240 BinanceRateLimitQuota {
241 rate_limit_type: BinanceRateLimitType::RequestWeight,
242 interval: BinanceRateLimitInterval::Minute,
243 interval_num: 1,
244 limit: 2_400,
245 },
246 BinanceRateLimitQuota {
247 rate_limit_type: BinanceRateLimitType::Orders,
248 interval: BinanceRateLimitInterval::Second,
249 interval_num: 10,
250 limit: 300,
251 },
252 BinanceRateLimitQuota {
253 rate_limit_type: BinanceRateLimitType::Orders,
254 interval: BinanceRateLimitInterval::Minute,
255 interval_num: 1,
256 limit: 1_200,
257 },
258];
259
260pub const BINANCE_DAPI_RATE_LIMITS: &[BinanceRateLimitQuota] = &[
265 BinanceRateLimitQuota {
266 rate_limit_type: BinanceRateLimitType::RequestWeight,
267 interval: BinanceRateLimitInterval::Minute,
268 interval_num: 1,
269 limit: 2_400,
270 },
271 BinanceRateLimitQuota {
272 rate_limit_type: BinanceRateLimitType::Orders,
273 interval: BinanceRateLimitInterval::Second,
274 interval_num: 10,
275 limit: 300,
276 },
277 BinanceRateLimitQuota {
278 rate_limit_type: BinanceRateLimitType::Orders,
279 interval: BinanceRateLimitInterval::Minute,
280 interval_num: 1,
281 limit: 1_200,
282 },
283];
284
285pub const BINANCE_EAPI_RATE_LIMITS: &[BinanceRateLimitQuota] = &[
290 BinanceRateLimitQuota {
291 rate_limit_type: BinanceRateLimitType::RequestWeight,
292 interval: BinanceRateLimitInterval::Minute,
293 interval_num: 1,
294 limit: 3_000,
295 },
296 BinanceRateLimitQuota {
297 rate_limit_type: BinanceRateLimitType::Orders,
298 interval: BinanceRateLimitInterval::Second,
299 interval_num: 1,
300 limit: 5,
301 },
302 BinanceRateLimitQuota {
303 rate_limit_type: BinanceRateLimitType::Orders,
304 interval: BinanceRateLimitInterval::Minute,
305 interval_num: 1,
306 limit: 200,
307 },
308];
309
310pub const BINANCE_PAPI_RATE_LIMITS: &[BinanceRateLimitQuota] = &[
315 BinanceRateLimitQuota {
316 rate_limit_type: BinanceRateLimitType::RequestWeight,
317 interval: BinanceRateLimitInterval::Minute,
318 interval_num: 1,
319 limit: 6_000,
320 },
321 BinanceRateLimitQuota {
322 rate_limit_type: BinanceRateLimitType::Orders,
323 interval: BinanceRateLimitInterval::Minute,
324 interval_num: 1,
325 limit: 1_200,
326 },
327];
328
329pub static BINANCE_WS_SUBSCRIPTION_QUOTA: LazyLock<Quota> =
338 LazyLock::new(|| Quota::with_period(Duration::from_millis(300)).expect("valid constant"));
339
340pub static BINANCE_WS_CONNECTION_QUOTA: LazyLock<Quota> = LazyLock::new(|| {
345 Quota::per_second(NonZeroU32::new(1).expect("non-zero")).expect("valid constant")
346});
347
348pub static BINANCE_RATE_LIMIT_KEY_SUBSCRIPTION: LazyLock<[Ustr; 1]> =
350 LazyLock::new(|| [Ustr::from("subscription")]);
351
352pub const BINANCE_GTX_ORDER_REJECT_CODE: i64 = -5022;
356
357pub const BINANCE_NEW_ORDER_REJECTED_CODE: i64 = -2010;
362
363pub const BINANCE_NO_SUCH_ORDER_CODE: i64 = -2013;
365
366pub const BINANCE_INVALID_LISTEN_KEY_CODE: i64 = -1125;
368
369pub const BINANCE_UNEXPECTED_RESPONSE_CODE: i64 = -1006;
371
372pub const BINANCE_STATUS_UNKNOWN_CODE: i64 = -1007;
374
375pub const BINANCE_FUTURES_DUAL_SIDE_SYNC_REJECT_CODE: i64 = -4531;
381
382pub const BINANCE_SPOT_POST_ONLY_REJECT_MSG: &str = "Order would immediately match and take.";
386
387pub const BINANCE_PARTIAL_BOOK_DEPTH: usize = 20;
389
390pub const BINANCE_BOOK_DEPTHS: [u32; 7] = [5, 10, 20, 50, 100, 500, 1000];
392
393#[cfg(test)]
394mod tests {
395 use rstest::rstest;
396
397 use super::*;
398
399 #[rstest]
400 fn test_venue_error_code_values() {
401 assert_eq!(BINANCE_GTX_ORDER_REJECT_CODE, -5022);
402 assert_eq!(BINANCE_NEW_ORDER_REJECTED_CODE, -2010);
403 assert_eq!(BINANCE_NO_SUCH_ORDER_CODE, -2013);
404 assert_eq!(BINANCE_INVALID_LISTEN_KEY_CODE, -1125);
405 assert_eq!(BINANCE_UNEXPECTED_RESPONSE_CODE, -1006);
406 assert_eq!(BINANCE_STATUS_UNKNOWN_CODE, -1007);
407 assert_eq!(BINANCE_FUTURES_DUAL_SIDE_SYNC_REJECT_CODE, -4531);
408 }
409
410 #[rstest]
411 #[case(BINANCE_SPOT_SBE_WS_API_URL)]
412 #[case(BINANCE_SPOT_SBE_WS_API_TESTNET_URL)]
413 #[case(BINANCE_SPOT_SBE_WS_API_DEMO_URL)]
414 fn test_spot_sbe_ws_api_urls_use_current_schema(#[case] url: &str) {
415 assert!(url.ends_with("sbeSchemaId=3&sbeSchemaVersion=5"));
416 }
417
418 #[rstest]
419 fn test_ws_subscription_quota_paces_one_message_per_period() {
420 let quota = *BINANCE_WS_SUBSCRIPTION_QUOTA;
421 assert_eq!(quota.burst_size().get(), 1);
422 assert_eq!(quota.replenish_interval(), Duration::from_millis(300));
423 }
424}