Iv thea mh benchmarks (#804)

## Describe your changes
Pallet `thea-message-handler` benchmarks, weights and feature gated
runtime integration.

## Checklist before requesting a review
- [x] I have performed a self-review of my code.
- [x] If it is a core feature, I have added thorough tests.
- [x] I removed all Clippy and Formatting Warnings. 
- [x] I added required Copyrights.

Author: serhii-temchenko

Cargo.lock

@@ -16,7 +16,7 @@ frame-benchmarking = { workspace = true, default-features = false, optional = tr
 sp-core = { workspace = true, default-features = false }
 bls-primitives = { workspace = true, default-features = false }
 thea-primitives = { path = "../../primitives/thea", default-features = false }
-
+lazy_static = { version = "1.4.0", default-features = false, features = ["spin_no_std"], optional = true }
 
 [dev-dependencies]
 pallet-assets = { workspace = true, features = ["std"] }
@@ -47,6 +47,7 @@ runtime-benchmarks = [
   "frame-benchmarking/runtime-benchmarks",
   "frame-support/runtime-benchmarks",
   "frame-system/runtime-benchmarks",
+  "lazy_static",
 ]
 try-runtime = ["frame-support/try-runtime"]
 parachain = ["bls-primitives/parachain"]

pallets/thea-message-handler/Cargo.toml

@@ -0,0 +1,105 @@
+// This file is part of Polkadex.
+//
+// Copyright (c) 2022-2023 Polkadex oü.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+//! Benchmarking setup for pallet thea-message-handler
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+use frame_benchmarking::benchmarks;
+use frame_support::BoundedVec;
+use frame_system::RawOrigin;
+use parity_scale_codec::Decode;
+
+// Check if last event generated by pallet is the one we're expecting
+fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {
+	frame_system::Pallet::<T>::assert_last_event(generic_event.into());
+}
+
+fn produce_authorities<T: Config>(
+) -> BoundedVec<<T as crate::Config>::TheaId, <T as crate::Config>::MaxAuthorities> {
+	let mut authorities: BoundedVec<
+		<T as crate::Config>::TheaId,
+		<T as crate::Config>::MaxAuthorities,
+	> = BoundedVec::with_bounded_capacity(1);
+	let key = <T as crate::Config>::TheaId::decode(&mut PK.as_ref()).unwrap();
+	authorities.try_push(key).unwrap();
+	authorities
+}
+
+lazy_static::lazy_static! {
+	static ref M: Message = Message {
+		block_no: u64::MAX,
+		nonce: 1,
+		data: [255u8; 576].into(), //10 MB
+		network: 0u8,
+		is_key_change: false,
+		validator_set_id: 0,
+		validator_set_len: 1,
+	};
+}
+
+const SIG: [u8; 48] = [
+	149, 78, 11, 39, 209, 149, 209, 101, 74, 132, 154, 96, 46, 218, 114, 207, 95, 52, 40, 70, 44,
+	13, 7, 236, 224, 87, 192, 58, 99, 125, 175, 25, 35, 186, 6, 53, 246, 152, 164, 191, 169, 212,
+	133, 30, 143, 196, 55, 214,
+];
+
+const PK: [u8; 96] = [
+	128, 68, 92, 111, 149, 140, 246, 244, 137, 50, 23, 217, 197, 153, 235, 255, 228, 58, 108, 191,
+	41, 203, 237, 112, 203, 173, 118, 41, 92, 3, 165, 18, 200, 173, 125, 232, 182, 162, 9, 122, 13,
+	77, 41, 222, 92, 53, 60, 0, 22, 227, 136, 163, 35, 121, 27, 34, 208, 233, 191, 74, 36, 223, 17,
+	34, 79, 35, 164, 208, 138, 207, 171, 53, 254, 213, 17, 141, 35, 196, 81, 247, 20, 171, 33, 187,
+	152, 79, 229, 3, 121, 17, 242, 252, 147, 209, 50, 186,
+];
+
+benchmarks! {
+	insert_authorities {
+		let b in 0 .. u32::MAX;
+		let authorities = produce_authorities::<T>();
+		let b = b as u64;
+	}: _(RawOrigin::Root, authorities.clone(), b)
+	verify {
+		assert_eq!(<Authorities<T>>::get(b), authorities);
+		assert_eq!(<ValidatorSetId<T>>::get(), b);
+	}
+
+	incoming_message {
+		let bitmap = vec!(u128::MAX);
+		let authorities = produce_authorities::<T>();
+		<ValidatorSetId<T>>::put(0);
+	}: _(RawOrigin::None, bitmap, M.clone(), <T as crate::Config>::Signature::decode(&mut SIG.as_ref()).unwrap())
+	verify {
+		assert_last_event::<T>(Event::TheaMessageExecuted { message: M.clone() }.into());
+		assert_eq!(1, <IncomingNonce<T>>::get());
+		assert_eq!(M.clone(), <IncomingMessages<T>>::get(1).unwrap());
+	}
+
+	update_incoming_nonce {
+		let b in 1 .. u32::MAX;
+		let b = b as u64;
+	}: _(RawOrigin::Root, b)
+	verify {
+		assert_eq!(b, <IncomingNonce<T>>::get());
+	}
+}
+
+//#[cfg(test)]
+//use frame_benchmarking::impl_benchmark_test_suite;
+//
+//#[cfg(test)]
+//impl_benchmark_test_suite!(TheaMH, crate::mock::new_test_ext(), crate::mock::Test);

pallets/thea-message-handler/src/benchmarking.rs

@@ -27,18 +27,27 @@
 
 use frame_support::{pallet_prelude::*, traits::Get, BoundedVec, Parameter};
 use frame_system::pallet_prelude::*;
+pub use pallet::*;
 use parity_scale_codec::{Encode, MaxEncodedLen};
+use polkadex_primitives::utils::return_set_bits;
 use sp_runtime::{
 	traits::{BlockNumberProvider, Member},
 	transaction_validity::{InvalidTransaction, TransactionValidity, ValidTransaction},
 	RuntimeAppPublic, SaturatedConversion,
 };
 use sp_std::prelude::*;
-
-pub use pallet::*;
-use polkadex_primitives::utils::return_set_bits;
 use thea_primitives::{types::Message, Network, ValidatorSet};
 
+#[cfg(feature = "runtime-benchmarks")]
+mod benchmarking;
+
+pub trait WeightInfo {
+	fn insert_authorities(_b: u32) -> Weight;
+	fn incoming_message() -> Weight;
+	fn update_incoming_nonce(_b: u32) -> Weight;
+}
+pub mod weights;
+
 #[frame_support::pallet]
 pub mod pallet {
 	use super::*;
@@ -69,6 +78,9 @@ pub mod pallet {
 
 		/// Something that executes the payload
 		type Executor: thea_primitives::TheaIncomingExecutor;
+
+		/// Type representing the weight of this pallet
+		type WeightInfo: WeightInfo;
 	}
 
 	#[pallet::pallet]
@@ -157,7 +169,7 @@ pub mod pallet {
 	impl<T: Config> Pallet<T> {
 		/// Inserts a new authority set using sudo
 		#[pallet::call_index(0)]
-		#[pallet::weight(Weight::default())]
+		#[pallet::weight(<T as Config>::WeightInfo::insert_authorities(1))]
 		#[transactional]
 		pub fn insert_authorities(
 			origin: OriginFor<T>,
@@ -172,7 +184,7 @@ pub mod pallet {
 
 		/// Handles the verified incoming message
 		#[pallet::call_index(1)]
-		#[pallet::weight(Weight::default())]
+		#[pallet::weight(<T as Config>::WeightInfo::incoming_message())]
 		#[transactional]
 		pub fn incoming_message(
 			origin: OriginFor<T>,
@@ -220,7 +232,7 @@ pub mod pallet {
 
 		/// A governance endpoint to update last processed nonce
 		#[pallet::call_index(2)]
-		#[pallet::weight(Weight::default())]
+		#[pallet::weight(<T as Config>::WeightInfo::update_incoming_nonce(1))]
 		#[transactional]
 		pub fn update_incoming_nonce(origin: OriginFor<T>, nonce: u64) -> DispatchResult {
 			ensure_root(origin)?;

pallets/thea-message-handler/src/lib.rs

@@ -0,0 +1,96 @@
+// This file is part of Polkadex.
+//
+// Copyright (c) 2023 Polkadex oü.
+// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+//! Autogenerated weights for `thea_message_handler`
+//!
+//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
+//! DATE: 2023-06-15, STEPS: `100`, REPEAT: `200`, LOW RANGE: `[]`, HIGH RANGE: `[]`
+//! WORST CASE MAP SIZE: `1000000`
+//! HOSTNAME: `Ubuntu-2204-jammy-amd64-base`, CPU: `Intel(R) Core(TM) i7-7700 CPU @ 3.60GHz`
+//! EXECUTION: None, WASM-EXECUTION: Compiled, CHAIN: None, DB CACHE: 1024
+
+// Executed Command:
+// ./polkadex-node
+// benchmark
+// pallet
+// --pallet
+// thea-message-handler
+// --steps
+// 100
+// --repeat
+// 200
+// --extrinsic
+// *
+// --output
+// liquidity_weights.rs
+
+#![cfg_attr(rustfmt, rustfmt_skip)]
+#![allow(unused_parens)]
+#![allow(unused_imports)]
+#![allow(missing_docs)]
+
+use frame_support::{traits::Get, weights::Weight};
+use core::marker::PhantomData;
+
+/// Weight functions for `thea_message_handler`.
+pub struct WeightInfo<T>(PhantomData<T>);
+impl<T: frame_system::Config> crate::WeightInfo for WeightInfo<T> {
+	/// Storage: TheaMH Authorities (r:0 w:1)
+	/// Proof Skipped: TheaMH Authorities (max_values: None, max_size: None, mode: Measured)
+	/// Storage: TheaMH ValidatorSetId (r:0 w:1)
+	/// Proof Skipped: TheaMH ValidatorSetId (max_values: Some(1), max_size: None, mode: Measured)
+	/// The range of component `b` is `[0, 4294967295]`.
+	fn insert_authorities(_b: u32, ) -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `0`
+		//  Estimated: `0`
+		// Minimum execution time: 4_557_000 picoseconds.
+		Weight::from_parts(5_048_603, 0)
+			.saturating_add(Weight::from_parts(0, 0))
+			.saturating_add(T::DbWeight::get().writes(2))
+	}
+	/// Storage: TheaMH IncomingNonce (r:1 w:1)
+	/// Proof Skipped: TheaMH IncomingNonce (max_values: Some(1), max_size: None, mode: Measured)
+	/// Storage: TheaMH ValidatorSetId (r:1 w:0)
+	/// Proof Skipped: TheaMH ValidatorSetId (max_values: Some(1), max_size: None, mode: Measured)
+	/// Storage: TheaMH IncomingMessages (r:0 w:1)
+	/// Proof Skipped: TheaMH IncomingMessages (max_values: None, max_size: None, mode: Measured)
+	fn incoming_message() -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `108`
+		//  Estimated: `1593`
+		// Minimum execution time: 28_319_000 picoseconds.
+		Weight::from_parts(36_715_000, 0)
+			.saturating_add(Weight::from_parts(0, 1593))
+			.saturating_add(T::DbWeight::get().reads(2))
+			.saturating_add(T::DbWeight::get().writes(2))
+	}
+	/// Storage: TheaMH IncomingNonce (r:1 w:1)
+	/// Proof Skipped: TheaMH IncomingNonce (max_values: Some(1), max_size: None, mode: Measured)
+	/// The range of component `b` is `[1, 4294967295]`.
+	fn update_incoming_nonce(_b: u32, ) -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `76`
+		//  Estimated: `1561`
+		// Minimum execution time: 5_647_000 picoseconds.
+		Weight::from_parts(6_126_151, 0)
+			.saturating_add(Weight::from_parts(0, 1561))
+			.saturating_add(T::DbWeight::get().reads(1))
+			.saturating_add(T::DbWeight::get().writes(1))
+	}
+}

pallets/thea-message-handler/src/weights.rs

@@ -99,6 +99,7 @@ pallet-ocex-lmp = { path = "../pallets/ocex", default-features = false }
 # Thea
 thea = { path = "../pallets/thea", default-features = false }
 thea-executor = { path = "../pallets/thea-executor", default-features = false }
+thea-message-handler = { path = "../pallets/thea-message-handler", default-features = false, optional = true }
 
 # Liquidity Pallet
 liquidity = { path = "../pallets/liquidity", default-features = false }
@@ -184,6 +185,7 @@ std = [
   "thea-executor/std",
   "thea-primitives/std",
   "frame-try-runtime?/std",
+  "thea-message-handler?/std",
 ]
 runtime-benchmarks = [
   #theirs
@@ -201,6 +203,7 @@ runtime-benchmarks = [
   "pallet-rewards/runtime-benchmarks",
   "liquidity/runtime-benchmarks",
   "thea/runtime-benchmarks",
+  "thea-message-handler/runtime-benchmarks",
 ]
 
 try-runtime = [