Utility to run a regtest bitcoind process, useful in integration testing environment.
rust
use bitcoincore_rpc::RpcApi;
let exe_path = exe_path().expect("bitcoind executable must be provided in BITCOIND_EXE, or with a feature like '23_0', or be in PATH");
let bitcoind = bitcoind::BitcoinD::new(exe_path).unwrap();
assert_eq!(0, bitcoind.client.get_blockchain_info().unwrap().blocks);
When a feature like 23_0 is selected, the build script will automatically download the bitcoin core version 23.0, verify the hashes and place it in the build directory for this crate.
Use utility function downloaded_exe_path() to get the downloaded executable path.
In your project Cargo.toml, activate the following features
```toml
[dev-dependencies] bitcoind = { version = "0.20.0", features = [ "23_0" ] } ```
Then use it:
rust
let bitcoind = bitcoind::BitcoinD::new(bitcoind::downloaded_exe_path().unwrap()).unwrap();
When the BITCOIND_DOWNLOAD_ENDPOINT environment variable is set, bitcoind will try to download the binaries from the given endpoint. Otherwise it defaults to https://bitcoincore.org/bin/.
The MSRV is 1.41.1 for version 0.29.* if no feature is used, otherwise is 1.57
Note: to respect 1.41.1 MSRV you need to use and older version of the which and tempfile dependencies, like it's done in the CI cargo update -p which --precise 4.3.0 and cargo update -p tempfile --precise 3.3.0. Pinning in Cargo.toml is avoided because it could cause compilation issues downstream.
I used integration testing based on external bash script launching needed external processes, there are many issues with this approach like:
/dev/shm)Thanks to these features every #[test] could easily run isolated with its own environment.