nautilus_blockchain/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//! Blockchain data adapter for [NautilusTrader](https://nautilustrader.io).
17//!
18//! The `nautilus-blockchain` crate provides a high-performance, universal, extensible adapter for ingesting
19//! DeFi data from decentralized exchanges (DEXs), liquidity pools, and on-chain events.
20//! It enables you to power analytics pipelines and trading strategies with real-time and historical
21//! on-chain data.
22//!
23//! # NautilusTrader
24//!
25//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
26//! engine for multi-asset, multi-venue trading systems.
27//!
28//! The system spans research, deterministic simulation, and live execution within a single
29//! event-driven architecture, providing research-to-live semantic parity.
30//!
31//! # Feature Flags
32//!
33//! This crate provides feature flags to control source code inclusion during compilation,
34//! depending on the intended use case, i.e. whether to provide Python bindings
35//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
36//! or as part of a Rust only build.
37//!
38//! - `hypersync`: Enables the [HyperSync](https://envio.dev/#hypersync) client integration.
39//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
40//! - `extension-module`: Builds as a Python extension module.
41//! - `turmoil`: Enables deterministic network simulation testing with [turmoil](https://github.com/tokio-rs/turmoil).
42
43#![warn(rustc::all)]
44#![deny(unsafe_code)]
45#![deny(nonstandard_style)]
46#![deny(missing_debug_implementations)]
47#![deny(clippy::missing_errors_doc)]
48#![deny(clippy::missing_panics_doc)]
49#![deny(rustdoc::broken_intra_doc_links)]
50
51pub mod config;
52pub mod constants;
53pub mod contracts;
54pub mod decode;
55pub mod events;
56pub mod math;
57pub mod reporting;
58pub mod rpc;
59
60#[cfg(feature = "hypersync")]
61pub mod cache;
62
63#[cfg(feature = "hypersync")]
64pub mod execution;
65
66#[cfg(feature = "hypersync")]
67pub mod data;
68
69#[cfg(feature = "hypersync")]
70pub mod exchanges;
71
72#[cfg(feature = "hypersync")]
73pub mod factories;
74
75#[cfg(feature = "hypersync")]
76pub mod hypersync;
77
78#[cfg(feature = "hypersync")]
79pub mod services;
80
81#[cfg(feature = "python")]
82pub mod python;