swarm/: Enable advanced dialing requests (#2317)

Enable advanced dialing requests both on `Swarm` and via
`NetworkBehaviourAction`. Users can now trigger a dial with a specific
set of addresses, optionally extended via
`NetworkBehaviour::addresses_of_peer`. In addition the whole process is
now modelled in a type safe way via the builder pattern.

Example of a `NetworkBehaviour` requesting a dial to a specific peer
with a set of addresses additionally extended through
`NetworkBehaviour::addresses_of_peer`:

```rust
NetworkBehaviourAction::Dial {
    opts: DialOpts::peer_id(peer_id)
              .condition(PeerCondition::Always)
              .addresses(addresses)
              .extend_addresses_through_behaviour()
              .build(),
    handler,
}
```

Example of a user requesting a dial to an unknown peer with a single
address via `Swarm`:

```rust
swarm1.dial(
    DialOpts::unknown_peer_id()
        .address(addr2.clone())
        .build()
)
```

Author: mxinden

Cargo.toml

@@ -72,21 +72,21 @@ getrandom = "0.2.3" # Explicit dependency to be used in `wasm-bindgen` feature
 instant = "0.1.11" # Explicit dependency to be used in `wasm-bindgen` feature
 lazy_static = "1.2"
 libp2p-core = { version = "0.30.0", path = "core",  default-features = false }
-libp2p-floodsub = { version = "0.31.0", path = "protocols/floodsub", optional = true }
-libp2p-gossipsub = { version = "0.33.0", path = "./protocols/gossipsub", optional = true }
-libp2p-identify = { version = "0.31.0", path = "protocols/identify", optional = true }
+libp2p-floodsub = { version = "0.32.0", path = "protocols/floodsub", optional = true }
+libp2p-gossipsub = { version = "0.34.0", path = "./protocols/gossipsub", optional = true }
+libp2p-identify = { version = "0.32.0", path = "protocols/identify", optional = true }
 libp2p-kad = { version = "0.33.0", path = "protocols/kad", optional = true }
-libp2p-metrics = { version = "0.1.0", path = "misc/metrics", optional = true }
+libp2p-metrics = { version = "0.2.0", path = "misc/metrics", optional = true }
 libp2p-mplex = { version = "0.30.0", path = "muxers/mplex", optional = true }
 libp2p-noise = { version = "0.33.0", path = "transports/noise", optional = true }
-libp2p-ping = { version = "0.31.0", path = "protocols/ping", optional = true }
+libp2p-ping = { version = "0.32.0", path = "protocols/ping", optional = true }
 libp2p-plaintext = { version = "0.30.0", path = "transports/plaintext", optional = true }
 libp2p-pnet = { version = "0.22.0", path = "transports/pnet", optional = true }
-libp2p-relay = { version = "0.4.0", path = "protocols/relay", optional = true }
-libp2p-rendezvous = { version = "0.1.0", path = "protocols/rendezvous", optional = true }
-libp2p-request-response = { version = "0.13.0", path = "protocols/request-response", optional = true }
-libp2p-swarm = { version = "0.31.0", path = "swarm" }
-libp2p-swarm-derive = { version = "0.25.0", path = "swarm-derive" }
+libp2p-relay = { version = "0.5.0", path = "protocols/relay", optional = true }
+libp2p-rendezvous = { version = "0.2.0", path = "protocols/rendezvous", optional = true }
+libp2p-request-response = { version = "0.14.0", path = "protocols/request-response", optional = true }
+libp2p-swarm = { version = "0.32.0", path = "swarm" }
+libp2p-swarm-derive = { version = "0.26.0", path = "swarm-derive" }
 libp2p-uds = { version = "0.30.0", path = "transports/uds", optional = true }
 libp2p-wasm-ext = { version = "0.30.0", path = "transports/wasm-ext", default-features = false, optional = true }
 libp2p-yamux = { version = "0.34.0", path = "muxers/yamux", optional = true }
@@ -99,7 +99,7 @@ smallvec = "1.6.1"
 [target.'cfg(not(any(target_os = "emscripten", target_os = "wasi", target_os = "unknown")))'.dependencies]
 libp2p-deflate = { version = "0.30.0", path = "transports/deflate", optional = true }
 libp2p-dns = { version = "0.30.0", path = "transports/dns", optional = true, default-features = false }
-libp2p-mdns = { version = "0.32.0", path = "protocols/mdns", optional = true }
+libp2p-mdns = { version = "0.33.0", path = "protocols/mdns", optional = true }
 libp2p-tcp = { version = "0.30.0", path = "transports/tcp", default-features = false, optional = true }
 libp2p-websocket = { version = "0.32.0", path = "transports/websocket", optional = true }
 

examples/chat-tokio.rs

@@ -44,7 +44,7 @@ use libp2p::{
     mdns::{Mdns, MdnsEvent},
     mplex,
     noise,
-    swarm::{NetworkBehaviourEventProcess, SwarmBuilder, SwarmEvent},
+    swarm::{dial_opts::DialOpts, NetworkBehaviourEventProcess, SwarmBuilder, SwarmEvent},
     // `TokioTcpConfig` is available through the `tcp-tokio` feature.
     tcp::TokioTcpConfig,
     Multiaddr,
@@ -148,7 +148,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     // Reach out to another node if specified
     if let Some(to_dial) = std::env::args().nth(1) {
         let addr: Multiaddr = to_dial.parse()?;
-        swarm.dial_addr(addr)?;
+        swarm.dial(addr)?;
         println!("Dialed {:?}", to_dial)
     }
 

examples/chat.rs

@@ -128,7 +128,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     // Reach out to another node if specified
     if let Some(to_dial) = std::env::args().nth(1) {
         let addr: Multiaddr = to_dial.parse()?;
-        swarm.dial_addr(addr)?;
+        swarm.dial(addr)?;
         println!("Dialed {:?}", to_dial)
     }
 

examples/file-sharing.rs

@@ -525,7 +525,7 @@ mod network {
                             .add_address(&peer_id, peer_addr.clone());
                         match self
                             .swarm
-                            .dial_addr(peer_addr.with(Protocol::P2p(peer_id.into())))
+                            .dial(peer_addr.with(Protocol::P2p(peer_id.into())))
                         {
                             Ok(()) => {
                                 self.pending_dial.insert(peer_id, sender);

examples/gossipsub-chat.rs

@@ -53,7 +53,7 @@ use libp2p::gossipsub::MessageId;
 use libp2p::gossipsub::{
     GossipsubEvent, GossipsubMessage, IdentTopic as Topic, MessageAuthenticity, ValidationMode,
 };
-use libp2p::{gossipsub, identity, swarm::SwarmEvent, PeerId};
+use libp2p::{gossipsub, identity, swarm::SwarmEvent, Multiaddr, PeerId};
 use std::collections::hash_map::DefaultHasher;
 use std::hash::{Hash, Hasher};
 use std::time::Duration;
@@ -122,14 +122,11 @@ async fn main() -> Result<(), Box<dyn Error>> {
 
     // Reach out to another node if specified
     if let Some(to_dial) = std::env::args().nth(1) {
-        let dialing = to_dial.clone();
-        match to_dial.parse() {
-            Ok(to_dial) => match swarm.dial_addr(to_dial) {
-                Ok(_) => println!("Dialed {:?}", dialing),
-                Err(e) => println!("Dial {:?} failed: {:?}", dialing, e),
-            },
-            Err(err) => println!("Failed to parse address to dial: {:?}", err),
-        }
+        let address: Multiaddr = to_dial.parse().expect("User to provide valid address.");
+        match swarm.dial(address.clone()) {
+            Ok(_) => println!("Dialed {:?}", address),
+            Err(e) => println!("Dial {:?} failed: {:?}", address, e),
+        };
     }
 
     // Read full lines from stdin

examples/ipfs-private.rs

@@ -265,7 +265,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     // Reach out to other nodes if specified
     for to_dial in std::env::args().skip(1) {
         let addr: Multiaddr = parse_legacy_multiaddr(&to_dial)?;
-        swarm.dial_addr(addr)?;
+        swarm.dial(addr)?;
         println!("Dialed {:?}", to_dial)
     }
 

examples/ping.rs

@@ -43,7 +43,7 @@
 use futures::executor::block_on;
 use futures::prelude::*;
 use libp2p::swarm::{Swarm, SwarmEvent};
-use libp2p::{identity, ping, PeerId};
+use libp2p::{identity, ping, Multiaddr, PeerId};
 use std::error::Error;
 use std::task::Poll;
 
@@ -70,8 +70,8 @@ fn main() -> Result<(), Box<dyn Error>> {
     // Dial the peer identified by the multi-address given as the second
     // command-line argument, if any.
     if let Some(addr) = std::env::args().nth(1) {
-        let remote = addr.parse()?;
-        swarm.dial_addr(remote)?;
+        let remote: Multiaddr = addr.parse()?;
+        swarm.dial(remote)?;
         println!("Dialed {}", addr)
     }
 

misc/metrics/CHANGELOG.md

@@ -1,3 +1,7 @@
+## Version 0.2.0 [unreleased]
+
+- Update dependencies.
+
 ## Version 0.1.0 [2021-11-01]
 
 - Add initial version.

misc/metrics/Cargo.toml

@@ -2,7 +2,7 @@
 name = "libp2p-metrics"
 edition = "2018"
 description = "Metrics for libp2p"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["Max Inden <mail@max-inden.de>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -15,11 +15,11 @@ kad = ["libp2p-kad"]
 ping = ["libp2p-ping"]
 
 [dependencies]
-libp2p-core=  { version = "0.30.0", path = "../../core" }
-libp2p-identify =  { version = "0.31.0", path = "../../protocols/identify", optional = true }
-libp2p-kad =  { version = "0.33.0", path = "../../protocols/kad", optional = true }
-libp2p-ping =  { version = "0.31.0", path = "../../protocols/ping", optional = true }
-libp2p-swarm =  { version = "0.31.0", path = "../../swarm" }
+libp2p-core = { version = "0.30.0", path = "../../core" }
+libp2p-identify = { version = "0.32.0", path = "../../protocols/identify", optional = true }
+libp2p-kad = { version = "0.33.0", path = "../../protocols/kad", optional = true }
+libp2p-ping = { version = "0.32.0", path = "../../protocols/ping", optional = true }
+libp2p-swarm = { version = "0.32.0", path = "../../swarm" }
 open-metrics-client = "0.12.0"
 
 [dev-dependencies]

misc/metrics/examples/metrics.rs

@@ -50,6 +50,7 @@
 
 use futures::executor::block_on;
 use futures::stream::StreamExt;
+use libp2p::core::Multiaddr;
 use libp2p::metrics::{Metrics, Recorder};
 use libp2p::ping::{Ping, PingConfig};
 use libp2p::swarm::SwarmEvent;
@@ -74,8 +75,8 @@ fn main() -> Result<(), Box<dyn Error>> {
     );
     swarm.listen_on("/ip4/0.0.0.0/tcp/0".parse()?)?;
     if let Some(addr) = std::env::args().nth(1) {
-        let remote = addr.parse()?;
-        swarm.dial_addr(remote)?;
+        let remote: Multiaddr = addr.parse()?;
+        swarm.dial(remote)?;
         tide::log::info!("Dialed {}", addr)
     }