[][src]Crate bitcoin_harness

bitcoin-harness

A simple lib to start a bitcoind container, generate blocks and funds addresses. Note: It uses tokio.

Examples

Just connect to bitcoind and get the network

use bitcoin_harness::{Bitcoind, bitcoind_rpc, Client};

let tc_client = testcontainers::clients::Cli::default();
let bitcoind = Bitcoind::new(&tc_client, "0.20.0").unwrap();
let client = Client::new(bitcoind.node_url);
let network = client.network().await.unwrap();

assert_eq!(network, bitcoin::Network::Regtest)

Create a wallet, fund it and get a UTXO

use bitcoin_harness::{Bitcoind, bitcoind_rpc, Client, Wallet};

let tc_client = testcontainers::clients::Cli::default();
let bitcoind = Bitcoind::new(&tc_client, "0.19.1").unwrap();
let client = Client::new(bitcoind.node_url.clone());

bitcoind.init(5).await.unwrap();

let wallet = Wallet::new("my_wallet", bitcoind.node_url.clone()).await.unwrap();
let address = wallet.new_address().await.unwrap();
let amount = bitcoin::Amount::from_btc(3.0).unwrap();

bitcoind.mint(address, amount).await.unwrap();

let balance = wallet.balance().await.unwrap();

assert_eq!(balance, amount);

let utxos = wallet.list_unspent().await.unwrap();

assert_eq!(utxos.get(0).unwrap().amount, 3.0);

Re-exports

pub use crate::bitcoind_rpc::Client;
pub use crate::wallet::Wallet;

Modules

bitcoind_rpc

An incomplete async bitcoind rpc client that support multi-wallet features

json_rpc
wallet

Structs

Bitcoind

Enums

Error

Type Definitions

Result