Crate bitceptron_regtest_utils

This is a tiny Bitcoin Regtest utility crate.

Usage:

const BITCOIND_PATH: &str = "/Users/x/Desktop/bitcoin-26.0/bin/bitcoind";
const BITCOIN_CONF_PATH: &str = "/Users/x/Desktop/bitcoin-26.0/bitcoin.conf";
const TEMP_PATH: &str = "/Users/x/Desktop/regtemp";
const NETWORK: Network = Network::Regtest;
 
let mut clients = spawn_regtest(
       BITCOIND_PATH,
       BITCOIN_CONF_PATH,
       TEMP_PATH,
       vec![
           RegtestConf::new(18447, 18448).unwrap(),
           RegtestConf::new(18449, 18450).unwrap(),
       ],
       500,
       2,
   )
   .unwrap();
let mining_client = clients.remove(0);
let rusty_client = clients.remove(0);
 
let mining_address = mining_client
       .get_new_address(Some("mining"), Some(AddressType::Bech32))
       .unwrap()
       .require_network(NETWORK)
       .unwrap();
let _ = mining_client
       .generate_to_address(150, &mining_address)
       .unwrap();
unwind_regtest(vec![rusty_client, mining_client], TEMP_PATH, 200);

Structs

RegtestConf

A config struct for Regtest instances. Just a port for instances to connect through and an rpc-port for rpc calls.

Enums

RegtestUtilsError

Errors of the crate.

Functions

get_balance

This functions gets the balance of an x-only pubkey descriptor.

send_and_mine

This function is to send and mine a transaction.

spawn_regtest

This function runs one or more regtest instances on your system.

unwind_regtest

This function stops regtest instances and removes the temp folder.