move peer_block_sync and block production suspension to 'common' crate

also rename 'attemp_block_sync' to just 'block_sync'

Author: Felix Müller

Cargo.lock

@@ -2786,11 +2786,13 @@ dependencies = [
  "its-consensus-aura",
  "its-primitives",
  "its-state",
+ "its-test",
  "log 0.4.14 (registry+https://github.com/rust-lang/crates.io-index)",
  "parity-scale-codec",
  "sgx-externalities",
  "sgx_tstd",
  "sgx_types",
+ "sp-core",
  "sp-keyring",
  "sp-runtime",
  "thiserror 1.0.30",

sidechain/consensus/aura/src/lib.rs

@@ -48,8 +48,6 @@ use sp_runtime::{
 use std::{string::ToString, sync::Arc, time::Duration, vec::Vec};
 
 pub mod block_importer;
-pub mod block_production_suspension;
-pub mod peer_block_sync;
 pub mod proposer_factory;
 pub mod slot_proposer;
 mod verifier;

sidechain/consensus/aura/src/test/mocks/mod.rs

@@ -15,7 +15,6 @@
 
 */
 
-pub mod block_importer_mock;
 pub mod environment_mock;
 pub mod proposer_mock;
 pub mod state_mock;

sidechain/consensus/common/Cargo.toml

@@ -48,7 +48,12 @@ thiserror-sgx = { package = "thiserror", git = "https://github.com/mesalock-linu
 sp-runtime = { version = "4.0.0-dev", default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "master"}
 
 [dev-dependencies]
-its-consensus-aura = { path = "../aura" }
+# local
 itp-test = { path = "../../../core-primitives/test" }
+its-consensus-aura = { path = "../aura" }
+its-test = { path = "../../test" }
+# substrate
+sp-core = { version = "4.1.0-dev", default-features = false, features = ["full_crypto"], git = "https://github.com/paritytech/substrate.git", branch = "master" }
 sp-keyring = { version = "4.0.0-dev", git = "https://github.com/paritytech/substrate.git", branch = "master"}
+# integritee / scs
 sgx-externalities = { git = "https://github.com/integritee-network/sgx-runtime", branch = "master" }

sidechain/consensus/aura/src/block_production_suspension.rs renamed to sidechain/consensus/common/src/block_production_suspension.rs

@@ -23,7 +23,7 @@ use std::sync::SgxRwLock as RwLock;
 #[cfg(feature = "std")]
 use std::sync::RwLock;
 
-use its_consensus_common::{Error, Result};
+use crate::error::{Error, Result};
 use log::*;
 
 /// Trait to suspend the production of sidechain blocks.

sidechain/consensus/common/src/lib.rs

@@ -18,6 +18,7 @@
 //! Common stuff that could be shared across multiple consensus engines
 
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(test, feature(assert_matches))]
 
 #[cfg(all(feature = "std", feature = "sgx"))]
 compile_error!("feature \"std\" and feature \"sgx\" cannot be enabled at the same time");
@@ -32,10 +33,17 @@ use sp_runtime::traits::Block as ParentchainBlockTrait;
 use std::{time::Duration, vec::Vec};
 
 mod block_import;
+mod block_production_suspension;
 mod error;
+mod peer_block_sync;
+
+#[cfg(test)]
+mod test;
 
 pub use block_import::*;
+pub use block_production_suspension::*;
 pub use error::*;
+pub use peer_block_sync::*;
 
 pub trait Verifier<ParentchainBlock, SignedSidechainBlock>: Send + Sync
 where

sidechain/consensus/aura/src/peer_block_sync.rs renamed to sidechain/consensus/common/src/peer_block_sync.rs

@@ -15,9 +15,11 @@
 
 */
 
-use crate::block_production_suspension::{IsBlockProductionSuspended, SuspendBlockProduction};
+use crate::{
+	block_production_suspension::{IsBlockProductionSuspended, SuspendBlockProduction},
+	BlockImport, Error, Result,
+};
 use core::marker::PhantomData;
-use its_consensus_common::{BlockImport, Error, Result};
 use its_primitives::{traits::SignedBlock as SignedSidechainBlockTrait, types::BlockHash};
 use log::*;
 use sp_runtime::traits::{Block as ParentchainBlockTrait, Header as ParentchainHeaderTrait};
@@ -32,7 +34,7 @@ where
 	ParentchainHeader: ParentchainHeaderTrait,
 	SignedSidechainBlock: SignedSidechainBlockTrait,
 {
-	fn attempt_block_sync(
+	fn sync_block(
 		&self,
 		sidechain_block: SignedSidechainBlock,
 		last_imported_parentchain_header: &ParentchainHeader,
@@ -91,7 +93,7 @@ where
 	BlockImporter: BlockImport<ParentchainBlock, SignedSidechainBlock>,
 	BlockProductionSuspender: SuspendBlockProduction + IsBlockProductionSuspended,
 {
-	fn attempt_block_sync(
+	fn sync_block(
 		&self,
 		sidechain_block: SignedSidechainBlock,
 		last_imported_parentchain_header: &ParentchainBlock::Header,
@@ -160,9 +162,7 @@ mod tests {
 
 		block_import_suspender.suspend().unwrap();
 
-		peer_syncer
-			.attempt_block_sync(signed_sidechain_block, &parentchain_header)
-			.unwrap();
+		peer_syncer.sync_block(signed_sidechain_block, &parentchain_header).unwrap();
 
 		assert!(block_import_suspender.is_suspended().unwrap());
 		assert!(block_importer_mock.get_imported_blocks().is_empty());
@@ -181,9 +181,7 @@ mod tests {
 		let parentchain_header = ParentchainHeaderBuilder::default().build();
 		let signed_sidechain_block = SidechainBlockBuilder::default().build_signed();
 
-		peer_syncer
-			.attempt_block_sync(signed_sidechain_block, &parentchain_header)
-			.unwrap();
+		peer_syncer.sync_block(signed_sidechain_block, &parentchain_header).unwrap();
 
 		assert!(!block_import_suspender.is_suspended().unwrap());
 		assert_eq!(1, block_importer_mock.get_imported_blocks().len());
@@ -204,8 +202,7 @@ mod tests {
 		let parentchain_header = ParentchainHeaderBuilder::default().build();
 		let signed_sidechain_block = SidechainBlockBuilder::default().build_signed();
 
-		let sync_result =
-			peer_syncer.attempt_block_sync(signed_sidechain_block, &parentchain_header);
+		let sync_result = peer_syncer.sync_block(signed_sidechain_block, &parentchain_header);
 
 		assert_matches!(sync_result, Err(Error::Other(_)));
 		assert!(!block_import_suspender.is_suspended().unwrap());

sidechain/consensus/aura/src/test/mocks/block_importer_mock.rs renamed to sidechain/consensus/common/src/test/mocks/block_importer_mock.rs

@@ -15,12 +15,11 @@
 
 */
 
-use crate::AuraVerifier;
+use crate::{test::mocks::verifier_mock::VerifierMock, BlockImport, Error, Result};
 use core::marker::PhantomData;
 use itp_sgx_crypto::aes::Aes;
 use itp_test::mock::onchain_mock::OnchainMock;
 use itp_types::H256;
-use its_consensus_common::{BlockImport, Error, Result};
 use its_primitives::traits::{ShardIdentifierFor, SignedBlock as SignedSidechainBlockTrait};
 use its_state::SidechainDB;
 use sgx_externalities::SgxExternalities;
@@ -41,13 +40,11 @@ where
 	SignedSidechainBlock:
 		SignedSidechainBlockTrait<Public = <sp_core::ed25519::Pair as Pair>::Public> + 'static,
 {
-	#[allow(unused)]
 	pub fn with_import_result(mut self, result: Result<()>) -> Self {
 		self.import_result = Some(result);
 		self
 	}
 
-	#[allow(unused)]
 	pub fn get_imported_blocks(&self) -> Vec<SignedSidechainBlock> {
 		(*self.imported_blocks.read().unwrap()).clone()
 	}
@@ -72,13 +69,8 @@ where
 	SignedSidechainBlock:
 		SignedSidechainBlockTrait<Public = <sp_core::ed25519::Pair as Pair>::Public> + 'static,
 {
-	type Verifier = AuraVerifier<
-		sp_core::ed25519::Pair,
-		ParentchainBlock,
-		SignedSidechainBlock,
-		SidechainDB<SignedSidechainBlock::Block, SgxExternalities>,
-		OnchainMock,
-	>;
+	type Verifier =
+		VerifierMock<ParentchainBlock, SignedSidechainBlock, SignedSidechainBlock, OnchainMock>;
 	type SidechainState = SidechainDB<SignedSidechainBlock::Block, SgxExternalities>;
 	type StateCrypto = Aes;
 	type Context = OnchainMock;

sidechain/consensus/common/src/test/mocks/mod.rs

@@ -0,0 +1,19 @@
+/*
+	Copyright 2021 Integritee AG and Supercomputing Systems AG
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+
+*/
+
+pub mod block_importer_mock;
+pub mod verifier_mock;

sidechain/consensus/common/src/test/mocks/verifier_mock.rs

@@ -0,0 +1,61 @@
+/*
+	Copyright 2021 Integritee AG and Supercomputing Systems AG
+
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+
+		http://www.apache.org/licenses/LICENSE-2.0
+
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+
+*/
+
+use crate::{Result, Verifier};
+use itp_types::H256;
+use its_primitives::traits::SignedBlock as SignedSidechainBlockTrait;
+use sp_core::Pair;
+use sp_runtime::traits::Block as ParentchainBlockTrait;
+use std::marker::PhantomData;
+
+/// Verifier mock implementation.
+pub struct VerifierMock<
+	ParentchainBlock,
+	SignedSidechainBlock,
+	BlockImportParameters,
+	VerifierContext,
+> {
+	_phantom: PhantomData<(
+		ParentchainBlock,
+		SignedSidechainBlock,
+		BlockImportParameters,
+		VerifierContext,
+	)>,
+}
+
+impl<ParentchainBlock, SignedSidechainBlock, BlockImportParameters, VerifierContext>
+	Verifier<ParentchainBlock, SignedSidechainBlock>
+	for VerifierMock<ParentchainBlock, SignedSidechainBlock, BlockImportParameters, VerifierContext>
+where
+	ParentchainBlock: ParentchainBlockTrait<Hash = H256>,
+	SignedSidechainBlock:
+		SignedSidechainBlockTrait<Public = <sp_core::ed25519::Pair as Pair>::Public> + 'static,
+	BlockImportParameters: Send + Sync,
+	VerifierContext: Send + Sync,
+{
+	type BlockImportParams = BlockImportParameters;
+	type Context = VerifierContext;
+
+	fn verify(
+		&mut self,
+		_block: SignedSidechainBlock,
+		_parentchain_header: &ParentchainBlock::Header,
+		_ctx: &Self::Context,
+	) -> Result<Self::BlockImportParams> {
+		todo!()
+	}
+}