nautilus_hyperliquid/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//! [NautilusTrader](https://nautilustrader.io) adapter for the [Hyperliquid](https://hyperliquid.gitbook.io/hyperliquid-docs) decentralized exchange.
17//!
18//! The `nautilus-hyperliquid` crate provides integration with the Hyperliquid API for
19//! trading perpetual futures on a decentralized exchange.
20//!
21//! # NautilusTrader
22//!
23//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
24//! engine for multi-asset, multi-venue trading systems.
25//!
26//! The system spans research, deterministic simulation, and live execution within a single
27//! event-driven architecture, providing research-to-live semantic parity.
28//!
29//! # Feature Flags
30//!
31//! This crate provides feature flags to control source code inclusion during compilation,
32//! depending on the intended use case, i.e. whether to provide Python bindings
33//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
34//! or as part of a Rust only build.
35//!
36//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
37//! - `extension-module`: Builds as a Python extension module.
38//!
39//! [High-precision mode](https://nautilustrader.io/docs/nightly/getting_started/installation#precision-mode) (128-bit value types) is enabled by default.
40
41#![warn(rustc::all)]
42#![deny(unsafe_code)]
43#![deny(nonstandard_style)]
44#![deny(missing_debug_implementations)]
45// #![deny(clippy::missing_errors_doc)]
46#![deny(clippy::missing_panics_doc)]
47#![deny(rustdoc::broken_intra_doc_links)]
48
49pub mod common;
50pub mod config;
51pub mod data;
52pub mod execution;
53pub mod factories;
54pub mod http;
55pub mod signing;
56pub mod websocket;
57
58#[cfg(feature = "python")]
59pub mod python;
60
61pub use crate::{
62 config::{HyperliquidDataClientConfig, HyperliquidExecClientConfig},
63 data::HyperliquidDataClient,
64 execution::HyperliquidExecutionClient,
65 factories::{
66 HyperliquidDataClientFactory, HyperliquidExecFactoryConfig,
67 HyperliquidExecutionClientFactory,
68 },
69 http::client::HyperliquidHttpClient,
70 websocket::client::HyperliquidWebSocketClient,
71};