Update HRMP pallet benchmarking to use benchmarks v2 (#1676)

Updates the HRMP pallet benchmarks to Benchmarks v2 and fixes a small misconfiguration in one benchmark. --------- Co-authored-by: command-bot <>
2026-05-31 07:31:02 +00:00 · 2023-09-22 17:02:15 +01:00
parent b09ab37119
commit 22d9e2abc6
1 changed files with 179 additions and 101 deletions
@@ -14,12 +14,15 @@
 // You should have received a copy of the GNU General Public License
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.

+#![cfg(feature = "runtime-benchmarks")]
+
 use crate::{
 	configuration::Pallet as Configuration,
 	hrmp::{Pallet as Hrmp, *},
 	paras::{Pallet as Paras, ParaKind, ParachainsCache},
 	shared::Pallet as Shared,
 };
+use frame_benchmarking::{impl_benchmark_test_suite, v2::*, whitelisted_caller};
 use frame_support::{assert_ok, traits::Currency};

 type BalanceOf<T> =
@@ -138,10 +141,12 @@ static_assertions::const_assert!(MAX_UNIQUE_CHANNELS < PREFIX_0);
 static_assertions::const_assert!(HRMP_MAX_INBOUND_CHANNELS_BOUND < PREFIX_0);
 static_assertions::const_assert!(HRMP_MAX_OUTBOUND_CHANNELS_BOUND < PREFIX_0);

-frame_benchmarking::benchmarks! {
-	where_clause { where <T as frame_system::Config>::RuntimeOrigin: From<crate::Origin> }
+#[benchmarks(where <T as frame_system::Config>::RuntimeOrigin: From<crate::Origin>)]
+mod benchmarks {
+	use super::*;

-	hrmp_init_open_channel {
+	#[benchmark]
+	fn hrmp_init_open_channel() {
 		let sender_id: ParaId = 1u32.into();
 		let sender_origin: crate::Origin = 1u32.into();

@@ -149,51 +154,68 @@ frame_benchmarking::benchmarks! {

 		// make sure para is registered, and has enough balance.
 		let ed = T::Currency::minimum_balance();
-		let deposit: BalanceOf<T> = Configuration::<T>::config().hrmp_sender_deposit.unique_saturated_into();
+		let deposit: BalanceOf<T> =
+			Configuration::<T>::config().hrmp_sender_deposit.unique_saturated_into();
 		register_parachain_with_balance::<T>(sender_id, deposit + ed);
 		register_parachain_with_balance::<T>(recipient_id, deposit + ed);

 		let capacity = Configuration::<T>::config().hrmp_channel_max_capacity;
 		let message_size = Configuration::<T>::config().hrmp_channel_max_message_size;
-	}: _(sender_origin, recipient_id, capacity, message_size)
-	verify {
+
+		#[extrinsic_call]
+		_(sender_origin, recipient_id, capacity, message_size);
+
 		assert_last_event::<T>(
-			Event::<T>::OpenChannelRequested(sender_id, recipient_id, capacity, message_size).into()
+			Event::<T>::OpenChannelRequested(sender_id, recipient_id, capacity, message_size)
+				.into(),
 		);
 	}

-	hrmp_accept_open_channel {
+	#[benchmark]
+	fn hrmp_accept_open_channel() {
 		let [(sender, _), (recipient, recipient_origin)] =
 			establish_para_connection::<T>(1, 2, ParachainSetupStep::Requested);
-	}: _(recipient_origin, sender)
-	verify {
+
+		#[extrinsic_call]
+		_(recipient_origin, sender);
+
 		assert_last_event::<T>(Event::<T>::OpenChannelAccepted(sender, recipient).into());
 	}

-	hrmp_close_channel {
+	#[benchmark]
+	fn hrmp_close_channel() {
 		let [(sender, sender_origin), (recipient, _)] =
 			establish_para_connection::<T>(1, 2, ParachainSetupStep::Established);
 		let channel_id = HrmpChannelId { sender, recipient };
-	}: _(sender_origin, channel_id.clone())
-	verify {
+
+		#[extrinsic_call]
+		_(sender_origin, channel_id.clone());
+
 		assert_last_event::<T>(Event::<T>::ChannelClosed(sender, channel_id).into());
 	}

 	// NOTE: a single parachain should have the maximum number of allowed ingress and egress
 	// channels.
-	force_clean_hrmp {
+	#[benchmark]
+	fn force_clean_hrmp(
 		// ingress channels to a single leaving parachain that need to be closed.
-		let i in 0 .. (HRMP_MAX_INBOUND_CHANNELS_BOUND - 1);
+		i: Linear<0, { HRMP_MAX_INBOUND_CHANNELS_BOUND - 1 }>,
 		// egress channels to a single leaving parachain that need to be closed.
-		let e in 0 .. (HRMP_MAX_OUTBOUND_CHANNELS_BOUND - 1);
-
+		e: Linear<0, { HRMP_MAX_OUTBOUND_CHANNELS_BOUND - 1 }>,
+	) {
 		// first, update the configs to support this many open channels...
-		assert_ok!(
-			Configuration::<T>::set_hrmp_max_parachain_outbound_channels(frame_system::RawOrigin::Root.into(), e + 1)
-		);
-		assert_ok!(
-			Configuration::<T>::set_hrmp_max_parachain_inbound_channels(frame_system::RawOrigin::Root.into(), i + 1)
-		);
+		assert_ok!(Configuration::<T>::set_hrmp_max_parachain_outbound_channels(
+			frame_system::RawOrigin::Root.into(),
+			e + 1
+		));
+		assert_ok!(Configuration::<T>::set_hrmp_max_parachain_inbound_channels(
+			frame_system::RawOrigin::Root.into(),
+			i + 1
+		));
+		assert_ok!(Configuration::<T>::set_max_downward_message_size(
+			frame_system::RawOrigin::Root.into(),
+			1024
+		));
 		// .. and enact it.
 		Configuration::<T>::initializer_on_new_session(&Shared::<T>::scheduled_session());

@@ -201,14 +223,17 @@ frame_benchmarking::benchmarks! {
 		let deposit: BalanceOf<T> = config.hrmp_sender_deposit.unique_saturated_into();

 		let para: ParaId = 1u32.into();
-		let para_origin: crate::Origin = 1u32.into();
 		register_parachain_with_balance::<T>(para, deposit);
 		T::Currency::make_free_balance_be(&para.into_account_truncating(), deposit * 256u32.into());

 		for ingress_para_id in 0..i {
 			// establish ingress channels to `para`.
 			let ingress_para_id = ingress_para_id + PREFIX_0;
-			let _ = establish_para_connection::<T>(ingress_para_id, para.into(), ParachainSetupStep::Established);
+			let _ = establish_para_connection::<T>(
+				ingress_para_id,
+				para.into(),
+				ParachainSetupStep::Established,
+			);
 		}

 		// nothing should be left unprocessed.
@@ -217,7 +242,11 @@ frame_benchmarking::benchmarks! {
 		for egress_para_id in 0..e {
 			// establish egress channels to `para`.
 			let egress_para_id = egress_para_id + PREFIX_1;
-			let _ = establish_para_connection::<T>(para.into(), egress_para_id, ParachainSetupStep::Established);
+			let _ = establish_para_connection::<T>(
+				para.into(),
+				egress_para_id,
+				ParachainSetupStep::Established,
+			);
 		}

 		// nothing should be left unprocessed.
@@ -225,7 +254,10 @@ frame_benchmarking::benchmarks! {

 		// all in all, we have created this many channels.
 		assert_eq!(HrmpChannels::<T>::iter().count() as u32, i + e);
-	}: _(frame_system::Origin::<T>::Root, para, i, e) verify {
+
+		#[extrinsic_call]
+		_(frame_system::Origin::<T>::Root, para, i, e);
+
 		// all in all, all of them must be gone by now.
 		assert_eq!(HrmpChannels::<T>::iter().count() as u32, 0);
 		// borrow this function from the tests to make sure state is clear, given that we do a lot
@@ -233,73 +265,108 @@ frame_benchmarking::benchmarks! {
 		Hrmp::<T>::assert_storage_consistency_exhaustive();
 	}

-	force_process_hrmp_open {
+	#[benchmark]
+	fn force_process_hrmp_open(
 		// number of channels that need to be processed. Worse case is an N-M relation: unique
 		// sender and recipients for all channels.
-		let c in 0 .. MAX_UNIQUE_CHANNELS;
-
+		c: Linear<0, MAX_UNIQUE_CHANNELS>,
+	) {
 		for id in 0..c {
-			let _ = establish_para_connection::<T>(PREFIX_0 + id, PREFIX_1 + id, ParachainSetupStep::Accepted);
+			let _ = establish_para_connection::<T>(
+				PREFIX_0 + id,
+				PREFIX_1 + id,
+				ParachainSetupStep::Accepted,
+			);
 		}
 		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, c);
-	}: _(frame_system::Origin::<T>::Root, c)
-	verify {
+
+		#[extrinsic_call]
+		_(frame_system::Origin::<T>::Root, c);
+
 		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, 0);
 	}

-	force_process_hrmp_close {
+	#[benchmark]
+	fn force_process_hrmp_close(
 		// number of channels that need to be processed. Worse case is an N-M relation: unique
 		// sender and recipients for all channels.
-		let c in 0 .. MAX_UNIQUE_CHANNELS;
-
+		c: Linear<0, MAX_UNIQUE_CHANNELS>,
+	) {
 		for id in 0..c {
-			let _ = establish_para_connection::<T>(PREFIX_0 + id, PREFIX_1 + id, ParachainSetupStep::CloseRequested);
+			let _ = establish_para_connection::<T>(
+				PREFIX_0 + id,
+				PREFIX_1 + id,
+				ParachainSetupStep::CloseRequested,
+			);
 		}

 		assert_eq!(HrmpCloseChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, c);
-	}: _(frame_system::Origin::<T>::Root, c)
-	verify {
+
+		#[extrinsic_call]
+		_(frame_system::Origin::<T>::Root, c);
+
 		assert_eq!(HrmpCloseChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, 0);
 	}

-	hrmp_cancel_open_request {
+	#[benchmark]
+	fn hrmp_cancel_open_request(
 		// number of items already existing in the `HrmpOpenChannelRequestsList`, other than the
 		// one that we remove.
-		let c in 0 .. MAX_UNIQUE_CHANNELS;
-
+		c: Linear<0, MAX_UNIQUE_CHANNELS>,
+	) {
 		for id in 0..c {
-			let _ = establish_para_connection::<T>(PREFIX_0 + id, PREFIX_1 + id, ParachainSetupStep::Requested);
+			let _ = establish_para_connection::<T>(
+				PREFIX_0 + id,
+				PREFIX_1 + id,
+				ParachainSetupStep::Requested,
+			);
 		}

 		let [(sender, sender_origin), (recipient, _)] =
 			establish_para_connection::<T>(1, 2, ParachainSetupStep::Requested);
-		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, c + 1);
+		assert_eq!(
+			HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32,
+			c + 1
+		);
 		let channel_id = HrmpChannelId { sender, recipient };
-	}: _(sender_origin, channel_id, c + 1)
-	verify {
+
+		#[extrinsic_call]
+		_(sender_origin, channel_id, c + 1);
+
 		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, c);
 	}

 	// worse case will be `n` parachain channel requests, where in all of them either the sender or
 	// the recipient need to be cleaned. This enforces the deposit of at least one to be processed.
 	// No code path for triggering two deposit process exists.
-	clean_open_channel_requests {
-		let c in 0 .. MAX_UNIQUE_CHANNELS;
-
+	#[benchmark]
+	fn clean_open_channel_requests(c: Linear<0, MAX_UNIQUE_CHANNELS>) {
 		for id in 0..c {
-			let _ = establish_para_connection::<T>(PREFIX_0 + id, PREFIX_1 + id, ParachainSetupStep::Requested);
+			let _ = establish_para_connection::<T>(
+				PREFIX_0 + id,
+				PREFIX_1 + id,
+				ParachainSetupStep::Requested,
+			);
 		}

 		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, c);
 		let outgoing = (0..c).map(|id| (id + PREFIX_1).into()).collect::<Vec<ParaId>>();
 		let config = Configuration::<T>::config();
-	}: {
+
+		#[block]
+		{
 			Hrmp::<T>::clean_open_channel_requests(&config, &outgoing);
-	} verify {
+		}
+
 		assert_eq!(HrmpOpenChannelRequestsList::<T>::decode_len().unwrap_or_default() as u32, 0);
 	}

-	force_open_hrmp_channel {
+	#[benchmark]
+	fn force_open_hrmp_channel(
+		// Weight parameter only accepts `u32`, `0` and `1` used to represent `false` and `true`,
+		// respectively.
+		c: Linear<0, 1>,
+	) {
 		let sender_id: ParaId = 1u32.into();
 		let sender_origin: crate::Origin = 1u32.into();
 		let recipient_id: ParaId = 2u32.into();
@@ -315,12 +382,8 @@ frame_benchmarking::benchmarks! {
 		let capacity = Configuration::<T>::config().hrmp_channel_max_capacity;
 		let message_size = Configuration::<T>::config().hrmp_channel_max_message_size;

-		// Weight parameter only accepts `u32`, `0` and `1` used to represent `false` and `true`,
-		// respectively.
-		let c = [0, 1];
 		let channel_id = HrmpChannelId { sender: sender_id, recipient: recipient_id };
-		for channels_to_close in c {
-			if channels_to_close == 1 {
+		if c == 1 {
 			// this will consume more weight if a channel _request_ already exists, because it
 			// will need to clear the request.
 			assert_ok!(Hrmp::<T>::hrmp_init_open_channel(
@@ -340,22 +403,25 @@ frame_benchmarking::benchmarks! {
 			}
 			assert!(HrmpOpenChannelRequests::<T>::get(&channel_id).is_none());
 		}
-		}

 		// but the _channel_ should not exist
 		assert!(HrmpChannels::<T>::get(&channel_id).is_none());
-	}: _(frame_system::Origin::<T>::Root, sender_id, recipient_id, capacity, message_size)
-	verify {
+
+		#[extrinsic_call]
+		_(frame_system::Origin::<T>::Root, sender_id, recipient_id, capacity, message_size);
+
 		assert_last_event::<T>(
-			Event::<T>::HrmpChannelForceOpened(sender_id, recipient_id, capacity, message_size).into()
+			Event::<T>::HrmpChannelForceOpened(sender_id, recipient_id, capacity, message_size)
+				.into(),
 		);
 	}

-	establish_system_channel {
+	#[benchmark]
+	fn establish_system_channel() {
 		let sender_id: ParaId = 1u32.into();
 		let recipient_id: ParaId = 2u32.into();

-		let caller: T::AccountId = frame_benchmarking::whitelisted_caller();
+		let caller: T::AccountId = whitelisted_caller();
 		let config = Configuration::<T>::config();

 		// make sure para is registered, and has zero balance.
@@ -364,19 +430,23 @@ frame_benchmarking::benchmarks! {

 		let capacity = config.hrmp_channel_max_capacity;
 		let message_size = config.hrmp_channel_max_message_size;
-	}: _(frame_system::RawOrigin::Signed(caller), sender_id, recipient_id)
-	verify {
+
+		#[extrinsic_call]
+		_(frame_system::RawOrigin::Signed(caller), sender_id, recipient_id);
+
 		assert_last_event::<T>(
-			Event::<T>::HrmpSystemChannelOpened(sender_id, recipient_id, capacity, message_size).into()
+			Event::<T>::HrmpSystemChannelOpened(sender_id, recipient_id, capacity, message_size)
+				.into(),
 		);
 	}

-	poke_channel_deposits {
+	#[benchmark]
+	fn poke_channel_deposits() {
 		let sender_id: ParaId = 1u32.into();
 		let recipient_id: ParaId = 2u32.into();
 		let channel_id = HrmpChannelId { sender: sender_id, recipient: recipient_id };

-		let caller: T::AccountId = frame_benchmarking::whitelisted_caller();
+		let caller: T::AccountId = whitelisted_caller();
 		let config = Configuration::<T>::config();

 		// make sure para is registered, and has balance to reserve.
@@ -403,23 +473,31 @@ frame_benchmarking::benchmarks! {
 		// Actually reserve the deposits.
 		let _ = T::Currency::reserve(&sender_id.into_account_truncating(), sender_deposit);
 		let _ = T::Currency::reserve(&recipient_id.into_account_truncating(), recipient_deposit);
-	}: _(frame_system::RawOrigin::Signed(caller), sender_id, recipient_id)
-	verify {
+
+		#[extrinsic_call]
+		_(frame_system::RawOrigin::Signed(caller), sender_id, recipient_id);
+
 		assert_last_event::<T>(
-			Event::<T>::OpenChannelDepositsUpdated(sender_id, recipient_id).into()
+			Event::<T>::OpenChannelDepositsUpdated(sender_id, recipient_id).into(),
 		);
 		let channel = HrmpChannels::<T>::get(&channel_id).unwrap();
 		// Check that the deposit was updated in the channel state.
 		assert_eq!(channel.sender_deposit, 0);
 		assert_eq!(channel.recipient_deposit, 0);
 		// And that the funds were unreserved.
-		assert_eq!(T::Currency::reserved_balance(&sender_id.into_account_truncating()), 0u128.unique_saturated_into());
-		assert_eq!(T::Currency::reserved_balance(&recipient_id.into_account_truncating()), 0u128.unique_saturated_into());
-	}
+		assert_eq!(
+			T::Currency::reserved_balance(&sender_id.into_account_truncating()),
+			0u128.unique_saturated_into()
+		);
+		assert_eq!(
+			T::Currency::reserved_balance(&recipient_id.into_account_truncating()),
+			0u128.unique_saturated_into()
+		);
 	}

-frame_benchmarking::impl_benchmark_test_suite!(
+	impl_benchmark_test_suite!(
 		Hrmp,
 		crate::mock::new_test_ext(crate::hrmp::tests::GenesisConfigBuilder::default().build()),
 		crate::mock::Test
 	);
+}