BitcoinClient

Struct BitcoinClient 

Source
pub struct BitcoinClient { /* private fields */ }
Expand description

Bitcoin Core RPC client wrapper with automatic reconnection

§Examples

use kaccy_bitcoin::{BitcoinClient, BitcoinNetwork};

let client = BitcoinClient::new(
    "http://localhost:8332",
    "rpcuser",
    "rpcpassword",
    BitcoinNetwork::Testnet,
)?;

// Check connection health
let is_healthy = client.health_check()?;
println!("Bitcoin node healthy: {}", is_healthy);

Implementations§

Source§

impl BitcoinClient

Source

pub fn new( url: &str, user: &str, password: &str, network: BitcoinNetwork, ) -> Result<Self>

Create a new Bitcoin RPC client

§Examples
use kaccy_bitcoin::{BitcoinClient, BitcoinNetwork};

let client = BitcoinClient::new(
    "http://localhost:18443",
    "user",
    "pass",
    BitcoinNetwork::Regtest,
)?;
Source

pub fn with_config( url: &str, user: &str, password: &str, network: BitcoinNetwork, reconnect_config: ReconnectConfig, ) -> Result<Self>

Create a new Bitcoin RPC client with custom reconnection config

Source

pub fn network(&self) -> BitcoinNetwork

Get the configured network

Source

pub fn health_check(&self) -> Result<bool>

Check if the connection is healthy

Source

pub fn get_blockchain_info(&self) -> Result<GetBlockchainInfoResult>

Get blockchain info

Source

pub fn get_network_info(&self) -> Result<GetNetworkInfoResult>

Get network info

Source

pub fn get_block_height(&self) -> Result<u64>

Get current block height

Source

pub fn get_best_block_hash(&self) -> Result<BlockHash>

Get best block hash

Source

pub fn get_new_address( &self, label: Option<&str>, ) -> Result<Address<NetworkUnchecked>>

Generate a new address

Source

pub fn get_received_by_address( &self, address: &Address, min_confirmations: Option<u32>, ) -> Result<Amount>

Get amount received by address

Source

pub fn get_transaction(&self, txid: &Txid) -> Result<GetTransactionResult>

Get transaction by ID

Source

pub fn get_raw_transaction( &self, txid: &Txid, ) -> Result<GetRawTransactionResult>

Get raw transaction

Source

pub fn list_unspent( &self, min_conf: Option<usize>, max_conf: Option<usize>, addresses: Option<&[&Address<NetworkChecked>]>, ) -> Result<Vec<ListUnspentResultEntry>>

Get unspent transactions for an address

Source

pub fn get_balance(&self) -> Result<Amount>

Get wallet balance

Source

pub fn validate_address(&self, address: &str) -> Result<AddressValidation>

Validate an address (basic validation without RPC)

Source

pub fn get_mempool_info(&self) -> Result<GetMempoolInfoResult>

Get mempool info

Source

pub fn estimate_smart_fee(&self, conf_target: u16) -> Result<Option<f64>>

Estimate smart fee (sats/vB)

Source§

impl BitcoinClient

Source

pub fn get_node_status(&self) -> Result<NodeStatus>

Get comprehensive node status

Source

pub fn list_since_block( &self, block_hash: Option<&BlockHash>, target_confirmations: Option<usize>, ) -> Result<ListSinceBlockResult>

List transactions since a specific block

Source

pub fn get_address_info(&self, address: &str) -> Result<AddressInfo>

Get detailed address info including balance

Source

pub fn send_raw_transaction(&self, tx_hex: &str) -> Result<Txid>

Send raw transaction to the network

Source

pub fn get_block_hash(&self, height: u64) -> Result<BlockHash>

Get block by height

Source

pub fn test_mempool_accept(&self, tx_hex: &str) -> Result<bool>

Test mempool accept for a transaction

Source

pub fn generate_to_address( &self, blocks: u64, address: &Address, ) -> Result<Vec<BlockHash>>

Generate blocks to an address (regtest only)

Source

pub fn send_to_address(&self, address: &Address, amount: Amount) -> Result<Txid>

Send to an address

Source

pub fn invalidate_block(&self, block_hash: &BlockHash) -> Result<()>

Invalidate a block (regtest only)

Source

pub fn reconsider_block(&self, block_hash: &BlockHash) -> Result<()>

Reconsider a block (regtest only)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more