From 09512711e7e8bb510364995e6b35a94d25cab0c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Oliveira?= Date: Fri, 23 Dec 2022 19:27:18 +0000 Subject: [PATCH] review: apply suggestions. --- protocols/relay/examples/relay.rs | 33 +------------- protocols/relay/src/lib.rs | 2 + protocols/relay/src/priv_client/transport.rs | 4 +- protocols/relay/src/v2.rs | 5 +- protocols/relay/tests/lib.rs | 48 +------------------- 5 files changed, 12 insertions(+), 80 deletions(-) diff --git a/protocols/relay/examples/relay.rs b/protocols/relay/examples/relay.rs index 4b755269e36..5d88f1739df 100644 --- a/protocols/relay/examples/relay.rs +++ b/protocols/relay/examples/relay.rs @@ -79,7 +79,7 @@ fn main() -> Result<(), Box> { block_on(async { loop { match swarm.next().await.expect("Infinite Stream.") { - SwarmEvent::Behaviour(Event::Relay(event)) => { + SwarmEvent::Behaviour(event) => { println!("{event:?}") } SwarmEvent::NewListenAddr { address, .. } => { @@ -92,42 +92,13 @@ fn main() -> Result<(), Box> { } #[derive(NetworkBehaviour)] -#[behaviour( - out_event = "Event", - event_process = false, - prelude = "libp2p_swarm::derive_prelude" -)] +#[behaviour(prelude = "libp2p_swarm::derive_prelude")] struct Behaviour { relay: relay::Behaviour, ping: ping::Behaviour, identify: identify::Behaviour, } -#[derive(Debug)] -enum Event { - Ping(ping::Event), - Identify(identify::Event), - Relay(relay::Event), -} - -impl From for Event { - fn from(e: ping::Event) -> Self { - Event::Ping(e) - } -} - -impl From for Event { - fn from(e: identify::Event) -> Self { - Event::Identify(e) - } -} - -impl From for Event { - fn from(e: relay::Event) -> Self { - Event::Relay(e) - } -} - fn generate_ed25519(secret_key_seed: u8) -> identity::Keypair { let mut bytes = [0u8; 32]; bytes[0] = secret_key_seed; diff --git a/protocols/relay/src/lib.rs b/protocols/relay/src/lib.rs index 22f7edd0498..aa5a82043f5 100644 --- a/protocols/relay/src/lib.rs +++ b/protocols/relay/src/lib.rs @@ -72,6 +72,8 @@ static_assertions::const_assert! { } /// The ID of an outgoing / incoming, relay / destination request. +// TODO remove this type and it's usage on `TransportToBehaviourMsg::DialReq` +// when removed from `v2`. #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] pub struct RequestId(u64); diff --git a/protocols/relay/src/priv_client/transport.rs b/protocols/relay/src/priv_client/transport.rs index 772ad34dfcd..264eb3abcd5 100644 --- a/protocols/relay/src/priv_client/transport.rs +++ b/protocols/relay/src/priv_client/transport.rs @@ -72,11 +72,11 @@ use thiserror::Error; /// # use libp2p_core::{Multiaddr, multiaddr::{Protocol}, Transport, PeerId}; /// # use libp2p_core::transport::memory::MemoryTransport; /// # use libp2p_core::transport::choice::OrTransport; -/// # use libp2p_relay::client; +/// # use libp2p_relay as relay; /// # let relay_id = PeerId::random(); /// # let local_peer_id = PeerId::random(); /// let actual_transport = MemoryTransport::default(); -/// let (relay_transport, behaviour) = client::Behaviour::new_transport_and_behaviour( +/// let (relay_transport, behaviour) = relay::client::new( /// local_peer_id, /// ); /// let mut transport = OrTransport::new(relay_transport, actual_transport); diff --git a/protocols/relay/src/v2.rs b/protocols/relay/src/v2.rs index 8491e455f79..bf428684bbc 100644 --- a/protocols/relay/src/v2.rs +++ b/protocols/relay/src/v2.rs @@ -167,5 +167,8 @@ pub mod protocol { pub const STOP_PROTOCOL_NAME: &[u8; 32] = crate::STOP_PROTOCOL_NAME; } -#[deprecated(since = "0.15.0", note = "Use libp2p_relay::RequestId instead.")] +#[deprecated( + since = "0.15.0", + note = "RequestId will be deprecated as it isn't used" +)] pub type RequestId = super::RequestId; diff --git a/protocols/relay/tests/lib.rs b/protocols/relay/tests/lib.rs index df5e0b0315e..a26d09e6e3b 100644 --- a/protocols/relay/tests/lib.rs +++ b/protocols/relay/tests/lib.rs @@ -342,63 +342,19 @@ where } #[derive(NetworkBehaviour)] -#[behaviour( - out_event = "RelayEvent", - event_process = false, - prelude = "libp2p_swarm::derive_prelude" -)] +#[behaviour(prelude = "libp2p_swarm::derive_prelude")] struct Relay { relay: relay::Behaviour, ping: ping::Behaviour, } -#[derive(Debug)] -enum RelayEvent { - Relay(relay::Event), - Ping(ping::Event), -} - -impl From for RelayEvent { - fn from(event: relay::Event) -> Self { - RelayEvent::Relay(event) - } -} - -impl From for RelayEvent { - fn from(event: ping::Event) -> Self { - RelayEvent::Ping(event) - } -} - #[derive(NetworkBehaviour)] -#[behaviour( - out_event = "ClientEvent", - event_process = false, - prelude = "libp2p_swarm::derive_prelude" -)] +#[behaviour(prelude = "libp2p_swarm::derive_prelude")] struct Client { relay: relay::client::Behaviour, ping: ping::Behaviour, } -#[derive(Debug)] -enum ClientEvent { - Relay(relay::client::Event), - Ping(ping::Event), -} - -impl From for ClientEvent { - fn from(event: relay::client::Event) -> Self { - ClientEvent::Relay(event) - } -} - -impl From for ClientEvent { - fn from(event: ping::Event) -> Self { - ClientEvent::Ping(event) - } -} - fn spawn_swarm_on_pool(pool: &LocalPool, swarm: Swarm) { pool.spawner() .spawn_obj(swarm.collect::>().map(|_| ()).boxed().into())