feat: add hooks for utility batch

cumulus/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs

@@ -473,6 +473,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs

@@ -472,6 +472,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-rococo/src/lib.rs

@@ -543,6 +543,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/bridge-hubs/bridge-hub-westend/src/lib.rs

@@ -519,6 +519,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/collectives/collectives-westend/src/lib.rs

@@ -264,6 +264,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/contracts/contracts-rococo/src/lib.rs

@@ -274,6 +274,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = pallet_utility::weights::SubstrateWeight<Runtime>;
 }
 

cumulus/parachains/runtimes/coretime/coretime-rococo/src/lib.rs

@@ -583,6 +583,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/coretime/coretime-westend/src/lib.rs

@@ -584,6 +584,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+    type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/people/people-rococo/src/lib.rs

@@ -526,6 +526,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

cumulus/parachains/runtimes/people/people-westend/src/lib.rs

@@ -525,6 +525,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

polkadot/runtime/rococo/src/lib.rs

@@ -748,6 +748,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

polkadot/runtime/westend/src/lib.rs

@@ -985,6 +985,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = weights::pallet_utility::WeightInfo<Runtime>;
 }
 

substrate/bin/node/runtime/src/lib.rs

@@ -374,6 +374,7 @@ impl pallet_utility::Config for Runtime {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = pallet_utility::weights::SubstrateWeight<Runtime>;
 }
 

substrate/frame/utility/README.md

@@ -22,6 +22,9 @@ This module contains two basic pieces of functionality:
 Since proxy filters are respected in all dispatches of this module, it should never need to be
 filtered by any proxy.
 
+Pre- and post-hooks can be configured via `BatchHook` associated type. 
+They are triggered for each batch call: `batch`, `batch_all`, and `force_batch`. Use the unit type `()` if no behavior is required.
+
 ## Interface
 
 ### Dispatchable Functions

substrate/frame/utility/src/lib.rs

@@ -68,9 +68,30 @@
 use sp_io::hashing::blake2_256;
 use sp_runtime::traits::{BadOrigin, Dispatchable, TrailingZeroInput};
 pub use weights::WeightInfo;
-
 pub use pallet::*;
 
+/// Hooks that will be called for `batch` calls.
+#[impl_trait_for_tuples::impl_for_tuples(30)]
+pub trait BatchHook {
+	/// Will be called before a batch is executed.
+	fn on_batch_start() -> sp_runtime::DispatchResult;
+	/// Will be called after the batch was executed.
+	///
+	/// Depending on the exact batch call used, it may not be called when a batch item failed.
+	fn on_batch_end() -> sp_runtime::DispatchResult;
+}
+
+impl BatchHook for () {
+	fn on_batch_start() -> sp_runtime::DispatchResult {
+		Ok(())
+	}
+
+	fn on_batch_end() -> sp_runtime::DispatchResult {
+		Ok(())
+	}
+
+}
+
 #[frame_support::pallet]
 pub mod pallet {
 	use super::*;
@@ -100,6 +121,9 @@
 			Into<<Self as frame_system::Config>::RuntimeOrigin> +
 			IsType<<<Self as frame_system::Config>::RuntimeOrigin as frame_support::traits::OriginTrait>::PalletsOrigin>;
 
+		/// Hook to be called before any batch operation.
+		type BatchHook: BatchHook;
+
 		/// Weight information for extrinsics in this pallet.
 		type WeightInfo: WeightInfo;
 	}
@@ -196,6 +220,8 @@
 				return Err(BadOrigin.into())
 			}
 
+			T::BatchHook::on_batch_start()?;
+
 			let is_root = ensure_root(origin.clone()).is_ok();
 			let calls_len = calls.len();
 			ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
@@ -225,6 +251,9 @@
 				Self::deposit_event(Event::ItemCompleted);
 			}
 			Self::deposit_event(Event::BatchCompleted);
+
+			T::BatchHook::on_batch_end()?;
+
 			let base_weight = T::WeightInfo::batch(calls_len as u32);
 			Ok(Some(base_weight.saturating_add(weight)).into())
 		}
@@ -305,6 +334,8 @@
 				return Err(BadOrigin.into())
 			}
 
+			T::BatchHook::on_batch_start()?;
+
 			let is_root = ensure_root(origin.clone()).is_ok();
 			let calls_len = calls.len();
 			ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
@@ -339,6 +370,9 @@
 				Self::deposit_event(Event::ItemCompleted);
 			}
 			Self::deposit_event(Event::BatchCompleted);
+
+			T::BatchHook::on_batch_end()?;
+
 			let base_weight = T::WeightInfo::batch_all(calls_len as u32);
 			Ok(Some(base_weight.saturating_add(weight)).into())
 		}
@@ -401,6 +435,8 @@
 				return Err(BadOrigin.into())
 			}
 
+			T::BatchHook::on_batch_start()?;
+
 			let is_root = ensure_root(origin.clone()).is_ok();
 			let calls_len = calls.len();
 			ensure!(calls_len <= Self::batched_calls_limit() as usize, Error::<T>::TooManyCalls);
@@ -431,6 +467,9 @@
 			} else {
 				Self::deposit_event(Event::BatchCompleted);
 			}
+
+			T::BatchHook::on_batch_end()?;
+
 			let base_weight = T::WeightInfo::batch(calls_len as u32);
 			Ok(Some(base_weight.saturating_add(weight)).into())
 		}

substrate/frame/utility/src/tests.rs

@@ -222,6 +222,7 @@ impl Config for Test {
 	type RuntimeEvent = RuntimeEvent;
 	type RuntimeCall = RuntimeCall;
 	type PalletsOrigin = OriginCaller;
+	type BatchHook = ();
 	type WeightInfo = ();
 }