Move syncing code from sc-network-common to sc-network-sync (#1912)

This PR moves syncing-related code from `sc-network-common` to
`sc-network-sync`.

Unfortunately, some parts are tightly integrated with networking, so
they were left in `sc-network-common` for now:

1. `SyncMode` in `common/src/sync.rs` (used in `NetworkConfiguration`).
2. `BlockAnnouncesHandshake`, `BlockRequest`, `BlockResponse`, etc. in
`common/src/sync/message.rs` (used in `src/protocol.rs` and
`src/protocol/message.rs`).

More substantial refactoring is needed to decouple syncing and
networking completely, including getting rid of the hardcoded sync
protocol.

## Release notes

Move syncing-related code from `sc-network-common` to `sc-network-sync`.
Delete `ChainSync` trait as it's never used (the only implementation is
accessed directly from `SyncingEngine` and exposes a lot of public
methods that are not part of the trait). Some new trait(s) for syncing
will likely be introduced as part of Sync 2.0 refactoring to represent
syncing strategies.

substrate/client/consensus/grandpa/Cargo.toml

@@ -37,6 +37,7 @@ sc-consensus = { path = "../common" }
 sc-network = { path = "../../network" }
 sc-network-gossip = { path = "../../network-gossip" }
 sc-network-common = { path = "../../network/common" }
+sc-network-sync = { path = "../../network/sync" }
 sc-telemetry = { path = "../../telemetry" }
 sc-utils = { path = "../../utils" }
 sp-api = { path = "../../../primitives/api" }

substrate/client/consensus/grandpa/src/communication/mod.rs

@@ -59,7 +59,7 @@ use crate::{
 use gossip::{
 	FullCatchUpMessage, FullCommitMessage, GossipMessage, GossipValidator, PeerReport, VoteMessage,
 };
-use sc_network_common::sync::SyncEventStream;
+use sc_network_sync::SyncEventStream;
 use sc_utils::mpsc::TracingUnboundedReceiver;
 use sp_consensus_grandpa::{AuthorityId, AuthoritySignature, RoundNumber, SetId as SetIdNumber};
 

substrate/client/consensus/grandpa/src/communication/tests.rs

@@ -33,11 +33,9 @@ use sc_network::{
 	NetworkSyncForkRequest, NotificationSenderError, NotificationSenderT as NotificationSender,
 	PeerId, ReputationChange,
 };
-use sc_network_common::{
-	role::ObservedRole,
-	sync::{SyncEvent as SyncStreamEvent, SyncEventStream},
-};
+use sc_network_common::role::ObservedRole;
 use sc_network_gossip::Validator;
+use sc_network_sync::{SyncEvent as SyncStreamEvent, SyncEventStream};
 use sc_network_test::{Block, Hash};
 use sc_utils::mpsc::{tracing_unbounded, TracingUnboundedReceiver, TracingUnboundedSender};
 use sp_consensus_grandpa::AuthorityList;

substrate/client/consensus/grandpa/src/warp_proof.rs

@@ -23,7 +23,7 @@ use crate::{
 	BlockNumberOps, GrandpaJustification, SharedAuthoritySet,
 };
 use sc_client_api::Backend as ClientBackend;
-use sc_network_common::sync::warp::{EncodedProof, VerificationResult, WarpSyncProvider};
+use sc_network_sync::warp::{EncodedProof, VerificationResult, WarpSyncProvider};
 use sp_blockchain::{Backend as BlockchainBackend, HeaderBackend};
 use sp_consensus_grandpa::{AuthorityList, SetId, GRANDPA_ENGINE_ID};
 use sp_runtime::{

substrate/client/informant/Cargo.toml

@@ -19,6 +19,7 @@ futures-timer = "3.0.1"
 log = "0.4.17"
 sc-client-api = { path = "../api" }
 sc-network-common = { path = "../network/common" }
+sc-network-sync = { path = "../network/sync" }
 sc-network = { path = "../network" }
 sp-blockchain = { path = "../../primitives/blockchain" }
 sp-runtime = { path = "../../primitives/runtime" }

substrate/client/informant/src/display.rs

@@ -21,7 +21,7 @@ use ansi_term::Colour;
 use log::info;
 use sc_client_api::ClientInfo;
 use sc_network::NetworkStatus;
-use sc_network_common::sync::{
+use sc_network_sync::{
 	warp::{WarpSyncPhase, WarpSyncProgress},
 	SyncState, SyncStatus,
 };

substrate/client/informant/src/lib.rs

@@ -24,7 +24,7 @@ use futures_timer::Delay;
 use log::{debug, info, trace};
 use sc_client_api::{BlockchainEvents, UsageProvider};
 use sc_network::NetworkStatusProvider;
-use sc_network_common::sync::SyncStatusProvider;
+use sc_network_sync::SyncStatusProvider;
 use sp_blockchain::HeaderMetadata;
 use sp_runtime::traits::{Block as BlockT, Header};
 use std::{collections::VecDeque, fmt::Display, sync::Arc, time::Duration};

substrate/client/network-gossip/Cargo.toml

@@ -24,6 +24,7 @@ tracing = "0.1.29"
 prometheus-endpoint = { package = "substrate-prometheus-endpoint", path = "../../utils/prometheus" }
 sc-network = { path = "../network" }
 sc-network-common = { path = "../network/common" }
+sc-network-sync = { path = "../network/sync" }
 sp-runtime = { path = "../../primitives/runtime" }
 
 [dev-dependencies]

substrate/client/network-gossip/src/bridge.rs

@@ -22,7 +22,7 @@ use crate::{
 };
 
 use sc_network::{event::Event, types::ProtocolName, ReputationChange};
-use sc_network_common::sync::SyncEvent;
+use sc_network_sync::SyncEvent;
 
 use futures::{
 	channel::mpsc::{channel, Receiver, Sender},
@@ -338,7 +338,8 @@ mod tests {
 		config::MultiaddrWithPeerId, NetworkBlock, NetworkEventStream, NetworkNotification,
 		NetworkPeers, NotificationSenderError, NotificationSenderT as NotificationSender,
 	};
-	use sc_network_common::{role::ObservedRole, sync::SyncEventStream};
+	use sc_network_common::role::ObservedRole;
+	use sc_network_sync::SyncEventStream;
 	use sp_runtime::{
 		testing::H256,
 		traits::{Block as BlockT, NumberFor},

substrate/client/network-gossip/src/lib.rs

@@ -71,7 +71,7 @@ use libp2p::{multiaddr, PeerId};
 use sc_network::{
 	types::ProtocolName, NetworkBlock, NetworkEventStream, NetworkNotification, NetworkPeers,
 };
-use sc_network_common::sync::SyncEventStream;
+use sc_network_sync::SyncEventStream;
 use sp_runtime::traits::{Block as BlockT, NumberFor};
 use std::iter;