Added generic DispatchLevelResult to the MessageDispatchResult (#1670)

* Added generic DispatchLevelResult to the MessageDispatchResult

* Removed unnecessery `Clone + Decode + sp_std::fmt::Debug + Eq` + clippy

bridges/primitives/messages/src/lib.rs

@@ -30,8 +30,8 @@ pub mod source_chain;
 pub mod storage_keys;
 pub mod target_chain;
 
-// Weight is reexported to avoid additional frame-support dependencies in related crates.
 use bp_runtime::messages::MessageDispatchResult;
+// Weight is reexported to avoid additional frame-support dependencies in related crates.
 pub use frame_support::weights::Weight;
 
 /// Messages pallet operating mode.
@@ -212,21 +212,24 @@ pub struct UnrewardedRelayer<RelayerId> {
 
 /// Received messages with their dispatch result.
 #[derive(Clone, Default, Encode, Decode, RuntimeDebug, PartialEq, Eq, TypeInfo)]
-pub struct ReceivedMessages<Result> {
+pub struct ReceivedMessages<DispatchLevelResult> {
 	/// Id of the lane which is receiving messages.
 	pub lane: LaneId,
 	/// Result of messages which we tried to dispatch
-	pub receive_results: Vec<(MessageNonce, Result)>,
+	pub receive_results: Vec<(MessageNonce, ReceivalResult<DispatchLevelResult>)>,
 	/// Messages which were skipped and never dispatched
 	pub skipped_for_not_enough_weight: Vec<MessageNonce>,
 }
 
-impl<Result> ReceivedMessages<Result> {
-	pub fn new(lane: LaneId, receive_results: Vec<(MessageNonce, Result)>) -> Self {
+impl<DispatchLevelResult> ReceivedMessages<DispatchLevelResult> {
+	pub fn new(
+		lane: LaneId,
+		receive_results: Vec<(MessageNonce, ReceivalResult<DispatchLevelResult>)>,
+	) -> Self {
 		ReceivedMessages { lane, receive_results, skipped_for_not_enough_weight: Vec::new() }
 	}
 
-	pub fn push(&mut self, message: MessageNonce, result: Result) {
+	pub fn push(&mut self, message: MessageNonce, result: ReceivalResult<DispatchLevelResult>) {
 		self.receive_results.push((message, result));
 	}
 
@@ -237,12 +240,12 @@ impl<Result> ReceivedMessages<Result> {
 
 /// Result of single message receival.
 #[derive(RuntimeDebug, Encode, Decode, PartialEq, Eq, Clone, TypeInfo)]
-pub enum ReceivalResult {
+pub enum ReceivalResult<DispatchLevelResult> {
 	/// Message has been received and dispatched. Note that we don't care whether dispatch has
 	/// been successful or not - in both case message falls into this category.
 	///
 	/// The message dispatch result is also returned.
-	Dispatched(MessageDispatchResult),
+	Dispatched(MessageDispatchResult<DispatchLevelResult>),
 	/// Message has invalid nonce and lane has rejected to accept this message.
 	InvalidNonce,
 	/// There are too many unrewarded relayer entries at the lane.

bridges/primitives/messages/src/target_chain.rs

@@ -89,6 +89,9 @@ pub trait MessageDispatch<AccountId> {
 	/// (opaque `MessagePayload` used in delivery and this `DispatchPayload` used in dispatch).
 	type DispatchPayload: Decode;
 
+	/// Fine-grained result of single message dispatch (for better diagnostic purposes)
+	type DispatchLevelResult: Clone + Decode + sp_std::fmt::Debug + Eq;
+
 	/// Estimate dispatch weight.
 	///
 	/// This function must return correct upper bound of dispatch weight. The return value
@@ -106,7 +109,7 @@ pub trait MessageDispatch<AccountId> {
 	fn dispatch(
 		relayer_account: &AccountId,
 		message: DispatchMessage<Self::DispatchPayload>,
-	) -> MessageDispatchResult;
+	) -> MessageDispatchResult<Self::DispatchLevelResult>;
 }
 
 impl<Message> Default for ProvedLaneMessages<Message> {
@@ -149,15 +152,20 @@ impl SourceHeaderChain for ForbidInboundMessages {
 
 impl<AccountId> MessageDispatch<AccountId> for ForbidInboundMessages {
 	type DispatchPayload = ();
+	type DispatchLevelResult = ();
 
 	fn dispatch_weight(_message: &mut DispatchMessage<Self::DispatchPayload>) -> Weight {
 		Weight::MAX
 	}
 
-	fn dispatch(_: &AccountId, _: DispatchMessage<Self::DispatchPayload>) -> MessageDispatchResult {
+	fn dispatch(
+		_: &AccountId,
+		_: DispatchMessage<Self::DispatchPayload>,
+	) -> MessageDispatchResult<Self::DispatchLevelResult> {
 		MessageDispatchResult {
 			unspent_weight: Weight::zero(),
 			dispatch_fee_paid_during_dispatch: false,
+			dispatch_level_result: (),
 		}
 	}
 }