Struct Builder

pub struct Builder<S, C = NoChainTip>
where
    S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static,
    S::Future: Send,
    C: ChainTip + Clone + Send + 'static,
{
    config: Option<Config>,
    our_services: Option<PeerServices>,
    user_agent: Option<String>,
    relay: Option<bool>,
    inbound_service: Option<S>,
    address_book_updater: Option<Sender<MetaAddrChange>>,
    inv_collector: Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>,
    latest_chain_tip: C,
}

A builder for Handshake.

Fields

config: Option<Config>

our_services: Option<PeerServices>

user_agent: Option<String>

relay: Option<bool>

inbound_service: Option<S>

address_book_updater: Option<Sender<MetaAddrChange>>

inv_collector: Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>

latest_chain_tip: C

Implementations

impl<S, C> Builder<S, C>

where S: Service<Request, Response = Response, Error = BoxError> + Clone + Send + 'static, S::Future: Send, C: ChainTip + Clone + Send + 'static,

pub fn with_config(self, config: Config) -> Self

Provide a config. Mandatory.

pub fn with_inbound_service(self, inbound_service: S) -> Self

Provide a service to handle inbound requests. Mandatory.

pub fn with_inventory_collector( self, inv_collector: Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>, ) -> Self

Provide a channel for registering inventory advertisements. Optional.

This channel takes transient remote addresses, which the PeerSet uses to look up peers that have specific inventory.

pub fn with_address_book_updater( self, address_book_updater: Sender<MetaAddrChange>, ) -> Self

Provide a hook for timestamp collection. Optional.

This channel takes MetaAddrs, permanent addresses which can be used to make outbound connections to peers.

pub fn with_advertised_services(self, services: PeerServices) -> Self

Provide the services this node advertises to other peers. Optional.

If this is unset, the node will advertise itself as a client.

pub fn with_user_agent(self, user_agent: String) -> Self

Provide this node’s user agent. Optional.

This must be a valid BIP14 string. If it is unset, the user-agent will be empty.

pub fn with_latest_chain_tip<NewC>( self, latest_chain_tip: NewC, ) -> Builder<S, NewC>

where NewC: ChainTip + Clone + Send + 'static,

Provide a realtime endpoint to obtain the current best chain tip block height. Optional.

If this is unset, the minimum accepted protocol version for peer connections is kept constant over network upgrade activations.

Use NoChainTip to explicitly provide no chain tip.

pub fn want_transactions(self, relay: bool) -> Self

Whether to request that peers relay transactions to our node. Optional.

If this is unset, the node will not request transactions.

pub fn finish(self) -> Result<Handshake<S, C>, &'static str>

Consume this builder and produce a Handshake.

Returns an error only if any mandatory field was unset.