support: add lateness trait (#5519)

* support: add lateness trait

* babe: implement the lateness trait

* babe: add docs about lateness entry lifetime

* babe: don't use option for lateness storage entry

substrate/frame/babe/src/lib.rs

@@ -152,6 +152,13 @@ decl_storage! {
 		/// Temporary value (cleared at block finalization) which is `Some`
 		/// if per-block initialization has already been called for current block.
 		Initialized get(fn initialized): Option<MaybeVrf>;
+
+		/// How late the current block is compared to its parent.
+		///
+		/// This entry is populated as part of block execution and is cleaned up
+		/// on block finalization. Querying this storage entry outside of block
+		/// execution context should always yield zero.
+		Lateness get(fn lateness): T::BlockNumber;
 	}
 	add_extra_genesis {
 		config(authorities): Vec<(AuthorityId, BabeAuthorityWeight)>;
@@ -190,6 +197,9 @@ decl_module! {
 			if let Some(Some(vrf_output)) = Initialized::take() {
 				Self::deposit_vrf_output(&vrf_output);
 			}
+
+			// remove temporary "environment" entry from storage
+			Lateness::<T>::kill();
 		}
 	}
 }
@@ -443,7 +453,15 @@ impl<T: Trait> Module<T> {
 				Self::deposit_consensus(ConsensusLog::NextEpochData(next))
 			}
 
-			CurrentSlot::put(digest.slot_number());
+			// the slot number of the current block being initialized
+			let current_slot = digest.slot_number();
+
+			// how many slots were skipped between current and last block
+			let lateness = current_slot.saturating_sub(CurrentSlot::get() + 1);
+			let lateness = T::BlockNumber::from(lateness as u32);
+
+			Lateness::<T>::put(lateness);
+			CurrentSlot::put(current_slot);
 
 			if let RawPreDigest::Primary(primary) = digest {
 				// place the VRF output into the `Initialized` storage item
@@ -498,6 +516,12 @@ impl<T: Trait> frame_support::traits::EstimateNextSessionRotation<T::BlockNumber
 	}
 }
 
+impl<T: Trait> frame_support::traits::Lateness<T::BlockNumber> for Module<T> {
+	fn lateness(&self) -> T::BlockNumber {
+		Self::lateness()
+	}
+}
+
 impl<T: Trait> sp_runtime::BoundToRuntimeAppPublic for Module<T> {
 	type Public = AuthorityId;
 }

substrate/frame/support/src/traits.rs

@@ -24,7 +24,7 @@ use sp_core::u32_trait::Value as U32;
 use sp_runtime::{
 	RuntimeDebug,
 	ConsensusEngineId, DispatchResult, DispatchError,
-	traits::{MaybeSerializeDeserialize, AtLeast32Bit, Saturating, TrailingZeroInput, Bounded},
+	traits::{MaybeSerializeDeserialize, AtLeast32Bit, Saturating, TrailingZeroInput, Bounded, Zero},
 };
 use crate::dispatch::Parameter;
 use crate::storage::StorageMap;
@@ -1032,6 +1032,21 @@ impl<Output: Decode + Default> Randomness<Output> for () {
 	}
 }
 
+/// Trait to be used by block producing consensus engine modules to determine
+/// how late the current block is (e.g. in a slot-based proposal mechanism how
+/// many slots were skipped since the previous block).
+pub trait Lateness<N> {
+	/// Returns a generic measure of how late the current block is compared to
+	/// its parent.
+	fn lateness(&self) -> N;
+}
+
+impl<N: Zero> Lateness<N> for () {
+	fn lateness(&self) -> N {
+		Zero::zero()
+	}
+}
+
 /// Implementors of this trait provide information about whether or not some validator has
 /// been registered with them. The [Session module](../../pallet_session/index.html) is an implementor.
 pub trait ValidatorRegistration<ValidatorId> {