remove slot dependency from pallet-block-production-log

Author: AmbientTea

Cargo.lock

@@ -17,6 +17,9 @@ and epoch duration to calculate current epoch.
 Since the block timestamp is not passed to the inherent data provider creation logic by Aura, the exact timestamp is not
 available during block verification, but it can be approximated based on the slot number. See the example impelementation
 in the demo node crate.
+* `pallet-block-production-log` no longer uses slots and is instead parametrized by a `Moment` type.
+To match this change, `BlockProductionLogApi::get_author` now accepts a `Moment` value and `BlockAuthorInherentProvider`
+also takes `Moment` as type and constructor parameter.
 
 ## Removed
 

changelog.md

@@ -60,7 +60,7 @@ where
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		>,
-	T::Api: BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>>,
+	T::Api: BlockProductionLogApi<Block, BlockAuthor, Slot>,
 	T::Api: BlockParticipationApi<Block, BlockAuthor>,
 	T::Api: GovernedMapIDPApi<Block>,
 	T::Api: TokenBridgeIDPRuntimeApi<Block>,
@@ -70,7 +70,7 @@ where
 		TimestampIDP,
 		McHashIDP,
 		AriadneIDP,
-		BlockAuthorInherentProvider<BlockAuthor>,
+		BlockAuthorInherentProvider<Slot, BlockAuthor>,
 		BlockParticipationInherentDataProvider<BlockAuthor, DelegatorKey>,
 		GovernedMapInherentDataProvider,
 		TokenBridgeInherentDataProvider<AccountId>,
@@ -183,15 +183,15 @@ where
 			AuthoritySelectionInputs,
 			ScEpochNumber,
 		>,
-	T::Api: BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>>,
+	T::Api: BlockProductionLogApi<Block, BlockAuthor, Slot>,
 	T::Api: BlockParticipationApi<Block, BlockAuthor>,
 	T::Api: GovernedMapIDPApi<Block>,
 	T::Api: TokenBridgeIDPRuntimeApi<Block>,
 {
 	type InherentDataProviders = (
 		TimestampIDP,
 		AriadneIDP,
-		BlockAuthorInherentProvider<BlockAuthor>,
+		BlockAuthorInherentProvider<Slot, BlockAuthor>,
 		BlockParticipationInherentDataProvider<BlockAuthor, DelegatorKey>,
 		GovernedMapInherentDataProvider,
 		TokenBridgeInherentDataProvider<AccountId>,

demo/node/src/inherent_data.rs

@@ -15,6 +15,7 @@ use sidechain_domain::{
 };
 use sidechain_mc_hash::mock::MockMcHashDataSource;
 use sp_block_participation::BlockProductionData;
+use sp_block_production_log::BlockProductionInherentDataV1;
 use sp_consensus_aura::Slot;
 use sp_core::ecdsa;
 use sp_inherents::CreateInherentDataProviders;
@@ -87,14 +88,19 @@ async fn block_proposal_cidp_should_be_created_correctly() {
 	);
 	assert_eq!(
 		inherent_data
-			.get_data::<BlockAuthor>(&sp_block_production_log::INHERENT_IDENTIFIER)
+			.get_data::<BlockProductionInherentDataV1<u64, BlockAuthor>>(
+				&sp_block_production_log::INHERENT_IDENTIFIER
+			)
 			.unwrap(),
-		Some(BlockAuthor::ProBono(
-			ecdsa::Public::from_raw(hex!(
-				"000000000000000000000000000000000000000000000000000000000000000001"
-			))
-			.into()
-		))
+		Some(BlockProductionInherentDataV1 {
+			moment: 30,
+			block_producer_id: BlockAuthor::ProBono(
+				ecdsa::Public::from_raw(hex!(
+					"000000000000000000000000000000000000000000000000000000000000000001"
+				))
+				.into()
+			)
+		})
 	);
 	assert_eq!(
 		inherent_data
@@ -163,14 +169,19 @@ async fn block_verification_cidp_should_be_created_correctly() {
 	);
 	assert_eq!(
 		inherent_data
-			.get_data::<BlockAuthor>(&sp_block_production_log::INHERENT_IDENTIFIER)
+			.get_data::<BlockProductionInherentDataV1<u64, BlockAuthor>>(
+				&sp_block_production_log::INHERENT_IDENTIFIER
+			)
 			.unwrap(),
-		Some(BlockAuthor::ProBono(
-			ecdsa::Public::from_raw(hex!(
-				"000000000000000000000000000000000000000000000000000000000000000001"
-			))
-			.into()
-		))
+		Some(BlockProductionInherentDataV1 {
+			moment: 30,
+			block_producer_id: BlockAuthor::ProBono(
+				ecdsa::Public::from_raw(hex!(
+					"000000000000000000000000000000000000000000000000000000000000000001"
+				))
+				.into()
+			)
+		})
 	);
 	assert_eq!(
 		inherent_data

demo/node/src/tests/inherent_data_tests.rs

@@ -8,7 +8,7 @@ use sidechain_mc_hash::McHashInherentDigest;
 use sidechain_slots::Slot;
 use sp_api::{ApiRef, ProvideRuntimeApi};
 use sp_blockchain::HeaderBackend;
-use sp_core::{ecdsa, ed25519, sr25519};
+use sp_core::ecdsa;
 use sp_governed_map::MainChainScriptsV1;
 use sp_inherents::InherentIdentifier;
 use sp_runtime::Digest;
@@ -97,14 +97,10 @@ sp_api::mock_impl_runtime_apis! {
 		}
 	}
 
-	impl sp_block_production_log::BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>> for TestApi {
-		fn get_author(_slot: Slot) -> Option<CommitteeMember<CrossChainPublic, SessionKeys>> {
-			Some(CommitteeMember::permissioned(
-				ecdsa::Public::from_raw(hex!("000000000000000000000000000000000000000000000000000000000000000001")).into(),
-				SessionKeys {
-					aura: sr25519::Public::default().into(),
-					grandpa: ed25519::Public::default().into()
-				}
+	impl sp_block_production_log::BlockProductionLogApi<Block, BlockAuthor, Slot> for TestApi {
+		fn get_author(_slot: &Slot) -> Option<BlockAuthor> {
+			Some(BlockAuthor::ProBono(
+				ecdsa::Public::from_raw(hex!("000000000000000000000000000000000000000000000000000000000000000001")).into()
 			))
 		}
 	}

demo/node/src/tests/runtime_api_mock.rs

@@ -514,10 +514,7 @@ impl pallet_block_production_log::Config for Runtime {
 	type BlockProducerId = BlockAuthor;
 	type WeightInfo = pallet_block_production_log::weights::SubstrateWeight<Runtime>;
 
-	fn current_slot() -> sp_consensus_slots::Slot {
-		let slot: u64 = pallet_aura::CurrentSlot::<Runtime>::get().into();
-		sp_consensus_slots::Slot::from(slot)
-	}
+	type Moment = Slot;
 
 	#[cfg(feature = "runtime-benchmarks")]
 	type BenchmarkHelper = PalletBlockProductionLogBenchmarkHelper;
@@ -1135,9 +1132,10 @@ impl_runtime_apis! {
 		}
 	}
 
-	impl sp_block_production_log::BlockProductionLogApi<Block, CommitteeMember<CrossChainPublic, SessionKeys>>  for Runtime {
-		fn get_author(slot: Slot) -> Option<CommitteeMember<CrossChainPublic, SessionKeys>> {
-			 SessionCommitteeManagement::get_current_authority_round_robin(*slot as usize)
+	impl sp_block_production_log::BlockProductionLogApi<Block, BlockAuthor, Slot>  for Runtime {
+		fn get_author(slot: &Slot) -> Option<BlockAuthor> {
+			SessionCommitteeManagement::get_current_authority_round_robin(u64::from(*slot) as usize)
+				.map(Into::into)
 		}
 	}
 

demo/runtime/src/lib.rs

@@ -597,6 +597,12 @@ def get_validator_set(self, block):
                 result.append(memberParams)
         return result
 
+    def get_block_slot(self, block):
+        return self.substrate.query("Aura", "CurrentSlot", block_hash=block["header"]["hash"]).value
+
+    def get_block_timestamp(self, block):
+        return self.substrate.query("Timestamp", "Now", block_hash=block["header"]["hash"]).value
+
     def get_block_author_and_slot(self, block, validator_set):
         """Custom implementation of substrate.get_block(include_author=True) to get block author, and block slot.
         py-substrate-interface does not work because it calls "Validators" function from "Session" pallet,

e2e-tests/src/substrate_api.py

@@ -17,6 +17,7 @@ def test_block_production_log_pallet(api: BlockchainApi, config: ApiConfig):
     block_production_log.reverse()
     for slot, block_producer_id in block_production_log:
         committee = api.get_validator_set(block)
+
         author_aura_key = committee[slot % len(committee)]["keys"]["aura"]
         expected_node = next(x for x in config.nodes_config.nodes.values() if x.aura_public_key == author_aura_key)
 

e2e-tests/tests/delegator_rewards/test_block_production_log.py

@@ -1,7 +1,7 @@
 [package]
 name = "pallet-block-production-log"
 version.workspace = true
-description = "Keeps log of slot to block producer id"
+description = "Keeps log of timestamp to block producer id"
 license = "Apache-2.0"
 readme = "README.md"
 authors.workspace = true
@@ -21,7 +21,6 @@ parity-scale-codec = { workspace = true }
 scale-info = { workspace = true }
 sidechain-domain = { workspace = true }
 sp-block-production-log = { workspace = true }
-sp-consensus-slots = { workspace = true, features = ["serde"] }
 sp-runtime = { workspace = true }
 sp-std = { workspace = true }
 

toolkit/block-production-log/pallet/Cargo.toml

@@ -1,7 +1,6 @@
 # Block Production Log pallet
 
-This pallet keeps a sorted log of Slot to BlockProducerId.
+This pallet keeps a sorted log of timestamp to BlockProducerId.
 It is a user decision what is the concrete type of BlockProducerId.
 Inherent data provider that provides BlockProducerId should be wired into the node to make this pallet useful.
 User should periodically call `take_prefix` to shrink used storage and consume the log according to their needs.
-Pallet supports handling many blocks per slot.