Rename Ethereum Headers to AuraHeader (paritytech#354)

* Rename Header to AuraHeader

This prevents some type conflicts with the PolkadotJS Apps types.

* Fix test and benchmark builds

* Update AuraHeader in types.json

bin/rialto-runtime/src/kovan.rs

@@ -16,7 +16,7 @@
 
 use crate::exchange::EthereumTransactionInclusionProof;
 
-use bp_eth_poa::{Address, Header, RawTransaction, U256};
+use bp_eth_poa::{Address, AuraHeader, RawTransaction, U256};
 use bp_header_chain::BaseHeaderChain;
 use frame_support::RuntimeDebug;
 use hex_literal::hex;
@@ -95,8 +95,8 @@ pub fn genesis_validators() -> Vec<Address> {
 }
 
 /// Genesis header of the Kovan chain.
-pub fn genesis_header() -> Header {
-	Header {
+pub fn genesis_header() -> AuraHeader {
+	AuraHeader {
 		parent_hash: Default::default(),
 		timestamp: 0,
 		number: 0,

bin/rialto-runtime/src/lib.rs

@@ -526,7 +526,7 @@ impl_runtime_apis! {
 			(finalized_block.number, finalized_block.hash)
 		}
 
-		fn is_import_requires_receipts(header: bp_eth_poa::Header) -> bool {
+		fn is_import_requires_receipts(header: bp_eth_poa::AuraHeader) -> bool {
 			BridgeRialto::is_import_requires_receipts(header)
 		}
 
@@ -546,7 +546,7 @@ impl_runtime_apis! {
 			(finalized_block.number, finalized_block.hash)
 		}
 
-		fn is_import_requires_receipts(header: bp_eth_poa::Header) -> bool {
+		fn is_import_requires_receipts(header: bp_eth_poa::AuraHeader) -> bool {
 			BridgeKovan::is_import_requires_receipts(header)
 		}
 

bin/rialto-runtime/src/rialto.rs

@@ -16,7 +16,7 @@
 
 use crate::exchange::EthereumTransactionInclusionProof;
 
-use bp_eth_poa::{Address, Header, RawTransaction, U256};
+use bp_eth_poa::{Address, AuraHeader, RawTransaction, U256};
 use bp_header_chain::BaseHeaderChain;
 use frame_support::RuntimeDebug;
 use hex_literal::hex;
@@ -70,8 +70,8 @@ pub fn genesis_validators() -> Vec<Address> {
 /// ```bash
 /// $ http localhost:8545 jsonrpc=2.0 id=1 method=eth_getBlockByNumber params:='["earliest", false]' -v
 /// ```
-pub fn genesis_header() -> Header {
-	Header {
+pub fn genesis_header() -> AuraHeader {
+	AuraHeader {
 		parent_hash: Default::default(),
 		timestamp: 0,
 		number: 0,

modules/ethereum/src/benchmarking.rs

@@ -218,7 +218,7 @@ benchmarks_instance! {
 	}
 }
 
-fn initialize_bench<T: Trait<I>, I: Instance>(num_validators: usize) -> Header {
+fn initialize_bench<T: Trait<I>, I: Instance>(num_validators: usize) -> AuraHeader {
 	// Initialize storage with some initial header
 	let initial_header = build_genesis_header(&validator(0));
 	let initial_difficulty = initial_header.difficulty;

modules/ethereum/src/finality.rs

@@ -16,7 +16,7 @@
 
 use crate::error::Error;
 use crate::Storage;
-use bp_eth_poa::{public_to_address, Address, Header, HeaderId, SealedEmptyStep, H256};
+use bp_eth_poa::{public_to_address, Address, AuraHeader, HeaderId, SealedEmptyStep, H256};
 use codec::{Decode, Encode};
 use sp_io::crypto::secp256k1_ecdsa_recover;
 use sp_runtime::RuntimeDebug;
@@ -37,7 +37,7 @@ pub struct CachedFinalityVotes<Submitter> {
 	pub stopped_at_finalized_sibling: bool,
 	/// Header ancestors that were read while we have been searching for
 	/// cached votes entry. Newest header has index 0.
-	pub unaccounted_ancestry: VecDeque<(HeaderId, Option<Submitter>, Header)>,
+	pub unaccounted_ancestry: VecDeque<(HeaderId, Option<Submitter>, AuraHeader)>,
 	/// Cached finality votes, if they have been found. The associated
 	/// header is not included into `unaccounted_ancestry`.
 	pub votes: Option<FinalityVotes<Submitter>>,
@@ -86,7 +86,7 @@ pub fn finalize_blocks<S: Storage>(
 	header_validators: (HeaderId, &[Address]),
 	id: HeaderId,
 	submitter: Option<&S::Submitter>,
-	header: &Header,
+	header: &AuraHeader,
 	two_thirds_majority_transition: u64,
 ) -> Result<FinalityEffects<S::Submitter>, Error> {
 	// compute count of voters for every unfinalized block in ancestry
@@ -145,7 +145,7 @@ fn prepare_votes<Submitter>(
 	best_finalized: HeaderId,
 	validators: &BTreeSet<&Address>,
 	id: HeaderId,
-	header: &Header,
+	header: &AuraHeader,
 	submitter: Option<Submitter>,
 ) -> Result<FinalityVotes<Submitter>, Error> {
 	// if we have reached finalized block sibling, then we're trying
@@ -243,7 +243,7 @@ fn remove_signers_votes(signers_to_remove: &BTreeSet<Address>, votes: &mut BTree
 }
 
 /// Returns unique set of empty steps signers.
-fn empty_steps_signers(header: &Header) -> BTreeSet<Address> {
+fn empty_steps_signers(header: &AuraHeader) -> BTreeSet<Address> {
 	header
 		.empty_steps()
 		.into_iter()
@@ -298,7 +298,7 @@ mod tests {
 					(Default::default(), &[]),
 					Default::default(),
 					None,
-					&Header::default(),
+					&AuraHeader::default(),
 					0,
 				),
 				Err(Error::NotValidator),

modules/ethereum/src/import.rs

@@ -19,7 +19,7 @@ use crate::finality::finalize_blocks;
 use crate::validators::{Validators, ValidatorsConfiguration};
 use crate::verification::{is_importable_header, verify_aura_header};
 use crate::{AuraConfiguration, ChangeToEnact, PruningStrategy, Storage};
-use bp_eth_poa::{Header, HeaderId, Receipt};
+use bp_eth_poa::{AuraHeader, HeaderId, Receipt};
 use sp_std::{collections::btree_map::BTreeMap, prelude::*};
 
 /// Imports bunch of headers and updates blocks finality.
@@ -37,7 +37,7 @@ pub fn import_headers<S: Storage, PS: PruningStrategy>(
 	aura_config: &AuraConfiguration,
 	validators_config: &ValidatorsConfiguration,
 	submitter: Option<S::Submitter>,
-	headers: Vec<(Header, Option<Vec<Receipt>>)>,
+	headers: Vec<(AuraHeader, Option<Vec<Receipt>>)>,
 	finalized_headers: &mut BTreeMap<S::Submitter, u64>,
 ) -> Result<(u64, u64), Error> {
 	let mut useful = 0;
@@ -85,7 +85,7 @@ pub fn import_header<S: Storage, PS: PruningStrategy>(
 	aura_config: &AuraConfiguration,
 	validators_config: &ValidatorsConfiguration,
 	submitter: Option<S::Submitter>,
-	header: Header,
+	header: AuraHeader,
 	receipts: Option<Vec<Receipt>>,
 ) -> Result<(HeaderId, FinalizedHeaders<S>), Error> {
 	// first check that we are able to import this header at all
@@ -153,7 +153,7 @@ pub fn import_header<S: Storage, PS: PruningStrategy>(
 pub fn header_import_requires_receipts<S: Storage>(
 	storage: &S,
 	validators_config: &ValidatorsConfiguration,
-	header: &Header,
+	header: &AuraHeader,
 ) -> bool {
 	is_importable_header(storage, header)
 		.map(|_| Validators::new(validators_config))
@@ -391,7 +391,7 @@ mod tests {
 	fn import_custom_block<S: Storage>(
 		storage: &mut S,
 		validators: &[SecretKey],
-		header: Header,
+		header: AuraHeader,
 	) -> Result<HeaderId, Error> {
 		let id = header.compute_id();
 		import_header(

modules/ethereum/src/lib.rs

@@ -19,7 +19,7 @@
 #![allow(clippy::large_enum_variant)]
 
 use crate::finality::{CachedFinalityVotes, FinalityVotes};
-use bp_eth_poa::{Address, Header, HeaderId, RawTransaction, RawTransactionReceipt, Receipt, H256, U256};
+use bp_eth_poa::{Address, AuraHeader, HeaderId, RawTransaction, RawTransactionReceipt, Receipt, H256, U256};
 use codec::{Decode, Encode};
 use frame_support::{decl_module, decl_storage, traits::Get};
 use sp_runtime::{
@@ -91,7 +91,7 @@ pub struct StoredHeader<Submitter> {
 	/// using unsigned transaction.
 	pub submitter: Option<Submitter>,
 	/// The block header itself.
-	pub header: Header,
+	pub header: AuraHeader,
 	/// Total difficulty of the chain.
 	pub total_difficulty: U256,
 	/// The ID of set of validators that is expected to produce direct descendants of
@@ -138,7 +138,7 @@ pub struct HeaderToImport<Submitter> {
 	/// The id of the header.
 	pub id: HeaderId,
 	/// The header itself.
-	pub header: Header,
+	pub header: AuraHeader,
 	/// Total chain difficulty at the header.
 	pub total_difficulty: U256,
 	/// New validators set and the hash of block where it has been scheduled (if applicable).
@@ -185,7 +185,7 @@ struct PruningRange {
 pub struct ImportContext<Submitter> {
 	submitter: Option<Submitter>,
 	parent_hash: H256,
-	parent_header: Header,
+	parent_header: AuraHeader,
 	parent_total_difficulty: U256,
 	parent_scheduled_change: Option<ScheduledChange>,
 	validators_set_id: u64,
@@ -200,7 +200,7 @@ impl<Submitter> ImportContext<Submitter> {
 	}
 
 	/// Returns reference to parent header.
-	pub fn parent_header(&self) -> &Header {
+	pub fn parent_header(&self) -> &AuraHeader {
 		&self.parent_header
 	}
 
@@ -242,7 +242,7 @@ impl<Submitter> ImportContext<Submitter> {
 		self,
 		is_best: bool,
 		id: HeaderId,
-		header: Header,
+		header: AuraHeader,
 		total_difficulty: U256,
 		enacted_change: Option<ChangeToEnact>,
 		scheduled_change: Option<Vec<Address>>,
@@ -275,7 +275,7 @@ pub trait Storage {
 	/// Get imported header by its hash.
 	///
 	/// Returns header and its submitter (if known).
-	fn header(&self, hash: &H256) -> Option<(Header, Option<Self::Submitter>)>;
+	fn header(&self, hash: &H256) -> Option<(AuraHeader, Option<Self::Submitter>)>;
 	/// Returns latest cached finality votes (if any) for block ancestors, starting
 	/// from `parent_hash` block and stopping at genesis block, best finalized block
 	/// or block where `stop_at` returns true.
@@ -375,7 +375,7 @@ decl_module! {
 	pub struct Module<T: Trait<I>, I: Instance = DefaultInstance> for enum Call where origin: T::Origin {
 		/// Import single Aura header. Requires transaction to be **UNSIGNED**.
 		#[weight = 0] // TODO: update me (https://github.com/paritytech/parity-bridges-common/issues/78)
-		pub fn import_unsigned_header(origin, header: Header, receipts: Option<Vec<Receipt>>) {
+		pub fn import_unsigned_header(origin, header: AuraHeader, receipts: Option<Vec<Receipt>>) {
 			frame_system::ensure_none(origin)?;
 
 			import::import_header(
@@ -396,7 +396,7 @@ decl_module! {
 		/// This should be used with caution - passing too many headers could lead to
 		/// enormous block production/import time.
 		#[weight = 0] // TODO: update me (https://github.com/paritytech/parity-bridges-common/issues/78)
-		pub fn import_signed_headers(origin, headers_with_receipts: Vec<(Header, Option<Vec<Receipt>>)>) {
+		pub fn import_signed_headers(origin, headers_with_receipts: Vec<(AuraHeader, Option<Vec<Receipt>>)>) {
 			let submitter = frame_system::ensure_signed(origin)?;
 			let mut finalized_headers = BTreeMap::new();
 			let import_result = import::import_headers(
@@ -459,7 +459,7 @@ decl_storage! {
 		ScheduledChanges: map hasher(identity) H256 => Option<ScheduledChange>;
 	}
 	add_extra_genesis {
-		config(initial_header): Header;
+		config(initial_header): AuraHeader;
 		config(initial_difficulty): U256;
 		config(initial_validators): Vec<Address>;
 		build(|config| {
@@ -496,7 +496,7 @@ impl<T: Trait<I>, I: Instance> Module<T, I> {
 	}
 
 	/// Returns true if the import of given block requires transactions receipts.
-	pub fn is_import_requires_receipts(header: Header) -> bool {
+	pub fn is_import_requires_receipts(header: AuraHeader) -> bool {
 		import::header_import_requires_receipts(
 			&BridgeStorage::<T, I>::new(),
 			&T::ValidatorsConfiguration::get(),
@@ -670,7 +670,7 @@ impl<T: Trait<I>, I: Instance> Storage for BridgeStorage<T, I> {
 		FinalizedBlock::<I>::get()
 	}
 
-	fn header(&self, hash: &H256) -> Option<(Header, Option<Self::Submitter>)> {
+	fn header(&self, hash: &H256) -> Option<(AuraHeader, Option<Self::Submitter>)> {
 		Headers::<T, I>::get(hash).map(|header| (header.header, header.submitter))
 	}
 
@@ -840,7 +840,7 @@ impl<T: Trait<I>, I: Instance> Storage for BridgeStorage<T, I> {
 /// Initialize storage.
 #[cfg(any(feature = "std", feature = "runtime-benchmarks"))]
 pub(crate) fn initialize_storage<T: Trait<I>, I: Instance>(
-	initial_header: &Header,
+	initial_header: &AuraHeader,
 	initial_difficulty: U256,
 	initial_validators: &[Address],
 ) {
@@ -1004,7 +1004,7 @@ fn pool_configuration() -> PoolConfiguration {
 }
 
 /// Return iterator of given header ancestors.
-fn ancestry<'a, S: Storage>(storage: &'a S, mut parent_hash: H256) -> impl Iterator<Item = (H256, Header)> + 'a {
+fn ancestry<'a, S: Storage>(storage: &'a S, mut parent_hash: H256) -> impl Iterator<Item = (H256, AuraHeader)> + 'a {
 	sp_std::iter::from_fn(move || {
 		let (header, _) = storage.header(&parent_hash)?;
 		if header.number == 0 {
@@ -1044,26 +1044,26 @@ pub(crate) mod tests {
 		.rlp()
 	}
 
-	fn example_header_with_failed_receipt() -> Header {
-		let mut header = Header::default();
+	fn example_header_with_failed_receipt() -> AuraHeader {
+		let mut header = AuraHeader::default();
 		header.number = 3;
 		header.transactions_root = compute_merkle_root(vec![example_tx()].into_iter());
 		header.receipts_root = compute_merkle_root(vec![example_tx_receipt(false)].into_iter());
 		header.parent_hash = example_header().compute_hash();
 		header
 	}
 
-	fn example_header() -> Header {
-		let mut header = Header::default();
+	fn example_header() -> AuraHeader {
+		let mut header = AuraHeader::default();
 		header.number = 2;
 		header.transactions_root = compute_merkle_root(vec![example_tx()].into_iter());
 		header.receipts_root = compute_merkle_root(vec![example_tx_receipt(true)].into_iter());
 		header.parent_hash = example_header_parent().compute_hash();
 		header
 	}
 
-	fn example_header_parent() -> Header {
-		let mut header = Header::default();
+	fn example_header_parent() -> AuraHeader {
+		let mut header = AuraHeader::default();
 		header.number = 1;
 		header.transactions_root = compute_merkle_root(vec![example_tx()].into_iter());
 		header.receipts_root = compute_merkle_root(vec![example_tx_receipt(true)].into_iter());

modules/ethereum/src/mock.rs

@@ -19,7 +19,7 @@ pub use bp_eth_poa::signatures::secret_to_address;
 
 use crate::validators::{ValidatorsConfiguration, ValidatorsSource};
 use crate::{AuraConfiguration, GenesisConfig, PruningStrategy, Trait};
-use bp_eth_poa::{Address, Header, H256, U256};
+use bp_eth_poa::{Address, AuraHeader, H256, U256};
 use frame_support::{impl_outer_origin, parameter_types, weights::Weight};
 use secp256k1::SecretKey;
 use sp_runtime::{
@@ -89,7 +89,7 @@ impl Trait for TestRuntime {
 /// Test context.
 pub struct TestContext {
 	/// Initial (genesis) header.
-	pub genesis: Header,
+	pub genesis: AuraHeader,
 	/// Number of initial validators.
 	pub total_validators: usize,
 	/// Secret keys of validators, ordered by validator index.
@@ -118,7 +118,7 @@ pub fn test_validators_config() -> ValidatorsConfiguration {
 }
 
 /// Genesis header that is used in tests by default.
-pub fn genesis() -> Header {
+pub fn genesis() -> AuraHeader {
 	HeaderBuilder::genesis().sign_by(&validator(0))
 }
 
@@ -128,7 +128,11 @@ pub fn run_test<T>(total_validators: usize, test: impl FnOnce(TestContext) -> T)
 }
 
 /// Run test with default genesis header.
-pub fn run_test_with_genesis<T>(genesis: Header, total_validators: usize, test: impl FnOnce(TestContext) -> T) -> T {
+pub fn run_test_with_genesis<T>(
+	genesis: AuraHeader,
+	total_validators: usize,
+	test: impl FnOnce(TestContext) -> T,
+) -> T {
 	let validators = validators(total_validators);
 	let addresses = validators_addresses(total_validators);
 	sp_io::TestExternalities::new(