Struct Discv5 

pub struct Discv5 { /* private fields */ }

Transparent wrapper around [discv5::Discv5].

Implementations

impl Discv5

pub fn add_node(&self, node_record: Enr<SecretKey>) -> Result<(), Error>

Adds the node to the table, if it is not already present.

pub fn set_eip868_in_local_enr(&self, key: Vec<u8>, rlp: Bytes)

Sets the pair in the EIP-868 Enr of the node.

If the key already exists, this will update it.

CAUTION: The value must be rlp encoded

pub fn encode_and_set_eip868_in_local_enr( &self, key: Vec<u8>, value: impl Encodable, )

Sets the pair in the EIP-868 Enr of the node.

If the key already exists, this will update it.

pub fn ban(&self, peer_id: PeerId, ip: IpAddr)

Adds the peer and id to the ban list.

This will prevent any future inclusion in the table

pub fn ban_ip(&self, ip: IpAddr)

Adds the ip to the ban list.

This will prevent any future inclusion in the table

pub fn node_record(&self) -> Option<NodeRecord>

Returns the NodeRecord of the local node.

This includes the currently tracked external IP address of the node.

Returns None if the local ENR does not contain the required fields.

pub fn local_enr(&self) -> Enr<CombinedKey>

Returns the local Enr of the service.

pub const fn local_port(&self) -> u16

The port the discv5 service is listening on.

pub async fn start( sk: &SecretKey, discv5_config: Config, ) -> Result<(Self, Receiver<Event>), Error>

Spawns [discv5::Discv5]. Returns [discv5::Discv5] handle in reth compatible wrapper type Discv5, a receiver of [discv5::Event]s from the underlying node, and the local Enr converted into the reth compatible NodeRecord type.

pub fn on_discv5_update(&self, update: Event) -> Option<DiscoveredPeer>

Process an event from the underlying [discv5::Discv5] node.

pub fn on_discovered_peer( &self, enr: &Enr, socket: SocketAddr, ) -> Option<DiscoveredPeer>

Processes a discovered peer. Returns true if peer is added to

pub fn try_into_reachable( &self, enr: &Enr, socket: SocketAddr, ) -> Result<NodeRecord, Error>

Tries to recover an unreachable Enr received via [discv5::Event::UnverifiableEnr], into a NodeRecord usable by RLPx.

NOTE: Fallback solution to be compatible with Geth which includes peers into the discv5 WAN topology which, for example, advertise in their ENR that localhost is their UDP IP address. These peers are only discovered if they initiate a connection attempt, and we by such means learn their reachable IP address. If we receive their ENR from any other peer as part of a lookup query, we won’t find a reachable IP address on which to dial them by reading their ENR.

pub fn filter_discovered_peer(&self, enr: &Enr) -> FilterOutcome

Applies filtering rules on an ENR. Returns Ok if peer should be passed up to app, and Ignore if peer should instead be dropped.

pub fn get_fork_id<K: EnrKey>(&self, enr: &Enr<K>) -> Result<ForkId, Error>

Returns the [ForkId] of the given Enr w.r.t. the local node’s network stack, if field is set.

pub fn with_discv5<F, R>(&self, f: F) -> R

where F: FnOnce(&Discv5) -> R,

Exposes API of [discv5::Discv5].

pub const fn ip_mode(&self) -> IpMode

Returns the RLPx IpMode of the local node.

pub const fn fork_key(&self) -> Option<&[u8]>

Returns the key to use to identify the [ForkId] kv-pair on the Enr.

Trait Implementations

impl Clone for Discv5

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Discv5

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