BlockId removal: refactor: HeaderBackend::header (#12874)

* BlockId removal: refactor: HeaderBackend::header

It changes the arguments of:
- `HeaderBackend::header`,
- `Client::header`,
- `PeersClient::header`
- `ChainApi::block_header`

methods from: `BlockId<Block>` to: `Block::Hash`

This PR is part of BlockId::Number refactoring analysis (paritytech/substrate#11292)

* non-trivial usages of haeder(block_id) refactored

This may required introduction of dedicated function:
header_for_block_num

* fmt

* fix

* doc fixed

* ".git/.scripts/fmt.sh"

* BlockId removal: refactor: HeaderBackend::expect_header

It changes the arguments of `HeaderBackend::expect_header` method from: `BlockId<Block>` to: `Block::Hash`

* ".git/.scripts/fmt.sh"

* readme updated

* ".git/.scripts/fmt.sh"

* fix

Co-authored-by: parity-processbot <>

substrate/client/consensus/manual-seal/src/consensus/babe.rs

@@ -44,7 +44,7 @@ use sp_consensus_babe::{
 use sp_consensus_slots::Slot;
 use sp_inherents::InherentData;
 use sp_runtime::{
-	generic::{BlockId, Digest},
+	generic::Digest,
 	traits::{Block as BlockT, Header},
 	DigestItem,
 };
@@ -108,7 +108,7 @@ where
 		let parent_hash = import_params.header.parent_hash();
 		let parent = self
 			.client
-			.header(BlockId::Hash(*parent_hash))
+			.header(*parent_hash)
 			.ok()
 			.flatten()
 			.ok_or_else(|| format!("header for block {} not found", parent_hash))?;

substrate/client/consensus/manual-seal/src/consensus/timestamp.rs

@@ -30,10 +30,7 @@ use sp_consensus_aura::{
 use sp_consensus_babe::BabeApi;
 use sp_consensus_slots::{Slot, SlotDuration};
 use sp_inherents::{InherentData, InherentDataProvider, InherentIdentifier};
-use sp_runtime::{
-	generic::BlockId,
-	traits::{Block as BlockT, Zero},
-};
+use sp_runtime::traits::{Block as BlockT, Zero};
 use sp_timestamp::{InherentType, INHERENT_IDENTIFIER};
 use std::{
 	sync::{atomic, Arc},
@@ -109,7 +106,7 @@ impl SlotTimestampProvider {
 		// otherwise we'd be producing blocks for older slots.
 		let time = if info.best_number != Zero::zero() {
 			let header = client
-				.header(BlockId::Hash(info.best_hash))?
+				.header(info.best_hash)?
 				.ok_or_else(|| "best header not found in the db!".to_string())?;
 			let slot = func(header)?;
 			// add the slot duration so there's no collision of slots

substrate/client/consensus/manual-seal/src/lib.rs

@@ -360,7 +360,7 @@ mod tests {
 		let (client, select_chain) = builder.build_with_longest_chain();
 		let client = Arc::new(client);
 		let spawner = sp_core::testing::TaskExecutor::new();
-		let genesis_hash = client.header(&BlockId::Number(0)).unwrap().unwrap().hash();
+		let genesis_hash = client.info().genesis_hash;
 		let pool = Arc::new(BasicPool::with_revalidation_type(
 			Options::default(),
 			true.into(),
@@ -424,7 +424,8 @@ mod tests {
 			}
 		);
 		// assert that there's a new block in the db.
-		assert!(client.header(&BlockId::Number(1)).unwrap().is_some())
+		assert!(client.header(created_block.hash).unwrap().is_some());
+		assert_eq!(client.header(created_block.hash).unwrap().unwrap().number, 1)
 	}
 
 	#[tokio::test]
@@ -433,7 +434,7 @@ mod tests {
 		let (client, select_chain) = builder.build_with_longest_chain();
 		let client = Arc::new(client);
 		let spawner = sp_core::testing::TaskExecutor::new();
-		let genesis_hash = client.header(&BlockId::Number(0)).unwrap().unwrap().hash();
+		let genesis_hash = client.info().genesis_hash;
 		let pool = Arc::new(BasicPool::with_revalidation_type(
 			Options::default(),
 			true.into(),
@@ -494,7 +495,7 @@ mod tests {
 			}
 		);
 		// assert that there's a new block in the db.
-		let header = client.header(&BlockId::Number(1)).unwrap().unwrap();
+		let header = client.header(created_block.hash).unwrap().unwrap();
 		let (tx, rx) = futures::channel::oneshot::channel();
 		sink.send(EngineCommand::FinalizeBlock {
 			sender: Some(tx),
@@ -518,7 +519,7 @@ mod tests {
 			&sp_core::testing::TaskExecutor::new(),
 		));
 		let spawner = sp_core::testing::TaskExecutor::new();
-		let genesis_hash = client.header(&BlockId::Number(0)).unwrap().unwrap().hash();
+		let genesis_hash = client.info().genesis_hash;
 		let pool = Arc::new(BasicPool::with_revalidation_type(
 			Options::default(),
 			true.into(),
@@ -582,7 +583,8 @@ mod tests {
 
 		assert!(pool.submit_one(&BlockId::Number(1), SOURCE, uxt(Alice, 1)).await.is_ok());
 
-		let header = client.header(&BlockId::Number(1)).expect("db error").expect("imported above");
+		let header = client.header(created_block.hash).expect("db error").expect("imported above");
+		assert_eq!(header.number, 1);
 		pool.maintain(sc_transaction_pool_api::ChainEvent::NewBestBlock {
 			hash: header.hash(),
 			tree_route: None,
@@ -614,7 +616,7 @@ mod tests {
 			.is_ok());
 		let imported = rx2.await.unwrap().unwrap();
 		// assert that fork block is in the db
-		assert!(client.header(&BlockId::Hash(imported.hash)).unwrap().is_some())
+		assert!(client.header(imported.hash).unwrap().is_some())
 	}
 
 	#[tokio::test]
@@ -623,7 +625,7 @@ mod tests {
 		let (client, select_chain) = builder.build_with_longest_chain();
 		let client = Arc::new(client);
 		let spawner = sp_core::testing::TaskExecutor::new();
-		let genesis_hash = client.header(&BlockId::Number(0)).unwrap().unwrap().hash();
+		let genesis_hash = client.header(client.info().genesis_hash).unwrap().unwrap().hash();
 		let pool = Arc::new(BasicPool::with_revalidation_type(
 			Options::default(),
 			true.into(),
@@ -665,7 +667,7 @@ mod tests {
 		let created_block = rx.await.unwrap().unwrap();
 
 		// assert that the background task returned the actual header hash
-		let header = client.header(&BlockId::Number(1)).unwrap().unwrap();
-		assert_eq!(header.hash(), created_block.hash);
+		let header = client.header(created_block.hash).unwrap().unwrap();
+		assert_eq!(header.number, 1);
 	}
 }

substrate/client/consensus/manual-seal/src/seal_block.rs

@@ -26,10 +26,7 @@ use sp_api::{ProvideRuntimeApi, TransactionFor};
 use sp_blockchain::HeaderBackend;
 use sp_consensus::{self, BlockOrigin, Environment, Proposer, SelectChain};
 use sp_inherents::{CreateInherentDataProviders, InherentDataProvider};
-use sp_runtime::{
-	generic::BlockId,
-	traits::{Block as BlockT, Header as HeaderT},
-};
+use sp_runtime::traits::{Block as BlockT, Header as HeaderT};
 use std::{collections::HashMap, sync::Arc, time::Duration};
 
 /// max duration for creating a proposal in secs
@@ -102,9 +99,8 @@ pub async fn seal_block<B, BI, SC, C, E, TP, CIDP, P>(
 		// use the parent_hash supplied via `EngineCommand`
 		// or fetch the best_block.
 		let parent = match parent_hash {
-			Some(hash) => client
-				.header(BlockId::Hash(hash))?
-				.ok_or_else(|| Error::BlockNotFound(format!("{}", hash)))?,
+			Some(hash) =>
+				client.header(hash)?.ok_or_else(|| Error::BlockNotFound(format!("{}", hash)))?,
 			None => select_chain.best_chain().await?,
 		};