Merge branch 'master' into discv5.2

Author: divagant-martian

.github/pull_request_template.md

@@ -0,0 +1,17 @@
+## Description
+
+<!--
+A summary of what this pull request achieves and a rough list of changes.
+-->
+
+## Notes & open questions
+
+<!--
+Any notes, remarks or open questions you have to make about the PR. Feel free to remove this section if it's unnecessary 
+-->
+
+## Change checklist
+
+- [ ] Self-review
+- [ ] Documentation updates if relevant
+- [ ] Tests if relevant

.github/workflows/build.yml

@@ -6,7 +6,7 @@ jobs:
   cargo-fmt:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Get latest version of stable rust
         run: rustup update stable
       - name: Check formatting with cargofmt
@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: cargo-fmt
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Get latest version of stable rust
         run: rustup update stable
       - name: Install protobuf compiler for the libp2p-core dependency
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     needs: cargo-fmt
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Get latest version of stable rust
         run: rustup update stable
       - name: Run tests in release
@@ -37,7 +37,7 @@ jobs:
       image: rust
     needs: cargo-fmt
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Get latest version of stable rust
         run: rustup update stable
       - name: Install protobuf compiler for the libp2p-core dependency
@@ -50,8 +50,20 @@ jobs:
     container:
       image: rust
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Get latest version of stable rust
         run: rustup update stable
       - name: Check rustdoc links
         run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
+  cargo-udeps:
+    name: cargo-udeps
+    runs-on: ubuntu-latest
+    needs: cargo-fmt
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install Rust nightly
+      run: rustup toolchain install nightly
+    - name: Install cargo-udeps
+      run: cargo install cargo-udeps --locked --force
+    - name: Run cargo udeps to identify unused crates in the dependency graph
+      run: cargo +nightly udeps --tests --all-targets --release

Cargo.toml

@@ -12,10 +12,8 @@ categories = ["network-programming", "asynchronous"]
 exclude = [".gitignore", ".github/*"]
 
 [dependencies]
-enr = { version = "0.7.0", features = ["k256", "ed25519"] }
+enr = { version = "0.8.1", features = ["k256", "ed25519"] }
 tokio = { version = "1.15.0", features = ["net", "sync", "macros", "rt"] }
-tokio-stream = "0.1.8"
-tokio-util = { version = "0.6.9", features = ["time"] }
 libp2p-core = { version = "0.36.0", optional = true }
 zeroize = { version = "1.4.3", features = ["zeroize_derive"] }
 futures = "0.3.19"
@@ -43,14 +41,11 @@ more-asserts = "0.2.2"
 [dev-dependencies]
 rand_07 = { package = "rand", version = "0.7" }
 quickcheck = "0.9.2"
-env_logger = "0.9.0"
-hex-literal = "0.3.4"
-simple_logger = "1.16.0"
-tokio-util = { version = "0.6.9", features = ["time"] }
 tokio = { version = "1.15.0", features = ["full"] }
 rand_xorshift = "0.3.0"
 rand_core = "0.6.3"
 clap = { version = "3.1", features = ["derive"] }
+if-addrs = "0.10.1"
 
 [features]
 libp2p = ["libp2p-core"]

README.md

@@ -38,11 +38,9 @@ A simple example of creating this service is as follows:
 
 ```rust
    use discv5::{enr, enr::{CombinedKey, NodeId}, TokioExecutor, Discv5, Discv5ConfigBuilder};
+   use discv5::socket::ListenConfig;
    use std::net::SocketAddr;
 
-   // listening address and port
-   let listen_addr = "0.0.0.0:9000".parse::<SocketAddr>().unwrap();
-
    // construct a local ENR
    let enr_key = CombinedKey::generate_secp256k1();
    let enr = enr::EnrBuilder::new("v4").build(&enr_key).unwrap();
@@ -54,8 +52,14 @@ A simple example of creating this service is as follows:
        .build()
        .unwrap();
 
+   // configuration for the sockets to listen on
+   let listen_config = ListenConfig::Ipv4 {
+       ip: Ipv4Addr::UNSPECIFIED,
+       port: 9000,
+   };
+
    // default configuration
-   let config = Discv5ConfigBuilder::new().build();
+   let config = Discv5ConfigBuilder::new(listen_config).build();
 
    // construct the discv5 server
    let mut discv5: Discv5 = Discv5::new(enr, enr_key, config).unwrap();
@@ -65,7 +69,7 @@ A simple example of creating this service is as follows:
    // discv5.add_enr(<ENR>)
 
    // start the discv5 server
-   runtime.block_on(discv5.start(listen_addr));
+   runtime.block_on(discv5.start());
 
    // run a find_node query
    runtime.block_on(async {

examples/custom_executor.rs

@@ -9,8 +9,8 @@
 //! $ cargo run --example custom_executor <BASE64ENR>
 //! ```
 
-use discv5::{enr, enr::CombinedKey, Discv5, Discv5ConfigBuilder, Discv5Event};
-use std::net::SocketAddr;
+use discv5::{enr, enr::CombinedKey, Discv5, Discv5ConfigBuilder, Discv5Event, ListenConfig};
+use std::net::Ipv4Addr;
 
 fn main() {
     // allows detailed logging with the RUST_LOG env variable
@@ -22,7 +22,10 @@ fn main() {
         .try_init();
 
     // listening address and port
-    let listen_addr = "0.0.0.0:9000".parse::<SocketAddr>().unwrap();
+    let listen_config = ListenConfig::Ipv4 {
+        ip: Ipv4Addr::UNSPECIFIED,
+        port: 9000,
+    };
 
     let enr_key = CombinedKey::generate_secp256k1();
     // construct a local ENR
@@ -36,7 +39,7 @@ fn main() {
         .unwrap();
 
     // default configuration - uses the current executor
-    let config = Discv5ConfigBuilder::new().build();
+    let config = Discv5ConfigBuilder::new(listen_config).build();
 
     // construct the discv5 server
     let mut discv5: Discv5 = Discv5::new(enr, enr_key, config).unwrap();
@@ -61,7 +64,7 @@ fn main() {
 
     runtime.block_on(async {
         // start the discv5 service
-        discv5.start(listen_addr).await.unwrap();
+        discv5.start().await.unwrap();
         println!("Server started");
 
         // get an event stream

examples/find_nodes.rs

@@ -19,18 +19,17 @@ use clap::Parser;
 use discv5::{
     enr,
     enr::{k256, CombinedKey},
-    Discv5, Discv5ConfigBuilder, Discv5Event,
+    Discv5, Discv5ConfigBuilder, Discv5Event, ListenConfig,
 };
 use std::{
-    net::{Ipv4Addr, Ipv6Addr, SocketAddr},
+    net::{Ipv4Addr, Ipv6Addr},
     time::Duration,
 };
 use tracing::{info, warn};
 
 #[derive(Parser)]
 struct FindNodesArgs {
-    /// Type of socket to bind ['ds', 'ip4', 'ip6']. The dual stack option will enable mapped
-    /// addresses over an IpV6 socket.
+    /// Type of socket to bind ['ds', 'ip4', 'ip6'].
     #[clap(long, default_value_t = SocketKind::Ds)]
     socket_kind: SocketKind,
     /// IpV4 to advertise in the ENR. This is needed so that other IpV4 nodes can connect to us.
@@ -43,6 +42,10 @@ struct FindNodesArgs {
     /// randomly.
     #[clap(long)]
     port: Option<u16>,
+    /// Port to bind for ipv6. If none is provided, a random one in the 9000 - 9999 range will be picked
+    /// randomly.
+    #[clap(long)]
+    port6: Option<u16>,
     /// Use a default test key.
     #[clap(long)]
     use_test_key: bool,
@@ -67,13 +70,19 @@ async fn main() {
     let port = args
         .port
         .unwrap_or_else(|| (rand::random::<u16>() % 1000) + 9000);
+    let port6 = args.port.unwrap_or_else(|| loop {
+        let port6 = (rand::random::<u16>() % 1000) + 9000;
+        if port6 != port {
+            return port6;
+        }
+    });
 
     let enr_key = if args.use_test_key {
         // A fixed key for testing
         let raw_key =
             hex::decode("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
                 .unwrap();
-        let secret_key = k256::ecdsa::SigningKey::from_bytes(&raw_key).unwrap();
+        let secret_key = k256::ecdsa::SigningKey::from_slice(&raw_key).unwrap();
         CombinedKey::from(secret_key)
     } else {
         // use a new key if specified
@@ -93,29 +102,28 @@ async fn main() {
         if let Some(ip6) = args.enr_ip6 {
             // if the given address is the UNSPECIFIED address we want to advertise localhost
             if ip6.is_unspecified() {
-                builder.ip6(Ipv6Addr::LOCALHOST).udp6(port);
+                builder.ip6(Ipv6Addr::LOCALHOST).udp6(port6);
             } else {
-                builder.ip6(ip6).udp6(port);
+                builder.ip6(ip6).udp6(port6);
             }
         }
         builder.build(&enr_key).unwrap()
     };
 
+    // 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::Ds => ListenConfig::default()
+            .with_ipv4(Ipv4Addr::UNSPECIFIED, port)
+            .with_ipv6(Ipv6Addr::UNSPECIFIED, port6),
+    };
+
     // default configuration with packet filtering
-    // let config = Discv5ConfigBuilder::new().enable_packet_filter().build();
+    // let config = Discv5ConfigBuilder::new(listen_config).enable_packet_filter().build();
 
     // default configuration without packet filtering
-    let config = Discv5ConfigBuilder::new()
-        .ip_mode(match args.socket_kind {
-            SocketKind::Ip4 => discv5::IpMode::Ip4,
-            SocketKind::Ip6 => discv5::IpMode::Ip6 {
-                enable_mapped_addresses: false,
-            },
-            SocketKind::Ds => discv5::IpMode::Ip6 {
-                enable_mapped_addresses: true,
-            },
-        })
-        .build();
+    let config = Discv5ConfigBuilder::new(listen_config).build();
 
     info!("Node Id: {}", enr.node_id());
     if args.enr_ip6.is_some() || args.enr_ip4.is_some() {
@@ -127,12 +135,6 @@ async fn main() {
             enr.udp4_socket()
         );
     }
-    // the address to listen on.
-    let bind_addr = match args.socket_kind {
-        SocketKind::Ip4 => Ipv4Addr::UNSPECIFIED.into(),
-        SocketKind::Ip6 | SocketKind::Ds => Ipv6Addr::UNSPECIFIED.into(),
-    };
-    let socket_addr = SocketAddr::new(bind_addr, port);
 
     // construct the discv5 server
     let mut discv5: Discv5 = Discv5::new(enr, enr_key, config).unwrap();
@@ -154,7 +156,7 @@ async fn main() {
     }
 
     // start the discv5 service
-    discv5.start(socket_addr).await.unwrap();
+    discv5.start().await.unwrap();
     let mut event_stream = discv5.event_stream().await.unwrap();
     let check_evs = args.events;
 

examples/request_enr.rs

@@ -13,9 +13,13 @@
 //!
 //! This requires the "libp2p" feature.
 #[cfg(feature = "libp2p")]
-use discv5::{enr, enr::CombinedKey, Discv5, Discv5Config};
+use discv5::Discv5ConfigBuilder;
 #[cfg(feature = "libp2p")]
-use std::net::SocketAddr;
+use discv5::ListenConfig;
+#[cfg(feature = "libp2p")]
+use discv5::{enr, enr::CombinedKey, Discv5};
+#[cfg(feature = "libp2p")]
+use std::net::Ipv4Addr;
 
 #[cfg(not(feature = "libp2p"))]
 fn main() {}
@@ -31,15 +35,18 @@ async fn main() {
         .try_init();
 
     // listening address and port
-    let listen_addr = "0.0.0.0:9000".parse::<SocketAddr>().unwrap();
+    let listen_config = ListenConfig::Ipv4 {
+        ip: Ipv4Addr::UNSPECIFIED,
+        port: 9000,
+    };
 
     // generate a new enr key
     let enr_key = CombinedKey::generate_secp256k1();
     // construct a local ENR
     let enr = enr::EnrBuilder::new("v4").build(&enr_key).unwrap();
 
     // default discv5 configuration
-    let config = Discv5Config::default();
+    let config = Discv5ConfigBuilder::new(listen_config).build();
 
     let multiaddr = std::env::args()
         .nth(1)
@@ -49,7 +56,7 @@ async fn main() {
     let mut discv5: Discv5 = Discv5::new(enr, enr_key, config).unwrap();
 
     // start the discv5 service
-    discv5.start(listen_addr).await.unwrap();
+    discv5.start().await.unwrap();
 
     // search for the ENR
     match discv5.request_enr(multiaddr).await {

examples/simple_server.rs

@@ -10,8 +10,8 @@
 //! $ cargo run --example simple_server -- <ENR-IP> <ENR-PORT> <BASE64ENR>
 //! ```
 
-use discv5::{enr, enr::CombinedKey, Discv5, Discv5Config, Discv5Event};
-use std::net::{Ipv4Addr, SocketAddr};
+use discv5::{enr, enr::CombinedKey, Discv5, Discv5ConfigBuilder, Discv5Event, ListenConfig};
+use std::net::Ipv4Addr;
 
 #[tokio::main]
 async fn main() {
@@ -37,7 +37,10 @@ async fn main() {
     };
 
     // listening address and port
-    let listen_addr = "0.0.0.0:9000".parse::<SocketAddr>().unwrap();
+    let listen_config = ListenConfig::Ipv4 {
+        ip: Ipv4Addr::UNSPECIFIED,
+        port: 9000,
+    };
 
     let enr_key = CombinedKey::generate_secp256k1();
 
@@ -69,7 +72,7 @@ async fn main() {
     }
 
     // default configuration
-    let config = Discv5Config::default();
+    let config = Discv5ConfigBuilder::new(listen_config).build();
 
     // construct the discv5 server
     let mut discv5: Discv5 = Discv5::new(enr, enr_key, config).unwrap();
@@ -93,7 +96,7 @@ async fn main() {
     }
 
     // start the discv5 service
-    discv5.start(listen_addr).await.unwrap();
+    discv5.start().await.unwrap();
     println!("Server started");
 
     // get an event stream