tweaks and docs

Author: AmbientTea

demo/runtime/src/lib.rs

@@ -594,6 +594,7 @@ impl pallet_block_producer_metadata::Config for Runtime {
 impl pallet_block_participation::Config for Runtime {
 	type WeightInfo = pallet_block_participation::weights::SubstrateWeight<Runtime>;
 	type DelegatorId = DelegatorKey;
+	type BlockAuthor = BlockAuthor;
 
 	type Moment = Slot;
 

toolkit/block-participation/pallet/src/lib.rs

@@ -18,12 +18,6 @@
 //!
 //! ### Adding into the runtime
 //!
-//! The pallet's configuration can be divided into three groups by purpose:
-//! - `BlockAuthor` and `DelegatorId` types representing block authors and their dependant block beneficiaries
-//! - `should_release_data` function that controls when the inherent data provider is active
-//! - `blocks_produced_up_to_slot` and `blocks_produced_upd_to_slot` functions that provide bindings for consuming
-//!   (reading and clearing) block production data. Most easily these should come from `pallet_block_production_log`.
-//!
 //! Consult documentation of [pallet::Config] for details on each configuration field.
 //!
 //! Assuming that the runtime also contains the `pallet_block_production_log`, an example configuration of
@@ -36,22 +30,7 @@
 //!     type BlockAuthor = BlockAuthor;
 //!     type DelegatorId = DelegatorKey;
 //!
-//!     // release data every `RELEASE_PERIOD` blocks, up to current slot
-//!     fn should_release_data(slot: sidechain_slots::Slot) -> Option<sidechain_slots::Slot> {
-//!         if System::block_number() % RELEASE_PERIOD == 0 {
-//!             Some(slot)
-//!         } else {
-//!             None
-//!         }
-//!     }
-//!
-//!     fn blocks_produced_up_to_slot(slot: Slot) -> impl Iterator<Item = (Slot, BlockAuthor)> {
-//!         BlockProductionLog::peek_prefix(slot)
-//!     }
-//!
-//!     fn discard_blocks_produced_up_to_slot(slot: Slot) {
-//!         BlockProductionLog::drop_prefix(&slot)
-//!     }
+//!     type BlockParticipationProvider = BlockProductionLog;
 //!
 //!     const TARGET_INHERENT_ID: InherentIdentifier = *b"_example";
 //! }
@@ -72,12 +51,9 @@ pub use pallet::*;
 use sp_block_participation::*;
 
 /// Source of block participation data
-pub trait BlockParticipationProvider<Moment> {
-	/// Block participation data type
-	type BlockData;
-
+pub trait BlockParticipationProvider<Moment, BlockProducer> {
 	/// Returns the block data for processing
-	fn blocks_to_process(moment: &Moment) -> impl Iterator<Item = Self::BlockData>;
+	fn blocks_to_process(moment: &Moment) -> impl Iterator<Item = (Moment, BlockProducer)>;
 
 	/// Discards processed data
 	fn discard_processed_blocks(moment: &Moment);
@@ -98,10 +74,19 @@ pub mod pallet {
 		type WeightInfo: crate::weights::WeightInfo;
 
 		/// Moment in time at which the participation data should be processed
+		///
+		/// This type should be convertible to a timestamp value. If it represents a time range,
+		/// a representative timestamp, such as the start of the range should be computable from it.
 		type Moment: Parameter + Default + MaxEncodedLen + PartialOrd;
 
 		/// Source of block participation data
-		type BlockParticipationProvider: BlockParticipationProvider<Self::Moment>;
+		///
+		/// The default implementation provided by the Partner Chains toolit is the block production
+		/// log pallet implemented by the `pallet_block_production_log` crate.
+		type BlockParticipationProvider: BlockParticipationProvider<Self::Moment, Self::BlockAuthor>;
+
+		/// Type identifying the producer of a block on the Partner Chain
+		type BlockAuthor: Member + Parameter + MaxEncodedLen;
 
 		/// Type identifying indirect block production participants on the Partner Chain
 		/// This can be native stakers on Partner Chain, stakers on the main chain or other.
@@ -188,10 +173,7 @@ pub mod pallet {
 
 	impl<T: Config> Pallet<T> {
 		/// Fetches all blocks to be processed
-		pub fn blocks_to_process(
-			moment: &T::Moment,
-		) -> Vec<<<T as Config>::BlockParticipationProvider as BlockParticipationProvider<T::Moment>>::BlockData>
-		{
+		pub fn blocks_to_process(moment: &T::Moment) -> Vec<(T::Moment, T::BlockAuthor)> {
 			<T as Config>::BlockParticipationProvider::blocks_to_process(moment).collect()
 		}
 

toolkit/block-participation/pallet/src/mock.rs

@@ -41,10 +41,8 @@ construct_runtime! {
 	}
 }
 
-impl BlockParticipationProvider<u64> for Mock {
-	type BlockData = (u64, BlockProducerId);
-
-	fn blocks_to_process(up_to_moment: &u64) -> impl Iterator<Item = Self::BlockData> {
+impl BlockParticipationProvider<u64, BlockProducerId> for Mock {
+	fn blocks_to_process(up_to_moment: &u64) -> impl Iterator<Item = (u64, BlockProducerId)> {
 		mock_pallet::BlockProductionLog::<Test>::get()
 			.unwrap()
 			.clone()
@@ -104,6 +102,7 @@ const TEST_INHERENT_ID: InherentIdentifier = [42; 8];
 impl crate::pallet::Config for Test {
 	type WeightInfo = ();
 
+	type BlockAuthor = BlockProducerId;
 	type DelegatorId = DelegatorId;
 	type Moment = u64;
 

toolkit/block-production-log/pallet/src/lib.rs

@@ -253,10 +253,12 @@ pub mod pallet {
 mod block_participation {
 	use pallet_block_participation::BlockParticipationProvider;
 
-	impl<T: crate::Config> BlockParticipationProvider<T::Moment> for crate::Pallet<T> {
-		type BlockData = (T::Moment, T::BlockProducerId);
-
-		fn blocks_to_process(moment: &T::Moment) -> impl Iterator<Item = Self::BlockData> {
+	impl<T: crate::Config> BlockParticipationProvider<T::Moment, T::BlockProducerId>
+		for crate::Pallet<T>
+	{
+		fn blocks_to_process(
+			moment: &T::Moment,
+		) -> impl Iterator<Item = (T::Moment, T::BlockProducerId)> {
 			Self::peek_prefix(moment)
 		}