Files
reth/crates/interfaces/src/lib.rs
2023-09-28 14:27:30 +00:00

44 lines
1.1 KiB
Rust

//! A collection of shared traits and error types used in Reth.
//!
//! ## Feature Flags
//!
//! - `test-utils`: Export utilities for testing
#![doc(
html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",
html_favicon_url = "https://avatars0.githubusercontent.com/u/97369466?s=256",
issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
)]
#![warn(missing_debug_implementations, missing_docs, unreachable_pub, rustdoc::all)]
#![deny(unused_must_use, rust_2018_idioms)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
/// Consensus traits.
pub mod consensus;
/// Database error
pub mod db;
/// Block Execution traits.
pub mod executor;
/// Possible errors when interacting with the chain.
mod error;
pub use error::{RethError, RethResult};
/// P2P traits.
pub mod p2p;
/// Provider error
pub mod provider;
/// Syncing related traits.
pub mod sync;
/// BlockchainTree related traits.
pub mod blockchain_tree;
#[cfg(any(test, feature = "test-utils"))]
/// Common test helpers for mocking out Consensus, Downloaders and Header Clients.
pub mod test_utils;