Struct bitcoind::BitcoinD

pub struct BitcoinD {
    pub client: Client,
    pub params: ConnectParams,
    // some fields omitted
}

Struct representing the bitcoind process with related information

Fields

client: Client

Rpc client linked to this bitcoind process

params: ConnectParams

Contains information to connect to this node

Implementations

impl BitcoinD

pub fn new<S: AsRef<OsStr>>(exe: S) -> Result<BitcoinD, Error>

Launch the bitcoind process from the given exe executable with default args.

Waits for the node to be ready to accept connections before returning

pub fn with_conf<S: AsRef<OsStr>>(
    exe: S,
    conf: &Conf<'_>
) -> Result<BitcoinD, Error>

Launch the bitcoind process from the given exe executable with given Conf param

pub fn rpc_url(&self) -> String

Returns the rpc URL including the schema eg. http://127.0.0.1:44842

pub fn rpc_url_with_wallet<T: AsRef<str>>(&self, wallet_name: T) -> String

Returns the rpc URL including the schema and the given wallet_name eg. http://127.0.0.1:44842/wallet/my_wallet

pub fn p2p_connect(&self, listen: bool) -> Option<P2P>

Returns the P2P enum to connect to this node p2p port

pub fn stop(&mut self) -> Result<ExitStatus, Error>

Stop the node, waiting correct process termination

pub fn create_wallet<T: AsRef<str>>(&self, wallet: T) -> Result<Client, Error>

Create a new wallet in the running node, and return an RPC client connected to the just created wallet

Trait Implementations

impl Drop for BitcoinD

fn drop(&mut self)

Executes the destructor for this type.