feat(yamux): rename symbols to follow module-based naming convention

Implements our naming convention for the `libp2p-yamux` crate. Related: libp2p#2217. Pull-Request: libp2p#3852.
alindima · May 1, 2023 · b1cdf8d · b1cdf8d
1 parent 193d2a1
commit b1cdf8d
Show file tree

Hide file tree

Showing 35 changed files with 108 additions and 92 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/autonat/src/bin/autonat_client.rs b/examples/autonat/src/bin/autonat_client.rs
@@ -65,7 +65,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&local_key)?)
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     let behaviour = Behaviour::new(local_key.public());

diff --git a/examples/autonat/src/bin/autonat_server.rs b/examples/autonat/src/bin/autonat_server.rs
@@ -54,7 +54,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&local_key)?)
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     let behaviour = Behaviour::new(local_key.public());

diff --git a/examples/chat-example/src/main.rs b/examples/chat-example/src/main.rs
@@ -78,7 +78,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let tcp_transport = tcp::async_io::Transport::new(tcp::Config::default().nodelay(true))
         .upgrade(upgrade::Version::V1Lazy)
         .authenticate(noise::Config::new(&id_keys).expect("signing libp2p-noise static keypair"))
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .timeout(std::time::Duration::from_secs(20))
         .boxed();
     let quic_transport = quic::async_std::Transport::new(quic::Config::new(&id_keys));

diff --git a/examples/dcutr/src/main.rs b/examples/dcutr/src/main.rs
@@ -100,7 +100,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     .authenticate(
         noise::Config::new(&local_key).expect("Signing libp2p-noise static DH keypair failed."),
     )
-    .multiplex(yamux::YamuxConfig::default())
+    .multiplex(yamux::Config::default())
     .boxed();
 
     #[derive(NetworkBehaviour)]

diff --git a/examples/distributed-key-value-store/src/main.rs b/examples/distributed-key-value-store/src/main.rs
@@ -66,7 +66,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&local_key)?)
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     // We create a custom network behaviour that combines Kademlia and mDNS.

diff --git a/examples/file-sharing/src/network.rs b/examples/file-sharing/src/network.rs
@@ -50,7 +50,7 @@ pub(crate) async fn new(
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&id_keys)?)
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     // Build the Swarm, connecting the lower layer transport logic with the

diff --git a/examples/identify/src/main.rs b/examples/identify/src/main.rs
@@ -54,7 +54,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&local_key).unwrap())
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     // Create a identify network behaviour.

diff --git a/examples/ipfs-private/src/main.rs b/examples/ipfs-private/src/main.rs
@@ -41,9 +41,7 @@ use libp2p::{
     noise, ping,
     pnet::{PnetConfig, PreSharedKey},
     swarm::{NetworkBehaviour, SwarmBuilder, SwarmEvent},
-    tcp,
-    yamux::YamuxConfig,
-    Multiaddr, PeerId, Transport,
+    tcp, yamux, Multiaddr, PeerId, Transport,
 };
 use std::{env, error::Error, fs, path::Path, str::FromStr, time::Duration};
 
@@ -53,7 +51,7 @@ pub fn build_transport(
     psk: Option<PreSharedKey>,
 ) -> transport::Boxed<(PeerId, StreamMuxerBox)> {
     let noise_config = noise::Config::new(&key_pair).unwrap();
-    let yamux_config = YamuxConfig::default();
+    let yamux_config = yamux::Config::default();
 
     let base_transport = tcp::async_io::Transport::new(tcp::Config::default().nodelay(true));
     let maybe_encrypted = match psk {

diff --git a/examples/metrics/src/main.rs b/examples/metrics/src/main.rs
@@ -75,7 +75,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         tcp::async_io::Transport::default()
             .upgrade(Version::V1Lazy)
             .authenticate(noise::Config::new(&local_key)?)
-            .multiplex(yamux::YamuxConfig::default())
+            .multiplex(yamux::Config::default())
             .boxed(),
         Behaviour::new(local_pub_key),
         local_peer_id,

diff --git a/examples/ping-example/src/main.rs b/examples/ping-example/src/main.rs
@@ -58,7 +58,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = tcp::async_io::Transport::default()
         .upgrade(Version::V1Lazy)
         .authenticate(noise::Config::new(&local_key)?)
-        .multiplex(yamux::YamuxConfig::default())
+        .multiplex(yamux::Config::default())
         .boxed();
 
     let mut swarm =

diff --git a/examples/relay-server/src/main.rs b/examples/relay-server/src/main.rs
@@ -53,7 +53,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         .authenticate(
             noise::Config::new(&local_key).expect("Signing libp2p-noise static DH keypair failed."),
         )
-        .multiplex(libp2p::yamux::YamuxConfig::default())
+        .multiplex(libp2p::yamux::Config::default())
         .boxed();
 
     let behaviour = Behaviour {

diff --git a/examples/rendezvous/src/bin/rzv-discover.rs b/examples/rendezvous/src/bin/rzv-discover.rs
@@ -45,7 +45,7 @@ async fn main() {
         tcp::tokio::Transport::default()
             .upgrade(Version::V1Lazy)
             .authenticate(noise::Config::new(&key_pair).unwrap())
-            .multiplex(yamux::YamuxConfig::default())
+            .multiplex(yamux::Config::default())
             .boxed(),
         MyBehaviour {
             rendezvous: rendezvous::client::Behaviour::new(key_pair.clone()),

diff --git a/examples/rendezvous/src/bin/rzv-identify.rs b/examples/rendezvous/src/bin/rzv-identify.rs
@@ -41,7 +41,7 @@ async fn main() {
         tcp::tokio::Transport::default()
             .upgrade(Version::V1Lazy)
             .authenticate(noise::Config::new(&key_pair).unwrap())
-            .multiplex(yamux::YamuxConfig::default())
+            .multiplex(yamux::Config::default())
             .boxed(),
         MyBehaviour {
             identify: identify::Behaviour::new(identify::Config::new(

diff --git a/examples/rendezvous/src/bin/rzv-register.rs b/examples/rendezvous/src/bin/rzv-register.rs
@@ -41,7 +41,7 @@ async fn main() {
         tcp::tokio::Transport::default()
             .upgrade(Version::V1Lazy)
             .authenticate(noise::Config::new(&key_pair).unwrap())
-            .multiplex(yamux::YamuxConfig::default())
+            .multiplex(yamux::Config::default())
             .boxed(),
         MyBehaviour {
             rendezvous: rendezvous::client::Behaviour::new(key_pair.clone()),

diff --git a/examples/rendezvous/src/main.rs b/examples/rendezvous/src/main.rs
@@ -55,7 +55,7 @@ async fn main() {
         tcp::tokio::Transport::default()
             .upgrade(Version::V1Lazy)
             .authenticate(noise::Config::new(&key_pair).unwrap())
-            .multiplex(yamux::YamuxConfig::default())
+            .multiplex(yamux::Config::default())
             .boxed(),
         MyBehaviour {
             identify: identify::Behaviour::new(identify::Config::new(

diff --git a/interop-tests/src/bin/ping.rs b/interop-tests/src/bin/ping.rs
@@ -181,9 +181,9 @@ async fn main() -> Result<()> {
     Ok(())
 }
 
-fn muxer_protocol_from_env() -> Result<Either<yamux::YamuxConfig, mplex::MplexConfig>> {
+fn muxer_protocol_from_env() -> Result<Either<yamux::Config, mplex::MplexConfig>> {
     Ok(match from_env("muxer")? {
-        Muxer::Yamux => Either::Left(yamux::YamuxConfig::default()),
+        Muxer::Yamux => Either::Left(yamux::Config::default()),
         Muxer::Mplex => Either::Right(mplex::MplexConfig::new()),
     })
 }

diff --git a/libp2p/Cargo.toml b/libp2p/Cargo.toml
@@ -116,7 +116,7 @@ libp2p-rendezvous = { version = "0.12.0", path = "../protocols/rendezvous", opti
 libp2p-request-response = { version = "0.24.0", path = "../protocols/request-response", optional = true }
 libp2p-swarm = { version = "0.42.0", path = "../swarm" }
 libp2p-wasm-ext = { version = "0.39.0", path = "../transports/wasm-ext", optional = true }
-libp2p-yamux = { version = "0.43.0", path = "../muxers/yamux", optional = true }
+libp2p-yamux = { version = "0.43.1", path = "../muxers/yamux", optional = true }
 multiaddr = { version = "0.17.0" }
 pin-project = "1.0.0"
 

diff --git a/libp2p/src/lib.rs b/libp2p/src/lib.rs
@@ -233,7 +233,7 @@ pub async fn development_transport(
         .upgrade(core::upgrade::Version::V1)
         .authenticate(noise::Config::new(&keypair).unwrap())
         .multiplex(core::upgrade::SelectUpgrade::new(
-            yamux::YamuxConfig::default(),
+            yamux::Config::default(),
             #[allow(deprecated)]
             mplex::MplexConfig::default(),
         ))
@@ -290,7 +290,7 @@ pub fn tokio_development_transport(
         .upgrade(core::upgrade::Version::V1)
         .authenticate(noise::Config::new(&keypair).unwrap())
         .multiplex(core::upgrade::SelectUpgrade::new(
-            yamux::YamuxConfig::default(),
+            yamux::Config::default(),
             #[allow(deprecated)]
             mplex::MplexConfig::default(),
         ))

diff --git a/muxers/yamux/CHANGELOG.md b/muxers/yamux/CHANGELOG.md
@@ -1,3 +1,11 @@
+## 0.43.1 - unreleased
+
+- Drop `Yamux` prefix from all types.
+  Users are encouraged to import the `yamux` module and refer to types via `yamux::Muxer`, `yamux::Config` etc.
+  See [PR XXXX].
+
+[PR XXXX]: https://github.com/libp2p/rust-libp2p/pull/XXXX
+
 ## 0.43.0
 
 - Update to `libp2p-core` `v0.39.0`.

diff --git a/muxers/yamux/Cargo.toml b/muxers/yamux/Cargo.toml
@@ -3,7 +3,7 @@ name = "libp2p-yamux"
 edition = "2021"
 rust-version = "1.60.0"
 description = "Yamux multiplexing protocol for libp2p"
-version = "0.43.0"
+version = "0.43.1"
 authors = ["Parity Technologies <[email protected]>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"