nautilus_binance/futures/websocket/trading/mod.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Binance Futures WebSocket Trading API client.
17//!
18//! This module provides a WebSocket Trading API client for Binance USD-M Futures
19//! using the JSON request/response pattern. It complements the HTTP client by
20//! offering lower-latency order submission via WebSocket.
21//!
22//! ## Architecture
23//!
24//! The client uses a two-tier architecture:
25//!
26//! - **Outer client** (`BinanceFuturesWsTradingClient`): Orchestrates connection lifecycle,
27//! maintains state, sends commands via channel.
28//! - **Inner handler** (`BinanceFuturesWsTradingHandler`): Runs in dedicated Tokio task,
29//! owns WebSocket connection, processes commands and JSON responses.
30//!
31//! ## Features
32//!
33//! - Order placement, cancellation, and modification via WebSocket
34//! - JSON responses (unlike Spot which uses SBE binary)
35//! - HMAC-SHA256 authentication per request
36//! - Request/response correlation by ID
37
38pub mod client;
39pub mod error;
40pub mod handler;
41pub mod messages;
42
43pub(crate) mod dispatch;
44
45pub use client::BinanceFuturesWsTradingClient;
46pub use error::{BinanceFuturesWsApiError, BinanceFuturesWsApiResult};
47pub use handler::BinanceFuturesWsTradingHandler;
48pub use messages::{BinanceFuturesWsTradingCommand, BinanceFuturesWsTradingMessage};