Skip to main content

Crate bitcoin_rs_node

Crate bitcoin_rs_node 

Source
Expand description

Integration crate for running a synchronous bitcoin-rs node.

The crate owns process-level concerns: layered configuration, storage backend selection, signal bridging, metrics/tracing setup, crash recovery, and the central crossbeam-driven event loop that connects the subsystem crates.

Re-exports§

pub use bip9_context::BlockTreeContext;
pub use block_source::NodeBlockSource;
pub use config::Auth;
pub use config::Config;
pub use p2p_chain::NodeP2pChainQuery;
pub use run::run;
pub use state::ApplyError;
pub use sync::BlockSync;
pub use utxo_view::UtxoSetView;
pub use zmq_publisher::NoOpZmqPublisher;
pub use zmq_publisher::SocketZmqPublisher;
pub use zmq_publisher::TracingZmqPublisher;
pub use zmq_publisher::ZmqPublisher;

Modules§

apply
Block-apply pipeline executed by NodeState::apply_block and BlockSync::tick. Block-apply pipeline over shared node handles.
bip9_context
BIP9 deployment-state adapter over BlockTree. Adapter implementing bitcoin_rs_consensus::DeploymentContext over bitcoin_rs_chain::BlockTree.
bitcoin_conf_compat
Bitcoin Core configuration compatibility.
block_source
Adapter.
config
Layered node configuration.
crash_recovery
Startup crash recovery. Startup crash-recovery: detect partial commits and replay the gap.
event_loop
Central synchronous event loop.
import
Block import pipeline. Block import pipeline (skeleton).
logging
Tracing initialization.
metrics
Metrics instrumentation and optional exposition.
p2p_chain
Node-side active-chain view for server-side P2P responders. Node-side adapter for server-side P2P active-chain requests.
run
Top-level node runner. Top-level orchestration: wire subsystems, spin the event loop, drain.
shutdown
Graceful shutdown.
signal
Signal handling.
state
Shared node state. Shared node state aggregating subsystem handles.
sync
Block download orchestrator. Block download orchestrator.
utxo_view
UTXO view adapter for consensus transaction checks. UtxoView adapter over the in-memory UtxoSet.
zmq_publisher
ZMQ publisher trait + implementations for the notification subsystem. ZMQ publisher trait and transport-backed implementation for node notifications.

Enums§

Network
A supported Bitcoin network.