lib.rs

//! Standalone crate for Optimism Trie Node storage.
//!
//! External storage for intermediary trie nodes that are otherwise discarded by pipeline and
//! live sync upon successful state root update. Storing these intermediary trie nodes enables
//! efficient retrieval of inputs to proof computation for duration of OP fault proof window.

#![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/"
)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]

// Used only for feature propagation (serde-bincode-compat workaround).
#[cfg(feature = "serde-bincode-compat")]
use reth_ethereum_primitives as _;

pub mod api;
pub use api::{BlockStateDiff, OpProofsInitProvider, OpProofsProviderRO, OpProofsProviderRw, OpProofsStore};

pub mod initialize;
pub use initialize::InitializationJob;

pub mod in_memory;
pub use in_memory::{
    InMemoryAccountCursor, InMemoryProofsStorage, InMemoryStorageCursor, InMemoryTrieCursor,
};

pub mod db;
pub use db::{
    MdbxAccountCursor, MdbxProofsStorage, MdbxProofsStorageV2, MdbxStorageCursor, MdbxTrieCursor,
};

#[cfg(feature = "metrics")]
pub mod metrics;
#[cfg(feature = "metrics")]
pub use metrics::{
    OpProofsHashedAccountCursor, OpProofsHashedStorageCursor, OpProofsStorage, OpProofsTrieCursor,
    StorageMetrics,
};

#[cfg(not(feature = "metrics"))]
/// Alias for [`OpProofsStore`] type without metrics (`metrics` feature is disabled).
pub type OpProofsStorage<S> = S;

pub mod proof;

pub mod provider;
pub mod overlay_provider;

pub mod live;

pub mod cursor;
#[cfg(not(feature = "metrics"))]
pub use cursor::{OpProofsHashedAccountCursor, OpProofsHashedStorageCursor, OpProofsTrieCursor};

pub mod cursor_factory;
pub use cursor_factory::{OpProofsHashedAccountCursorFactory, OpProofsTrieCursorFactory};

pub mod error;
pub use error::{OpProofsStorageError, OpProofsStorageResult};

mod prune;
pub use prune::{
    OpProofStoragePruner, OpProofStoragePrunerResult, OpProofStoragePrunerTask, PrunerError,
    PrunerOutput,
};

pub mod state;
pub mod persistence;