#environment #process #integration #integration-tests #electrs #temp-dir #connected


Utility to run a regtest electrs process, useful in integration testing environment

37 releases (breaking)

0.28.0 May 29, 2024
0.27.1 Jan 25, 2024
0.27.0 Dec 22, 2023
0.26.0 Oct 18, 2023
0.8.0 Jul 26, 2021

#795 in Magic Beans

Download history 1828/week @ 2024-02-14 2012/week @ 2024-02-21 2248/week @ 2024-02-28 2231/week @ 2024-03-06 1963/week @ 2024-03-13 2649/week @ 2024-03-20 1633/week @ 2024-03-27 2216/week @ 2024-04-03 2539/week @ 2024-04-10 2450/week @ 2024-04-17 2634/week @ 2024-04-24 2510/week @ 2024-05-01 2736/week @ 2024-05-08 2550/week @ 2024-05-15 2277/week @ 2024-05-22 3053/week @ 2024-05-29

11,245 downloads per month
Used in 13 crates (12 directly)

MIT license

602 lines

MIT license Crates


Utility to run a regtest electrs process connected to a given bitcoind instance, useful in integration testing environment.

let bitcoind = bitcoind::BitcoinD::new("/usr/local/bin/bitcoind").unwrap();
let electrsd = electrsd::ElectrsD::new("/usr/local/bin/electrs", bitcoind).unwrap();
let header = electrsd.client.block_headers_subscribe().unwrap();
assert_eq!(header.height, 0);

Automatic binaries download

In your project Cargo.toml, activate the following features

electrsd = { version= "0.23", features = ["bitcoind_23_1", "electrs_0_9_1"] }

Then use it:

let bitcoind_exe = bitcoind::downloaded_exe_path().expect("bitcoind version feature must be enabled");
let bitcoind = bitcoind::BitcoinD::new(bitcoind_exe).unwrap();
let electrs_exe = electrsd::downloaded_exe_path().expect("electrs version feature must be enabled");
let electrsd = electrsd::ElectrsD::new(electrs_exe, bitcoind).unwrap();

When the ELECTRSD_DOWNLOAD_ENDPOINT/BITCOIND_DOWNLOAD_ENDPOINT environment variables are set, electrsd/bitcoind will try to download the binaries from the given endpoints.

When you don't use the auto-download feature you have the following options:

  • have electrs executable in the PATH
  • provide the electrs executable via the ELECTRS_EXEC env var
if let Ok(exe_path) = electrsd::exe_path() {
  let electrsd = electrsd::electrsD::new(exe_path).unwrap();

Startup options could be configured via the Conf struct using electrsD::with_conf or electrsD::from_downloaded_with_conf.


For determinisim, in nix you cannot hit the internet within the build.rs. Moreover, some downstream crates cannot remove the auto-download feature from their dev-deps. In this case you can set the ELECTRSD_SKIP_DOWNLOAD env var and provide the electrs executable in the PATH (or skip the test execution).

Issues with traditional approach

I used integration testing based on external bash script launching needed external processes, there are many issues with this approach like:


  • electrsd use a temporary directory as db dir
  • A free port is asked to the OS (a very low probability race condition is still possible)
  • The process is killed when the struct goes out of scope no matter how the test finishes
  • Automatically download electrs executable with enabled features. Since there are no official binaries, they are built using the manual workflow under this project. Supported version are:

Thanks to these features every #[test] could easily run isolated with its own environment


  • Starting from version 0.26 the env var ELECTRS_EXE is deprecated in favor of ELECTRS_EXEC.

Used by


~283K SLoC