Delay beefy worker initialization while network is on major sync

client/beefy/Cargo.toml

@@ -25,6 +25,7 @@ sp-blockchain = { version = "4.0.0-dev", path = "../../primitives/blockchain" }
 sp-core = { version = "4.1.0-dev", path = "../../primitives/core" }
 sp-keystore = { version = "0.10.0", path = "../../primitives/keystore" }
 sp-runtime = { version = "4.1.0-dev", path = "../../primitives/runtime" }
+sp-consensus = { version = "0.10.0-dev", path = "../../primitives/consensus/common" }
 
 sc-chain-spec = { version = "4.0.0-dev", path = "../../client/chain-spec" }
 sc-utils = { version = "4.0.0-dev", path = "../utils" }

client/beefy/src/lib.rs

@@ -26,6 +26,7 @@ use sc_network_gossip::{GossipEngine, Network as GossipNetwork};
 
 use sp_api::ProvideRuntimeApi;
 use sp_blockchain::HeaderBackend;
+pub use sp_consensus::SyncOracle;
 use sp_keystore::SyncCryptoStorePtr;
 use sp_runtime::traits::Block;
 
@@ -106,13 +107,14 @@ where
 }
 
 /// BEEFY gadget initialization parameters.
-pub struct BeefyParams<B, BE, C, N>
+pub struct BeefyParams<B, BE, C, N, SO>
 where
 	B: Block,
 	BE: Backend<B>,
 	C: Client<B, BE>,
 	C::Api: BeefyApi<B>,
 	N: GossipNetwork<B> + Clone + Send + 'static,
+	SO: SyncOracle + Send + Sync + Clone + 'static,
 {
 	/// BEEFY client
 	pub client: Arc<C>,
@@ -132,18 +134,21 @@ where
 	pub prometheus_registry: Option<Registry>,
 	/// Chain specific GRANDPA protocol name. See [`beefy_protocol_name::standard_name`].
 	pub protocol_name: std::borrow::Cow<'static, str>,
+	/// A handle to the sync oracle
+	pub sync_oracle: SO,
 }
 
 /// 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>(beefy_params: BeefyParams<B, BE, C, N>)
+pub async fn start_beefy_gadget<B, BE, C, N, SO>(beefy_params: BeefyParams<B, BE, C, N, SO>)
 where
 	B: Block,
 	BE: Backend<B>,
 	C: Client<B, BE>,
 	C::Api: BeefyApi<B>,
 	N: GossipNetwork<B> + Clone + Send + 'static,
+	SO: SyncOracle + Send + Sync + Clone + 'static,
 {
 	let BeefyParams {
 		client,
@@ -155,6 +160,7 @@ where
 		min_block_delta,
 		prometheus_registry,
 		protocol_name,
+		sync_oracle,
 	} = beefy_params;
 
 	let gossip_validator = Arc::new(gossip::GossipValidator::new());
@@ -184,9 +190,10 @@ where
 		gossip_validator,
 		min_block_delta,
 		metrics,
+		sync_oracle,
 	};
 
-	let worker = worker::BeefyWorker::<_, _, _>::new(worker_params);
+	let worker = worker::BeefyWorker::<_, _, _, _>::new(worker_params);
 
 	worker.run().await
 }

client/beefy/src/worker.rs

@@ -22,6 +22,7 @@ use codec::{Codec, Decode, Encode};
 use futures::{future, FutureExt, StreamExt};
 use log::{debug, error, info, log_enabled, trace, warn};
 use parking_lot::Mutex;
+use std::task::Poll;
 
 use sc_client_api::{Backend, FinalityNotification, FinalityNotifications};
 use sc_network_gossip::GossipEngine;
@@ -47,10 +48,10 @@ use crate::{
 	metric_inc, metric_set,
 	metrics::Metrics,
 	notification::{BeefyBestBlockSender, BeefySignedCommitmentSender},
-	round, Client,
+	round, Client, SyncOracle,
 };
 
-pub(crate) struct WorkerParams<B, BE, C>
+pub(crate) struct WorkerParams<B, BE, C, SO>
 where
 	B: Block,
 {
@@ -63,14 +64,16 @@ where
 	pub gossip_validator: Arc<GossipValidator<B>>,
 	pub min_block_delta: u32,
 	pub metrics: Option<Metrics>,
+	pub sync_oracle: SO,
 }
 
 /// A BEEFY worker plays the BEEFY protocol
-pub(crate) struct BeefyWorker<B, C, BE>
+pub(crate) struct BeefyWorker<B, C, BE, SO>
 where
 	B: Block,
 	BE: Backend<B>,
 	C: Client<B, BE>,
+	SO: SyncOracle + Send + Sync + Clone + 'static,
 {
 	client: Arc<C>,
 	backend: Arc<BE>,
@@ -91,24 +94,27 @@ where
 	beefy_best_block_sender: BeefyBestBlockSender<B>,
 	/// Validator set id for the last signed commitment
 	last_signed_id: u64,
+	/// Handle to the sync oracle
+	sync_oracle: SO,
 	// keep rustc happy
 	_backend: PhantomData<BE>,
 }
 
-impl<B, C, BE> BeefyWorker<B, C, BE>
+impl<B, C, BE, SO> BeefyWorker<B, C, BE, SO>
 where
 	B: Block + Codec,
 	BE: Backend<B>,
 	C: Client<B, BE>,
 	C::Api: BeefyApi<B>,
+	SO: SyncOracle + Send + Sync + Clone + 'static,
 {
 	/// 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, C>) -> Self {
+	pub(crate) fn new(worker_params: WorkerParams<B, BE, C, SO>) -> Self {
 		let WorkerParams {
 			client,
 			backend,
@@ -119,6 +125,7 @@ where
 			gossip_validator,
 			min_block_delta,
 			metrics,
+			sync_oracle,
 		} = worker_params;
 
 		BeefyWorker {
@@ -136,17 +143,19 @@ where
 			best_beefy_block: None,
 			last_signed_id: 0,
 			beefy_best_block_sender,
+			sync_oracle,
 			_backend: PhantomData,
 		}
 	}
 }
 
-impl<B, C, BE> BeefyWorker<B, C, BE>
+impl<B, C, BE, SO> BeefyWorker<B, C, BE, SO>
 where
 	B: Block,
 	BE: Backend<B>,
 	C: Client<B, BE>,
 	C::Api: BeefyApi<B>,
+	SO: SyncOracle + Send + Sync + Clone + 'static,
 {
 	/// Return `true`, if we should vote on block `number`
 	fn should_vote_on(&self, number: NumberFor<B>) -> bool {
@@ -400,6 +409,11 @@ where
 		));
 
 		loop {
+			if self.sync_oracle.is_major_syncing() {
+				debug!(target: "beefy", "Skipping initialization due to sync.");
+				wait_for_major_syncing(self.sync_oracle.clone()).await;
+			}
+
 			let engine = self.gossip_engine.clone();
 			let gossip_engine = future::poll_fn(|cx| engine.lock().poll_unpin(cx));
 
@@ -430,6 +444,19 @@ where
 	}
 }
 
+/// Returns a future that waits until major sync is done
+/// before completing
+fn wait_for_major_syncing<SO: SyncOracle + Send + Sync + Clone + 'static>(
+	mut sync_oracle: SO,
+) -> impl future::Future<Output = ()> {
+	return future::poll_fn(move |_cx| {
+		if sync_oracle.is_major_syncing() {
+			Poll::Pending
+		} else {
+			Poll::Ready(())
+		}
+	})
+}
 /// Extract the MMR root hash from a digest in the given header, if it exists.
 fn find_mmr_root_digest<B, Id>(header: &B::Header) -> Option<MmrRootHash>
 where