Struct nakamoto_node::client::Handle

pub struct Handle<W>where
    W: Waker,{ /* private fields */ }

An instance of handle::Handle for Client.

Implementations

impl<W> Handle<W>where
    W: Waker,

pub fn listening(&mut self) -> Result<SocketAddr, Error>

Wait for node to start listening for incoming connections.

pub fn set_timeout(&mut self, timeout: Duration)

Set the timeout for operations that wait on the network.

pub fn get_peers(
    &self,
    services: impl Into<ServiceFlags>
) -> Result<Vec<Peer, Global>, Error>

Get connected peers.

pub fn get_block_by_height(
    &self,
    height: u64
) -> Result<Option<BlockHeader>, Error>

Get block by height.

Trait Implementations

impl<W> Clone for Handle<W>where
    W: Waker,

fn clone(&self) -> Handle<W>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W> Handle for Handle<W>where
    W: Waker,

fn get_tip(&self) -> Result<(u64, BlockHeader), Error>

Get the tip of the chain.

fn query_tree(
    &self,
    query: impl Fn(&dyn BlockReader) + Send + Sync + 'static
) -> Result<(), Error>

Query the block tree using the given function. To return results from the query function, a channel may be used.

fn find_branch(
    &self,
    to: &BlockHash
) -> Result<Option<(u64, NonEmpty<BlockHeader>)>, Error>

Find a branch from the active chain to the given (stale) block.

fn get_block(&self, hash: &BlockHash) -> Result<(), Error>

Get a full block from the network.

fn get_filters(&self, range: RangeInclusive<u64>) -> Result<(), Error>

Get compact filters from the network.

fn blocks(&self) -> Receiver<(Block, u64)>

Subscribe to blocks received.

fn filters(&self) -> Receiver<(BlockFilter, BlockHash, u64)>

Subscribe to compact filters received.

fn subscribe(&self) -> Receiver<Event>

Subscribe to SPV events.

fn command(&self, cmd: Command) -> Result<(), Error>

Send a command to the client.

fn broadcast(
    &self,
    msg: NetworkMessage,
    predicate: fn(Peer) -> bool
) -> Result<Vec<SocketAddr, Global>, Error>

Broadcast a message to peers matching the predicate. To only broadcast to outbound peers, use Peer::is_outbound.

fn query(&self, msg: NetworkMessage) -> Result<Option<SocketAddr>, Error>

Send a message to a random outbound peer. Return the chosen peer or nothing if no peer was available.

fn connect(&self, addr: SocketAddr) -> Result<Link, Error>

Connect to the designated peer address.

fn disconnect(&self, addr: SocketAddr) -> Result<(), Error>

Disconnect from the designated peer address.

fn import_headers(
    &self,
    headers: Vec<BlockHeader, Global>
) -> Result<Result<ImportResult, Error>, Error>

Import block headers into the node. This may cause the node to broadcast header or inventory messages to its peers.

fn import_addresses(&self, addrs: Vec<Address, Global>) -> Result<(), Error>

Import peer addresses into the node’s address book.

fn submit_transaction(
    &self,
    tx: Transaction
) -> Result<NonEmpty<SocketAddr>, Error>

Submit a transaction to the network.

fn wait<F, T>(&self, f: F) -> Result<T, Error>where
    F: FnMut(Event) -> Option<T>,

Wait for the given predicate to be fulfilled.

fn wait_for_peers(
    &self,
    count: usize,
    required_services: impl Into<ServiceFlags>
) -> Result<Vec<(SocketAddr, u64, ServiceFlags), Global>, Error>

Wait for a given number of peers to be connected with the given services.

fn wait_for_height(&self, h: u64) -> Result<BlockHash, Error>

Wait for the node’s active chain to reach a certain height. The hash at that height is returned.

fn events(&self) -> Receiver<Event>

Listen on events.

fn shutdown(self) -> Result<(), Error>

Shutdown the node process.

fn rescan(
    &self,
    range: impl RangeBounds<u64>,
    watch: impl Iterator<Item = Script>
) -> Result<(), Error>

Rescan the blockchain for matching scripts.

fn watch(&self, watch: impl Iterator<Item = Script>) -> Result<(), Error>

Update the watchlist with the provided scripts.