swarm-derive: Add prelude configuration option to NetworkBehaviour macro

CHANGELOG.md

@@ -50,6 +50,9 @@
 - Remove deprecated features: `tcp-tokio`, `mdns-tokio`, `dns-tokio`, `tcp-async-io`, `mdns-async-io`, `dns-async-std`.
   See [PR 3001].
 - Introduce [`libp2p-tls` `v0.1.0`](transports/tls/CHANGELOG.md#010). See [PR 2945].
+- Remove `NetworkBehaviour` macro export from root crate in favor of re-exported macro from `libp2p::swarm`.
+  Change your import from `libp2p::NetworkBehaviour` to `libp2p::swarm::NetworkBehaviour`. See [PR 3055].
+- Feature-gate `NetworkBehaviour` macro behind `macros` feature flag. See [PR 3055].
 - Update individual crates.
   - Update to [`libp2p-autonat` `v0.89.0`](protocols/autonat/CHANGELOG.md#090).
   - Update to [`libp2p-core` `v0.38.0`](core/CHANGELOG.md#0380).
@@ -79,6 +82,7 @@
 [PR 2945]: https://github.com/libp2p/rust-libp2p/pull/2945
 [PR 3001]: https://github.com/libp2p/rust-libp2p/pull/3001
 [PR 2945]: https://github.com/libp2p/rust-libp2p/pull/2945
+[PR 3055]: https://github.com/libp2p/rust-libp2p/pull/3055
 
 # 0.49.0
 

Cargo.toml

@@ -29,6 +29,7 @@ full = [
     "ping",
     "plaintext",
     "pnet",
+    "macros",
     "relay",
     "rendezvous",
     "request-response",
@@ -45,38 +46,39 @@ full = [
     "websocket",
     "yamux",
 ]
+async-std = ["libp2p-mdns?/async-io", "libp2p-tcp?/async-io", "libp2p-dns?/async-std"]
 autonat = ["dep:libp2p-autonat"]
 dcutr = ["dep:libp2p-dcutr", "libp2p-metrics?/dcutr"]
 deflate = ["dep:libp2p-deflate"]
 dns = ["dep:libp2p-dns"]
+ecdsa = ["libp2p-core/ecdsa"]
 floodsub = ["dep:libp2p-floodsub"]
+gossipsub = ["dep:libp2p-gossipsub", "libp2p-metrics?/gossipsub"]
 identify = ["dep:libp2p-identify", "libp2p-metrics?/identify"]
 kad = ["dep:libp2p-kad", "libp2p-metrics?/kad"]
-gossipsub = ["dep:libp2p-gossipsub", "libp2p-metrics?/gossipsub"]
+macros = ["libp2p-swarm/macros"]
+mdns = ["dep:libp2p-mdns"]
 tls = ["dep:libp2p-tls"]
 metrics = ["dep:libp2p-metrics"]
-mdns = ["dep:libp2p-mdns"]
 mplex = ["dep:libp2p-mplex"]
 noise = ["dep:libp2p-noise"]
 ping = ["dep:libp2p-ping", "libp2p-metrics?/ping"]
 plaintext = ["dep:libp2p-plaintext"]
 pnet = ["dep:libp2p-pnet"]
 relay = ["dep:libp2p-relay", "libp2p-metrics?/relay"]
-request-response = ["dep:libp2p-request-response"]
 rendezvous = ["dep:libp2p-rendezvous"]
+request-response = ["dep:libp2p-request-response"]
+rsa = ["libp2p-core/rsa"]
+secp256k1 = ["libp2p-core/secp256k1"]
+serde = ["libp2p-core/serde", "libp2p-kad?/serde", "libp2p-gossipsub?/serde"]
 tcp = ["dep:libp2p-tcp"]
+tokio = ["libp2p-mdns?/tokio", "libp2p-tcp?/tokio", "libp2p-dns?/tokio"]
 uds = ["dep:libp2p-uds"]
 wasm-bindgen = ["futures-timer/wasm-bindgen", "instant/wasm-bindgen", "getrandom/js"]
 wasm-ext = ["dep:libp2p-wasm-ext"]
 wasm-ext-websocket = ["wasm-ext", "libp2p-wasm-ext?/websocket"]
 websocket = ["dep:libp2p-websocket"]
 yamux = ["dep:libp2p-yamux"]
-secp256k1 = ["libp2p-core/secp256k1"]
-rsa = ["libp2p-core/rsa"]
-ecdsa = ["libp2p-core/ecdsa"]
-serde = ["libp2p-core/serde", "libp2p-kad?/serde", "libp2p-gossipsub?/serde"]
-tokio = ["libp2p-mdns?/tokio", "libp2p-tcp?/tokio", "libp2p-dns?/tokio"]
-async-std = ["libp2p-mdns?/async-io", "libp2p-tcp?/async-io", "libp2p-dns?/async-std"]
 
 [dependencies]
 bytes = "1"
@@ -102,7 +104,6 @@ libp2p-relay = { version = "0.14.0", path = "protocols/relay", optional = true }
 libp2p-rendezvous = { version = "0.11.0", path = "protocols/rendezvous", optional = true }
 libp2p-request-response = { version = "0.23.0", path = "protocols/request-response", optional = true }
 libp2p-swarm = { version = "0.41.0", path = "swarm" }
-libp2p-swarm-derive = { version = "0.30.1", path = "swarm-derive" }
 libp2p-uds = { version = "0.37.0", path = "transports/uds", optional = true }
 libp2p-wasm-ext = { version = "0.38.0", path = "transports/wasm-ext", optional = true }
 libp2p-yamux = { version = "0.42.0", path = "muxers/yamux", optional = true }

examples/chat-tokio.rs

@@ -39,8 +39,8 @@ use libp2p::{
         TokioMdns,
     },
     mplex, noise,
-    swarm::{SwarmBuilder, SwarmEvent},
-    tcp, Multiaddr, NetworkBehaviour, PeerId, Transport,
+    swarm::{NetworkBehaviour, SwarmBuilder, SwarmEvent},
+    tcp, Multiaddr, PeerId, Transport,
 };
 use std::error::Error;
 use tokio::io::{self, AsyncBufReadExt};

examples/chat.rs

@@ -58,8 +58,8 @@ use libp2p::{
     floodsub::{self, Floodsub, FloodsubEvent},
     identity,
     mdns::{Mdns, MdnsConfig, MdnsEvent},
-    swarm::SwarmEvent,
-    Multiaddr, NetworkBehaviour, PeerId, Swarm,
+    swarm::{NetworkBehaviour, SwarmEvent},
+    Multiaddr, PeerId, Swarm,
 };
 use std::error::Error;
 

examples/distributed-key-value-store.rs

@@ -50,8 +50,8 @@ use libp2p::kad::{
 use libp2p::{
     development_transport, identity,
     mdns::{Mdns, MdnsConfig, MdnsEvent},
-    swarm::SwarmEvent,
-    NetworkBehaviour, PeerId, Swarm,
+    swarm::{NetworkBehaviour, SwarmEvent},
+    PeerId, Swarm,
 };
 use std::error::Error;
 

examples/file-sharing.rs

@@ -219,8 +219,9 @@ mod network {
         ProtocolSupport, RequestId, RequestResponse, RequestResponseCodec, RequestResponseEvent,
         RequestResponseMessage, ResponseChannel,
     };
-    use libp2p::swarm::{ConnectionHandlerUpgrErr, SwarmBuilder, SwarmEvent};
-    use libp2p::{NetworkBehaviour, Swarm};
+    use libp2p::swarm::{
+        ConnectionHandlerUpgrErr, NetworkBehaviour, Swarm, SwarmBuilder, SwarmEvent,
+    };
     use std::collections::{hash_map, HashMap, HashSet};
     use std::iter;
 

examples/gossipsub-chat.rs

@@ -55,8 +55,9 @@ use libp2p::gossipsub::{
 use libp2p::{
     gossipsub, identity,
     mdns::{Mdns, MdnsConfig, MdnsEvent},
+    swarm::NetworkBehaviour,
     swarm::SwarmEvent,
-    NetworkBehaviour, PeerId, Swarm,
+    PeerId, Swarm,
 };
 use std::collections::hash_map::DefaultHasher;
 use std::error::Error;

examples/ipfs-private.rs

@@ -42,10 +42,10 @@ use libp2p::{
     multiaddr::Protocol,
     noise, ping,
     pnet::{PnetConfig, PreSharedKey},
-    swarm::SwarmEvent,
+    swarm::{NetworkBehaviour, SwarmEvent},
     tcp,
     yamux::YamuxConfig,
-    Multiaddr, NetworkBehaviour, PeerId, Swarm, Transport,
+    Multiaddr, PeerId, Swarm, Transport,
 };
 use std::{env, error::Error, fs, path::Path, str::FromStr, time::Duration};
 

examples/ping.rs

@@ -41,8 +41,8 @@
 //! and begin pinging each other.
 
 use futures::prelude::*;
-use libp2p::swarm::{Swarm, SwarmEvent};
-use libp2p::{identity, ping, Multiaddr, NetworkBehaviour, PeerId};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
+use libp2p::{identity, ping, Multiaddr, PeerId};
 use libp2p_swarm::keep_alive;
 use std::error::Error;
 

misc/metrics/examples/metrics/main.rs

@@ -53,8 +53,8 @@ use futures::executor::block_on;
 use futures::stream::StreamExt;
 use libp2p::core::Multiaddr;
 use libp2p::metrics::{Metrics, Recorder};
-use libp2p::swarm::SwarmEvent;
-use libp2p::{identity, ping, NetworkBehaviour, PeerId, Swarm};
+use libp2p::swarm::{NetworkBehaviour, SwarmEvent};
+use libp2p::{identity, ping, PeerId, Swarm};
 use libp2p_swarm::keep_alive;
 use log::info;
 use prometheus_client::registry::Registry;

protocols/autonat/examples/autonat_client.rs

@@ -34,8 +34,8 @@ use futures::prelude::*;
 use libp2p::autonat;
 use libp2p::identify;
 use libp2p::multiaddr::Protocol;
-use libp2p::swarm::{Swarm, SwarmEvent};
-use libp2p::{identity, Multiaddr, NetworkBehaviour, PeerId};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
+use libp2p::{identity, Multiaddr, PeerId};
 use std::error::Error;
 use std::net::Ipv4Addr;
 use std::time::Duration;

protocols/autonat/examples/autonat_server.rs

@@ -31,8 +31,8 @@ use futures::prelude::*;
 use libp2p::autonat;
 use libp2p::identify;
 use libp2p::multiaddr::Protocol;
-use libp2p::swarm::{Swarm, SwarmEvent};
-use libp2p::{identity, Multiaddr, NetworkBehaviour, PeerId};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
+use libp2p::{identity, Multiaddr, PeerId};
 use std::error::Error;
 use std::net::Ipv4Addr;
 

protocols/dcutr/examples/dcutr.rs

@@ -29,11 +29,11 @@ use libp2p::dns::DnsConfig;
 use libp2p::identify;
 use libp2p::noise;
 use libp2p::relay::v2::client::{self, Client};
-use libp2p::swarm::{SwarmBuilder, SwarmEvent};
+use libp2p::swarm::{NetworkBehaviour, SwarmBuilder, SwarmEvent};
 use libp2p::tcp;
 use libp2p::Transport;
 use libp2p::{dcutr, ping};
-use libp2p::{identity, NetworkBehaviour, PeerId};
+use libp2p::{identity, PeerId};
 use log::info;
 use std::convert::TryInto;
 use std::error::Error;

protocols/dcutr/tests/lib.rs

@@ -34,7 +34,6 @@ use libp2p::plaintext::PlainText2Config;
 use libp2p::relay::v2::client;
 use libp2p::relay::v2::relay;
 use libp2p::swarm::{AddressScore, NetworkBehaviour, Swarm, SwarmEvent};
-use libp2p::NetworkBehaviour;
 use std::time::Duration;
 
 #[test]

protocols/ping/tests/ping.rs

@@ -30,10 +30,9 @@ use libp2p::core::{
 use libp2p::mplex;
 use libp2p::noise;
 use libp2p::ping;
-use libp2p::swarm::{Swarm, SwarmEvent};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
 use libp2p::tcp;
 use libp2p::yamux;
-use libp2p::NetworkBehaviour;
 use libp2p_swarm::keep_alive;
 use quickcheck::*;
 use std::{num::NonZeroU8, time::Duration};

protocols/relay/examples/relay_v2.rs

@@ -27,10 +27,10 @@ use libp2p::identify;
 use libp2p::multiaddr::Protocol;
 use libp2p::ping;
 use libp2p::relay::v2::relay::{self, Relay};
-use libp2p::swarm::{Swarm, SwarmEvent};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
 use libp2p::tcp;
 use libp2p::Transport;
-use libp2p::{identity, NetworkBehaviour, PeerId};
+use libp2p::{identity, PeerId};
 use libp2p::{noise, Multiaddr};
 use std::error::Error;
 use std::net::{Ipv4Addr, Ipv6Addr};

protocols/relay/tests/v2.rs

@@ -29,11 +29,11 @@ use libp2p::core::transport::choice::OrTransport;
 use libp2p::core::transport::{Boxed, MemoryTransport, Transport};
 use libp2p::core::PublicKey;
 use libp2p::core::{identity, upgrade, PeerId};
+use libp2p::ping;
 use libp2p::plaintext::PlainText2Config;
 use libp2p::relay::v2::client;
 use libp2p::relay::v2::relay;
 use libp2p::swarm::{AddressScore, NetworkBehaviour, Swarm, SwarmEvent};
-use libp2p::{ping, NetworkBehaviour};
 use std::time::Duration;
 
 #[test]

protocols/rendezvous/examples/discover.rs

@@ -143,7 +143,7 @@ impl From<Void> for MyEvent {
     }
 }
 
-#[derive(libp2p::NetworkBehaviour)]
+#[derive(libp2p::swarm::NetworkBehaviour)]
 #[behaviour(event_process = false)]
 #[behaviour(out_event = "MyEvent")]
 struct MyBehaviour {

protocols/rendezvous/examples/register.rs

@@ -22,9 +22,9 @@ use futures::StreamExt;
 use libp2p::core::identity;
 use libp2p::core::PeerId;
 use libp2p::ping;
-use libp2p::swarm::{Swarm, SwarmEvent};
+use libp2p::swarm::{NetworkBehaviour, Swarm, SwarmEvent};
+use libp2p::Multiaddr;
 use libp2p::{development_transport, rendezvous};
-use libp2p::{Multiaddr, NetworkBehaviour};
 use libp2p_swarm::AddressScore;
 use std::time::Duration;
 

protocols/rendezvous/examples/register_with_identify.rs

@@ -23,9 +23,9 @@ use libp2p::core::identity;
 use libp2p::core::PeerId;
 use libp2p::identify;
 use libp2p::ping;
-use libp2p::swarm::{keep_alive, Swarm, SwarmEvent};
+use libp2p::swarm::{keep_alive, NetworkBehaviour, Swarm, SwarmEvent};
+use libp2p::Multiaddr;
 use libp2p::{development_transport, rendezvous};
-use libp2p::{Multiaddr, NetworkBehaviour};
 use std::time::Duration;
 use void::Void;
 

protocols/rendezvous/examples/rendezvous_point.rs

@@ -23,8 +23,7 @@ use libp2p::core::identity;
 use libp2p::core::PeerId;
 use libp2p::identify;
 use libp2p::ping;
-use libp2p::swarm::{keep_alive, Swarm, SwarmEvent};
-use libp2p::NetworkBehaviour;
+use libp2p::swarm::{keep_alive, NetworkBehaviour, Swarm, SwarmEvent};
 use libp2p::{development_transport, rendezvous};
 use void::Void;
 

protocols/rendezvous/tests/rendezvous.rs

@@ -366,7 +366,7 @@ async fn new_impersonating_client() -> Swarm<rendezvous::client::Behaviour> {
     eve
 }
 
-#[derive(libp2p::NetworkBehaviour)]
+#[derive(libp2p::swarm::NetworkBehaviour)]
 #[behaviour(event_process = false, out_event = "CombinedEvent")]
 struct CombinedBehaviour {
     client: rendezvous::client::Behaviour,

src/lib.rs

@@ -145,7 +145,6 @@ pub use self::multiaddr::{multiaddr as build_multiaddr, Multiaddr};
 pub use self::simple::SimpleProtocol;
 pub use self::swarm::Swarm;
 pub use self::transport_ext::TransportExt;
-pub use libp2p_swarm_derive::NetworkBehaviour;
 
 /// Builds a `Transport` based on TCP/IP that supports the most commonly-used features of libp2p:
 ///

swarm-derive/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.30.2 [unreleased]
+
+- Add `prelude` configuration option.
+  The derive-macro generates code that needs to refer to various symbols. See [PR 3055].
+
+[PR 3055]: https://github.com/libp2p/rust-libp2p/pull/3055
+
 # 0.30.1
 
 - Fix an issue where the derive would generate bad code if the type parameters between the behaviour and a custom

swarm-derive/Cargo.toml

@@ -3,7 +3,7 @@ name = "libp2p-swarm-derive"
 edition = "2021"
 rust-version = "1.56.1"
 description = "Procedural macros of libp2p-core"
-version = "0.30.1"
+version = "0.30.2"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"
@@ -18,13 +18,7 @@ heck = "0.4"
 quote = "1.0"
 syn = { version = "1.0.8", default-features = false, features = ["clone-impls", "derive", "parsing", "printing", "proc-macro"] }
 
-[dev-dependencies]
-libp2p = { path = "..", features = ["full"] }
-either = "1.6.0"
-futures = "0.3.1"
-void = "1"
-
-# Passing arguments to the docsrs builder in order to properly document cfg's. 
+# Passing arguments to the docsrs builder in order to properly document cfg's.
 # More information: https://docs.rs/about/builds#cross-compiling
 [package.metadata.docs.rs]
 all-features = true