Skip to main content

nautilus_system/
lib.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//! System-level components and orchestration for [NautilusTrader](https://nautilustrader.io).
17//!
18//! The `nautilus-system` crate provides the core system architecture for orchestrating trading systems,
19//! including the kernel that manages all engines, configuration management,
20//! and system-level factories for creating components:
21//!
22//! - `NautilusKernel` - Core system orchestrator managing engines and components.
23//! - `NautilusKernelConfig` - Configuration for kernel initialization.
24//! - System builders and factories for component creation.
25//!
26//! # NautilusTrader
27//!
28//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
29//! engine for multi-asset, multi-venue trading systems.
30//!
31//! The system spans research, deterministic simulation, and live execution within a single
32//! event-driven architecture, providing research-to-live semantic parity.
33//!
34//! # Feature Flags
35//!
36//! This crate provides feature flags to control source code inclusion during compilation,
37//! depending on the intended use case, i.e. whether to provide Python bindings
38//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
39//! or as part of a Rust only build.
40//!
41//! - `streaming`: Enables `persistence` dependency for streaming configuration.
42//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs) (auto-enables `streaming`).
43//! - `defi`: Enables DeFi (Decentralized Finance) support.
44//! - `live`: Enables live trading mode dependencies.
45//! - `tracing-bridge`: Enables the `tracing` subscriber bridge for log integration.
46//! - `extension-module`: Builds the crate as a Python extension module.
47
48#![warn(rustc::all)]
49#![warn(clippy::pedantic)]
50#![deny(unsafe_code)]
51#![deny(unsafe_op_in_unsafe_fn)]
52#![deny(nonstandard_style)]
53#![deny(missing_debug_implementations)]
54#![deny(clippy::missing_errors_doc)]
55#![deny(clippy::missing_panics_doc)]
56#![deny(rustdoc::broken_intra_doc_links)]
57
58pub mod builder;
59pub mod clock_factory;
60pub mod config;
61pub mod controller;
62pub mod event_store;
63pub mod kernel;
64pub mod messages;
65pub mod trader;
66
67mod registration;
68
69#[cfg(feature = "python")]
70pub mod python;
71
72// Re-exports
73pub use builder::NautilusKernelBuilder;
74pub use clock_factory::ClockFactory;
75pub use config::{NautilusKernelConfig, RotationConfig, StreamingConfig};
76pub use controller::Controller;
77pub use event_store::{EventStoreFactory, KernelEventStore, RegisteredComponents};
78pub use kernel::NautilusKernel;
79pub use messages::{
80    ControllerCommand, CreateActor, CreateStrategy, RemoveActor, RemoveStrategy, StartActor,
81    StartStrategy, StopActor, StopStrategy,
82};
83#[cfg(feature = "python")]
84pub use python::{FactoryRegistry, get_global_pyo3_registry};