Struct bdk_debug::blockchain::compact_filters::Peer

pub struct Peer { /* private fields */ }

Available on crate feature compact_filters only.

A Bitcoin peer

Implementations

impl Peer

pub fn connect<A: ToSocketAddrs>( address: A, mempool: Arc<Mempool>, network: Network ) -> Result<Self, CompactFiltersError>

Connect to a peer over a plaintext TCP connection

This function internally spawns a new thread that will monitor incoming messages from the peer, and optionally reply to some of them transparently, like pings

pub fn connect_proxy<T: ToTargetAddr, P: ToSocketAddrs>( target: T, proxy: P, credentials: Option<(&str, &str)>, mempool: Arc<Mempool>, network: Network ) -> Result<Self, CompactFiltersError>

Connect to a peer through a SOCKS5 proxy, optionally by using some credentials, specified as a tuple of (username, password)

This function internally spawns a new thread that will monitor incoming messages from the peer, and optionally reply to some of them transparently, like pings

pub fn get_version(&self) -> &VersionMessage

Return the VersionMessage sent by the peer

pub fn get_network(&self) -> Network

Return the Bitcoin Network in use

pub fn get_mempool(&self) -> Arc<Mempool>

Return the mempool used by this peer

pub fn is_connected(&self) -> bool

Return whether or not the peer is still connected

pub fn send(&self, payload: NetworkMessage) -> Result<(), CompactFiltersError>

Send a raw Bitcoin message to the peer

pub fn recv( &self, wait_for: &'static str, timeout: Option<Duration> ) -> Result<Option<NetworkMessage>, CompactFiltersError>

Waits for a specific incoming Bitcoin message, optionally with a timeout

Trait Implementations

impl Debug for Peer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.