nautilus_live/

lib.rs

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! Live system node for [NautilusTrader](https://nautilustrader.io).
//!
//! The crate provides live event transport, execution state management, and node lifecycle support.
//!
//! - [`execution`] supplies adapter-facing order context, failure classification, report filtering,
//!   event emission, and the execution manager. The manager tracks reconciliation state, requests
//!   reports for individual checks, and applies startup reconciliation events.
//! - `node` (with the `node` feature) owns the kernel lifecycle, recurring reconciliation tasks,
//!   collection deadlines, cancellation, and dispatch through the live event loop.
//! - [`runner`] routes asynchronous data, execution, system, and timer traffic.
//!
//! # NautilusTrader
//!
//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
//! engine for multi-asset, multi-venue trading systems.
//!
//! The system spans research, deterministic simulation, and live execution within a single
//! event-driven architecture, providing research-to-live semantic parity.
//!
//! # Feature Flags
//!
//! This crate provides feature flags to control source code inclusion during compilation,
//! depending on the intended use case, i.e. whether to provide Python bindings
//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
//! or as part of a Rust only build.
//!
//! - `defi`: Enables DeFi (Decentralized Finance) support.
//! - `examples`: Enables example strategies and testkit support for live nodes.
//! - `extension-module`: Builds as a Python extension module.
//! - `fuzz`: Provides shared libFuzzer integration for adapter fuzz binaries.
//! - `node` (default): Enables the live node, builder, configuration, and system-kernel dependencies.
//! - `plugin` (default): Keeps compatibility stubs for plug-in config validation.
//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs) and auto-enables `node` and
//!   `streaming`.
//! - `simulation`: Enables deterministic simulation testing with
//!   [MadSim](https://crates.io/crates/madsim).
//! - `streaming`: Enables the `nautilus-persistence` dependency for streaming configuration and
//!   requires `node`.
//! - `test-support`: Enables engine-wired execution support for adapter integration tests.
//!
//! # Lean adapter builds
//!
//! Adapters and other consumers that only need the async event emitter, runner, and
//! `ExecutionClientCore` re-export can opt out of the full kernel by disabling the
//! `node` feature:
//!
//! ```toml
//! nautilus-live = { workspace = true, default-features = false }
//! ```
//!
//! With `node` disabled, execution support (including the manager), run-to-completion
//! reconciliation, the runner, socket controls, and task support remain available. This skips
//! the transitive dependencies on `nautilus-system`, `nautilus-trading`,
//! `nautilus-portfolio`, `nautilus-risk`, and `nautilus-data`.
//!
//! # Plug-in support
//!
//! The open-source live crate does not host dynamic plug-ins directly.
//! `nautilus-plugin` is the public guest ABI crate, while host-side loading,
//! vtables, bridge adapters, and server policy belong to the host-side plug-in
//! integration.
//! A non-empty `LiveNodeConfig.plugins` list is rejected unless an application
//! provides that host-side integration.
//!
//! ```toml
//! nautilus-live = { workspace = true, default-features = false, features = ["node"] }
//! ```
//!
//! With `plugin` disabled, the compatibility `plugin` module is removed. A
//! non-empty `LiveNodeConfig.plugins` list is rejected under this configuration
//! as well.

#![warn(rustc::all)]
#![warn(clippy::pedantic)]
#![allow(
    clippy::manual_let_else,
    clippy::option_if_let_else,
    clippy::or_fun_call,
    clippy::redundant_else,
    clippy::similar_names,
    clippy::single_match_else,
    reason = "workspace policy; generated by scripts/update-clippy-allowances.py"
)]
#![deny(unsafe_code)]
#![deny(unsafe_op_in_unsafe_fn)]
#![deny(nonstandard_style)]
#![deny(missing_debug_implementations)]
#![deny(clippy::missing_errors_doc)]
#![deny(clippy::missing_panics_doc)]
#![deny(rustdoc::broken_intra_doc_links)]
#![allow(
    clippy::too_many_lines,
    reason = "live node lifecycle and reconciliation flows exceed the default threshold by design"
)]
#![allow(
    clippy::unsafe_derive_deserialize,
    reason = "config types deserialize plain field values; unsafe in unrelated impls is sound"
)]
#![allow(
    clippy::assert_is_empty,
    reason = "`assert!(x.is_empty())` is clearer than comparing against an empty value"
)]
// pyo3's `from_py_object` generates `.clone()` on `Copy` fields that clippy flags from the
// macro expansion; an item-level `allow` cannot reach the expansion
#![allow(clippy::clone_on_copy)]

pub mod book;
pub mod execution;
pub mod runner;
pub mod socket;
pub mod task;

#[cfg(feature = "fuzz")]
#[doc(hidden)]
pub mod fuzz;

#[cfg(feature = "fuzz")]
#[doc(hidden)]
pub use fuzz::Corpus;

#[cfg(feature = "node")]
pub mod node;

#[cfg(feature = "python")]
pub mod python;

#[cfg(feature = "test-support")]
pub mod testing;

mod dispatch;

// Re-exports for adapters
pub use execution::{emitter, emitter::ExecutionEventEmitter, manager};
pub use nautilus_common::factories::OrderEventFactory;
pub use nautilus_execution::client::core::ExecutionClientCore;
#[cfg(feature = "plugin")]
pub use node::plugin;
#[cfg(feature = "node")]
pub use node::{builder, config};
pub use socket::{
    SocketControl, SocketControlFactory, SocketReconnectLookup, SocketReconnectRegistry,
    SocketReconnectRequestOutcome,
};