Merge branch 'master' into discv5.2

Author: divagant-martian

Cargo.toml

@@ -2,7 +2,7 @@
 name = "discv5"
 authors = ["Age Manning <[email protected]>"]
 edition = "2018"
-version = "0.2.2"
+version = "0.3.0"
 description = "Implementation of the p2p discv5 discovery protocol"
 license = "Apache-2.0"
 repository = "https://github.com/sigp/discv5"

examples/find_nodes.rs

@@ -22,7 +22,7 @@ use discv5::{
     Discv5, Discv5ConfigBuilder, Discv5Event, ListenConfig,
 };
 use std::{
-    net::{Ipv4Addr, Ipv6Addr},
+    net::{IpAddr, Ipv4Addr, Ipv6Addr},
     time::Duration,
 };
 use tracing::{info, warn};
@@ -112,8 +112,8 @@ async fn main() {
 
     // the address to listen on.
     let listen_config = match args.socket_kind {
-        SocketKind::Ip4 => ListenConfig::new_ipv4(Ipv4Addr::UNSPECIFIED, port),
-        SocketKind::Ip6 => ListenConfig::new_ipv6(Ipv6Addr::UNSPECIFIED, port6),
+        SocketKind::Ip4 => ListenConfig::from_ip(IpAddr::V4(Ipv4Addr::UNSPECIFIED), port),
+        SocketKind::Ip6 => ListenConfig::from_ip(IpAddr::V6(Ipv6Addr::UNSPECIFIED), port6),
         SocketKind::Ds => ListenConfig::default()
             .with_ipv4(Ipv4Addr::UNSPECIFIED, port)
             .with_ipv6(Ipv6Addr::UNSPECIFIED, port6),

src/config.rs

@@ -1,8 +1,8 @@
+//! A set of configuration parameters to tune the discovery protocol.
 use crate::{
     kbucket::MAX_NODES_PER_BUCKET, socket::ListenConfig, Enr, Executor, PermitBanList, RateLimiter,
     RateLimiterBuilder,
 };
-///! A set of configuration parameters to tune the discovery protocol.
 use std::time::Duration;
 
 /// Configuration parameters that define the performance of the discovery network.

src/executor.rs

@@ -1,6 +1,5 @@
-///! A simple trait to allow generic executors or wrappers for spawning the discv5 tasks.
-use std::future::Future;
-use std::pin::Pin;
+//! A simple trait to allow generic executors or wrappers for spawning the discv5 tasks.
+use std::{future::Future, pin::Pin};
 
 pub trait Executor: ExecutorClone {
     /// Run the given future in the background until it ends.

src/handler/mod.rs

@@ -595,7 +595,7 @@ impl Handler {
             Some((node_address, request_call)) => {
                 // Verify that the src_addresses match
                 if node_address.socket_addr != src_address {
-                    trace!("Received a WHOAREYOU packet for a message with a non-expected source. Source {}, expected_source: {} message_nonce {}", src_address, node_address.socket_addr, hex::encode(request_nonce));
+                    debug!("Received a WHOAREYOU packet for a message with a non-expected source. Source {}, expected_source: {} message_nonce {}", src_address, node_address.socket_addr, hex::encode(request_nonce));
                     // Add the request back if src_address doesn't match
                     self.active_requests.insert(node_address, request_call);
                     return;

src/ipmode.rs

@@ -1,12 +1,11 @@
+//! A set of configuration parameters to tune the discovery protocol.
 use crate::{
     socket::ListenConfig,
     Enr,
     IpMode::{DualStack, Ip4, Ip6},
 };
 use std::net::SocketAddr;
 
-///! A set of configuration parameters to tune the discovery protocol.
-
 /// Sets the socket type to be established and also determines the type of ENRs that we will store
 /// in our routing table.
 /// We store ENR's that have a `get_contractable_addr()` based on the `IpMode` set.

src/service.rs

@@ -1133,7 +1133,8 @@ impl Service {
                     return;
                 }
                 Err(NonContactable { enr }) => {
-                    error!("Query {} has a non contactable enr: {}", *query_id, enr);
+                    // This can happen quite often in ipv6 only nodes
+                    debug!("Query {} has a non contactable enr: {}", *query_id, enr);
                 }
             }
         } else {

src/socket/mod.rs

@@ -6,7 +6,7 @@ use socket2::{Domain, Protocol, Socket as Socket2, Type};
 use std::{
     collections::HashMap,
     io::Error,
-    net::{Ipv4Addr, Ipv6Addr, SocketAddr},
+    net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV4, SocketAddrV6},
     sync::Arc,
     time::Duration,
 };
@@ -157,14 +157,39 @@ impl Socket {
 }
 
 impl ListenConfig {
-    /// Creates a [`ListenConfig`] with an ipv4-only socket.
-    pub fn new_ipv4(ip: Ipv4Addr, port: u16) -> ListenConfig {
-        Self::Ipv4 { ip, port }
+    /// If an [`IpAddr`] is known, a ListenConfig can be created based on the version. This will
+    /// not create a dual stack configuration.
+    pub fn from_ip(ip: IpAddr, port: u16) -> ListenConfig {
+        match ip {
+            IpAddr::V4(ip) => ListenConfig::Ipv4 { ip, port },
+            IpAddr::V6(ip) => ListenConfig::Ipv6 { ip, port },
+        }
     }
 
-    /// Creates a [`ListenConfig`] with an ipv6-only socket.
-    pub fn new_ipv6(ip: Ipv6Addr, port: u16) -> ListenConfig {
-        Self::Ipv6 { ip, port }
+    /// Allows optional ipv4 and ipv6 addresses to be entered to create a [`ListenConfig`]. If both
+    /// are specified a dual-stack configuration will result. This will panic if both parameters
+    /// are None.
+    pub fn from_two_sockets(
+        ipv4: Option<SocketAddrV4>,
+        ipv6: Option<SocketAddrV6>,
+    ) -> ListenConfig {
+        match (ipv4, ipv6) {
+            (Some(ipv4), None) => ListenConfig::Ipv4 {
+                ip: *ipv4.ip(),
+                port: ipv4.port(),
+            },
+            (None, Some(ipv6)) => ListenConfig::Ipv6 {
+                ip: *ipv6.ip(),
+                port: ipv6.port(),
+            },
+            (Some(ipv4), Some(ipv6)) => ListenConfig::DualStack {
+                ipv4: *ipv4.ip(),
+                ipv4_port: ipv4.port(),
+                ipv6: *ipv6.ip(),
+                ipv6_port: ipv6.port(),
+            },
+            (None, None) => panic!("At least one IP address must be entered."),
+        }
     }
 
     // Overrides the ipv4 address and port of ipv4 and dual stack configurations. Ipv6
@@ -229,6 +254,21 @@ impl Default for ListenConfig {
     }
 }
 
+impl From<SocketAddr> for ListenConfig {
+    fn from(socket_addr: SocketAddr) -> Self {
+        match socket_addr {
+            SocketAddr::V4(socket) => ListenConfig::Ipv4 {
+                ip: *socket.ip(),
+                port: socket.port(),
+            },
+            SocketAddr::V6(socket) => ListenConfig::Ipv6 {
+                ip: *socket.ip(),
+                port: socket.port(),
+            },
+        }
+    }
+}
+
 impl Drop for Socket {
     // close the send/recv handlers
     fn drop(&mut self) {