This guide describes the architecture of NautilusTrader from highest to lowest level, including:
Component organization and interaction
Design philosophy ¶
The major architectural techniques and design patterns employed by NautilusTrader are:
Messaging patterns (Pub/Sub, Req/Rep, point-to-point)
These techniques have been utilized to assist in achieving certain architectural quality attributes.
Quality attributes ¶
Architectural decisions are often a trade-off between competing priorities. The below is a list of some of the most important quality attributes which are considered when making design and architectural decisions, roughly in order of ‘weighting’.
System architecture ¶
The NautilusTrader codebase is actually both a framework for composing trading systems, and a set of default system implementations which can operate in various environment contexts.
Environment contexts ¶
Backtest- Historical data with simulated venues
Sandbox- Real-time data with simulated venues
Live- Real-time data with live venues (paper trading or real accounts)
Common core ¶
The platform has been designed to share as much common code between backtest, sandbox and live trading systems as possible.
This is formalized in the
subpackage, where you will find the
providing a common core system ‘kernel’.
A ports and adapters architectural style allows modular components to be ‘plugged into’ the core system, providing many hooks for user defined / custom component implementations.
To facilitate modularity and loose coupling, an extremely efficient
passes messages (data, commands and events) between components.
From a high level architectural view, it’s important to understand that the platform has been designed to run efficiently on a single thread, for both backtesting and live trading. Much research and testing resulted in arriving at this design, as it was found the overhead of context switching between threads didn’t actually result in improved performance.
When considering the logic of how your trading will work within the system boundary, you can expect each component to consume messages in a predictable synchronous way ( similar to the actor model ).
Of interest is the LMAX exchange architecture, which achieves award winning performance running on a single thread. You can read about their disruptor pattern based architecture in this interesting article by Martin Fowler.
Framework organization ¶
The codebase is organized with a layering of abstraction levels, and generally grouped into logical subpackages of cohesive concepts. You can navigate to the documentation for each of these subpackages from the left nav menu.
Core / low-Level ¶
core- constants, functions and low-level components used throughout the framework
common- common parts for assembling the frameworks various components
network- low-level base components for networking clients
serialization- serialization base components and serializer implementations
model- defines a rich trading domain model
accounting- different account types and account management machinery
adapters- integration adapters for the platform including brokers and exchanges
analysis- components relating to trading performance statistics and analysis
cache- provides common caching infrastructure
data- the data stack and data tooling for the platform
execution- the execution stack for the platform
indicators- a set of efficient indicators and analyzers
infrastructure- technology specific infrastructure implementations
msgbus- a universal message bus for connecting system components
persistence- data storage, cataloging and retrieval, mainly to support backtesting
portfolio- portfolio management functionality
risk- risk specific components and tooling
trading- trading domain specific components and tooling
System implementations ¶
backtest- backtesting componentry as well as a backtest engine and node implementations
live- live engine and client implementations as well as a node for live trading
system- the core system kernel common between backtest, sandbox and live contexts
Code structure ¶
The foundation of the codebase is the
directory, containing a collection of core Rust libraries including a C API interface generated by
The bulk of the production code resides in the
directory, which contains a collection of Python and Cython modules.
Python bindings for the Rust core are achieved by statically linking the Rust libraries to the C extension modules generated by Cython at compile time (effectively extending the CPython API).
Both Rust and Cython are build dependencies. The binary wheels produced from a build do not themselves require Rust or Cython to be installed at runtime.
Dependency flow ¶
┌─────────────────────────┐ │ │ │ │ │ nautilus_trader │ │ │ │ Python / Cython │ │ │ │ │ └────────────┬────────────┘ C API │ │ │ │ C API ▼ ┌─────────────────────────┐ │ │ │ │ │ nautilus_core │ │ │ │ Rust │ │ │ │ │ └─────────────────────────┘
Type safety ¶
The design of the platform holds software correctness and safety at the highest level.
The Rust codebase in
is always type safe and memory safe as guaranteed by the
and so is
correct by construction
(unless explicitly marked
, see the Rust section of the
Cython provides type safety at the C level at both compile time, and runtime:
If you pass an argument with an invalid type to a Cython implemented module with typed parameters,
then you will receive a
If a function or methods parameter is not explicitly typed as allowing
, then you can assume you will receive a
as an argument at runtime.
The above exceptions are not explicitly documented, as this would bloat the docstrings significantly.
Errors and exceptions ¶
Every attempt has been made to accurately document the possible exceptions which can be raised from NautilusTrader code, and the conditions which will trigger them.
There may be other undocumented exceptions which can be raised by Pythons standard library, or from third party library dependencies.