Added receive_single_message_proof_with_dispatch benchmark (#1990)

* added receive_single_message_proof_with_dispatch benchmark

* clippy

Author: svyatonik

bin/millau/runtime/src/lib.rs

@@ -1007,7 +1007,7 @@ impl_runtime_apis! {
 						Runtime,
 						WithRialtoParachainsInstance,
 						WithRialtoParachainMessageBridge,
-					>(params)
+					>(params, xcm::v3::Junctions::Here)
 				}
 
 				fn prepare_message_delivery_proof(
@@ -1038,7 +1038,7 @@ impl_runtime_apis! {
 						Runtime,
 						RialtoGrandpaInstance,
 						WithRialtoMessageBridge,
-					>(params)
+					>(params, xcm::v3::Junctions::Here)
 				}
 
 				fn prepare_message_delivery_proof(

bin/millau/runtime/src/rialto_messages.rs

@@ -67,7 +67,7 @@ pub type FromRialtoMessageDispatch =
 		bp_millau::Millau,
 		bp_rialto::Rialto,
 		crate::xcm_config::OnMillauBlobDispatcher,
-		bridge_runtime_common::messages_xcm_extension::XcmRouterWeigher<crate::DbWeight>,
+		(),
 	>;
 
 /// Maximal outbound payload size of Millau -> Rialto messages.

bin/millau/runtime/src/rialto_parachain_messages.rs

@@ -62,7 +62,7 @@ pub type FromRialtoParachainMessageDispatch =
 		bp_millau::Millau,
 		bp_rialto::Rialto,
 		crate::xcm_config::OnMillauBlobDispatcher,
-		bridge_runtime_common::messages_xcm_extension::XcmRouterWeigher<crate::DbWeight>,
+		(),
 	>;
 
 /// Maximal outbound payload size of Millau -> RialtoParachain messages.

bin/millau/runtime/src/xcm_config.rs

@@ -233,20 +233,16 @@ impl ExportXcm for ToRialtoOrRialtoParachainSwitchExporter {
 mod tests {
 	use super::*;
 	use crate::{
-		rialto_messages::FromRialtoMessageDispatch,
-		rialto_parachain_messages::FromRialtoParachainMessageDispatch, DbWeight,
-		WithRialtoMessagesInstance, WithRialtoParachainMessagesInstance,
+		rialto_messages::FromRialtoMessageDispatch, WithRialtoMessagesInstance,
+		WithRialtoParachainMessagesInstance,
 	};
 	use bp_messages::{
 		target_chain::{DispatchMessage, DispatchMessageData, MessageDispatch},
 		LaneId, MessageKey,
 	};
-	use bridge_runtime_common::messages_xcm_extension::{
-		XcmBlobMessageDispatchResult, XcmRouterWeigher,
-	};
+	use bridge_runtime_common::messages_xcm_extension::XcmBlobMessageDispatchResult;
 	use codec::Encode;
 	use pallet_bridge_messages::OutboundLanes;
-	use sp_core::Get;
 	use xcm_executor::XcmExecutor;
 
 	fn new_test_ext() -> sp_io::TestExternalities {
@@ -347,10 +343,7 @@ mod tests {
 
 	#[test]
 	fn xcm_messages_from_rialto_are_dispatched() {
-		let mut incoming_message = prepare_inbound_bridge_message();
-
-		let dispatch_weight = FromRialtoMessageDispatch::dispatch_weight(&mut incoming_message);
-		assert_eq!(dispatch_weight, XcmRouterWeigher::<DbWeight>::get());
+		let incoming_message = prepare_inbound_bridge_message();
 
 		// we care only about handing message to the XCM dispatcher, so we don't care about its
 		// actual dispatch
@@ -364,11 +357,7 @@ mod tests {
 
 	#[test]
 	fn xcm_messages_from_rialto_parachain_are_dispatched() {
-		let mut incoming_message = prepare_inbound_bridge_message();
-
-		let dispatch_weight =
-			FromRialtoParachainMessageDispatch::dispatch_weight(&mut incoming_message);
-		assert_eq!(dispatch_weight, XcmRouterWeigher::<DbWeight>::get());
+		let incoming_message = prepare_inbound_bridge_message();
 
 		// we care only about handing message to the XCM dispatcher, so we don't care about its
 		// actual dispatch

bin/rialto-parachain/runtime/src/lib.rs

@@ -844,12 +844,10 @@ mod tests {
 		LaneId, MessageKey,
 	};
 	use bridge_runtime_common::{
-		integrity::check_additional_signed,
-		messages_xcm_extension::{XcmBlobMessageDispatchResult, XcmRouterWeigher},
+		integrity::check_additional_signed, messages_xcm_extension::XcmBlobMessageDispatchResult,
 	};
 	use codec::Encode;
 	use pallet_bridge_messages::OutboundLanes;
-	use sp_core::Get;
 	use sp_runtime::generic::Era;
 	use xcm_executor::XcmExecutor;
 
@@ -914,10 +912,7 @@ mod tests {
 	#[test]
 	fn xcm_messages_from_millau_are_dispatched() {
 		new_test_ext().execute_with(|| {
-			let mut incoming_message = prepare_inbound_bridge_message();
-
-			let dispatch_weight = FromMillauMessageDispatch::dispatch_weight(&mut incoming_message);
-			assert_eq!(dispatch_weight, XcmRouterWeigher::<()>::get());
+			let incoming_message = prepare_inbound_bridge_message();
 
 			// we care only about handing message to the XCM dispatcher, so we don't care about its
 			// actual dispatch

bin/rialto-parachain/runtime/src/millau_messages.rs

@@ -63,7 +63,7 @@ pub type FromMillauMessageDispatch =
 		bp_rialto_parachain::RialtoParachain,
 		bp_millau::Millau,
 		crate::OnRialtoParachainBlobDispatcher,
-		bridge_runtime_common::messages_xcm_extension::XcmRouterWeigher<()>,
+		(),
 	>;
 
 /// Messages proof for Millau -> RialtoParachain messages.

bin/rialto/runtime/src/millau_messages.rs

@@ -60,7 +60,7 @@ pub type FromMillauMessageDispatch =
 		bp_rialto::Rialto,
 		bp_millau::Millau,
 		crate::xcm_config::OnRialtoBlobDispatcher,
-		bridge_runtime_common::messages_xcm_extension::XcmRouterWeigher<crate::DbWeight>,
+		(),
 	>;
 
 /// Messages proof for Millau -> Rialto messages.

bin/rialto/runtime/src/xcm_config.rs

@@ -189,18 +189,15 @@ mod tests {
 	use super::*;
 	use crate::{
 		millau_messages::{FromMillauMessageDispatch, XCM_LANE},
-		DbWeight, WithMillauMessagesInstance,
+		WithMillauMessagesInstance,
 	};
 	use bp_messages::{
 		target_chain::{DispatchMessage, DispatchMessageData, MessageDispatch},
 		LaneId, MessageKey,
 	};
-	use bridge_runtime_common::messages_xcm_extension::{
-		XcmBlobMessageDispatchResult, XcmRouterWeigher,
-	};
+	use bridge_runtime_common::messages_xcm_extension::XcmBlobMessageDispatchResult;
 	use codec::Encode;
 	use pallet_bridge_messages::OutboundLanes;
-	use sp_core::Get;
 	use xcm_executor::XcmExecutor;
 
 	fn new_test_ext() -> sp_io::TestExternalities {
@@ -263,10 +260,7 @@ mod tests {
 
 	#[test]
 	fn xcm_messages_from_millau_are_dispatched() {
-		let mut incoming_message = prepare_inbound_bridge_message();
-
-		let dispatch_weight = FromMillauMessageDispatch::dispatch_weight(&mut incoming_message);
-		assert_eq!(dispatch_weight, XcmRouterWeigher::<DbWeight>::get());
+		let incoming_message = prepare_inbound_bridge_message();
 
 		// we care only about handing message to the XCM dispatcher, so we don't care about its
 		// actual dispatch

bin/runtime-common/src/messages_benchmarking.rs

@@ -40,6 +40,39 @@ use pallet_bridge_messages::benchmarking::{MessageDeliveryProofParams, MessagePr
 use sp_runtime::traits::{Header, Zero};
 use sp_std::prelude::*;
 use sp_trie::{trie_types::TrieDBMutBuilderV1, LayoutV1, MemoryDB, TrieMut};
+use xcm::v3::prelude::*;
+
+/// Prepare inbound bridge message according to given message proof parameters.
+fn prepare_inbound_message(
+	params: &MessageProofParams,
+	destination: InteriorMultiLocation,
+) -> Vec<u8> {
+	// we only care about **this** message size when message proof needs to be `Minimal`
+	let expected_size = match params.size {
+		StorageProofSize::Minimal(size) => size as usize,
+		_ => 0,
+	};
+
+	// if we don't need a correct message, then we may just return some random blob
+	if !params.is_successful_dispatch_expected {
+		return vec![0u8; expected_size]
+	}
+
+	// else let's prepare successful message. For XCM bridge hubs, it is the message that
+	// will be pushed further to some XCM queue (XCMP/UMP)
+	let location = xcm::VersionedInteriorMultiLocation::V3(destination);
+	let location_encoded_size = location.encoded_size();
+
+	// we don't need to be super-precise with `expected_size` here
+	let xcm_size = expected_size.saturating_sub(location_encoded_size);
+	let xcm = xcm::VersionedXcm::<()>::V3(vec![Instruction::ClearOrigin; xcm_size].into());
+
+	// this is the `BridgeMessage` from polkadot xcm builder, but it has no constructor
+	// or public fields, so just tuple
+	// (double encoding, because `.encode()` is called on original Xcm BLOB when it is pushed
+	// to the storage)
+	(location, xcm).encode().encode()
+}
 
 /// Prepare proof of messages for the `receive_messages_proof` call.
 ///
@@ -51,6 +84,7 @@ use sp_trie::{trie_types::TrieDBMutBuilderV1, LayoutV1, MemoryDB, TrieMut};
 /// function.
 pub fn prepare_message_proof_from_grandpa_chain<R, FI, B>(
 	params: MessageProofParams,
+	message_destination: InteriorMultiLocation,
 ) -> (FromBridgedChainMessagesProof<HashOf<BridgedChain<B>>>, Weight)
 where
 	R: pallet_bridge_grandpa::Config<FI, BridgedChain = UnderlyingChainOf<BridgedChain<B>>>,
@@ -61,12 +95,9 @@ where
 	let (state_root, storage_proof) = prepare_messages_storage_proof::<B>(
 		params.lane,
 		params.message_nonces.clone(),
-		params.outbound_lane_data,
+		params.outbound_lane_data.clone(),
 		params.size,
-		match params.size {
-			StorageProofSize::Minimal(ref size) => vec![0u8; *size as _],
-			_ => vec![],
-		},
+		prepare_inbound_message(&params, message_destination),
 		encode_all_messages,
 		encode_lane_data,
 	);
@@ -82,7 +113,7 @@ where
 			nonces_start: *params.message_nonces.start(),
 			nonces_end: *params.message_nonces.end(),
 		},
-		Weight::zero(),
+		Weight::MAX / 1000,
 	)
 }
 
@@ -96,6 +127,7 @@ where
 /// `prepare_message_proof_from_grandpa_chain` function.
 pub fn prepare_message_proof_from_parachain<R, PI, B>(
 	params: MessageProofParams,
+	message_destination: InteriorMultiLocation,
 ) -> (FromBridgedChainMessagesProof<HashOf<BridgedChain<B>>>, Weight)
 where
 	R: pallet_bridge_parachains::Config<PI>,
@@ -107,12 +139,9 @@ where
 	let (state_root, storage_proof) = prepare_messages_storage_proof::<B>(
 		params.lane,
 		params.message_nonces.clone(),
-		params.outbound_lane_data,
+		params.outbound_lane_data.clone(),
 		params.size,
-		match params.size {
-			StorageProofSize::Minimal(ref size) => vec![0u8; *size as _],
-			_ => vec![],
-		},
+		prepare_inbound_message(&params, message_destination),
 		encode_all_messages,
 		encode_lane_data,
 	);
@@ -129,7 +158,7 @@ where
 			nonces_start: *params.message_nonces.start(),
 			nonces_end: *params.message_nonces.end(),
 		},
-		Weight::zero(),
+		Weight::MAX / 1000,
 	)
 }
 

bin/runtime-common/src/messages_xcm_extension.rs

@@ -28,43 +28,15 @@ use bp_messages::{
 };
 use bp_runtime::{messages::MessageDispatchResult, AccountIdOf, Chain};
 use codec::{Decode, Encode};
-use frame_support::{
-	dispatch::Weight, traits::Get, weights::RuntimeDbWeight, CloneNoBound, EqNoBound,
-	PartialEqNoBound,
-};
+use frame_support::{dispatch::Weight, CloneNoBound, EqNoBound, PartialEqNoBound};
+use pallet_bridge_messages::WeightInfoExt as MessagesPalletWeights;
 use scale_info::TypeInfo;
-use sp_std::marker::PhantomData;
+use sp_runtime::SaturatedConversion;
 use xcm_builder::{DispatchBlob, DispatchBlobError, HaulBlob, HaulBlobError};
 
 /// Plain "XCM" payload, which we transfer through bridge
 pub type XcmAsPlainPayload = sp_std::prelude::Vec<u8>;
 
-// TODO: below are just rough estimations. Other things also happen there (including hashing and so
-// on). Shall we do some benchmarking??? TODO: add proof_size component here
-// https://github.com/paritytech/parity-bridges-common/issues/1986
-
-/// Simple weigher for incoming XCM dispatch at **bridge hubs** to use with
-/// `XcmBlobMessageDispatch`.
-///
-/// By our design, message at bridge hub is simply pushed to some other queue. This implementation
-/// is for this case only. If your runtime performs some other actions with incoming XCM messages,
-/// you shall use your own implementation.
-///
-/// If message is redirected to the relay chain, then `ParentAsUmp` is used and it roughly does
-/// 1 db read and 1 db write (in its `send_upward_message` method).
-///
-/// If message is redirected to some sibling parachain, then `XcmpQueue` is used and
-/// it roughly does 2 db reads and 2 db writes (in its `SendXcm` implementation).
-///
-/// The difference is not that big, so let's choose maximal.
-pub struct XcmRouterWeigher<T>(PhantomData<T>);
-
-impl<T: Get<RuntimeDbWeight>> Get<Weight> for XcmRouterWeigher<T> {
-	fn get() -> Weight {
-		T::get().reads_writes(2, 2)
-	}
-}
-
 /// Message dispatch result type for single message
 #[derive(CloneNoBound, EqNoBound, PartialEqNoBound, Encode, Decode, Debug, TypeInfo)]
 pub enum XcmBlobMessageDispatchResult {
@@ -74,38 +46,35 @@ pub enum XcmBlobMessageDispatchResult {
 }
 
 /// [`XcmBlobMessageDispatch`] is responsible for dispatching received messages
-pub struct XcmBlobMessageDispatch<
-	SourceBridgeHubChain,
-	TargetBridgeHubChain,
-	DispatchBlob,
-	DispatchBlobWeigher,
-> {
+pub struct XcmBlobMessageDispatch<SourceBridgeHubChain, TargetBridgeHubChain, DispatchBlob, Weights>
+{
 	_marker: sp_std::marker::PhantomData<(
 		SourceBridgeHubChain,
 		TargetBridgeHubChain,
 		DispatchBlob,
-		DispatchBlobWeigher,
+		Weights,
 	)>,
 }
 
 impl<
 		SourceBridgeHubChain: Chain,
 		TargetBridgeHubChain: Chain,
 		BlobDispatcher: DispatchBlob,
-		DispatchBlobWeigher: Get<Weight>,
+		Weights: MessagesPalletWeights,
 	> MessageDispatch<AccountIdOf<SourceBridgeHubChain>>
-	for XcmBlobMessageDispatch<
-		SourceBridgeHubChain,
-		TargetBridgeHubChain,
-		BlobDispatcher,
-		DispatchBlobWeigher,
-	>
+	for XcmBlobMessageDispatch<SourceBridgeHubChain, TargetBridgeHubChain, BlobDispatcher, Weights>
 {
 	type DispatchPayload = XcmAsPlainPayload;
 	type DispatchLevelResult = XcmBlobMessageDispatchResult;
 
-	fn dispatch_weight(_message: &mut DispatchMessage<Self::DispatchPayload>) -> Weight {
-		DispatchBlobWeigher::get()
+	fn dispatch_weight(message: &mut DispatchMessage<Self::DispatchPayload>) -> Weight {
+		match message.data.payload {
+			Ok(ref payload) => {
+				let payload_size = payload.encoded_size().saturated_into();
+				Weights::message_dispatch_weight(payload_size)
+			},
+			Err(_) => Weight::zero(),
+		}
 	}
 
 	fn dispatch(
@@ -122,7 +91,6 @@ impl<
 					message.key.nonce
 				);
 				return MessageDispatchResult {
-					// TODO:check-parameter - setup uspent_weight? https://github.com/paritytech/polkadot/issues/6629
 					unspent_weight: Weight::zero(),
 					dispatch_level_result: XcmBlobMessageDispatchResult::InvalidPayload,
 				}
@@ -158,11 +126,7 @@ impl<
 				XcmBlobMessageDispatchResult::NotDispatched(e)
 			},
 		};
-		MessageDispatchResult {
-			// TODO:check-parameter - setup uspent_weight?  https://github.com/paritytech/polkadot/issues/6629
-			unspent_weight: Weight::zero(),
-			dispatch_level_result,
-		}
+		MessageDispatchResult { unspent_weight: Weight::zero(), dispatch_level_result }
 	}
 }