Add EventEmitter to XCM Executor

bridges/modules/xcm-bridge-hub/src/mock.rs

@@ -239,6 +239,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = ();
+	type XcmEventEmitter = ();
 	type AssetTransactor = ();
 	type OriginConverter = BridgeHubLocationXcmOriginAsRoot<RuntimeOrigin>;
 	type IsReserve = ();

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

@@ -360,6 +360,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// Asset Hub trusts only particular, pre-configured bridged locations from a different consensus

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

@@ -380,6 +380,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// Asset Hub trusts only particular, pre-configured bridged locations from a different consensus

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

@@ -178,6 +178,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// BridgeHub does not recognize a reserve location for any asset. Users must teleport Native

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

@@ -175,6 +175,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// BridgeHub does not recognize a reserve location for any asset. Users must teleport Native

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

@@ -194,6 +194,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// Collectives does not recognize a reserve location for any asset. Users must teleport WND

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

@@ -178,6 +178,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	type IsReserve = NativeAsset;

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

@@ -187,6 +187,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// Coretime chain does not recognize a reserve location for any asset. Users must teleport ROC

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

@@ -201,6 +201,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// Coretime chain does not recognize a reserve location for any asset. Users must teleport ROC

cumulus/parachains/runtimes/glutton/glutton-westend/src/xcm_config.rs

@@ -65,6 +65,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = (); // sending XCM not supported
+	type XcmEventEmitter = ();
 	type AssetTransactor = (); // balances not supported
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	type IsReserve = (); // balances not supported

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

@@ -191,6 +191,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// People chain does not recognize a reserve location for any asset. Users must teleport ROC

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

@@ -205,6 +205,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;
 	// People does not recognize a reserve location for any asset. Users must teleport WND

cumulus/parachains/runtimes/testing/penpal/src/xcm_config.rs

@@ -364,6 +364,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	// How to withdraw and deposit an asset.
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;

cumulus/parachains/runtimes/testing/rococo-parachain/src/lib.rs

@@ -472,6 +472,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = PolkadotXcm;
 	// How to withdraw and deposit an asset.
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = XcmOriginToTransactDispatchOrigin;

polkadot/runtime/rococo/src/xcm_config.rs

@@ -191,6 +191,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = XcmPallet;
 	type AssetTransactor = LocalAssetTransactor;
 	type OriginConverter = LocalOriginConverter;
 	type IsReserve = ();

polkadot/runtime/test-runtime/src/xcm_config.rs

@@ -130,6 +130,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = super::RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = super::Xcm;
 	type AssetTransactor = DummyAssetTransactor;
 	type OriginConverter = OriginConverter;
 	type IsReserve = ();

polkadot/runtime/westend/src/xcm_config.rs

@@ -193,6 +193,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = XcmPallet;
 	type AssetTransactor = LocalAssetTransactor;
 	type OriginConverter = LocalOriginConverter;
 	type IsReserve = ();

polkadot/xcm/docs/src/cookbook/relay_token_transactor/parachain/xcm_config.rs

@@ -114,6 +114,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = ();
+	type XcmEventEmitter = ();
 	type AssetTransactor = asset_transactor::AssetTransactor;
 	type OriginConverter = ();
 	// The declaration of which Locations are reserves for which Assets.

polkadot/xcm/docs/src/cookbook/relay_token_transactor/relay_chain/xcm_config.rs

@@ -87,6 +87,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = ();
+	type XcmEventEmitter = ();
 	type AssetTransactor = asset_transactor::AssetTransactor;
 	type OriginConverter = ();
 	// We don't need to recognize anyone as a reserve

polkadot/xcm/pallet-xcm-benchmarks/src/fungible/mock.rs

@@ -94,6 +94,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = EnsureDecodableXcm<DevNull>;
+	type XcmEventEmitter = ();
 	type AssetTransactor = AssetTransactor;
 	type OriginConverter = ();
 	type IsReserve = TrustedReserves;

polkadot/xcm/pallet-xcm-benchmarks/src/generic/mock.rs

@@ -83,6 +83,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = EnsureDecodableXcm<DevNull>;
+	type XcmEventEmitter = ();
 	type AssetTransactor = NoAssetTransactor;
 	type OriginConverter = AlwaysSignedByDefault<RuntimeOrigin>;
 	type IsReserve = AllAssetLocationsPass;

polkadot/xcm/pallet-xcm/src/lib.rs

@@ -61,7 +61,7 @@ use xcm_builder::{
 use xcm_executor::{
 	traits::{
 		AssetTransferError, CheckSuspension, ClaimAssets, ConvertLocation, ConvertOrigin,
-		DropAssets, MatchesFungible, OnResponse, Properties, QueryHandler, QueryResponseStatus,
+		DropAssets, EventEmitter, MatchesFungible, OnResponse, Properties, QueryHandler, QueryResponseStatus,
 		RecordXcm, TransactAsset, TransferType, VersionChangeNotifier, WeightBounds,
 		XcmAssetTransfers,
 	},
@@ -402,13 +402,42 @@ pub mod pallet {
 		}
 	}
 
+	impl<T: Config> EventEmitter for Pallet<T> {
+		fn emit_sent_event(
+		origin: Location,
+		destination: Location,
+		message_id: XcmHash,
+		) {
+			Self::deposit_event(Event::Sent { origin, destination, message: Xcm::default(), message_id });
+		}
+
+		fn emit_sent_failure_event(
+			origin: Location,
+			destination: Location,
+			error: SendError,
+		) {
+            Self::deposit_event(Event::SentFailed { origin, destination, error });
+        }
+
+		fn emit_process_failure_event(
+			origin: Location,
+			error: XcmError,
+		) {
+			Self::deposit_event(Event::ProcessXcmError { origin, error });
+		}
+	}
+
 	#[pallet::event]
 	#[pallet::generate_deposit(pub(super) fn deposit_event)]
 	pub enum Event<T: Config> {
 		/// Execution of an XCM message was attempted.
 		Attempted { outcome: xcm::latest::Outcome },
 		/// A XCM message was sent.
 		Sent { origin: Location, destination: Location, message: Xcm<()>, message_id: XcmHash },
+		/// A XCM message failed to be sent.
+		SentFailed { origin: Location, destination: Location, error: SendError },
+		/// Process XCM message failed.
+		ProcessXcmError { origin: Location, error: XcmError },
 		/// Query response received which does not match a registered query. This may be because a
 		/// matching query was never registered, it may be because it is a duplicate response, or
 		/// because the query timed out.

polkadot/xcm/pallet-xcm/src/mock.rs

@@ -480,6 +480,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = XcmRouter;
+	type XcmEventEmitter = XcmPallet;
 	type AssetTransactor = AssetTransactors;
 	type OriginConverter = LocalOriginConverter;
 	type IsReserve = (Case<TrustedForeign>, Case<TrustedUsdc>, Case<TrustedPaidParaForeign>);

polkadot/xcm/pallet-xcm/src/tests/mod.rs

@@ -1456,3 +1456,55 @@ fn record_xcm_works() {
 		assert_eq!(RecordedXcm::<Test>::get(), Some(message.into()));
 	});
 }
+
+#[test]
+fn execute_initiate_transfer_and_check_sent_event() {
+	let balances = vec![(ALICE, INITIAL_BALANCE)];
+	new_test_ext_with_balances(balances).execute_with(|| {
+		let dest: Location = Location::new(1, [Junction::AccountId32 { network: None, id: BOB.into() }]);
+		let assets: Asset = (Parent, SEND_AMOUNT).into();
+
+		let message = Xcm(vec![
+			InitiateReserveWithdraw {
+				assets: Wild(All),
+				reserve: Parent.into(),
+				xcm: Xcm(vec![
+					BuyExecution { fees: assets.clone(), weight_limit: Unlimited },
+					DepositAsset { assets: All.into(), beneficiary: dest.clone() },
+				]),
+			},
+		]);
+
+		assert_ok!(XcmPallet::execute(
+            RuntimeOrigin::signed(ALICE),
+            Box::new(VersionedXcm::from(message.clone())),
+            BaseXcmWeight::get() * 3,
+        ));
+
+		let sender: Location = AccountId32 { network: None, id: ALICE.into() }.into();
+		let expected_message = Xcm(vec![
+					WithdrawAsset(Assets::new()),
+					ClearOrigin,
+					BuyExecution { fees: assets.clone(), weight_limit: Unlimited },
+					DepositAsset { assets: All.into(), beneficiary: dest.clone() },
+				]);
+		let id = fake_message_hash(&expected_message);
+
+		assert_eq!(
+			last_events(2),
+			vec![
+				RuntimeEvent::XcmPallet(crate::Event::Sent {
+					origin: sender,
+					destination: Parent.into(),
+					message: expected_message,
+					message_id: id,
+				}),
+				RuntimeEvent::XcmPallet(crate::Event::Attempted {
+					outcome: Outcome::Complete {
+						used: Weight::from_parts(1000, 1000)
+					}
+				})
+			]
+		);
+	});
+}

polkadot/xcm/xcm-builder/src/asset_exchange/single_asset_adapter/mock.rs

@@ -218,6 +218,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = ();
+	type XcmEventEmitter = ();
 	type AssetTransactor = FungibleTransactor;
 	type OriginConverter = ();
 	type IsReserve = ();

polkadot/xcm/xcm-builder/src/tests/pay/mock.rs

@@ -203,6 +203,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = TestMessageSender;
+	type XcmEventEmitter = XcmPallet;
 	type AssetTransactor = LocalAssetsTransactor;
 	type OriginConverter = OriginConverter;
 	type IsReserve = ();

polkadot/xcm/xcm-builder/tests/mock/mod.rs

@@ -168,6 +168,7 @@ pub struct XcmConfig;
 impl xcm_executor::Config for XcmConfig {
 	type RuntimeCall = RuntimeCall;
 	type XcmSender = TestXcmRouter;
+	type XcmEventEmitter = XcmPallet;
 	type AssetTransactor = LocalAssetTransactor;
 	type OriginConverter = LocalOriginConverter;
 	type IsReserve = ();

polkadot/xcm/xcm-executor/src/config.rs

@@ -15,7 +15,7 @@
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
 use crate::traits::{
-	AssetExchange, AssetLock, CallDispatcher, ClaimAssets, ConvertOrigin, DropAssets, ExportXcm,
+	AssetExchange, AssetLock, CallDispatcher, ClaimAssets, ConvertOrigin, DropAssets, EventEmitter, ExportXcm,
 	FeeManager, HandleHrmpChannelAccepted, HandleHrmpChannelClosing,
 	HandleHrmpNewChannelOpenRequest, OnResponse, ProcessTransaction, RecordXcm, ShouldExecute,
 	TransactAsset, VersionChangeNotifier, WeightBounds, WeightTrader,
@@ -39,6 +39,9 @@ pub trait Config {
 	/// the executor.
 	type XcmSender: SendXcm;
 
+	/// How to emit XCM events.
+	type XcmEventEmitter: EventEmitter;
+
 	/// How to withdraw and deposit an asset.
 	type AssetTransactor: TransactAsset;
 

polkadot/xcm/xcm-executor/src/lib.rs

@@ -34,7 +34,7 @@ use xcm::latest::{prelude::*, AssetTransferFilter};
 pub mod traits;
 use traits::{
 	validate_export, AssetExchange, AssetLock, CallDispatcher, ClaimAssets, ConvertOrigin,
-	DropAssets, Enact, ExportXcm, FeeManager, FeeReason, HandleHrmpChannelAccepted,
+	DropAssets, Enact, ExportXcm, EventEmitter, FeeManager, FeeReason, HandleHrmpChannelAccepted,
 	HandleHrmpChannelClosing, HandleHrmpNewChannelOpenRequest, OnResponse, ProcessTransaction,
 	Properties, ShouldExecute, TransactAsset, VersionChangeNotifier, WeightBounds, WeightTrader,
 	XcmAssetTransfers,
@@ -427,9 +427,27 @@ impl<Config: config::Config> XcmExecutor<Config> {
 			reason = ?reason,
 			"Sending msg",
 		);
-		let (ticket, fee) = validate_send::<Config::XcmSender>(dest, msg)?;
+		let (ticket, fee) = validate_send::<Config::XcmSender>(dest.clone(), msg)?;
 		self.take_fee(fee, reason)?;
-		Config::XcmSender::deliver(ticket).map_err(Into::into)
+		match Config::XcmSender::deliver(ticket) {
+			Ok(message_id) => {
+				Config::XcmEventEmitter::emit_sent_event(
+					self.original_origin.clone(),
+					dest,
+					message_id.clone(),
+				);
+				Ok(message_id)
+			},
+			Err(e) => {
+				tracing::error!(target: "xcm::send", ?e, "XCM failed to deliver with error");
+				Config::XcmEventEmitter::emit_sent_failure_event(
+					self.original_origin.clone(),
+					dest,
+					e.clone(),
+				);
+				Err(e.into())
+			},
+		}
 	}
 
 	/// Remove the registered error handler and return it. Do not refund its weight.
@@ -813,6 +831,7 @@ impl<Config: config::Config> XcmExecutor<Config> {
 						self.process_instruction(instr)
 					});
 					if let Err(e) = inst_res {
+						Config::XcmEventEmitter::emit_process_failure_event(self.original_origin.clone(), e.clone());
 						tracing::trace!(target: "xcm::execute", "!!! ERROR: {:?}", e);
 						*r = Err(ExecutorError {
 							index: i as u32,