primitives readme

Signed-off-by: Nikolaos Dymitriadis <[email protected]>

toolkit/primitives/block-rewards/README.md

@@ -0,0 +1,5 @@
+# Block Rewards Primitives
+
+This crate implements the primitives and inherent data provider for the block producer
+rewards feature. See the corresponding pallet's (`pallet-block-rewards`) documentation
+for more information.

toolkit/primitives/block-rewards/src/lib.rs

@@ -61,6 +61,7 @@ where
 	BeneficiaryId: TryFrom<Vec<u8>> + Send + Sync + Encode,
 	<BeneficiaryId as TryFrom<Vec<u8>>>::Error: std::fmt::Debug,
 {
+	/// Read and decode beneficiary ID from the specified environment variable
 	pub fn from_env(env_var: &str) -> Result<Self, InherentProviderCreationError> {
 		let beneficiary_string = std::env::var(env_var)
 			.map_err(|_| InherentProviderCreationError::NotSet(env_var.into()))?;