Struct BitcoinD 

pub struct BitcoinD { /* private fields */ }

A running bitcoind regtest node.

The node is started in BitcoinD::from_bin (or one of its siblings) and stopped — and its temporary files removed — when this value is dropped.

Wallet

A wallet named "wallet" is created (or loaded) automatically on startup. All RPC helpers that require a wallet (generate, new_address, …) use this wallet.

Networking

Both the RPC and P2P ports are chosen from the OS’s ephemeral range at startup. Use rpc_socket and get_p2p_socket to discover them after construction.

Implementations

impl BitcoinD

pub fn new() -> Result<BitcoinD, Error>

Start a BitcoinD node using the binary located by get_bitcoind_path, with the default BitcoinDConf.

If the binary is not cached under target/bin/, it will fetch one from bitcoincore.org per build.rs.

pub fn new_with_conf(conf: &BitcoinDConf<'_>) -> Result<BitcoinD, Error>

Start a BitcoinD node using the binary located by get_bitcoind_path, with a custom BitcoinDConf.

If the binary is not cached under target/bin/, it will fetch one from bitcoincore.org per build.rs.

pub fn from_bin<P: AsRef<Path>>(bitcoind_bin: P) -> Result<BitcoinD, Error>

Create a BitcoinD instance running the binary at Path with the default BitcoinDConf.

pub fn from_bin_with_conf<P: AsRef<Path>>( bitcoind_bin: P, conf: &BitcoinDConf<'_>, ) -> Result<BitcoinD, Error>

Create a BitcoinD instance running the binary at Path with a custom BitcoinDConf. The method retries up to BitcoinDConf::max_retries times. On each attempt it:

1. Picks fresh ephemeral RPC and P2P ports.
2. Spawns bitcoind with those ports and a fresh data directory.
3. Waits for the cookie file to appear (up to 5 s).
4. Creates or loads the default wallet and builds an RPC client.
5. Waits for the node to become responsive (up to 5 s).

Returns an error if all attempts are exhausted.

pub fn stop(&mut self) -> Result<ExitStatus, Error>

Send stop via RPC and wait for the process to exit.

Calling this method is not required in normal usage because Drop kills the process automatically. It is provided for cases where you need the exit status or want to ensure the node has fully shut down before proceeding.

pub fn get_pid(&self) -> u32

Get BitcoinD’s PID process.

pub fn get_working_directory(&self) -> PathBuf

Get BitcoinD’s data directory.

pub fn get_p2p_socket(&self) -> SocketAddr

Get BitcoinD’s P2P SocketAddr.

Pass this to BitcoinD::add_peer on another node to connect the two.

pub fn get_rpc_client(&self) -> &Client

Get a reference to BitcoinD’s RPC Client.

pub fn rpc_socket(&self) -> SocketAddr

Get BitcoinD’s JSON-RPC SocketAddr.

pub fn cookie_file(&self) -> &Path

Get the Path to BitcoinD’s cookie file.

pub fn get_chain_tip(&self) -> Result<u32, Error>

Get the current chain height.

pub fn get_filter_tip(&self) -> Result<u32, Error>

Get the current filter height.

pub fn get_block_hash(&self, height: u32) -> Result<BlockHash, Error>

Get the BlockHash of the block at height height.

pub fn has_peer(&self, socket: SocketAddr) -> Result<bool, Error>

Check whether this BitcoinD has a peer with a specific SocketAddr.

pub fn add_peer(&self, socket: SocketAddr) -> Result<(), Error>

Connect this BitcoinD to a peer at socket and wait until the connection is established.

Returns an error if the peer does not appear in getpeerinfo within the timeout.

pub fn get_peer_count(&self) -> Result<u32, Error>

Get BitcoinD’s peer count.

pub fn generate(&self, count: u32) -> Result<Vec<BlockHash>, Error>

Generate count blocks.

Returns the block hashes as a Vec<BlockHash>.

pub fn generate_to_address( &self, count: u32, address: &Address, ) -> Result<Vec<BlockHash>, Error>

Generate count blocks using the provided Address as the coinbase output Address.

Returns the block hashes as a Vec<BlockHash>.

Trait Implementations

impl Debug for BitcoinD

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for BitcoinD

fn drop(&mut self)

Gracefully stops the node (if it was started with a persistent directory) and kills the process.

Errors from stop and kill are silently discarded so that Drop never panics.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Node for BitcoinD

fn get_name() -> &'static str

The Node’s human-readable name.

fn get_bin_name() -> &'static str

The Node’s binary name.

fn get_p2p_socket(&self) -> SocketAddr

Get the Node’s P2P SocketAddr.

fn has_peer(&self, socket: SocketAddr) -> Result<bool, Error>

Check whether the Node is connected to a peer with a specific SocketAddr.

fn add_peer(&self, socket: SocketAddr) -> Result<(), Error>

Connect this Node to a peer at socket over P2P.

fn get_peer_count(&self) -> Result<u32, Error>

Get this Node’ s peer count.

fn get_chain_tip(&self) -> Result<u32, Error>

Get the Node’s current chain height.

fn get_filter_tip(&self) -> Result<u32, Error>

Get the Node’s current CBF height.

fn get_block_hash(&self, height: u32) -> Result<BlockHash, Error>

fn call(&self, method: &str, args: &[Value]) -> Result<Value, Error>

Call a JSON-RPC method with the given args list.

fn poll_interval() -> Duration

How long to sleep between get_height RPC calls.

fn wait_timeout() -> Duration

How long wait_for_height will poll before giving up.