Use SyncingService for BEEFY

client/beefy/Cargo.toml

@@ -29,6 +29,7 @@ sc-keystore = { version = "4.0.0-dev", path = "../keystore" }
 sc-network = { version = "0.10.0-dev", path = "../network" }
 sc-network-common = { version = "0.10.0-dev", path = "../network/common" }
 sc-network-gossip = { version = "0.10.0-dev", path = "../network-gossip" }
+sc-network-sync = { version = "0.10.0-dev", path = "../network/sync" }
 sc-utils = { version = "4.0.0-dev", path = "../utils" }
 sp-api = { version = "4.0.0-dev", path = "../../primitives/api" }
 sp-application-crypto = { version = "7.0.0", path = "../../primitives/application-crypto" }

client/beefy/src/lib.rs

@@ -165,11 +165,11 @@ where
 }
 
 /// BEEFY gadget network parameters.
-pub struct BeefyNetworkParams<B: Block, N> {
+pub struct BeefyNetworkParams<B: Block, N, S> {
 	/// Network implementing gossip, requests and sync-oracle.
 	pub network: Arc<N>,
-	/// Syncing service implementing event stream for peers.
-	pub sync: Arc<dyn SyncEventStream>,
+	/// Syncing service implementing a sync oracle and an event stream for peers.
+	pub sync: Arc<S>,
 	/// Chain specific BEEFY gossip protocol name. See
 	/// [`communication::beefy_protocol_name::gossip_protocol_name`].
 	pub gossip_protocol_name: ProtocolName,
@@ -181,7 +181,7 @@ pub struct BeefyNetworkParams<B: Block, N> {
 }
 
 /// BEEFY gadget initialization parameters.
-pub struct BeefyParams<B: Block, BE, C, N, P, R> {
+pub struct BeefyParams<B: Block, BE, C, N, P, R, S> {
 	/// BEEFY client
 	pub client: Arc<C>,
 	/// Client Backend
@@ -193,7 +193,7 @@ pub struct BeefyParams<B: Block, BE, C, N, P, R> {
 	/// Local key store
 	pub key_store: Option<SyncCryptoStorePtr>,
 	/// BEEFY voter network params
-	pub network_params: BeefyNetworkParams<B, N>,
+	pub network_params: BeefyNetworkParams<B, N, S>,
 	/// Minimal delta between blocks, BEEFY should vote for
 	pub min_block_delta: u32,
 	/// Prometheus metric registry
@@ -207,15 +207,17 @@ pub struct BeefyParams<B: Block, BE, C, N, P, R> {
 /// Start the BEEFY gadget.
 ///
 /// This is a thin shim around running and awaiting a BEEFY worker.
-pub async fn start_beefy_gadget<B, BE, C, N, P, R>(beefy_params: BeefyParams<B, BE, C, N, P, R>)
-where
+pub async fn start_beefy_gadget<B, BE, C, N, P, R, S>(
+	beefy_params: BeefyParams<B, BE, C, N, P, R, S>,
+) where
 	B: Block,
 	BE: Backend<B>,
 	C: Client<B, BE> + BlockBackend<B>,
 	P: PayloadProvider<B>,
 	R: ProvideRuntimeApi<B>,
 	R::Api: BeefyApi<B> + MmrApi<B, MmrRootHash, NumberFor<B>>,
-	N: GossipNetwork<B> + NetworkRequest + SyncOracle + Send + Sync + 'static,
+	N: GossipNetwork<B> + NetworkRequest + Send + Sync + 'static,
+	S: SyncEventStream + SyncOracle + 'static,
 {
 	let BeefyParams {
 		client,
@@ -292,7 +294,6 @@ where
 	let worker_params = worker::WorkerParams {
 		backend,
 		payload_provider,
-		network,
 		sync,
 		key_store: key_store.into(),
 		known_peers,

client/beefy/src/tests.rs

@@ -365,7 +365,7 @@ where
 			prometheus_registry: None,
 			on_demand_justifications_handler: on_demand_justif_handler,
 		};
-		let task = crate::start_beefy_gadget::<_, _, _, _, _, _>(beefy_params);
+		let task = crate::start_beefy_gadget::<_, _, _, _, _, _, _>(beefy_params);
 
 		fn assert_send<T: Send>(_: &T) {}
 		assert_send(&task);

client/beefy/src/worker.rs

@@ -29,10 +29,7 @@ use log::{debug, error, info, log_enabled, trace, warn};
 use parking_lot::Mutex;
 
 use sc_client_api::{Backend, FinalityNotification, FinalityNotifications, HeaderBackend};
-use sc_network_common::{
-	service::{NetworkEventStream, NetworkRequest},
-	sync::{SyncEvent, SyncEventStream},
-};
+use sc_network_common::sync::{SyncEvent, SyncEventStream};
 use sc_network_gossip::GossipEngine;
 
 use sp_api::{BlockId, ProvideRuntimeApi};
@@ -248,11 +245,10 @@ impl<B: Block> VoterOracle<B> {
 	}
 }
 
-pub(crate) struct WorkerParams<B: Block, BE, P, R, N> {
+pub(crate) struct WorkerParams<B: Block, BE, P, R, S> {
 	pub backend: Arc<BE>,
 	pub payload_provider: P,
-	pub network: N,
-	pub sync: Arc<dyn SyncEventStream>,
+	pub sync: Arc<S>,
 	pub key_store: BeefyKeystore,
 	pub known_peers: Arc<Mutex<KnownPeers<B>>>,
 	pub gossip_engine: GossipEngine<B>,
@@ -298,12 +294,11 @@ impl<B: Block> PersistedState<B> {
 }
 
 /// A BEEFY worker plays the BEEFY protocol
-pub(crate) struct BeefyWorker<B: Block, BE, P, R, N> {
+pub(crate) struct BeefyWorker<B: Block, BE, P, R, S> {
 	// utilities
 	backend: Arc<BE>,
 	payload_provider: P,
-	network: N,
-	sync: Arc<dyn SyncEventStream>,
+	sync: Arc<S>,
 	key_store: BeefyKeystore,
 
 	// communication
@@ -327,27 +322,26 @@ pub(crate) struct BeefyWorker<B: Block, BE, P, R, N> {
 	persisted_state: PersistedState<B>,
 }
 
-impl<B, BE, P, R, N> BeefyWorker<B, BE, P, R, N>
+impl<B, BE, P, R, S> BeefyWorker<B, BE, P, R, S>
 where
 	B: Block + Codec,
 	BE: Backend<B>,
 	P: PayloadProvider<B>,
 	R: ProvideRuntimeApi<B>,
 	R::Api: BeefyApi<B> + MmrApi<B, MmrRootHash, NumberFor<B>>,
-	N: NetworkEventStream + NetworkRequest + SyncOracle + Send + Sync + Clone + 'static,
+	S: SyncEventStream + SyncOracle,
 {
 	/// Return a new BEEFY worker instance.
 	///
 	/// Note that a BEEFY worker is only fully functional if a corresponding
 	/// BEEFY pallet has been deployed on-chain.
 	///
 	/// The BEEFY pallet is needed in order to keep track of the BEEFY authority set.
-	pub(crate) fn new(worker_params: WorkerParams<B, BE, P, R, N>) -> Self {
+	pub(crate) fn new(worker_params: WorkerParams<B, BE, P, R, S>) -> Self {
 		let WorkerParams {
 			backend,
 			payload_provider,
 			key_store,
-			network,
 			sync,
 			gossip_engine,
 			gossip_validator,
@@ -361,7 +355,6 @@ where
 		BeefyWorker {
 			backend,
 			payload_provider,
-			network,
 			sync,
 			known_peers,
 			key_store,
@@ -815,7 +808,7 @@ where
 
 		loop {
 			// Don't bother voting or requesting justifications during major sync.
-			if !self.network.is_major_syncing() {
+			if !self.sync.is_major_syncing() {
 				// If the current target is a mandatory block,
 				// make sure there's also an on-demand justification request out for it.
 				if let Some(block) = self.voting_oracle().mandatory_pending() {
@@ -984,7 +977,7 @@ pub(crate) mod tests {
 	use beefy_primitives::{known_payloads, mmr::MmrRootProvider};
 	use futures::{executor::block_on, future::poll_fn, task::Poll};
 	use sc_client_api::{Backend as BackendT, HeaderBackend};
-	use sc_network::NetworkService;
+	use sc_network_sync::SyncingService;
 	use sc_network_test::TestNetFactory;
 	use sp_api::HeaderT;
 	use sp_blockchain::Backend as BlockchainBackendT;
@@ -1028,7 +1021,7 @@ pub(crate) mod tests {
 		Backend,
 		MmrRootProvider<Block, TestApi>,
 		TestApi,
-		Arc<NetworkService<Block, H256>>,
+		Arc<SyncingService<Block>>,
 	> {
 		let keystore = create_beefy_keystore(*key);
 
@@ -1087,8 +1080,7 @@ pub(crate) mod tests {
 			gossip_engine,
 			gossip_validator,
 			metrics: None,
-			network,
-			sync,
+			sync: Arc::new(sync),
 			on_demand_justifications,
 			persisted_state,
 		};

client/network/test/src/lib.rs

@@ -1136,8 +1136,7 @@ where
 					peer.finality_notification_stream.as_mut().poll_next(cx)
 				{
 					use sc_network::ChainSyncService;
-					peer.sync_service
-						.on_block_finalized(notification.hash, notification.header);
+					peer.sync_service.on_block_finalized(notification.hash, notification.header);
 				}
 			}
 		});

client/service/src/builder.rs

@@ -1047,7 +1047,7 @@ where
 		system_rpc_tx,
 		tx_handler_controller,
 		NetworkStarter(network_start_tx),
-		sync_service.clone()
+		sync_service.clone(),
 	))
 }