nautilus_deribit/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 [Deribit](https://www.deribit.com) cryptocurrency exchange.
17//!
18//! The `nautilus-deribit` crate provides client bindings (HTTP & WebSocket), data
19//! models and helper utilities that wrap the official **Deribit API v2**.
20//!
21//! Deribit uses JSON-RPC 2.0 over both HTTP and WebSocket transports (not REST).
22//! WebSocket is preferred for subscriptions and real-time data.
23//!
24//! The official Deribit API reference can be found at <https://docs.deribit.com/v2/>.
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//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
42//! - `extension-module`: Builds as a Python extension module.
43//!
44//! [High-precision mode](https://nautilustrader.io/docs/nightly/getting_started/installation#precision-mode) (128-bit value types) is enabled by default.
45
46#![warn(rustc::all)]
47#![deny(unsafe_code)]
48#![deny(nonstandard_style)]
49#![deny(missing_debug_implementations)]
50#![deny(clippy::missing_errors_doc)]
51#![deny(clippy::missing_panics_doc)]
52#![deny(rustdoc::broken_intra_doc_links)]
53
54pub mod common;
55pub mod config;
56pub mod data;
57pub mod execution;
58pub mod factories;
59pub mod http;
60pub mod websocket;
61
62#[cfg(feature = "python")]
63pub mod python;