Add an IdentifyTopology (#770)

protocols/identify/src/identify.rs

@@ -21,6 +21,7 @@
 use crate::listen_handler::IdentifyListenHandler;
 use crate::periodic_id_handler::{PeriodicIdHandler, PeriodicIdHandlerEvent};
 use crate::protocol::{IdentifyInfo, IdentifySender, IdentifySenderFuture};
+use crate::topology::IdentifyTopology;
 use futures::prelude::*;
 use libp2p_core::protocols_handler::{ProtocolsHandler, ProtocolsHandlerSelect};
 use libp2p_core::swarm::{ConnectedPoint, NetworkBehaviour, NetworkBehaviourAction, PollParameters};
@@ -64,6 +65,7 @@ impl<TSubstream> Identify<TSubstream> {
 impl<TSubstream, TTopology> NetworkBehaviour<TTopology> for Identify<TSubstream>
 where
     TSubstream: AsyncRead + AsyncWrite,
+    TTopology: IdentifyTopology,
 {
     type ProtocolsHandler = ProtocolsHandlerSelect<IdentifyListenHandler<TSubstream>, PeriodicIdHandler<TSubstream>>;
     type OutEvent = IdentifyEvent;
@@ -130,6 +132,12 @@ where
         >,
     > {
         if let Some(event) = self.events.pop_front() {
+            // We intercept identified events in order to insert the addresses in the topology.
+            if let NetworkBehaviourAction::GenerateEvent(IdentifyEvent::Identified { ref peer_id, ref info, .. }) = event {
+                let iter = info.listen_addrs.iter().cloned();
+                params.topology().add_identify_discovered_addrs(peer_id, iter);
+            }
+
             return Async::Ready(event);
         }
 

protocols/identify/src/lib.rs

@@ -85,6 +85,7 @@ pub use self::identify::{Identify, IdentifyEvent};
 pub use self::id_transport::IdentifyTransport;
 pub use self::listen_layer::IdentifyListen;
 pub use self::periodic_id_layer::{PeriodicIdentify, PeriodicIdentifyEvent};
+pub use self::topology::IdentifyTopology;
 
 pub mod listen_handler;
 pub mod periodic_id_handler;
@@ -95,3 +96,4 @@ mod id_transport;
 mod listen_layer;
 mod periodic_id_layer;
 mod structs_proto;
+mod topology;

protocols/identify/src/topology.rs

@@ -0,0 +1,40 @@
+// Copyright 2018 Parity Technologies (UK) Ltd.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+
+use libp2p_core::{topology::MemoryTopology, Multiaddr, PeerId};
+
+/// Trait required on the topology for the identify system to store addresses.
+pub trait IdentifyTopology {
+    /// Adds to the topology an address discovered through identification.
+    fn add_identify_discovered_addrs<TIter>(&mut self, peer: &PeerId, addr: TIter)
+    where
+        TIter: Iterator<Item = Multiaddr>;
+}
+
+impl IdentifyTopology for MemoryTopology {
+    fn add_identify_discovered_addrs<TIter>(&mut self, peer: &PeerId, addr: TIter)
+    where
+        TIter: Iterator<Item = Multiaddr>,
+    {
+        for addr in addr {
+            self.add_address(peer.clone(), addr);
+        }
+    }
+}