libp2p · elenaf9 · Jan 7, 2023 · Jan 7, 2023 · Jan 7, 2023 · Jan 7, 2023
diff --git a/core/CHANGELOG.md b/core/CHANGELOG.md
@@ -12,6 +12,11 @@
 
 - Improve error messages in case keys cannot be decoded because of missing feature flags. See [PR 2972].
 
+- Add `Transport::box_multiplexed` implementation for boxing multiplexed transports into the
+  `Boxed<(PeerId, StreamMuxerBox)>` type used with the swarm.
+  Deprecate `Multiplexed::boxed` in favor of `box_multiplexed`. See [PR 3313].  
+
+[PR 3313]: https://github.com/libp2p/rust-libp2p/pull/3313
 [PR 3031]: https://github.com/libp2p/rust-libp2p/pull/3031
 [PR 3058]: https://github.com/libp2p/rust-libp2p/pull/3058
 [PR 3097]: https://github.com/libp2p/rust-libp2p/pull/3097

diff --git a/core/src/either.rs b/core/src/either.rs
@@ -255,6 +255,24 @@ where
     }
 }
 
+impl<T, A, B> From<EitherOutput<(T, A), (T, B)>> for (T, EitherOutput<A, B>) {
+    fn from(either_output: EitherOutput<(T, A), (T, B)>) -> Self {
+        match either_output {
+            EitherOutput::First((t, a)) => (t, EitherOutput::First(a)),
+            EitherOutput::Second((t, b)) => (t, EitherOutput::Second(b)),
+        }
+    }
+}
+
+impl<T, A, B> From<EitherOutput<(A, T), (B, T)>> for (EitherOutput<A, B>, T) {
+    fn from(either_output: EitherOutput<(A, T), (B, T)>) -> Self {
+        match either_output {
+            EitherOutput::First((a, t)) => (EitherOutput::First(a), t),
+            EitherOutput::Second((b, t)) => (EitherOutput::Second(b), t),
+        }
+    }
+}
+
 /// Implements `Future` and dispatches all method calls to either `First` or `Second`.
 #[pin_project(project = EitherFutureProj)]
 #[derive(Debug, Copy, Clone)]

diff --git a/core/src/transport.rs b/core/src/transport.rs
@@ -46,8 +46,9 @@ pub mod upgrade;
 mod boxed;
 mod optional;
 
-use crate::ConnectedPoint;
+use crate::{muxing::StreamMuxerBox, ConnectedPoint, PeerId, StreamMuxer};
 
+use self::boxed::boxed;
 pub use self::boxed::Boxed;
 pub use self::choice::OrTransport;
 pub use self::memory::MemoryTransport;
@@ -236,6 +237,25 @@ pub trait Transport {
     {
         upgrade::Builder::new(self, version)
     }
+
+    /// Box a multiplexed transport, including the inner muxer
+    /// and all errors.
+    fn box_multiplexed<M>(self) -> Boxed<(PeerId, StreamMuxerBox)>
+    where
+        Self: Sized + Send + Unpin + 'static,
+        Self::Dial: Send + 'static,
+        Self::ListenerUpgrade: Send + 'static,
+        Self::Error: Send + Sync,
+        Self::Output: Into<(PeerId, M)>,
+        M: StreamMuxer + Send + 'static,
+        M::Substream: Send + 'static,
+        M::Error: Send + Sync + 'static,
+    {
+        boxed(self.map(|o, _| {
+            let (i, m) = o.into();
+            (i, StreamMuxerBox::new(m))
+        }))
+    }
 }
 
 /// The ID of a single listener.

diff --git a/core/src/transport/upgrade.rs b/core/src/transport/upgrade.rs
@@ -26,8 +26,8 @@ use crate::{
     connection::ConnectedPoint,
     muxing::{StreamMuxer, StreamMuxerBox},
     transport::{
-        and_then::AndThen, boxed::boxed, timeout::TransportTimeout, ListenerId, Transport,
-        TransportError, TransportEvent,
+        and_then::AndThen, timeout::TransportTimeout, ListenerId, Transport, TransportError,
+        TransportEvent,
     },
     upgrade::{
         self, apply_inbound, apply_outbound, InboundUpgrade, InboundUpgradeApply, OutboundUpgrade,
@@ -293,6 +293,7 @@ pub struct Multiplexed<T>(#[pin] T);
 impl<T> Multiplexed<T> {
     /// Boxes the authenticated, multiplexed transport, including
     /// the [`StreamMuxer`] and custom transport errors.
+    #[deprecated(since = "0.39.0", note = "Use `Transport::box_multiplexed` instead.")]
     pub fn boxed<M>(self) -> super::Boxed<(PeerId, StreamMuxerBox)>
     where
         T: Transport<Output = (PeerId, M)> + Sized + Send + Unpin + 'static,
@@ -303,7 +304,7 @@ impl<T> Multiplexed<T> {
         M::Substream: Send + 'static,
         M::Error: Send + Sync + 'static,
     {
-        boxed(self.map(|(i, m), _| (i, StreamMuxerBox::new(m))))
+        self.box_multiplexed()
     }
 
     /// Adds a timeout to the setup and protocol upgrade process for all

diff --git a/core/tests/transport_upgrade.rs b/core/tests/transport_upgrade.rs
@@ -86,7 +86,7 @@ fn upgrade_pipeline() {
         .apply(HelloUpgrade {})
         .apply(HelloUpgrade {})
         .multiplex(MplexConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let dialer_keys = identity::Keypair::generate_ed25519();
     let dialer_id = dialer_keys.public().to_peer_id();
@@ -97,7 +97,7 @@ fn upgrade_pipeline() {
         .apply(HelloUpgrade {})
         .apply(HelloUpgrade {})
         .multiplex(MplexConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let listen_addr1 = Multiaddr::from(Protocol::Memory(random::<u64>()));
     let listen_addr2 = listen_addr1.clone();

diff --git a/examples/chat-tokio.rs b/examples/chat-tokio.rs
@@ -58,7 +58,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
                 .expect("Signing libp2p-noise static DH keypair failed."),
         )
         .multiplex(mplex::MplexConfig::new())
-        .boxed();
+        .box_multiplexed();
 
     // Create a Floodsub topic
     let floodsub_topic = floodsub::Topic::new("chat");

diff --git a/examples/ipfs-private.rs b/examples/ipfs-private.rs
@@ -69,7 +69,7 @@ pub fn build_transport(
         .authenticate(noise_config)
         .multiplex(yamux_config)
         .timeout(Duration::from_secs(20))
-        .boxed()
+        .box_multiplexed()
 }
 
 /// Get the current ipfs repo path, either from the IPFS_PATH environment variable or

diff --git a/misc/metrics/examples/metrics/main.rs b/misc/metrics/examples/metrics/main.rs
@@ -82,7 +82,7 @@ fn main() -> Result<(), Box<dyn Error>> {
             .upgrade(Version::V1)
             .authenticate(noise::NoiseAuthenticated::xx(&local_key)?)
             .multiplex(yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
         Behaviour::new(local_pub_key),
         local_peer_id,
     );

diff --git a/misc/multistream-select/tests/transport.rs b/misc/multistream-select/tests/transport.rs
@@ -45,7 +45,7 @@ fn mk_transport(up: upgrade::Version) -> (PeerId, TestTransport) {
                 local_public_key: keys.public(),
             })
             .multiplex(MplexConfig::default())
-            .boxed(),
+            .box_multiplexed(),
     )
 }
 

diff --git a/muxers/mplex/benches/split_send_size.rs b/muxers/mplex/benches/split_send_size.rs
@@ -174,7 +174,7 @@ fn tcp_transport(split_send_size: usize) -> BenchTransport {
         .authenticate(PlainText2Config { local_public_key })
         .multiplex(mplex)
         .timeout(Duration::from_secs(5))
-        .boxed()
+        .box_multiplexed()
 }
 
 fn mem_transport(split_send_size: usize) -> BenchTransport {
@@ -189,7 +189,7 @@ fn mem_transport(split_send_size: usize) -> BenchTransport {
         .authenticate(PlainText2Config { local_public_key })
         .multiplex(mplex)
         .timeout(Duration::from_secs(5))
-        .boxed()
+        .box_multiplexed()
 }
 
 criterion_group!(split_send_size, prepare);

diff --git a/protocols/autonat/examples/autonat_client.rs b/protocols/autonat/examples/autonat_client.rs
@@ -70,7 +70,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
         .upgrade(Version::V1)
         .authenticate(noise::NoiseAuthenticated::xx(&local_key)?)
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let behaviour = Behaviour::new(local_key.public());
 

diff --git a/protocols/autonat/examples/autonat_server.rs b/protocols/autonat/examples/autonat_server.rs
@@ -59,7 +59,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
         .upgrade(Version::V1)
         .authenticate(noise::NoiseAuthenticated::xx(&local_key)?)
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let behaviour = Behaviour::new(local_key.public());
 

diff --git a/protocols/autonat/tests/test_client.rs b/protocols/autonat/tests/test_client.rs
@@ -41,7 +41,7 @@ async fn init_swarm(config: Config) -> Swarm<Behaviour> {
         .upgrade(Version::V1)
         .authenticate(noise::NoiseAuthenticated::xx(&keypair).unwrap())
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
     let behaviour = Behaviour::new(local_id, config);
     Swarm::with_async_std_executor(transport, behaviour, local_id)
 }

diff --git a/protocols/autonat/tests/test_server.rs b/protocols/autonat/tests/test_server.rs
@@ -41,7 +41,7 @@ async fn init_swarm(config: Config) -> Swarm<Behaviour> {
         .upgrade(Version::V1)
         .authenticate(noise::NoiseAuthenticated::xx(&keypair).unwrap())
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
     let behaviour = Behaviour::new(local_id, config);
     Swarm::with_async_std_executor(transport, behaviour, local_id)
 }

diff --git a/protocols/dcutr/examples/dcutr.rs b/protocols/dcutr/examples/dcutr.rs
@@ -102,7 +102,7 @@ fn main() -> Result<(), Box<dyn Error>> {
             .expect("Signing libp2p-noise static DH keypair failed."),
     )
     .multiplex(libp2p_yamux::YamuxConfig::default())
-    .boxed();
+    .box_multiplexed();
 
     #[derive(NetworkBehaviour)]
     #[behaviour(

diff --git a/protocols/dcutr/tests/lib.rs b/protocols/dcutr/tests/lib.rs
@@ -142,7 +142,7 @@ where
         .upgrade(Version::V1)
         .authenticate(PlainText2Config { local_public_key })
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed()
+        .box_multiplexed()
 }
 
 #[derive(NetworkBehaviour)]

diff --git a/protocols/gossipsub/src/lib.rs b/protocols/gossipsub/src/lib.rs
@@ -103,7 +103,7 @@
 //!            .upgrade(libp2p_core::upgrade::Version::V1)
 //!            .authenticate(libp2p_noise::NoiseAuthenticated::xx(&local_key).unwrap())
 //!            .multiplex(libp2p_mplex::MplexConfig::new())
-//!            .boxed();
+//!            .box_multiplexed();
 //!
 //! // Create a Gossipsub topic
 //! let topic = libp2p_gossipsub::IdentTopic::new("example");

diff --git a/protocols/gossipsub/tests/smoke.rs b/protocols/gossipsub/tests/smoke.rs
@@ -153,7 +153,7 @@ fn build_node() -> (Multiaddr, Swarm<Gossipsub>) {
             local_public_key: public_key.clone(),
         })
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let peer_id = public_key.to_peer_id();
 

diff --git a/protocols/identify/examples/identify.rs b/protocols/identify/examples/identify.rs
@@ -53,7 +53,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
         .upgrade(Version::V1)
         .authenticate(libp2p_noise::NoiseAuthenticated::xx(&local_key).unwrap())
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     // Create a identify network behaviour.
     let behaviour = identify::Behaviour::new(identify::Config::new(

diff --git a/protocols/identify/src/behaviour.rs b/protocols/identify/src/behaviour.rs
@@ -545,7 +545,7 @@ mod tests {
             .upgrade(upgrade::Version::V1)
             .authenticate(noise::NoiseConfig::xx(noise_keys).into_authenticated())
             .multiplex(MplexConfig::new())
-            .boxed();
+            .box_multiplexed();
         (pubkey, transport)
     }
 

diff --git a/protocols/kad/src/behaviour/test.rs b/protocols/kad/src/behaviour/test.rs
@@ -60,7 +60,7 @@ fn build_node_with_config(cfg: KademliaConfig) -> (Multiaddr, TestSwarm) {
         .upgrade(upgrade::Version::V1)
         .authenticate(noise::NoiseAuthenticated::xx(&local_key).unwrap())
         .multiplex(yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let local_id = local_public_key.to_peer_id();
     let store = MemoryStore::new(local_id);

diff --git a/protocols/mdns/tests/use-async-std.rs b/protocols/mdns/tests/use-async-std.rs
@@ -62,7 +62,7 @@ async fn create_swarm(config: Config) -> Result<Swarm<Behaviour>, Box<dyn Error>
         .upgrade(Version::V1)
         .authenticate(libp2p_noise::NoiseAuthenticated::xx(&id_keys).unwrap())
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
     let behaviour = Behaviour::new(config, peer_id)?;
     let mut swarm = Swarm::with_async_std_executor(transport, behaviour, peer_id);
     swarm.listen_on("/ip4/0.0.0.0/tcp/0".parse()?)?;

diff --git a/protocols/mdns/tests/use-tokio.rs b/protocols/mdns/tests/use-tokio.rs
@@ -58,7 +58,7 @@ async fn create_swarm(config: Config) -> Result<Swarm<Behaviour>, Box<dyn Error>
         .upgrade(Version::V1)
         .authenticate(libp2p_noise::NoiseAuthenticated::xx(&id_keys).unwrap())
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
     let behaviour = Behaviour::new(config, peer_id)?;
     let mut swarm = Swarm::with_tokio_executor(transport, behaviour, peer_id);
     swarm.listen_on("/ip4/0.0.0.0/tcp/0".parse()?)?;

diff --git a/protocols/ping/tests/ping.rs b/protocols/ping/tests/ping.rs
@@ -254,7 +254,7 @@ fn mk_transport(muxer: MuxerChoice) -> (PeerId, transport::Boxed<(PeerId, Stream
                 MuxerChoice::Yamux => upgrade::EitherUpgrade::A(yamux::YamuxConfig::default()),
                 MuxerChoice::Mplex => upgrade::EitherUpgrade::B(mplex::MplexConfig::default()),
             })
-            .boxed(),
+            .box_multiplexed(),
     )
 }
 

diff --git a/protocols/relay/examples/relay.rs b/protocols/relay/examples/relay.rs
@@ -54,7 +54,7 @@ fn main() -> Result<(), Box<dyn Error>> {
                 .expect("Signing libp2p-noise static DH keypair failed."),
         )
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed();
+        .box_multiplexed();
 
     let behaviour = Behaviour {
         relay: relay::Behaviour::new(local_peer_id, Default::default()),

diff --git a/protocols/relay/tests/lib.rs b/protocols/relay/tests/lib.rs
@@ -338,7 +338,7 @@ where
         .upgrade(upgrade::Version::V1)
         .authenticate(PlainText2Config { local_public_key })
         .multiplex(libp2p_yamux::YamuxConfig::default())
-        .boxed()
+        .box_multiplexed()
 }
 
 #[derive(NetworkBehaviour)]

diff --git a/protocols/rendezvous/examples/discover.rs b/protocols/rendezvous/examples/discover.rs
@@ -43,7 +43,7 @@ async fn main() {
             .upgrade(Version::V1)
             .authenticate(libp2p_noise::NoiseAuthenticated::xx(&identity).unwrap())
             .multiplex(libp2p_yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
         MyBehaviour {
             rendezvous: rendezvous::client::Behaviour::new(identity.clone()),
             ping: ping::Behaviour::new(ping::Config::new().with_interval(Duration::from_secs(1))),

diff --git a/protocols/rendezvous/examples/register.rs b/protocols/rendezvous/examples/register.rs
@@ -42,7 +42,7 @@ async fn main() {
             .upgrade(Version::V1)
             .authenticate(libp2p_noise::NoiseAuthenticated::xx(&identity).unwrap())
             .multiplex(libp2p_yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
         MyBehaviour {
             rendezvous: rendezvous::client::Behaviour::new(identity.clone()),
             ping: ping::Behaviour::new(ping::Config::new().with_interval(Duration::from_secs(1))),

diff --git a/protocols/rendezvous/examples/register_with_identify.rs b/protocols/rendezvous/examples/register_with_identify.rs
@@ -43,7 +43,7 @@ async fn main() {
             .upgrade(Version::V1)
             .authenticate(libp2p_noise::NoiseAuthenticated::xx(&identity).unwrap())
             .multiplex(libp2p_yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
         MyBehaviour {
             identify: identify::Behaviour::new(identify::Config::new(
                 "rendezvous-example/1.0.0".to_string(),

diff --git a/protocols/rendezvous/examples/rendezvous_point.rs b/protocols/rendezvous/examples/rendezvous_point.rs
@@ -47,7 +47,7 @@ async fn main() {
             .upgrade(Version::V1)
             .authenticate(libp2p_noise::NoiseAuthenticated::xx(&identity).unwrap())
             .multiplex(libp2p_yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
         MyBehaviour {
             identify: identify::Behaviour::new(identify::Config::new(
                 "rendezvous-example/1.0.0".to_string(),

diff --git a/protocols/rendezvous/tests/harness.rs b/protocols/rendezvous/tests/harness.rs
@@ -51,7 +51,7 @@ where
             MplexConfig::new(),
         ))
         .timeout(Duration::from_secs(5))
-        .boxed();
+        .box_multiplexed();
 
     Swarm::with_tokio_executor(transport, behaviour_fn(peer_id, identity), peer_id)
 }

diff --git a/protocols/request-response/tests/ping.rs b/protocols/request-response/tests/ping.rs
@@ -302,7 +302,7 @@ fn mk_transport() -> (PeerId, transport::Boxed<(PeerId, StreamMuxerBox)>) {
             .upgrade(upgrade::Version::V1)
             .authenticate(NoiseAuthenticated::xx(&id_keys).unwrap())
             .multiplex(libp2p_yamux::YamuxConfig::default())
-            .boxed(),
+            .box_multiplexed(),
     )
 }
 

diff --git a/src/lib.rs b/src/lib.rs
@@ -211,7 +211,7 @@ pub async fn development_transport(
             mplex::MplexConfig::default(),
         ))
         .timeout(std::time::Duration::from_secs(20))
-        .boxed())
+        .box_multiplexed())
 }
 
 /// Builds a `Transport` based on TCP/IP that supports the most commonly-used features of libp2p:
@@ -267,5 +267,5 @@ pub fn tokio_development_transport(
             mplex::MplexConfig::default(),
         ))
         .timeout(std::time::Duration::from_secs(20))
-        .boxed())
+        .box_multiplexed())
 }
diff --git a/src/transport_ext.rs b/src/transport_ext.rs
@@ -62,7 +62,7 @@ pub trait TransportExt: Transport {
     ///             .expect("Signing libp2p-noise static DH keypair failed."),
     ///     )
     ///     .multiplex(mplex::MplexConfig::new())
-    ///     .boxed();
+    ///     .box_multiplexed();
     ///
     /// let (transport, sinks) = transport.with_bandwidth_logging();
     /// ```