refactor(relay): revise public API to follow naming convention

protocols/dcutr/examples/dcutr.rs

@@ -32,7 +32,7 @@ use libp2p_dns::DnsConfig;
 use libp2p_identify as identify;
 use libp2p_noise as noise;
 use libp2p_ping as ping;
-use libp2p_relay::v2::client::{self, Client};
+use libp2p_relay::v2::client;
 use libp2p_swarm::{NetworkBehaviour, SwarmBuilder, SwarmEvent};
 use libp2p_tcp as tcp;
 use log::info;
@@ -87,7 +87,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     let local_peer_id = PeerId::from(local_key.public());
     info!("Local peer id: {:?}", local_peer_id);
 
-    let (relay_transport, client) = Client::new_transport_and_behaviour(local_peer_id);
+    let (relay_transport, client) = client::Behaviour::new_transport_and_behaviour(local_peer_id);
 
     let transport = OrTransport::new(
         relay_transport,
@@ -111,7 +111,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         prelude = "libp2p_swarm::derive_prelude"
     )]
     struct Behaviour {
-        relay_client: Client,
+        relay_client: client::Behaviour,
         ping: ping::Behaviour,
         identify: identify::Behaviour,
         dcutr: dcutr::behaviour::Behaviour,

protocols/dcutr/tests/lib.rs

@@ -91,7 +91,7 @@ fn connect() {
     ));
 }
 
-fn build_relay() -> Swarm<relay::Relay> {
+fn build_relay() -> Swarm<relay::Behaviour> {
     let local_key = identity::Keypair::generate_ed25519();
     let local_public_key = local_key.public();
     let local_peer_id = local_public_key.to_peer_id();
@@ -100,7 +100,7 @@ fn build_relay() -> Swarm<relay::Relay> {
 
     Swarm::with_threadpool_executor(
         transport,
-        relay::Relay::new(
+        relay::Behaviour::new(
             local_peer_id,
             relay::Config {
                 reservation_duration: Duration::from_secs(2),
@@ -116,7 +116,8 @@ fn build_client() -> Swarm<Client> {
     let local_public_key = local_key.public();
     let local_peer_id = local_public_key.to_peer_id();
 
-    let (relay_transport, behaviour) = client::Client::new_transport_and_behaviour(local_peer_id);
+    let (relay_transport, behaviour) =
+        client::Behaviour::new_transport_and_behaviour(local_peer_id);
     let transport = build_transport(
         OrTransport::new(relay_transport, MemoryTransport::default()).boxed(),
         local_public_key,
@@ -153,7 +154,7 @@ where
     prelude = "libp2p_swarm::derive_prelude"
 )]
 struct Client {
-    relay: client::Client,
+    relay: client::Behaviour,
     dcutr: dcutr::behaviour::Behaviour,
 }
 

protocols/relay/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 0.15.0 [unreleased]
 
+- Rename types as per [discussion 2174].
+  `Relay` has been renamed to `Behaviour`.
+  The `Relay`, and `Client` prefixes have been removed from various types like `ClientTransport`.
+  Users should prefer importing the relay protocol as a module (`use libp2p::relay::v2::relay;`),
+  and refer to its types via `relay::`. For example: `relay::v2::relay::Behaviour` or `relay::v2::client::Behaviour`.
+  See [PR 3235].
+
 - Update to `libp2p-swarm` `v0.42.0`.
 
 # 0.14.0

protocols/relay/examples/relay_v2.rs

@@ -28,7 +28,7 @@ use libp2p_core::{identity, Multiaddr, PeerId, Transport};
 use libp2p_identify as identify;
 use libp2p_noise as noise;
 use libp2p_ping as ping;
-use libp2p_relay::v2::relay::{self, Relay};
+use libp2p_relay::v2::relay;
 use libp2p_swarm::{NetworkBehaviour, Swarm, SwarmEvent};
 use libp2p_tcp as tcp;
 use std::error::Error;
@@ -57,7 +57,7 @@ fn main() -> Result<(), Box<dyn Error>> {
         .boxed();
 
     let behaviour = Behaviour {
-        relay: Relay::new(local_peer_id, Default::default()),
+        relay: relay::Behaviour::new(local_peer_id, Default::default()),
         ping: ping::Behaviour::new(ping::Config::new()),
         identify: identify::Behaviour::new(identify::Config::new(
             "/TODO/0.0.1".to_string(),
@@ -98,7 +98,7 @@ fn main() -> Result<(), Box<dyn Error>> {
     prelude = "libp2p_swarm::derive_prelude"
 )]
 struct Behaviour {
-    relay: Relay,
+    relay: relay::Behaviour,
     ping: ping::Behaviour,
     identify: identify::Behaviour,
 }

protocols/relay/src/v2/client.rs

@@ -46,7 +46,7 @@ use std::ops::DerefMut;
 use std::pin::Pin;
 use std::task::{Context, Poll};
 
-/// The events produced by the [`Client`] behaviour.
+/// The events produced by the client `Behaviour`.
 #[derive(Debug)]
 pub enum Event {
     /// An outbound reservation has been accepted.
@@ -88,7 +88,17 @@ pub enum Event {
     },
 }
 
-pub struct Client {
+#[deprecated(
+    since = "0.15.0",
+    note = "Use libp2p_relay::v2::client::Behaviour instead."
+)]
+/// [`NetworkBehaviour`] implementation of the relay client
+/// functionality of the circuit relay v2 protocol.
+pub type Client = Behaviour;
+
+/// [`NetworkBehaviour`] implementation of the relay client
+/// functionality of the circuit relay v2 protocol.
+pub struct Behaviour {
     local_peer_id: PeerId,
 
     from_transport: Receiver<transport::TransportToBehaviourMsg>,
@@ -100,12 +110,10 @@ pub struct Client {
     queued_actions: VecDeque<Event>,
 }
 
-impl Client {
-    pub fn new_transport_and_behaviour(
-        local_peer_id: PeerId,
-    ) -> (transport::ClientTransport, Self) {
-        let (transport, from_transport) = transport::ClientTransport::new();
-        let behaviour = Client {
+impl Behaviour {
+    pub fn new_transport_and_behaviour(local_peer_id: PeerId) -> (transport::Transport, Self) {
+        let (transport, from_transport) = transport::Transport::new();
+        let behaviour = Behaviour {
             local_peer_id,
             from_transport,
             directly_connected_peers: Default::default(),
@@ -145,7 +153,7 @@ impl Client {
     }
 }
 
-impl NetworkBehaviour for Client {
+impl NetworkBehaviour for Behaviour {
     type ConnectionHandler = handler::Prototype;
     type OutEvent = Event;
 
@@ -322,10 +330,10 @@ impl NetworkBehaviour for Client {
                 }
             }
             None => unreachable!(
-                "`Relay` `NetworkBehaviour` polled after channel from \
+                "`relay::Behaviour` polled after channel from \
                      `RelayTransport` has been closed. Unreachable under \
-                     the assumption that the `Client` is never polled after \
-                     `ClientTransport` is dropped.",
+                     the assumption that the `client::Behaviour` is never polled after \
+                     `client::Transport` is dropped.",
             ),
         };
 

protocols/relay/src/v2/client/handler.rs

@@ -112,7 +112,7 @@ pub enum Event {
 
 pub struct Prototype {
     local_peer_id: PeerId,
-    /// Initial [`In`] event from [`super::Client`] provided at creation time.
+    /// Initial [`In`] event from [`super::Behaviour`] provided at creation time.
     initial_in: Option<In>,
 }