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

reth_discv5/
config.rs
