chore: change naming of symbols

libp2p · Feb 5, 2025 · 3bcd08a · 3bcd08a
1 parent 9db2ea0
commit 3bcd08a
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 27 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -79,7 +79,7 @@ libp2p-connection-limits = { version = "0.5.1", path = "misc/connection-limits"
 libp2p-core = { version = "0.43.0", path = "core" }
 libp2p-dcutr = { version = "0.13.0", path = "protocols/dcutr" }
 libp2p-dns = { version = "0.43.0", path = "transports/dns" }
-libp2p-floodsub = { version = "0.46.0", path = "protocols/floodsub" }
+libp2p-floodsub = { version = "0.46.1", path = "protocols/floodsub" }
 libp2p-gossipsub = { version = "0.48.1", path = "protocols/gossipsub" }
 libp2p-identify = { version = "0.46.0", path = "protocols/identify" }
 libp2p-identity = { version = "0.2.10" }

diff --git a/protocols/floodsub/CHANGELOG.md b/protocols/floodsub/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.46.1
+- Rename types to match naming convention in [discussion 2174](https://github.com/libp2p/rust-libp2p/discussions/2174).
+  See [PR XXXX](https://github.com/libp2p/rust-libp2p/pull/XXXX).
+
 ## 0.46.0
 
 <!-- Update to libp2p-core v0.43.0 -->

diff --git a/protocols/floodsub/Cargo.toml b/protocols/floodsub/Cargo.toml
@@ -3,7 +3,7 @@ name = "libp2p-floodsub"
 edition = "2021"
 rust-version = { workspace = true }
 description = "Floodsub protocol for libp2p"
-version = "0.46.0"
+version = "0.46.1"
 authors = ["Parity Technologies <admin@parity.io>"]
 license = "MIT"
 repository = "https://github.com/libp2p/rust-libp2p"

diff --git a/protocols/floodsub/src/layer.rs b/protocols/floodsub/src/layer.rs
@@ -40,19 +40,18 @@ use libp2p_swarm::{
 };
 use smallvec::SmallVec;
 
-use crate::{
-    protocol::{
-        FloodsubMessage, FloodsubProtocol, FloodsubRpc, FloodsubSubscription,
-        FloodsubSubscriptionAction,
-    },
-    topic::Topic,
-    FloodsubConfig,
-};
+use crate::{protocol::{
+    FloodsubMessage, FloodsubProtocol, FloodsubRpc, FloodsubSubscription,
+    FloodsubSubscriptionAction,
+}, topic::Topic, Config, FloodsubConfig};
+
+#[deprecated = "Use `Behaviour` instead."]
+pub type Floodsub = Behaviour;
 
 /// Network behaviour that handles the floodsub protocol.
-pub struct Floodsub {
+pub struct Behaviour {
     /// Events that need to be yielded to the outside when polling.
-    events: VecDeque<ToSwarm<FloodsubEvent, FloodsubRpc>>,
+    events: VecDeque<ToSwarm<Event, FloodsubRpc>>,
 
     config: FloodsubConfig,
 
@@ -73,15 +72,15 @@ pub struct Floodsub {
     received: CuckooFilter<DefaultHasher>,
 }
 
-impl Floodsub {
+impl Behaviour {
     /// Creates a `Floodsub` with default configuration.
     pub fn new(local_peer_id: PeerId) -> Self {
-        Self::from_config(FloodsubConfig::new(local_peer_id))
+        Self::from_config(Config::new(local_peer_id))
     }
 
     /// Creates a `Floodsub` with the given configuration.
-    pub fn from_config(config: FloodsubConfig) -> Self {
-        Floodsub {
+    pub fn from_config(config: Config) -> Self {
+        Behaviour {
             events: VecDeque::new(),
             config,
             target_peers: FnvHashSet::default(),
@@ -241,7 +240,7 @@ impl Floodsub {
             }
             if self.config.subscribe_local_messages {
                 self.events
-                    .push_back(ToSwarm::GenerateEvent(FloodsubEvent::Message(
+                    .push_back(ToSwarm::GenerateEvent(Event::Message(
                         message.clone(),
                     )));
             }
@@ -337,9 +336,9 @@ impl Floodsub {
     }
 }
 
-impl NetworkBehaviour for Floodsub {
+impl NetworkBehaviour for Behaviour {
     type ConnectionHandler = OneShotHandler<FloodsubProtocol, FloodsubRpc, InnerMessage>;
-    type ToSwarm = FloodsubEvent;
+    type ToSwarm = Event;
 
     fn handle_established_inbound_connection(
         &mut self,
@@ -393,7 +392,7 @@ impl NetworkBehaviour for Floodsub {
                         remote_peer_topics.push(subscription.topic.clone());
                     }
                     self.events
-                        .push_back(ToSwarm::GenerateEvent(FloodsubEvent::Subscribed {
+                        .push_back(ToSwarm::GenerateEvent(Event::Subscribed {
                             peer_id: propagation_source,
                             topic: subscription.topic,
                         }));
@@ -406,7 +405,7 @@ impl NetworkBehaviour for Floodsub {
                         remote_peer_topics.remove(pos);
                     }
                     self.events
-                        .push_back(ToSwarm::GenerateEvent(FloodsubEvent::Unsubscribed {
+                        .push_back(ToSwarm::GenerateEvent(Event::Unsubscribed {
                             peer_id: propagation_source,
                             topic: subscription.topic,
                         }));
@@ -439,7 +438,7 @@ impl NetworkBehaviour for Floodsub {
                 .iter()
                 .any(|t| message.topics.iter().any(|u| t == u))
             {
-                let event = FloodsubEvent::Message(message.clone());
+                let event = Event::Message(message.clone());
                 self.events.push_back(ToSwarm::GenerateEvent(event));
             }
 
@@ -530,9 +529,12 @@ impl From<()> for InnerMessage {
     }
 }
 
+#[deprecated = "Use `Event` instead."]
+pub type FloodsubEvent = Event;
+
 /// Event that can happen on the floodsub behaviour.
 #[derive(Debug)]
-pub enum FloodsubEvent {
+pub enum Event {
     /// A message has been received.
     Message(FloodsubMessage),
 

diff --git a/protocols/floodsub/src/lib.rs b/protocols/floodsub/src/lib.rs
@@ -35,15 +35,23 @@ mod proto {
     pub(crate) use self::floodsub::pb::{mod_RPC::SubOpts, Message, RPC};
 }
 
+#[allow(deprecated)]
 pub use self::{
-    layer::{Floodsub, FloodsubEvent},
+    layer::{Floodsub, FloodsubEvent}
+};
+
+pub use self::{
+    layer::{Behaviour, Event},
     protocol::{FloodsubMessage, FloodsubRpc},
     topic::Topic,
 };
 
+#[deprecated = "Use `Config` instead."]
+pub type FloodsubConfig = Config;
+
 /// Configuration options for the Floodsub protocol.
 #[derive(Debug, Clone)]
-pub struct FloodsubConfig {
+pub struct Config {
     /// Peer id of the local node. Used for the source of the messages that we publish.
     pub local_peer_id: PeerId,
 
@@ -52,7 +60,7 @@ pub struct FloodsubConfig {
     pub subscribe_local_messages: bool,
 }
 
-impl FloodsubConfig {
+impl Config {
     pub fn new(local_peer_id: PeerId) -> Self {
         Self {
             local_peer_id,