Network crate cleanups (#3049)

* Remove useless internal messages

* Remove NetworkService::disconnect_peer

* Remove NetworkMsg altogether

* Rename ProtocolMsg ServerToWorkerMsg

* Remove useless code

* Add example for parse_str_addr

* Move parse_str_addr and ProtocolId to config

* Don't reexport the content of config

* Rework the imports

* More reexports rework

* Add documentation

* Move finalization report to network future

* Move on_block_imported to worker

* get_value/put_value no longer locking

* local_peer_id() no longer locks

* Remove FetchFuture

* Service imports cleanup

* Produce the network state in the network task

* Merge network task and RPC network task

* Move network methods to NetworkWorker

* Remove Arc peers system from network

* add_reserved_peer now goes through the channel

* Remove Mutex around network swarm

* Remove the FnOnce alias traits

* Replace is_offline with num_connected

* Improve style of poll()

* Fix network tests

* Some doc in service module

* Remove macro export

* Minor doc changes

* Remove the synchronized() method of the import queue

* Line width

* Line widths

* Fix import queue tests

* Fix CLI tests

substrate/core/network/src/lib.rs

@@ -158,6 +158,15 @@
 //! `Arc<NetworkService>` from the `NetworkWorker`, which can be shared amongst multiple places
 //! in order to give orders to the networking.
 //!
+//! See the [`config`] module for more information about how to configure the networking.
+//!
+//! After the `NetworkWorker` has been created, the important things to do are:
+//!
+//! - Calling `NetworkWorker::poll` in order to advance the network.
+//! - Calling `on_block_import` whenever a block is added to the client.
+//! - Calling `on_block_finalized` whenever a block is finalized.
+//! - Calling `trigger_repropagate` when a transaction is added to the pool.
+//!
 //! More precise usage details are still being worked on and will likely change in the future.
 //!
 
@@ -167,7 +176,6 @@ mod custom_proto;
 mod debug_info;
 mod discovery;
 mod on_demand_layer;
-#[macro_use]
 mod protocol;
 mod service;
 mod transport;
@@ -180,27 +188,25 @@ pub mod test;
 
 pub use chain::{Client as ClientHandle, FinalityProofProvider};
 pub use service::{
-	NetworkService, NetworkWorker, FetchFuture, TransactionPool, ManageNetwork,
-	NetworkMsg, ExHashT, ReportHandle,
+	NetworkService, NetworkWorker, TransactionPool, ExHashT, ReportHandle,
 };
-pub use config::{NodeKeyConfig, Secret, Secp256k1Secret, Ed25519Secret};
-pub use protocol::{PeerInfo, Context, consensus_gossip, event, message, specialization};
+pub use protocol::{PeerInfo, Context, consensus_gossip, message, specialization};
 pub use protocol::sync::SyncState;
-pub use libp2p::{Multiaddr, multiaddr, build_multiaddr};
-pub use libp2p::{identity, PeerId, core::PublicKey, wasm_ext::ExtTransport};
+pub use libp2p::{Multiaddr, PeerId};
+#[doc(inline)]
+pub use libp2p::multiaddr;
 
 pub use message::{generic as generic_message, RequestId, Status as StatusMessage};
-pub use event::Event;
-pub use error::Error;
-pub use protocol::on_demand::AlwaysBadChecker;
 pub use on_demand_layer::{OnDemand, RemoteResponse};
+
+// Used by the `construct_simple_protocol!` macro.
 #[doc(hidden)]
 pub use runtime_primitives::traits::Block as BlockT;
 
 use libp2p::core::nodes::ConnectedPoint;
 use serde::{Deserialize, Serialize};
 use slog_derive::SerdeValue;
-use std::{collections::{HashMap, HashSet}, fmt, time::Duration};
+use std::{collections::{HashMap, HashSet}, time::Duration};
 
 /// Extension trait for `NetworkBehaviour` that also accepts discovering nodes.
 pub trait DiscoveryNetBehaviour {
@@ -213,73 +219,6 @@ pub trait DiscoveryNetBehaviour {
 	fn add_discovered_nodes(&mut self, nodes: impl Iterator<Item = PeerId>);
 }
 
-/// Name of a protocol, transmitted on the wire. Should be unique for each chain.
-#[derive(Debug, Clone, PartialEq, Eq, Hash)]
-pub struct ProtocolId(smallvec::SmallVec<[u8; 6]>);
-
-impl<'a> From<&'a [u8]> for ProtocolId {
-	fn from(bytes: &'a [u8]) -> ProtocolId {
-		ProtocolId(bytes.into())
-	}
-}
-
-impl ProtocolId {
-	/// Exposes the `ProtocolId` as bytes.
-	pub fn as_bytes(&self) -> &[u8] {
-		self.0.as_ref()
-	}
-}
-
-/// Parses a string address and returns the component, if valid.
-pub fn parse_str_addr(addr_str: &str) -> Result<(PeerId, Multiaddr), ParseErr> {
-	let mut addr: Multiaddr = addr_str.parse()?;
-
-	let who = match addr.pop() {
-		Some(multiaddr::Protocol::P2p(key)) => PeerId::from_multihash(key)
-			.map_err(|_| ParseErr::InvalidPeerId)?,
-		_ => return Err(ParseErr::PeerIdMissing),
-	};
-
-	Ok((who, addr))
-}
-
-/// Error that can be generated by `parse_str_addr`.
-#[derive(Debug)]
-pub enum ParseErr {
-	/// Error while parsing the multiaddress.
-	MultiaddrParse(multiaddr::Error),
-	/// Multihash of the peer ID is invalid.
-	InvalidPeerId,
-	/// The peer ID is missing from the address.
-	PeerIdMissing,
-}
-
-impl fmt::Display for ParseErr {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            ParseErr::MultiaddrParse(err) => write!(f, "{}", err),
-            ParseErr::InvalidPeerId => write!(f, "Peer id at the end of the address is invalid"),
-            ParseErr::PeerIdMissing => write!(f, "Peer id is missing from the address"),
-        }
-    }
-}
-
-impl std::error::Error for ParseErr {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
-        match self {
-            ParseErr::MultiaddrParse(err) => Some(err),
-            ParseErr::InvalidPeerId => None,
-            ParseErr::PeerIdMissing => None,
-        }
-    }
-}
-
-impl From<multiaddr::Error> for ParseErr {
-	fn from(err: multiaddr::Error) -> ParseErr {
-		ParseErr::MultiaddrParse(err)
-	}
-}
-
 /// Returns general information about the networking.
 ///
 /// Meant for general diagnostic purposes.