protocols/identify: Revise symbol naming (libp2p#2927)

CHANGELOG.md

@@ -77,6 +77,8 @@
 
 - [PR 2918]: https://github.com/libp2p/rust-libp2p/pull/2918
 
+- Update to [`libp2p-identify` `v0.39.1`](protocols/identify/CHANGELOG.md#0391).
+
 # 0.48.0
 
 - Update to [`libp2p-core` `v0.36.0`](core/CHANGELOG.md#0360).

examples/ipfs-private.rs

@@ -39,8 +39,7 @@ use libp2p::{
         either::EitherTransport, muxing::StreamMuxerBox, transport, transport::upgrade::Version,
     },
     gossipsub::{self, Gossipsub, GossipsubConfigBuilder, GossipsubEvent, MessageAuthenticity},
-    identify::{Identify, IdentifyConfig, IdentifyEvent},
-    identity,
+    identify, identity,
     multiaddr::Protocol,
     noise, ping,
     pnet::{PnetConfig, PreSharedKey},
@@ -157,13 +156,13 @@ async fn main() -> Result<(), Box<dyn Error>> {
     #[behaviour(out_event = "MyBehaviourEvent")]
     struct MyBehaviour {
         gossipsub: Gossipsub,
-        identify: Identify,
+        identify: identify::Behaviour,
         ping: ping::Behaviour,
     }
 
     enum MyBehaviourEvent {
         Gossipsub(GossipsubEvent),
-        Identify(IdentifyEvent),
+        Identify(identify::Event),
         Ping(ping::Event),
     }
 
@@ -173,8 +172,8 @@ async fn main() -> Result<(), Box<dyn Error>> {
         }
     }
 
-    impl From<IdentifyEvent> for MyBehaviourEvent {
-        fn from(event: IdentifyEvent) -> Self {
+    impl From<identify::Event> for MyBehaviourEvent {
+        fn from(event: identify::Event) -> Self {
             MyBehaviourEvent::Identify(event)
         }
     }
@@ -197,7 +196,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
                 gossipsub_config,
             )
             .expect("Valid configuration"),
-            identify: Identify::new(IdentifyConfig::new(
+            identify: identify::Behaviour::new(identify::Config::new(
                 "/ipfs/0.1.0".into(),
                 local_key.public(),
             )),

misc/metrics/CHANGELOG.md

@@ -1,7 +1,7 @@
 # 0.10.0 [unreleased]
 
 - Update to `libp2p-kad` `v0.41.0`.
-- 
+
 - Update to `libp2p-identify` `v0.39.1`.
 
 - Update to `libp2p-swarm` `v0.40.0`.

misc/metrics/src/identify.rs

@@ -112,16 +112,16 @@ impl Metrics {
     }
 }
 
-impl super::Recorder<libp2p_identify::IdentifyEvent> for Metrics {
-    fn record(&self, event: &libp2p_identify::IdentifyEvent) {
+impl super::Recorder<libp2p_identify::Event> for Metrics {
+    fn record(&self, event: &libp2p_identify::Event) {
         match event {
-            libp2p_identify::IdentifyEvent::Error { .. } => {
+            libp2p_identify::Event::Error { .. } => {
                 self.error.inc();
             }
-            libp2p_identify::IdentifyEvent::Pushed { .. } => {
+            libp2p_identify::Event::Pushed { .. } => {
                 self.pushed.inc();
             }
-            libp2p_identify::IdentifyEvent::Received { peer_id, info, .. } => {
+            libp2p_identify::Event::Received { peer_id, info, .. } => {
                 {
                     let mut protocols: Vec<String> = info
                         .protocols
@@ -168,7 +168,7 @@ impl super::Recorder<libp2p_identify::IdentifyEvent> for Metrics {
                 self.received_info_listen_addrs
                     .observe(info.listen_addrs.len() as f64);
             }
-            libp2p_identify::IdentifyEvent::Sent { .. } => {
+            libp2p_identify::Event::Sent { .. } => {
                 self.sent.inc();
             }
         }

misc/metrics/src/lib.rs

@@ -112,8 +112,8 @@ impl Recorder<libp2p_gossipsub::GossipsubEvent> for Metrics {
 }
 
 #[cfg(feature = "identify")]
-impl Recorder<libp2p_identify::IdentifyEvent> for Metrics {
-    fn record(&self, event: &libp2p_identify::IdentifyEvent) {
+impl Recorder<libp2p_identify::Event> for Metrics {
+    fn record(&self, event: &libp2p_identify::Event) {
         self.identify.record(event)
     }
 }

protocols/autonat/examples/autonat_client.rs

@@ -32,7 +32,7 @@
 use clap::Parser;
 use futures::prelude::*;
 use libp2p::autonat;
-use libp2p::identify::{Identify, IdentifyConfig, IdentifyEvent};
+use libp2p::identify;
 use libp2p::multiaddr::Protocol;
 use libp2p::swarm::{Swarm, SwarmEvent};
 use libp2p::{identity, Multiaddr, NetworkBehaviour, PeerId};
@@ -91,14 +91,14 @@ async fn main() -> Result<(), Box<dyn Error>> {
 #[derive(NetworkBehaviour)]
 #[behaviour(out_event = "Event")]
 struct Behaviour {
-    identify: Identify,
+    identify: identify::Behaviour,
     auto_nat: autonat::Behaviour,
 }
 
 impl Behaviour {
     fn new(local_public_key: identity::PublicKey) -> Self {
         Self {
-            identify: Identify::new(IdentifyConfig::new(
+            identify: identify::Behaviour::new(identify::Config::new(
                 "/ipfs/0.1.0".into(),
                 local_public_key.clone(),
             )),
@@ -119,11 +119,11 @@ impl Behaviour {
 #[derive(Debug)]
 enum Event {
     AutoNat(autonat::Event),
-    Identify(IdentifyEvent),
+    Identify(identify::Event),
 }
 
-impl From<IdentifyEvent> for Event {
-    fn from(v: IdentifyEvent) -> Self {
+impl From<identify::Event> for Event {
+    fn from(v: identify::Event) -> Self {
         Self::Identify(v)
     }
 }

protocols/autonat/examples/autonat_server.rs

@@ -29,7 +29,7 @@
 use clap::Parser;
 use futures::prelude::*;
 use libp2p::autonat;
-use libp2p::identify::{Identify, IdentifyConfig, IdentifyEvent};
+use libp2p::identify;
 use libp2p::multiaddr::Protocol;
 use libp2p::swarm::{Swarm, SwarmEvent};
 use libp2p::{identity, Multiaddr, NetworkBehaviour, PeerId};
@@ -76,14 +76,14 @@ async fn main() -> Result<(), Box<dyn Error>> {
 #[derive(NetworkBehaviour)]
 #[behaviour(out_event = "Event")]
 struct Behaviour {
-    identify: Identify,
+    identify: identify::Behaviour,
     auto_nat: autonat::Behaviour,
 }
 
 impl Behaviour {
     fn new(local_public_key: identity::PublicKey) -> Self {
         Self {
-            identify: Identify::new(IdentifyConfig::new(
+            identify: identify::Behaviour::new(identify::Config::new(
                 "/ipfs/0.1.0".into(),
                 local_public_key.clone(),
             )),
@@ -98,11 +98,11 @@ impl Behaviour {
 #[derive(Debug)]
 enum Event {
     AutoNat(autonat::Event),
-    Identify(IdentifyEvent),
+    Identify(identify::Event),
 }
 
-impl From<IdentifyEvent> for Event {
-    fn from(v: IdentifyEvent) -> Self {
+impl From<identify::Event> for Event {
+    fn from(v: identify::Event) -> Self {
         Self::Identify(v)
     }
 }

protocols/dcutr/examples/dcutr.rs

@@ -26,7 +26,7 @@ use libp2p::core::multiaddr::{Multiaddr, Protocol};
 use libp2p::core::transport::OrTransport;
 use libp2p::core::upgrade;
 use libp2p::dns::DnsConfig;
-use libp2p::identify::{Identify, IdentifyConfig, IdentifyEvent, IdentifyInfo};
+use libp2p::identify;
 use libp2p::noise;
 use libp2p::relay::v2::client::{self, Client};
 use libp2p::swarm::{SwarmBuilder, SwarmEvent};
@@ -108,14 +108,14 @@ fn main() -> Result<(), Box<dyn Error>> {
     struct Behaviour {
         relay_client: Client,
         ping: ping::Behaviour,
-        identify: Identify,
+        identify: identify::Behaviour,
         dcutr: dcutr::behaviour::Behaviour,
     }
 
     #[derive(Debug)]
     enum Event {
         Ping(ping::Event),
-        Identify(IdentifyEvent),
+        Identify(identify::Event),
         Relay(client::Event),
         Dcutr(dcutr::behaviour::Event),
     }
@@ -126,8 +126,8 @@ fn main() -> Result<(), Box<dyn Error>> {
         }
     }
 
-    impl From<IdentifyEvent> for Event {
-        fn from(e: IdentifyEvent) -> Self {
+    impl From<identify::Event> for Event {
+        fn from(e: identify::Event) -> Self {
             Event::Identify(e)
         }
     }
@@ -147,7 +147,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     let behaviour = Behaviour {
         relay_client: client,
         ping: ping::Behaviour::new(ping::Config::new()),
-        identify: Identify::new(IdentifyConfig::new(
+        identify: identify::Behaviour::new(identify::Config::new(
             "/TODO/0.0.1".to_string(),
             local_key.public(),
         )),
@@ -200,12 +200,12 @@ fn main() -> Result<(), Box<dyn Error>> {
                 SwarmEvent::Dialing { .. } => {}
                 SwarmEvent::ConnectionEstablished { .. } => {}
                 SwarmEvent::Behaviour(Event::Ping(_)) => {}
-                SwarmEvent::Behaviour(Event::Identify(IdentifyEvent::Sent { .. })) => {
+                SwarmEvent::Behaviour(Event::Identify(identify::Event::Sent { .. })) => {
                     info!("Told relay its public address.");
                     told_relay_observed_addr = true;
                 }
-                SwarmEvent::Behaviour(Event::Identify(IdentifyEvent::Received {
-                    info: IdentifyInfo { observed_addr, .. },
+                SwarmEvent::Behaviour(Event::Identify(identify::Event::Received {
+                    info: identify::Info { observed_addr, .. },
                     ..
                 })) => {
                     info!("Relay told us our public address: {:?}", observed_addr);

protocols/identify/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 - Update dependencies.
 
+- Rename types as per [discussion 2174].
+  `Identify` has been renamed to `Behaviour`.
+  The `Identify` prefix has been removed from various types like `IdentifyEvent`.
+  Users should prefer importing the identify protocol as a module (`use libp2p::identify;`),
+  and refer to its types via `identify::`. For example: `identify::Behaviour` or `identify::Event`.
+
+  [discussion 2174]: https://github.com/libp2p/rust-libp2p/discussions/2174
+
 - Update to `libp2p-core` `v0.37.0`.
 
 - Update to `libp2p-swarm` `v0.40.0`.

protocols/identify/examples/identify.rs

@@ -37,8 +37,7 @@
 //! and will send each other identify info which is then printed to the console.
 
 use futures::prelude::*;
-use libp2p::{identity, Multiaddr, PeerId};
-use libp2p_identify::{Identify, IdentifyConfig, IdentifyEvent};
+use libp2p::{identify, identity, Multiaddr, PeerId};
 use libp2p_swarm::{Swarm, SwarmEvent};
 use std::error::Error;
 
@@ -51,7 +50,7 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let transport = libp2p::development_transport(local_key.clone()).await?;
 
     // Create a identify network behaviour.
-    let behaviour = Identify::new(IdentifyConfig::new(
+    let behaviour = identify::Behaviour::new(identify::Config::new(
         "/ipfs/id/1.0.0".to_string(),
         local_key.public(),
     ));
@@ -74,11 +73,11 @@ async fn main() -> Result<(), Box<dyn Error>> {
         match swarm.select_next_some().await {
             SwarmEvent::NewListenAddr { address, .. } => println!("Listening on {:?}", address),
             // Prints peer id identify info is being sent to.
-            SwarmEvent::Behaviour(IdentifyEvent::Sent { peer_id, .. }) => {
+            SwarmEvent::Behaviour(identify::Event::Sent { peer_id, .. }) => {
                 println!("Sent identify info to {:?}", peer_id)
             }
             // Prints out the info received via the identify event
-            SwarmEvent::Behaviour(IdentifyEvent::Received { info, .. }) => {
+            SwarmEvent::Behaviour(identify::Event::Received { info, .. }) => {
                 println!("Received {:?}", info)
             }
             _ => {}