reth_discv5/
config.rs

1//! Wrapper around [`discv5::Config`].
2
3use std::{
4    collections::HashSet,
5    fmt::Debug,
6    net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6},
7};
8
9use alloy_primitives::Bytes;
10use derive_more::Display;
11use discv5::{
12    multiaddr::{Multiaddr, Protocol},
13    ListenConfig,
14};
15use reth_ethereum_forks::{EnrForkIdEntry, ForkId};
16use reth_network_peers::NodeRecord;
17use tracing::debug;
18
19use crate::{enr::discv4_id_to_multiaddr_id, filter::MustNotIncludeKeys, NetworkStackId};
20
21/// The default address for discv5 via UDP is IPv4.
22///
23/// Default is 0.0.0.0, all interfaces. See [`discv5::ListenConfig`] default.
24pub const DEFAULT_DISCOVERY_V5_ADDR: Ipv4Addr = Ipv4Addr::UNSPECIFIED;
25
26/// The default IPv6 address for discv5 via UDP.
27///
28/// Default is ::, all interfaces.
29pub const DEFAULT_DISCOVERY_V5_ADDR_IPV6: Ipv6Addr = Ipv6Addr::UNSPECIFIED;
30
31/// The default port for discv5 via UDP.
32///
33/// Default is port 9200.
34pub const DEFAULT_DISCOVERY_V5_PORT: u16 = 9200;
35
36/// The default [`discv5::ListenConfig`].
37///
38/// This is different from the upstream default.
39pub const DEFAULT_DISCOVERY_V5_LISTEN_CONFIG: ListenConfig =
40    ListenConfig::Ipv4 { ip: DEFAULT_DISCOVERY_V5_ADDR, port: DEFAULT_DISCOVERY_V5_PORT };
41
42/// Default interval in seconds at which to run a lookup up query.
43///
44/// Default is 20 seconds.
45pub const DEFAULT_SECONDS_LOOKUP_INTERVAL: u64 = 20;
46
47/// Default number of times to do pulse lookup queries, at bootstrap (pulse intervals, defaulting
48/// to 5 seconds).
49///
50/// Default is 200 counts.
51pub const DEFAULT_COUNT_BOOTSTRAP_LOOKUPS: u64 = 200;
52
53/// Default duration of the pulse lookup interval at bootstrap.
54///
55/// Default is 5 seconds.
56pub const DEFAULT_SECONDS_BOOTSTRAP_LOOKUP_INTERVAL: u64 = 5;
57
58/// Builds a [`Config`].
59#[derive(Debug)]
60pub struct ConfigBuilder {
61    /// Config used by [`discv5::Discv5`]. Contains the discovery listen socket.
62    discv5_config: Option<discv5::Config>,
63    /// Nodes to boot from.
64    bootstrap_nodes: HashSet<BootNode>,
65    /// Fork kv-pair to set in local node record. Identifies which network/chain/fork the node
66    /// belongs, e.g. `(b"opstack", ChainId)` or `(b"eth", ForkId)`.
67    ///
68    /// Defaults to L1 mainnet if not set.
69    fork: Option<(&'static [u8], ForkId)>,
70    /// `RLPx` TCP socket to advertise.
71    ///
72    /// NOTE: IP address of `RLPx` socket overwrites IP address of same IP version in
73    /// [`discv5::ListenConfig`].
74    tcp_socket: SocketAddr,
75    /// IPv4 address to advertise in the local ENR instead of the listen socket address.
76    ///
77    /// This is separate from [`discv5::ListenConfig`] because the listen address describes where
78    /// discv5 binds its UDP socket. Nodes commonly bind to an unspecified address like `0.0.0.0`
79    /// while advertising an externally reachable address from NAT configuration.
80    advertised_ipv4: Option<Ipv4Addr>,
81    /// IPv6 address to advertise in the local ENR instead of the listen socket address. See
82    /// [`Self::advertised_ipv4`].
83    advertised_ipv6: Option<Ipv6Addr>,
84    /// List of `(key, rlp-encoded-value)` tuples that should be advertised in local node record
85    /// (in addition to tcp port, udp port and fork).
86    other_enr_kv_pairs: Vec<(&'static [u8], Bytes)>,
87    /// Interval in seconds at which to run a lookup up query to populate kbuckets.
88    lookup_interval: Option<u64>,
89    /// Interval in seconds at which to run pulse lookup queries at bootstrap to boost kbucket
90    /// population.
91    bootstrap_lookup_interval: Option<u64>,
92    /// Number of times to run boost lookup queries at start up.
93    bootstrap_lookup_countdown: Option<u64>,
94    /// Custom filter rules to apply to a discovered peer in order to determine if it should be
95    /// passed up to rlpx or dropped.
96    discovered_peer_filter: Option<MustNotIncludeKeys>,
97}
98
99impl ConfigBuilder {
100    /// Returns a new builder, with all fields set like given instance.
101    pub fn new_from(discv5_config: Config) -> Self {
102        let Config {
103            discv5_config,
104            bootstrap_nodes,
105            fork,
106            tcp_socket,
107            advertised_ipv4,
108            advertised_ipv6,
109            other_enr_kv_pairs,
110            lookup_interval,
111            bootstrap_lookup_interval,
112            bootstrap_lookup_countdown,
113            discovered_peer_filter,
114        } = discv5_config;
115
116        Self {
117            discv5_config: Some(discv5_config),
118            bootstrap_nodes,
119            fork: fork.map(|(key, fork_id)| (key, fork_id.fork_id)),
120            tcp_socket,
121            advertised_ipv4,
122            advertised_ipv6,
123            other_enr_kv_pairs,
124            lookup_interval: Some(lookup_interval),
125            bootstrap_lookup_interval: Some(bootstrap_lookup_interval),
126            bootstrap_lookup_countdown: Some(bootstrap_lookup_countdown),
127            discovered_peer_filter: Some(discovered_peer_filter),
128        }
129    }
130
131    /// Set [`discv5::Config`], which contains the [`discv5::Discv5`] listen socket.
132    pub fn discv5_config(mut self, discv5_config: discv5::Config) -> Self {
133        self.discv5_config = Some(discv5_config);
134        self
135    }
136
137    /// Adds multiple boot nodes from a list of [`Enr`](discv5::Enr)s.
138    pub fn add_signed_boot_nodes(mut self, nodes: impl IntoIterator<Item = discv5::Enr>) -> Self {
139        self.bootstrap_nodes.extend(nodes.into_iter().map(BootNode::Enr));
140        self
141    }
142
143    /// Parses a comma-separated list of serialized [`Enr`](discv5::Enr)s, signed node records, and
144    /// adds any successfully deserialized records to boot nodes. Note: this type is serialized in
145    /// CL format since [`discv5`] is originally a CL library.
146    pub fn add_cl_serialized_signed_boot_nodes(mut self, enrs: &str) -> Self {
147        let bootstrap_nodes = &mut self.bootstrap_nodes;
148        for node in enrs.split(&[',']).flat_map(|record| record.trim().parse::<discv5::Enr>()) {
149            bootstrap_nodes.insert(BootNode::Enr(node));
150        }
151        self
152    }
153
154    /// Adds boot nodes in the form a list of [`NodeRecord`]s, parsed enodes.
155    pub fn add_unsigned_boot_nodes(mut self, enodes: impl IntoIterator<Item = NodeRecord>) -> Self {
156        for node in enodes {
157            if let Ok(node) = BootNode::from_unsigned(node) {
158                self.bootstrap_nodes.insert(node);
159            }
160        }
161
162        self
163    }
164
165    /// Adds a comma-separated list of enodes, serialized unsigned node records, to boot nodes.
166    pub fn add_serialized_unsigned_boot_nodes(mut self, enodes: &[&str]) -> Self {
167        for node in enodes {
168            if let Ok(node) = node.parse() &&
169                let Ok(node) = BootNode::from_unsigned(node)
170            {
171                self.bootstrap_nodes.insert(node);
172            }
173        }
174
175        self
176    }
177
178    /// Set fork ID kv-pair to set in local [`Enr`](discv5::enr::Enr). This lets peers on discovery
179    /// network know which chain this node belongs to.
180    pub const fn fork(mut self, fork_key: &'static [u8], fork_id: ForkId) -> Self {
181        self.fork = Some((fork_key, fork_id));
182        self
183    }
184
185    /// Sets the fork ID kv-pair if none has already been configured.
186    pub const fn fork_if_unset(mut self, fork_key: &'static [u8], fork_id: ForkId) -> Self {
187        if self.fork.is_none() {
188            self.fork = Some((fork_key, fork_id));
189        }
190        self
191    }
192
193    /// Sets the tcp socket to advertise in the local [`Enr`](discv5::enr::Enr). The IP address of
194    /// this socket will overwrite the discovery address of the same IP version, if one is
195    /// configured.
196    pub const fn tcp_socket(mut self, socket: SocketAddr) -> Self {
197        self.tcp_socket = socket;
198        self
199    }
200
201    /// Sets the IP address to advertise in the local [`Enr`](discv5::enr::Enr), without changing
202    /// the discv5 listen socket.
203    ///
204    /// Routed to the matching address family, so calling this once per family yields a dual-stack
205    /// advertisement.
206    pub const fn advertised_ip(mut self, ip: IpAddr) -> Self {
207        match ip {
208            IpAddr::V4(ip) => self.advertised_ipv4 = Some(ip),
209            IpAddr::V6(ip) => self.advertised_ipv6 = Some(ip),
210        }
211        self
212    }
213
214    /// Adds an additional kv-pair to include in the local [`Enr`](discv5::enr::Enr). Takes the key
215    /// to use for the kv-pair and the rlp encoded value.
216    pub fn add_enr_kv_pair(mut self, key: &'static [u8], value: Bytes) -> Self {
217        self.other_enr_kv_pairs.push((key, value));
218        self
219    }
220
221    /// Sets the interval at which to run lookup queries, in order to fill kbuckets. Lookup queries
222    /// are done periodically at the given interval for the whole run of the program.
223    pub const fn lookup_interval(mut self, seconds: u64) -> Self {
224        self.lookup_interval = Some(seconds);
225        self
226    }
227
228    /// Sets the interval at which to run boost lookup queries at start up. Queries will be started
229    /// at this interval for the configured number of times after start up.
230    pub const fn bootstrap_lookup_interval(mut self, seconds: u64) -> Self {
231        self.bootstrap_lookup_interval = Some(seconds);
232        self
233    }
234
235    /// Sets the number of times at which to run boost lookup queries to bootstrap the node.
236    pub const fn bootstrap_lookup_countdown(mut self, counts: u64) -> Self {
237        self.bootstrap_lookup_countdown = Some(counts);
238        self
239    }
240
241    /// Adds keys to disallow when filtering a discovered peer, to determine whether or not it
242    /// should be passed to rlpx. The discovered node record is scanned for any kv-pairs where the
243    /// key matches the disallowed keys. If not explicitly set, b"eth2" key will be disallowed.
244    pub fn must_not_include_keys(mut self, not_keys: &[&'static [u8]]) -> Self {
245        let mut filter = self.discovered_peer_filter.unwrap_or_default();
246        filter.add_disallowed_keys(not_keys);
247        self.discovered_peer_filter = Some(filter);
248        self
249    }
250
251    /// Returns a new [`Config`].
252    pub fn build(self) -> Config {
253        let Self {
254            discv5_config,
255            bootstrap_nodes,
256            fork,
257            tcp_socket,
258            advertised_ipv4,
259            advertised_ipv6,
260            other_enr_kv_pairs,
261            lookup_interval,
262            bootstrap_lookup_interval,
263            bootstrap_lookup_countdown,
264            discovered_peer_filter,
265        } = self;
266
267        let mut discv5_config = discv5_config.unwrap_or_else(|| {
268            discv5::ConfigBuilder::new(DEFAULT_DISCOVERY_V5_LISTEN_CONFIG).build()
269        });
270
271        discv5_config.listen_config =
272            amend_listen_config_wrt_rlpx(&discv5_config.listen_config, tcp_socket.ip());
273        if advertised_ipv4.is_some() || advertised_ipv6.is_some() {
274            // The upstream discv5 service can update local ENR IP fields from peer-observed
275            // socket addresses. When the operator configured a NAT address, that address is
276            // intentional advertisement state and must not be replaced by peer observations.
277            discv5_config.enr_update = false;
278        }
279
280        let fork = fork.map(|(key, fork_id)| (key, fork_id.into()));
281
282        let lookup_interval = lookup_interval.unwrap_or(DEFAULT_SECONDS_LOOKUP_INTERVAL);
283        let bootstrap_lookup_interval =
284            bootstrap_lookup_interval.unwrap_or(DEFAULT_SECONDS_BOOTSTRAP_LOOKUP_INTERVAL);
285        let bootstrap_lookup_countdown =
286            bootstrap_lookup_countdown.unwrap_or(DEFAULT_COUNT_BOOTSTRAP_LOOKUPS);
287
288        let discovered_peer_filter = discovered_peer_filter
289            .unwrap_or_else(|| MustNotIncludeKeys::new(&[NetworkStackId::ETH2]));
290
291        Config {
292            discv5_config,
293            bootstrap_nodes,
294            fork,
295            tcp_socket,
296            advertised_ipv4,
297            advertised_ipv6,
298            other_enr_kv_pairs,
299            lookup_interval,
300            bootstrap_lookup_interval,
301            bootstrap_lookup_countdown,
302            discovered_peer_filter,
303        }
304    }
305}
306
307/// Config used to bootstrap [`discv5::Discv5`].
308#[derive(Clone, Debug)]
309pub struct Config {
310    /// Config used by [`discv5::Discv5`]. Contains the [`ListenConfig`], with the discovery listen
311    /// socket.
312    pub(super) discv5_config: discv5::Config,
313    /// Nodes to boot from.
314    pub(super) bootstrap_nodes: HashSet<BootNode>,
315    /// Fork kv-pair to set in local node record. Identifies which network/chain/fork the node
316    /// belongs, e.g. `(b"opstack", ChainId)` or `(b"eth", [ForkId])`.
317    pub(super) fork: Option<(&'static [u8], EnrForkIdEntry)>,
318    /// `RLPx` TCP socket to advertise.
319    ///
320    /// NOTE: IP address of `RLPx` socket overwrites IP address of same IP version in
321    /// [`discv5::ListenConfig`].
322    pub(super) tcp_socket: SocketAddr,
323    /// IPv4 address to advertise in the local ENR instead of the listen socket address.
324    pub(super) advertised_ipv4: Option<Ipv4Addr>,
325    /// IPv6 address to advertise in the local ENR instead of the listen socket address.
326    pub(super) advertised_ipv6: Option<Ipv6Addr>,
327    /// Additional kv-pairs (besides tcp port, udp port and fork) that should be advertised to
328    /// peers by including in local node record.
329    pub(super) other_enr_kv_pairs: Vec<(&'static [u8], Bytes)>,
330    /// Interval in seconds at which to run a lookup up query with to populate kbuckets.
331    pub(super) lookup_interval: u64,
332    /// Interval in seconds at which to run pulse lookup queries at bootstrap to boost kbucket
333    /// population.
334    pub(super) bootstrap_lookup_interval: u64,
335    /// Number of times to run boost lookup queries at start up.
336    pub(super) bootstrap_lookup_countdown: u64,
337    /// Custom filter rules to apply to a discovered peer in order to determine if it should be
338    /// passed up to rlpx or dropped.
339    pub(super) discovered_peer_filter: MustNotIncludeKeys,
340}
341
342impl Config {
343    /// Returns a new [`ConfigBuilder`], with the `RLPx` TCP port and IP version configured w.r.t.
344    /// the given socket.
345    pub fn builder(rlpx_tcp_socket: SocketAddr) -> ConfigBuilder {
346        ConfigBuilder {
347            discv5_config: None,
348            bootstrap_nodes: HashSet::default(),
349            fork: None,
350            tcp_socket: rlpx_tcp_socket,
351            advertised_ipv4: None,
352            advertised_ipv6: None,
353            other_enr_kv_pairs: Vec::new(),
354            lookup_interval: None,
355            bootstrap_lookup_interval: None,
356            bootstrap_lookup_countdown: None,
357            discovered_peer_filter: None,
358        }
359    }
360
361    /// Returns a mutable reference to the inner [`discv5::Config`]. This allows overriding
362    /// the listen config after the config has been built.
363    pub const fn discv5_config_mut(&mut self) -> &mut discv5::Config {
364        &mut self.discv5_config
365    }
366
367    /// Returns `true` if any socket in the discv5 listen config matches the given address.
368    pub fn has_matching_socket(&self, addr: SocketAddr) -> bool {
369        ipv4(&self.discv5_config.listen_config).is_some_and(|v4| SocketAddr::V4(v4) == addr) ||
370            ipv6(&self.discv5_config.listen_config).is_some_and(|v6| SocketAddr::V6(v6) == addr)
371    }
372
373    /// Inserts a new boot node to the list of boot nodes.
374    pub fn insert_boot_node(&mut self, boot_node: BootNode) {
375        self.bootstrap_nodes.insert(boot_node);
376    }
377
378    /// Inserts a new unsigned enode boot node to the list of boot nodes if it can be parsed, see
379    /// also [`BootNode::from_unsigned`].
380    pub fn insert_unsigned_boot_node(&mut self, node_record: NodeRecord) {
381        let _ = BootNode::from_unsigned(node_record).map(|node| self.insert_boot_node(node));
382    }
383
384    /// Extends the list of boot nodes with a list of enode boot nodes if they can be parsed.
385    pub fn extend_unsigned_boot_nodes(
386        &mut self,
387        node_records: impl IntoIterator<Item = NodeRecord>,
388    ) {
389        for node_record in node_records {
390            self.insert_unsigned_boot_node(node_record);
391        }
392    }
393
394    /// Returns the discovery (UDP) socket contained in the [`discv5::Config`]. Returns the IPv6
395    /// socket, if both IPv4 and v6 are configured. This socket will be advertised to peers in the
396    /// local [`Enr`](discv5::enr::Enr).
397    pub fn discovery_socket(&self) -> SocketAddr {
398        // Prefer v6 when both are configured (matches original `DualStack` behavior).
399        ipv6(&self.discv5_config.listen_config)
400            .map(SocketAddr::V6)
401            .or_else(|| ipv4(&self.discv5_config.listen_config).map(SocketAddr::V4))
402            .unwrap_or_else(|| SocketAddr::from((std::net::Ipv4Addr::UNSPECIFIED, 0)))
403    }
404
405    /// Returns the `RLPx` (TCP) socket contained in the [`discv5::Config`]. This socket will be
406    /// advertised to peers in the local [`Enr`](discv5::enr::Enr).
407    pub const fn rlpx_socket(&self) -> &SocketAddr {
408        &self.tcp_socket
409    }
410
411    /// Sets the port of the `RLPx` TCP socket to advertise. This allows advertising the actually
412    /// bound listener port when the configured port was 0 (OS-assigned).
413    pub const fn set_rlpx_port(&mut self, port: u16) {
414        self.tcp_socket.set_port(port);
415    }
416}
417
418/// Returns the IPv4 discovery socket if one is configured.
419pub fn ipv4(listen_config: &ListenConfig) -> Option<SocketAddrV4> {
420    match listen_config {
421        ListenConfig::Ipv4 { ip, port } |
422        ListenConfig::DualStack { ipv4: ip, ipv4_port: port, .. } => {
423            Some(SocketAddrV4::new(*ip, *port))
424        }
425        ListenConfig::FromSockets { ipv4: Some(s), .. } => match s.local_addr().ok()? {
426            SocketAddr::V4(addr) => Some(addr),
427            SocketAddr::V6(_) => None,
428        },
429        _ => None,
430    }
431}
432
433/// Returns the IPv6 discovery socket if one is configured.
434pub fn ipv6(listen_config: &ListenConfig) -> Option<SocketAddrV6> {
435    match listen_config {
436        ListenConfig::Ipv6 { ip, port } |
437        ListenConfig::DualStack { ipv6: ip, ipv6_port: port, .. } => {
438            Some(SocketAddrV6::new(*ip, *port, 0, 0))
439        }
440        ListenConfig::FromSockets { ipv6: Some(s), .. } => match s.local_addr().ok()? {
441            SocketAddr::V6(addr) => Some(addr),
442            SocketAddr::V4(_) => None,
443        },
444        _ => None,
445    }
446}
447
448/// Returns the address for the opposite-family sibling socket in shared-port mode: that
449/// family's configured listen address, rebound to the shared port that discv4 advertises
450/// for both families.
451pub fn sibling_addr(
452    listen_config: &ListenConfig,
453    primary: SocketAddr,
454    shared_port: u16,
455) -> Option<SocketAddr> {
456    let mut addr = if primary.is_ipv4() {
457        SocketAddr::V6(ipv6(listen_config)?)
458    } else {
459        SocketAddr::V4(ipv4(listen_config)?)
460    };
461    addr.set_port(shared_port);
462    Some(addr)
463}
464
465/// Returns the amended [`discv5::ListenConfig`] based on the `RLPx` IP address. The ENR is limited
466/// to one IP address per IP version (atm, may become spec'd how to advertise different addresses).
467/// The `RLPx` address overwrites the discv5 address w.r.t. IP version.
468pub fn amend_listen_config_wrt_rlpx(
469    listen_config: &ListenConfig,
470    rlpx_addr: IpAddr,
471) -> ListenConfig {
472    let discv5_socket_ipv4 = ipv4(listen_config);
473    let discv5_socket_ipv6 = ipv6(listen_config);
474
475    let discv5_port_ipv4 =
476        discv5_socket_ipv4.map(|socket| socket.port()).unwrap_or(DEFAULT_DISCOVERY_V5_PORT);
477    let discv5_addr_ipv4 = discv5_socket_ipv4.map(|socket| *socket.ip());
478    let discv5_port_ipv6 =
479        discv5_socket_ipv6.map(|socket| socket.port()).unwrap_or(DEFAULT_DISCOVERY_V5_PORT);
480    let discv5_addr_ipv6 = discv5_socket_ipv6.map(|socket| *socket.ip());
481
482    let (discv5_socket_ipv4, discv5_socket_ipv6) = discv5_sockets_wrt_rlpx_addr(
483        rlpx_addr,
484        discv5_addr_ipv4,
485        discv5_port_ipv4,
486        discv5_addr_ipv6,
487        discv5_port_ipv6,
488    );
489
490    ListenConfig::from_two_sockets(discv5_socket_ipv4, discv5_socket_ipv6)
491}
492
493/// Returns the sockets that can be used for discv5 with respect to the `RLPx` address. ENR specs
494/// only acknowledge one address per IP version.
495pub fn discv5_sockets_wrt_rlpx_addr(
496    rlpx_addr: IpAddr,
497    discv5_addr_ipv4: Option<Ipv4Addr>,
498    discv5_port_ipv4: u16,
499    discv5_addr_ipv6: Option<Ipv6Addr>,
500    discv5_port_ipv6: u16,
501) -> (Option<SocketAddrV4>, Option<SocketAddrV6>) {
502    match rlpx_addr {
503        IpAddr::V4(rlpx_addr) => {
504            let discv5_socket_ipv6 =
505                discv5_addr_ipv6.map(|ip| SocketAddrV6::new(ip, discv5_port_ipv6, 0, 0));
506
507            if let Some(discv5_addr) = discv5_addr_ipv4 &&
508                discv5_addr != rlpx_addr
509            {
510                debug!(target: "net::discv5",
511                    %discv5_addr,
512                    %rlpx_addr,
513                    "Overwriting discv5 IPv4 address with RLPx IPv4 address, limited to one advertised IP address per IP version"
514                );
515            }
516
517            // overwrite discv5 ipv4 addr with RLPx address. this is since there is no
518            // spec'd way to advertise a different address for rlpx and discovery in the
519            // ENR.
520            (Some(SocketAddrV4::new(rlpx_addr, discv5_port_ipv4)), discv5_socket_ipv6)
521        }
522        IpAddr::V6(rlpx_addr) => {
523            let discv5_socket_ipv4 =
524                discv5_addr_ipv4.map(|ip| SocketAddrV4::new(ip, discv5_port_ipv4));
525
526            if let Some(discv5_addr) = discv5_addr_ipv6 &&
527                discv5_addr != rlpx_addr
528            {
529                debug!(target: "net::discv5",
530                    %discv5_addr,
531                    %rlpx_addr,
532                    "Overwriting discv5 IPv6 address with RLPx IPv6 address, limited to one advertised IP address per IP version"
533                );
534            }
535
536            // overwrite discv5 ipv6 addr with RLPx address. this is since there is no
537            // spec'd way to advertise a different address for rlpx and discovery in the
538            // ENR.
539            (discv5_socket_ipv4, Some(SocketAddrV6::new(rlpx_addr, discv5_port_ipv6, 0, 0)))
540        }
541    }
542}
543
544/// A boot node can be added either as a string in either 'enode' URL scheme or serialized from
545/// [`Enr`](discv5::Enr) type.
546#[derive(Clone, Debug, PartialEq, Eq, Hash, Display)]
547pub enum BootNode {
548    /// An unsigned node record.
549    #[display("{_0}")]
550    Enode(Multiaddr),
551    /// A signed node record.
552    #[display("{_0:?}")]
553    Enr(discv5::Enr),
554}
555
556impl BootNode {
557    /// Parses a [`NodeRecord`] and serializes according to CL format. Note: [`discv5`] is
558    /// originally a CL library hence needs this format to add the node.
559    pub fn from_unsigned(node_record: NodeRecord) -> Result<Self, secp256k1::Error> {
560        let NodeRecord { address, udp_port, id, .. } = node_record;
561        let mut multi_address = Multiaddr::empty();
562        match address {
563            IpAddr::V4(ip) => multi_address.push(Protocol::Ip4(ip)),
564            IpAddr::V6(ip) => multi_address.push(Protocol::Ip6(ip)),
565        }
566
567        multi_address.push(Protocol::Udp(udp_port));
568        let id = discv4_id_to_multiaddr_id(id)?;
569        multi_address.push(Protocol::P2p(id));
570
571        Ok(Self::Enode(multi_address))
572    }
573}
574
575#[cfg(test)]
576mod test {
577    use super::*;
578    use alloy_primitives::hex;
579    use std::net::SocketAddrV4;
580
581    const MULTI_ADDRESSES: &str = "/ip4/184.72.129.189/udp/30301/p2p/16Uiu2HAmSG2hdLwyQHQmG4bcJBgD64xnW63WMTLcrNq6KoZREfGb,/ip4/3.231.11.52/udp/30301/p2p/16Uiu2HAmMy4V8bi3XP7KDfSLQcLACSvTLroRRwEsTyFUKo8NCkkp,/ip4/54.198.153.150/udp/30301/p2p/16Uiu2HAmSVsb7MbRf1jg3Dvd6a3n5YNqKQwn1fqHCFgnbqCsFZKe,/ip4/3.220.145.177/udp/30301/p2p/16Uiu2HAm74pBDGdQ84XCZK27GRQbGFFwQ7RsSqsPwcGmCR3Cwn3B,/ip4/3.231.138.188/udp/30301/p2p/16Uiu2HAmMnTiJwgFtSVGV14ZNpwAvS1LUoF4pWWeNtURuV6C3zYB";
582    const BOOT_NODES_OP_MAINNET_AND_BASE_MAINNET: &[&str] = &[
583        "enode://ca2774c3c401325850b2477fd7d0f27911efbf79b1e8b335066516e2bd8c4c9e0ba9696a94b1cb030a88eac582305ff55e905e64fb77fe0edcd70a4e5296d3ec@34.65.175.185:30305",
584        "enode://dd751a9ef8912be1bfa7a5e34e2c3785cc5253110bd929f385e07ba7ac19929fb0e0c5d93f77827291f4da02b2232240fbc47ea7ce04c46e333e452f8656b667@34.65.107.0:30305",
585        "enode://c5d289b56a77b6a2342ca29956dfd07aadf45364dde8ab20d1dc4efd4d1bc6b4655d902501daea308f4d8950737a4e93a4dfedd17b49cd5760ffd127837ca965@34.65.202.239:30305",
586        "enode://87a32fd13bd596b2ffca97020e31aef4ddcc1bbd4b95bb633d16c1329f654f34049ed240a36b449fda5e5225d70fe40bc667f53c304b71f8e68fc9d448690b51@3.231.138.188:30301",
587        "enode://ca21ea8f176adb2e229ce2d700830c844af0ea941a1d8152a9513b966fe525e809c3a6c73a2c18a12b74ed6ec4380edf91662778fe0b79f6a591236e49e176f9@184.72.129.189:30301",
588        "enode://acf4507a211ba7c1e52cdf4eef62cdc3c32e7c9c47998954f7ba024026f9a6b2150cd3f0b734d9c78e507ab70d59ba61dfe5c45e1078c7ad0775fb251d7735a2@3.220.145.177:30301",
589        "enode://8a5a5006159bf079d06a04e5eceab2a1ce6e0f721875b2a9c96905336219dbe14203d38f70f3754686a6324f786c2f9852d8c0dd3adac2d080f4db35efc678c5@3.231.11.52:30301",
590        "enode://cdadbe835308ad3557f9a1de8db411da1a260a98f8421d62da90e71da66e55e98aaa8e90aa7ce01b408a54e4bd2253d701218081ded3dbe5efbbc7b41d7cef79@54.198.153.150:30301",
591    ];
592
593    #[test]
594    fn parse_boot_nodes() {
595        const OP_SEPOLIA_CL_BOOTNODES: &str = "enr:-J64QBwRIWAco7lv6jImSOjPU_W266lHXzpAS5YOh7WmgTyBZkgLgOwo_mxKJq3wz2XRbsoBItbv1dCyjIoNq67mFguGAYrTxM42gmlkgnY0gmlwhBLSsHKHb3BzdGFja4S0lAUAiXNlY3AyNTZrMaEDmoWSi8hcsRpQf2eJsNUx-sqv6fH4btmo2HsAzZFAKnKDdGNwgiQGg3VkcIIkBg,enr:-J64QFa3qMsONLGphfjEkeYyF6Jkil_jCuJmm7_a42ckZeUQGLVzrzstZNb1dgBp1GGx9bzImq5VxJLP-BaptZThGiWGAYrTytOvgmlkgnY0gmlwhGsV-zeHb3BzdGFja4S0lAUAiXNlY3AyNTZrMaEDahfSECTIS_cXyZ8IyNf4leANlZnrsMEWTkEYxf4GMCmDdGNwgiQGg3VkcIIkBg";
596
597        let config = Config::builder((Ipv4Addr::UNSPECIFIED, 30303).into())
598            .add_cl_serialized_signed_boot_nodes(OP_SEPOLIA_CL_BOOTNODES)
599            .build();
600
601        let socket_1 = "18.210.176.114:9222".parse::<SocketAddrV4>().unwrap();
602        let socket_2 = "107.21.251.55:9222".parse::<SocketAddrV4>().unwrap();
603
604        for node in config.bootstrap_nodes {
605            let BootNode::Enr(node) = node else { panic!() };
606            assert!(
607                socket_1 == node.udp4_socket().unwrap() && socket_1 == node.tcp4_socket().unwrap() ||
608                    socket_2 == node.udp4_socket().unwrap() &&
609                        socket_2 == node.tcp4_socket().unwrap()
610            );
611            assert_eq!("84b4940500", hex::encode(node.get_raw_rlp("opstack").unwrap()));
612        }
613    }
614
615    #[test]
616    fn parse_enodes() {
617        let config = Config::builder((Ipv4Addr::UNSPECIFIED, 30303).into())
618            .add_serialized_unsigned_boot_nodes(BOOT_NODES_OP_MAINNET_AND_BASE_MAINNET)
619            .build();
620
621        let bootstrap_nodes =
622            config.bootstrap_nodes.into_iter().map(|node| format!("{node}")).collect::<Vec<_>>();
623
624        for node in MULTI_ADDRESSES.split(&[',']) {
625            assert!(bootstrap_nodes.contains(&node.to_string()));
626        }
627    }
628
629    #[test]
630    fn overwrite_ipv4_addr() {
631        let rlpx_addr: Ipv4Addr = "192.168.0.1".parse().unwrap();
632
633        let listen_config = DEFAULT_DISCOVERY_V5_LISTEN_CONFIG;
634
635        let amended_config = amend_listen_config_wrt_rlpx(&listen_config, rlpx_addr.into());
636
637        let config_socket_ipv4 = ipv4(&amended_config).unwrap();
638
639        assert_eq!(*config_socket_ipv4.ip(), rlpx_addr);
640        assert_eq!(config_socket_ipv4.port(), DEFAULT_DISCOVERY_V5_PORT);
641        assert_eq!(ipv6(&amended_config), ipv6(&listen_config));
642    }
643
644    #[test]
645    fn overwrite_ipv6_addr() {
646        let rlpx_addr: Ipv6Addr = "fe80::1".parse().unwrap();
647
648        let listen_config = DEFAULT_DISCOVERY_V5_LISTEN_CONFIG;
649
650        let amended_config = amend_listen_config_wrt_rlpx(&listen_config, rlpx_addr.into());
651
652        let config_socket_ipv6 = ipv6(&amended_config).unwrap();
653
654        assert_eq!(*config_socket_ipv6.ip(), rlpx_addr);
655        assert_eq!(config_socket_ipv6.port(), DEFAULT_DISCOVERY_V5_PORT);
656        assert_eq!(ipv4(&amended_config), ipv4(&listen_config));
657    }
658
659    #[test]
660    fn sibling_addr_uses_shared_port() {
661        let listen_config = ListenConfig::DualStack {
662            ipv4: Ipv4Addr::UNSPECIFIED,
663            ipv4_port: 30303,
664            ipv6: Ipv6Addr::UNSPECIFIED,
665            ipv6_port: 9200,
666        };
667        let primary: SocketAddr = "0.0.0.0:30303".parse().unwrap();
668
669        let addr = sibling_addr(&listen_config, primary, 30303).unwrap();
670        assert_eq!(addr, "[::]:30303".parse::<SocketAddr>().unwrap());
671
672        let listen_config = ListenConfig::Ipv4 { ip: Ipv4Addr::UNSPECIFIED, port: 30303 };
673        assert_eq!(sibling_addr(&listen_config, primary, 30303), None);
674    }
675}
reth_discv5/config.rs

reth_discv5/
config.rs
