Struct Discv4

pub struct Discv4 { /* private fields */ }

The Discv4 frontend

This communicates with the Discv4Service by sending commands over a channel.

See also Discv4::spawn

Implementations

impl Discv4

pub async fn spawn( local_address: SocketAddr, local_enr: NodeRecord, secret_key: SecretKey, config: Discv4Config, ) -> Result<Self>

Same as Self::bind but also spawns the service onto a new task, Discv4Service::spawn()

pub fn noop() -> Self

Available on crate feature test-utils only.

Returns a new instance with the given channel directly

NOTE: this is only intended for test setups.

pub async fn bind( local_address: SocketAddr, local_node_record: NodeRecord, secret_key: SecretKey, config: Discv4Config, ) -> Result<(Self, Discv4Service)>

Binds a new UdpSocket and creates the service

use rand::thread_rng;
use reth_discv4::{Discv4, Discv4Config};
use reth_network_peers::{pk2id, NodeRecord, PeerId};
use secp256k1::SECP256K1;
use std::{net::SocketAddr, str::FromStr};
// generate a (random) keypair
let mut rng = thread_rng();
let (secret_key, pk) = SECP256K1.generate_keypair(&mut rng);
let id = pk2id(&pk);

let socket = SocketAddr::from_str("0.0.0.0:0").unwrap();
let local_enr =
    NodeRecord { address: socket.ip(), tcp_port: socket.port(), udp_port: socket.port(), id };
let config = Discv4Config::default();

let (discv4, mut service) = Discv4::bind(socket, local_enr, secret_key, config).await.unwrap();

// get an update strea
let updates = service.update_stream();

let _handle = service.spawn();

// lookup the local node in the DHT
let _discovered = discv4.lookup_self().await.unwrap();

pub const fn local_addr(&self) -> SocketAddr

Returns the address of the UDP socket.

pub fn node_record(&self) -> NodeRecord

Returns the NodeRecord of the local node.

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

pub fn external_ip(&self) -> IpAddr

Returns the currently tracked external IP of the node.

pub fn set_lookup_interval(&self, duration: Duration)

Sets the [Interval] used for periodically looking up targets over the network

pub async fn lookup_self(&self) -> Result<Vec<NodeRecord>, Discv4Error>

Starts a FindNode recursive lookup that locates the closest nodes to the given node id. See also: https://github.com/ethereum/devp2p/blob/master/discv4.md#recursive-lookup

The lookup initiator starts by picking α closest nodes to the target it knows of. The initiator then sends concurrent FindNode packets to those nodes. α is a system-wide concurrency parameter, such as 3. In the recursive step, the initiator resends FindNode to nodes it has learned about from previous queries. Of the k nodes the initiator has heard of closest to the target, it picks α that it has not yet queried and resends FindNode to them. Nodes that fail to respond quickly are removed from consideration until and unless they do respond.

pub async fn lookup( &self, node_id: PeerId, ) -> Result<Vec<NodeRecord>, Discv4Error>

Looks up the given node id.

Returning the closest nodes to the given node id.

pub async fn lookup_random(&self) -> Result<Vec<NodeRecord>, Discv4Error>

Performs a random lookup for node records.

pub fn send_lookup(&self, node_id: PeerId)

Sends a message to the service to lookup the closest nodes

pub fn send_lookup_self(&self)

Triggers a new self lookup without expecting a response

pub fn remove_peer(&self, node_id: PeerId)

Removes the peer from the table, if it exists.

pub fn add_node(&self, node_record: NodeRecord)

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

pub fn ban(&self, node_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 ban_node(&self, node_id: PeerId)

Adds the peer to the ban list.

This will prevent any future inclusion in the table

pub fn set_tcp_port(&self, port: u16)

Sets the tcp port

This will update our NodeRecord’s tcp port.

pub fn set_eip868_rlp_pair(&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 set_eip868_rlp(&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 async fn update_stream( &self, ) -> Result<ReceiverStream<DiscoveryUpdate>, Discv4Error>

Returns the receiver half of new listener channel that streams DiscoveryUpdates.

pub fn terminate(&self)

Terminates the spawned Discv4Service.

Trait Implementations

impl Clone for Discv4

fn clone(&self) -> Discv4

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Discv4

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