nautilus_binance/spot/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 Spot WebSocket API client with SBE (Simple Binary Encoding) support.
17//!
18//! This module provides a WebSocket API client for Binance Spot trading using
19//! the request/response pattern with SBE-encoded responses. It complements the
20//! HTTP client by offering lower-latency order submission via WebSocket.
21//!
22//! ## Architecture
23//!
24//! The client uses a two-tier architecture per the adapter design guidelines:
25//!
26//! - **Outer client** (`BinanceSpotWsTradingClient`): Orchestrates connection lifecycle,
27//! maintains state for Python access, sends commands via channel.
28//! - **Inner handler** (`BinanceSpotWsTradingHandler`): Runs in dedicated Tokio task,
29//! owns WebSocket connection, processes commands and responses.
30//!
31//! ## Features
32//!
33//! - Order placement, cancellation, and modification via WebSocket
34//! - SBE-encoded responses for consistency with HTTP client
35//! - Ed25519 and HMAC authentication (auto-detected)
36//! - Request/response correlation by ID
37//! - Inline user data stream (`session.logon` + `userDataStream.subscribe`)
38
39pub mod client;
40pub mod decode_sbe;
41pub mod error;
42pub mod handler;
43pub mod messages;
44pub mod parse;
45pub mod user_data;
46
47pub use client::BinanceSpotWsTradingClient;
48pub use error::{BinanceWsApiError, BinanceWsApiResult};
49pub use handler::BinanceSpotWsTradingHandler;
50pub use messages::{BinanceSpotWsTradingCommand, BinanceSpotWsTradingMessage};