Struct Discv4Config

pub struct Discv4Config {

    pub enable_packet_filter: bool,
    pub udp_egress_message_buffer: usize,
    pub udp_ingress_message_buffer: usize,
    pub max_find_node_failures: u8,
    pub ping_interval: Duration,
    pub ping_expiration: Duration,
    pub lookup_interval: Duration,
    pub request_timeout: Duration,
    pub enr_expiration: Duration,
    pub neighbours_expiration: Duration,
    pub ban_list: BanList,
    pub ban_duration: Option<Duration>,
    pub bootstrap_nodes: HashSet<NodeRecord>,
    pub enable_dht_random_walk: bool,
    pub enable_lookup: bool,
    pub enable_eip868: bool,
    pub enforce_expiration_timestamps: bool,
    pub additional_eip868_rlp_pairs: HashMap<Vec<u8>, Bytes>,
    pub external_ip_resolver: Option<NatResolver>,
    pub resolve_external_ip_interval: Option<Duration>,
    pub bond_expiration: Duration,
}

Configuration parameters that define the performance of the discovery network.

Fields

enable_packet_filter: bool

Whether to enable the incoming packet filter. Default: false.

udp_egress_message_buffer: usize

Size of the channel buffer for outgoing messages.

udp_ingress_message_buffer: usize

Size of the channel buffer for incoming messages.

max_find_node_failures: u8

The number of allowed consecutive failures for FindNode requests. Default: 5.

ping_interval: Duration

The interval to use when checking for expired nodes that need to be re-pinged. Default: 10min.

ping_expiration: Duration

The duration of we consider a ping timed out.

lookup_interval: Duration

The rate at which new random lookups should be triggered.

request_timeout: Duration

The duration of we consider a FindNode request timed out.

enr_expiration: Duration

The duration after which we consider an enr request timed out.

neighbours_expiration: Duration

The duration we set for neighbours responses.

ban_list: BanList

Provides a way to ban peers and ips.

ban_duration: Option<Duration>

Set the default duration for which nodes are banned for. This timeouts are checked every 5 minutes, so the precision will be to the nearest 5 minutes. If set to None, bans from the filter will last indefinitely. Default is 1 hour.

bootstrap_nodes: HashSet<NodeRecord>

Nodes to boot from.

enable_dht_random_walk: bool

Whether to randomly discover new peers.

If true, the node will automatically randomly walk the DHT in order to find new peers.

enable_lookup: bool

Whether to automatically lookup peers.

enable_eip868: bool

Whether to enforce EIP-868 extension.

enforce_expiration_timestamps: bool

Whether to respect expiration timestamps in messages.

additional_eip868_rlp_pairs: HashMap<Vec<u8>, Bytes>

Additional pairs to include in The Enr if EIP-868 extension is enabled https://eips.ethereum.org/EIPS/eip-868

external_ip_resolver: Option<NatResolver>

If configured, try to resolve public ip

resolve_external_ip_interval: Option<Duration>

If configured and a external_ip_resolver is configured, try to resolve the external ip using this interval.

bond_expiration: Duration

The duration after which we consider a bond expired.

Implementations

impl Discv4Config

pub fn builder() -> Discv4ConfigBuilder

Returns a new default builder instance

pub fn add_eip868_pair( &mut self, key: impl Into<Vec<u8>>, value: impl Encodable, ) -> &mut Self

Add another key value pair to include in the ENR

pub fn add_eip868_rlp_pair( &mut self, key: impl Into<Vec<u8>>, rlp: Bytes, ) -> &mut Self

Add another key value pair to include in the ENR

pub fn extend_eip868_rlp_pairs( &mut self, pairs: impl IntoIterator<Item = (impl Into<Vec<u8>>, Bytes)>, ) -> &mut Self

Extend additional key value pairs to include in the ENR

pub fn resolve_external_ip_interval(&self) -> Option<ResolveNatInterval>

Returns the corresponding [ResolveNatInterval], if a NatResolver and an interval was configured

Trait Implementations

impl Clone for Discv4Config

fn clone(&self) -> Discv4Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Discv4Config

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

Formats the value using the given formatter.

impl Default for Discv4Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Discv4Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Discv4Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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: 376 bytes