Add on_idle hook

bin/node-template/pallets/template/src/lib.rs

@@ -14,7 +14,7 @@ mod tests;
 
 #[frame_support::pallet]
 pub mod pallet {
-	use frame_support::{dispatch::DispatchResultWithPostInfo, pallet_prelude::*};
+	use frame_support::{dispatch::DispatchResultWithPostInfo, pallet_prelude::*, debug};
 	use frame_system::pallet_prelude::*;
 
 	/// Configure the pallet by specifying the parameters and types on which it depends.
@@ -46,7 +46,7 @@ pub mod pallet {
 		/// parameters. [something, who]
 		SomethingStored(u32, T::AccountId),
 	}
-	
+
 	// Errors inform users that something went wrong.
 	#[pallet::error]
 	pub enum Error<T> {
@@ -57,7 +57,18 @@ pub mod pallet {
 	}
 
 	#[pallet::hooks]
-	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {}
+	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
+		// TODO remove and add as an example
+		fn on_idle(block_number: T::BlockNumber, remaining_weight: frame_support::weights::Weight) -> Weight{
+			// TODO, better example implementation
+			if remaining_weight > 1994237262000 {
+				debug::info!("on idle: do something weight :{}", remaining_weight);
+			} else {
+				debug::info!("on idle: meh im busy weight :{}", remaining_weight);
+			}
+			0
+		}
+	}
 
 	// Dispatchable functions allows users to interact with the pallet and invoke state changes.
 	// These functions materialize as "extrinsics", which are often compared to transactions.

frame/executive/src/lib.rs

@@ -119,8 +119,8 @@
 use sp_std::{prelude::*, marker::PhantomData};
 use frame_support::{
 	weights::{GetDispatchInfo, DispatchInfo, DispatchClass},
-	traits::{OnInitialize, OnFinalize, OnRuntimeUpgrade, OffchainWorker},
-	dispatch::PostDispatchInfo,
+	traits::{OnInitialize, OnIdle, OnFinalize, OnRuntimeUpgrade, OffchainWorker},
+	dispatch::PostDispatchInfo
 };
 use sp_runtime::{
 	generic::Digest, ApplyExtrinsicResult,
@@ -166,6 +166,7 @@ impl<
 	AllModules:
 		OnRuntimeUpgrade +
 		OnInitialize<System::BlockNumber> +
+		OnIdle<System::BlockNumber> +
 		OnFinalize<System::BlockNumber> +
 		OffchainWorker<System::BlockNumber>,
 	COnRuntimeUpgrade: OnRuntimeUpgrade,
@@ -192,6 +193,7 @@ impl<
 		UnsignedValidator,
 		AllModules: OnRuntimeUpgrade
 			+ OnInitialize<System::BlockNumber>
+			+ OnIdle<System::BlockNumber>
 			+ OnFinalize<System::BlockNumber>
 			+ OffchainWorker<System::BlockNumber>,
 		COnRuntimeUpgrade: OnRuntimeUpgrade,
@@ -355,6 +357,13 @@ where
 
 		// post-extrinsics book-keeping
 		<frame_system::Module<System>>::note_finished_extrinsics();
+		//TODO: does this need to be implemented here too?
+		// let weight =  frame_system::BlockWeight;
+		// debug::info!("book keeping {}", weight);
+
+		// <frame_system::Module<System> as OnIdle<System::BlockNumber>>::on_idle(block_number);
+		// <AllModules as OnIdle<System::BlockNumber>>::on_idle(block_number);
+
 		<frame_system::Module<System> as OnFinalize<System::BlockNumber>>::on_finalize(block_number);
 		<AllModules as OnFinalize<System::BlockNumber>>::on_finalize(block_number);
 	}
@@ -366,6 +375,15 @@ where
 		sp_tracing::enter_span!( sp_tracing::Level::TRACE, "finalize_block" );
 		<frame_system::Module<System>>::note_finished_extrinsics();
 		let block_number = <frame_system::Module<System>>::block_number();
+
+
+		let weight =  <frame_system::Module<System>>::block_weight();
+		let max_weight =  <System::BlockWeights as frame_support::traits::Get<_>>::get().max_block;
+		let remaining_weight = max_weight.saturating_sub(weight.total());
+
+		<frame_system::Module<System> as OnIdle<System::BlockNumber>>::on_idle(block_number, remaining_weight);
+		<AllModules as OnIdle<System::BlockNumber>>::on_idle(block_number, remaining_weight);
+
 		<frame_system::Module<System> as OnFinalize<System::BlockNumber>>::on_finalize(block_number);
 		<AllModules as OnFinalize<System::BlockNumber>>::on_finalize(block_number);
 

frame/support/procedural/src/pallet/expand/hooks.rs

@@ -40,6 +40,19 @@ pub fn expand_hooks(def: &mut Def) -> proc_macro2::TokenStream {
 			}
 		}
 
+		impl<#type_impl_gen>
+			#frame_support::traits::OnIdle<<T as #frame_system::Config>::BlockNumber>
+			for #pallet_ident<#type_use_gen> #where_clause
+		{
+			fn on_idle(n: <T as #frame_system::Config>::BlockNumber, _remaining_weight: frame_support::weights::Weight) -> #frame_support::weights::Weight {
+				<
+					Self as #frame_support::traits::Hooks<
+						<T as #frame_system::Config>::BlockNumber
+					>
+				>::on_idle(n, _remaining_weight)
+			}
+		}
+
 		impl<#type_impl_gen>
 			#frame_support::traits::OnInitialize<<T as #frame_system::Config>::BlockNumber>
 			for #pallet_ident<#type_use_gen> #where_clause