Struct ConfigBuilder 

pub struct ConfigBuilder { /* private fields */ }

Builds a Config.

Implementations

impl ConfigBuilder

pub fn new_from(discv5_config: Config) -> Self

Returns a new builder, with all fields set like given instance.

pub fn discv5_config(self, discv5_config: Config) -> Self

Set [discv5::Config], which contains the [discv5::Discv5] listen socket.

pub fn add_signed_boot_nodes(self, nodes: impl IntoIterator<Item = Enr>) -> Self

Adds multiple boot nodes from a list of Enrs.

pub fn add_cl_serialized_signed_boot_nodes(self, enrs: &str) -> Self

Parses a comma-separated list of serialized Enrs, signed node records, and adds any successfully deserialized records to boot nodes. Note: this type is serialized in CL format since [discv5] is originally a CL library.

pub fn add_unsigned_boot_nodes( self, enodes: impl IntoIterator<Item = NodeRecord>, ) -> Self

Adds boot nodes in the form a list of NodeRecords, parsed enodes.

pub fn add_serialized_unsigned_boot_nodes(self, enodes: &[&str]) -> Self

Adds a comma-separated list of enodes, serialized unsigned node records, to boot nodes.

pub const fn fork(self, fork_key: &'static [u8], fork_id: ForkId) -> Self

Set fork ID kv-pair to set in local Enr. This lets peers on discovery network know which chain this node belongs to.

pub const fn fork_if_unset( self, fork_key: &'static [u8], fork_id: ForkId, ) -> Self

Sets the fork ID kv-pair if none has already been configured.

pub const fn tcp_socket(self, socket: SocketAddr) -> Self

Sets the tcp socket to advertise in the local Enr. The IP address of this socket will overwrite the discovery address of the same IP version, if one is configured.

pub const fn advertised_ip(self, ip: IpAddr) -> Self

Sets the IP address to advertise in the local Enr, without changing the discv5 listen socket.

Routed to the matching address family, so calling this once per family yields a dual-stack advertisement.

pub fn add_enr_kv_pair(self, key: &'static [u8], value: Bytes) -> Self

Adds an additional kv-pair to include in the local Enr. Takes the key to use for the kv-pair and the rlp encoded value.

pub const fn lookup_interval(self, seconds: u64) -> Self

Sets the interval at which to run lookup queries, in order to fill kbuckets. Lookup queries are done periodically at the given interval for the whole run of the program.

pub const fn bootstrap_lookup_interval(self, seconds: u64) -> Self

Sets the interval at which to run boost lookup queries at start up. Queries will be started at this interval for the configured number of times after start up.

pub const fn bootstrap_lookup_countdown(self, counts: u64) -> Self

Sets the number of times at which to run boost lookup queries to bootstrap the node.

pub fn must_not_include_keys(self, not_keys: &[&'static [u8]]) -> Self

Adds keys to disallow when filtering a discovered peer, to determine whether or not it should be passed to rlpx. The discovered node record is scanned for any kv-pairs where the key matches the disallowed keys. If not explicitly set, b“eth2“ key will be disallowed.

pub fn build(self) -> Config

Returns a new Config.

Trait Implementations

impl Debug for ConfigBuilder

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 888 bytes