bitceptron_regtest_utils 0.5.0

A tiny utility crate for running bitcoin's regtest network.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! 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);
//! ```
mod error;
mod spawn_regtest;
mod common;
mod unwind_regtest;

pub use spawn_regtest::{spawn_regtest, RegtestConf};
pub use unwind_regtest::unwind_regtest;
pub use common::{send_and_mine, get_balance};
pub use error::RegtestUtilsError;