Enum UserRequest

pub enum UserRequest {
    Config,
    Block(BlockHash),
    UtreexoProof(BlockHash),
    MempoolTransaction(Txid),
    GetPeerInfo,
    GetConnectionCount,
    Add((IpAddr, u16, bool)),
    Remove((IpAddr, u16)),
    Onetry((IpAddr, u16, bool)),
    Disconnect((IpAddr, u16)),
    Ping,
    SendTransaction(Transaction),
}

A request that can be made to the node.

While the node is running, consumers may want to request some useful data, like block data, mempool transactions or tell the node to connect with some given peers. This struct represents all the possible requests that can be made to the node as well as the data that needs to be sent along with the request.

Variants

Config

Request the UtreexoNodeConfig of the node.

Block(BlockHash)

Get a block by its hash.

This will cause network requests to be made to fetch the block data.

UtreexoProof(BlockHash)

Get the Utreexo proof and LeafData for a block by its hash.

MempoolTransaction(Txid)

Get an unconfirmed transaction from the mempool by its ID.

GetPeerInfo

Return information about all connected peers.

GetConnectionCount

Return the number of connected peers.

Add((IpAddr, u16, bool))

Add a peer to the node’s peer list.

This function will add this peer to a special list of peers such that, if we lose the connection, we will keep trying to connect to it until we succeed.

Remove((IpAddr, u16))

Removes a node from the node’s peer list.

This function will remove a node that was added with AddNode::Add. This will not disconnect the peer, but if it disconnects, it will not be reconnected again.

Onetry((IpAddr, u16, bool))

Attempts to connect to a peer once.

Different from AddNode::Add, this function will try to connect to the peer once, but will not add it to the node’s added peers list.

Disconnect((IpAddr, u16))

Attempt to disconnect from a peer.

Ping

Ping all connected peers to check if they are alive.

SendTransaction(Transaction)

Adds a transaction to mempool and advertises it

Trait Implementations

impl Clone for UserRequest

fn clone(&self) -> UserRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserRequest

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

Formats the value using the given formatter.

impl Hash for UserRequest

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UserRequest

fn eq(&self, other: &UserRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for UserRequest

impl StructuralPartialEq for UserRequest