Allows to customize how calls are dispatched from XCM (#5657)

nanocryk · web-flow · commit 119a494672ca · 2022-06-29T10:27:50.000+08:00
* CallDispatcher trait

* fmt

* unused import

* fix test-runtime

* remove JustDispatch type

* fix typo in test-runtime

* missing CallDispatcher

* more missing CallDispatcher
diff --git a/bridges/bin/rialto-parachain/runtime/src/lib.rs b/bridges/bin/rialto-parachain/runtime/src/lib.rs
@@ -385,6 +385,7 @@ impl Config for XcmConfig {
 	type AssetExchanger = ();
 	type AssetClaims = PolkadotXcm;
 	type SubscriptionService = PolkadotXcm;
+	type CallDispatcher = Call;
 }
 
 /// No local origins on this chain are allowed to dispatch XCM sends/executions.
diff --git a/runtime/kusama/src/xcm_config.rs b/runtime/kusama/src/xcm_config.rs
@@ -161,6 +161,7 @@ impl xcm_executor::Config for XcmConfig {
 	// No bridges yet...
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 parameter_types! {
diff --git a/runtime/polkadot/src/xcm_config.rs b/runtime/polkadot/src/xcm_config.rs
@@ -158,6 +158,7 @@ impl xcm_executor::Config for XcmConfig {
 	// No bridges yet...
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 parameter_types! {
diff --git a/runtime/rococo/src/xcm_config.rs b/runtime/rococo/src/xcm_config.rs
@@ -144,6 +144,7 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 parameter_types! {
diff --git a/runtime/test-runtime/src/xcm_config.rs b/runtime/test-runtime/src/xcm_config.rs
@@ -103,4 +103,5 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = super::Call;
 }
diff --git a/runtime/westend/src/xcm_config.rs b/runtime/westend/src/xcm_config.rs
@@ -123,6 +123,7 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 /// Type to convert an `Origin` type value into a `MultiLocation` value which represents an interior location
diff --git a/xcm/pallet-xcm-benchmarks/src/fungible/mock.rs b/xcm/pallet-xcm-benchmarks/src/fungible/mock.rs
@@ -153,6 +153,7 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 impl crate::Config for Test {
diff --git a/xcm/pallet-xcm-benchmarks/src/generic/mock.rs b/xcm/pallet-xcm-benchmarks/src/generic/mock.rs
@@ -129,6 +129,7 @@ impl xcm_executor::Config for XcmConfig {
 	// No bridges yet...
 	type MessageExporter = ();
 	type UniversalAliases = TestUniversalAliases;
+	type CallDispatcher = Call;
 }
 
 impl crate::Config for Test {
diff --git a/xcm/pallet-xcm/src/mock.rs b/xcm/pallet-xcm/src/mock.rs
@@ -300,6 +300,7 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 pub type LocalOriginToLocation = SignedToAccountId32<Origin, AccountId, AnyNetwork>;
diff --git a/xcm/xcm-builder/src/tests/mock.rs b/xcm/xcm-builder/src/tests/mock.rs
@@ -608,6 +608,7 @@ impl Config for TestConfig {
 	type FeeManager = TestFeeManager;
 	type UniversalAliases = TestUniversalAliases;
 	type MessageExporter = TestMessageExporter;
+	type CallDispatcher = TestCall;
 }
 
 pub fn fungible_multi_asset(location: MultiLocation, amount: u128) -> MultiAsset {
diff --git a/xcm/xcm-builder/tests/mock/mod.rs b/xcm/xcm-builder/tests/mock/mod.rs
@@ -195,6 +195,7 @@ impl xcm_executor::Config for XcmConfig {
 	type FeeManager = ();
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 pub type LocalOriginToLocation = SignedToAccountId32<Origin, AccountId, KusamaNetwork>;
diff --git a/xcm/xcm-executor/src/config.rs b/xcm/xcm-executor/src/config.rs
@@ -15,8 +15,9 @@
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
 use crate::traits::{
-	AssetExchange, AssetLock, ClaimAssets, ConvertOrigin, DropAssets, ExportXcm, FeeManager,
-	OnResponse, ShouldExecute, TransactAsset, VersionChangeNotifier, WeightBounds, WeightTrader,
+	AssetExchange, AssetLock, CallDispatcher, ClaimAssets, ConvertOrigin, DropAssets, ExportXcm,
+	FeeManager, OnResponse, ShouldExecute, TransactAsset, VersionChangeNotifier, WeightBounds,
+	WeightTrader,
 };
 use frame_support::{
 	dispatch::{Dispatchable, Parameter},
@@ -94,4 +95,10 @@ pub trait Config {
 	/// The origin locations and specific universal junctions to which they are allowed to elevate
 	/// themselves.
 	type UniversalAliases: Contains<(MultiLocation, Junction)>;
+
+	/// The call dispatcher used by XCM.
+	///
+	/// XCM will use this to dispatch any calls. When no special call dispatcher is required,
+	/// this can be set to the same type as `Self::Call`.
+	type CallDispatcher: CallDispatcher<Self::Call>;
 }
diff --git a/xcm/xcm-executor/src/lib.rs b/xcm/xcm-executor/src/lib.rs
@@ -17,7 +17,7 @@
 #![cfg_attr(not(feature = "std"), no_std)]
 
 use frame_support::{
-	dispatch::{Dispatchable, Weight},
+	dispatch::Weight,
 	ensure,
 	traits::{Contains, ContainsPair, Get, PalletsInfoAccess},
 	weights::GetDispatchInfo,
@@ -30,8 +30,8 @@ use xcm::latest::prelude::*;
 
 pub mod traits;
 use traits::{
-	validate_export, AssetExchange, AssetLock, ClaimAssets, ConvertOrigin, DropAssets, Enact,
-	ExportXcm, FeeManager, FeeReason, OnResponse, ShouldExecute, TransactAsset,
+	validate_export, AssetExchange, AssetLock, CallDispatcher, ClaimAssets, ConvertOrigin,
+	DropAssets, Enact, ExportXcm, FeeManager, FeeReason, OnResponse, ShouldExecute, TransactAsset,
 	VersionChangeNotifier, WeightBounds, WeightTrader,
 };
 
@@ -512,16 +512,17 @@ impl<Config: config::Config> XcmExecutor<Config> {
 					.map_err(|_| XcmError::BadOrigin)?;
 				let weight = message_call.get_dispatch_info().weight;
 				ensure!(weight <= require_weight_at_most, XcmError::MaxWeightInvalid);
-				let maybe_actual_weight = match message_call.dispatch(dispatch_origin) {
-					Ok(post_info) => {
-						self.transact_status = MaybeErrorCode::Success;
-						post_info.actual_weight
-					},
-					Err(error_and_info) => {
-						self.transact_status = error_and_info.error.encode().into();
-						error_and_info.post_info.actual_weight
-					},
-				};
+				let maybe_actual_weight =
+					match Config::CallDispatcher::dispatch(message_call, dispatch_origin) {
+						Ok(post_info) => {
+							self.transact_status = MaybeErrorCode::Success;
+							post_info.actual_weight
+						},
+						Err(error_and_info) => {
+							self.transact_status = error_and_info.error.encode().into();
+							error_and_info.post_info.actual_weight
+						},
+					};
 				let actual_weight = maybe_actual_weight.unwrap_or(weight);
 				let surplus = weight.saturating_sub(actual_weight);
 				// We assume that the `Config::Weigher` will counts the `require_weight_at_most`
diff --git a/xcm/xcm-executor/src/traits/conversion.rs b/xcm/xcm-executor/src/traits/conversion.rs
@@ -15,6 +15,7 @@
 // along with Polkadot.  If not, see <http://www.gnu.org/licenses/>.
 
 use parity_scale_codec::{Decode, Encode};
+use sp_runtime::{traits::Dispatchable, DispatchErrorWithPostInfo};
 use sp_std::{borrow::Borrow, prelude::*, result::Result};
 use xcm::latest::prelude::*;
 
@@ -203,3 +204,24 @@ impl<O> ConvertOrigin<O> for Tuple {
 		Err(origin)
 	}
 }
+
+/// Defines how a call is dispatched with given origin.
+/// Allows to customize call dispatch, such as adapting the origin based on the call
+/// or modifying the call.
+pub trait CallDispatcher<Call: Dispatchable> {
+	fn dispatch(
+		call: Call,
+		origin: Call::Origin,
+	) -> Result<Call::PostInfo, DispatchErrorWithPostInfo<Call::PostInfo>>;
+}
+
+// We implement it for every calls so they can dispatch themselves
+// (without any change).
+impl<Call: Dispatchable> CallDispatcher<Call> for Call {
+	fn dispatch(
+		call: Call,
+		origin: Call::Origin,
+	) -> Result<Call::PostInfo, DispatchErrorWithPostInfo<Call::PostInfo>> {
+		call.dispatch(origin)
+	}
+}
diff --git a/xcm/xcm-executor/src/traits/mod.rs b/xcm/xcm-executor/src/traits/mod.rs
@@ -17,7 +17,7 @@
 //! Various traits used in configuring the executor.
 
 mod conversion;
-pub use conversion::{Convert, ConvertOrigin, Decoded, Encoded, Identity, JustTry};
+pub use conversion::{CallDispatcher, Convert, ConvertOrigin, Decoded, Encoded, Identity, JustTry};
 mod drop_assets;
 pub use drop_assets::{ClaimAssets, DropAssets};
 mod asset_lock;
diff --git a/xcm/xcm-simulator/example/src/parachain.rs b/xcm/xcm-simulator/example/src/parachain.rs
@@ -237,6 +237,7 @@ impl Config for XcmConfig {
 	type MaxAssetsIntoHolding = MaxAssetsIntoHolding;
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 #[frame_support::pallet]
diff --git a/xcm/xcm-simulator/example/src/relay_chain.rs b/xcm/xcm-simulator/example/src/relay_chain.rs
@@ -181,6 +181,7 @@ impl Config for XcmConfig {
 	type MaxAssetsIntoHolding = MaxAssetsIntoHolding;
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 pub type LocalOriginToLocation = SignedToAccountId32<Origin, AccountId, RelayNetwork>;
diff --git a/xcm/xcm-simulator/fuzzer/src/parachain.rs b/xcm/xcm-simulator/fuzzer/src/parachain.rs
@@ -155,6 +155,7 @@ impl Config for XcmConfig {
 	type MaxAssetsIntoHolding = MaxAssetsIntoHolding;
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 #[frame_support::pallet]
diff --git a/xcm/xcm-simulator/fuzzer/src/relay_chain.rs b/xcm/xcm-simulator/fuzzer/src/relay_chain.rs
@@ -147,6 +147,7 @@ impl Config for XcmConfig {
 	type MaxAssetsIntoHolding = MaxAssetsIntoHolding;
 	type MessageExporter = ();
 	type UniversalAliases = Nothing;
+	type CallDispatcher = Call;
 }
 
 pub type LocalOriginToLocation = SignedToAccountId32<Origin, AccountId, ThisNetwork>;

Original file line number	Diff line number	Diff line change
`@@ -385,6 +385,7 @@ impl Config for XcmConfig {`
`385`	`385`	`type AssetExchanger = ();`
`386`	`386`	`type AssetClaims = PolkadotXcm;`
`387`	`387`	`type SubscriptionService = PolkadotXcm;`
	`388`	`+ type CallDispatcher = Call;`
`388`	`389`	`}`
`389`	`390`
`390`	`391`	`/// No local origins on this chain are allowed to dispatch XCM sends/executions.`
Original file line number	Diff line number	Diff line change
`@@ -161,6 +161,7 @@ impl xcm_executor::Config for XcmConfig {`
`161`	`161`	`// No bridges yet...`
`162`	`162`	`type MessageExporter = ();`
`163`	`163`	`type UniversalAliases = Nothing;`
	`164`	`+ type CallDispatcher = Call;`
`164`	`165`	`}`
`165`	`166`
`166`	`167`	`parameter_types! {`
Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,7 @@ impl xcm_executor::Config for XcmConfig {`
`158`	`158`	`// No bridges yet...`
`159`	`159`	`type MessageExporter = ();`
`160`	`160`	`type UniversalAliases = Nothing;`
	`161`	`+ type CallDispatcher = Call;`
`161`	`162`	`}`
`162`	`163`
`163`	`164`	`parameter_types! {`
Original file line number	Diff line number	Diff line change
`@@ -144,6 +144,7 @@ impl xcm_executor::Config for XcmConfig {`
`144`	`144`	`type FeeManager = ();`
`145`	`145`	`type MessageExporter = ();`
`146`	`146`	`type UniversalAliases = Nothing;`
	`147`	`+ type CallDispatcher = Call;`
`147`	`148`	`}`
`148`	`149`
`149`	`150`	`parameter_types! {`
Original file line number	Diff line number	Diff line change
`@@ -103,4 +103,5 @@ impl xcm_executor::Config for XcmConfig {`
`103`	`103`	`type FeeManager = ();`
`104`	`104`	`type MessageExporter = ();`
`105`	`105`	`type UniversalAliases = Nothing;`
	`106`	`+ type CallDispatcher = super::Call;`
`106`	`107`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ impl xcm_executor::Config for XcmConfig {`
`123`	`123`	`type FeeManager = ();`
`124`	`124`	`type MessageExporter = ();`
`125`	`125`	`type UniversalAliases = Nothing;`
	`126`	`+ type CallDispatcher = Call;`
`126`	`127`	`}`
`127`	`128`
`128`	`129`	/// Type to convert an `Origin` type value into a `MultiLocation` value which represents an interior location
Original file line number	Diff line number	Diff line change
`@@ -153,6 +153,7 @@ impl xcm_executor::Config for XcmConfig {`
`153`	`153`	`type FeeManager = ();`
`154`	`154`	`type MessageExporter = ();`
`155`	`155`	`type UniversalAliases = Nothing;`
	`156`	`+ type CallDispatcher = Call;`
`156`	`157`	`}`
`157`	`158`
`158`	`159`	`impl crate::Config for Test {`
Original file line number	Diff line number	Diff line change
`@@ -129,6 +129,7 @@ impl xcm_executor::Config for XcmConfig {`
`129`	`129`	`// No bridges yet...`
`130`	`130`	`type MessageExporter = ();`
`131`	`131`	`type UniversalAliases = TestUniversalAliases;`
	`132`	`+ type CallDispatcher = Call;`
`132`	`133`	`}`
`133`	`134`
`134`	`135`	`impl crate::Config for Test {`
Original file line number	Diff line number	Diff line change
`@@ -300,6 +300,7 @@ impl xcm_executor::Config for XcmConfig {`
`300`	`300`	`type FeeManager = ();`
`301`	`301`	`type MessageExporter = ();`
`302`	`302`	`type UniversalAliases = Nothing;`
	`303`	`+ type CallDispatcher = Call;`
`303`	`304`	`}`
`304`	`305`
`305`	`306`	`pub type LocalOriginToLocation = SignedToAccountId32<Origin, AccountId, AnyNetwork>;`
Original file line number	Diff line number	Diff line change
`@@ -608,6 +608,7 @@ impl Config for TestConfig {`
`608`	`608`	`type FeeManager = TestFeeManager;`
`609`	`609`	`type UniversalAliases = TestUniversalAliases;`
`610`	`610`	`type MessageExporter = TestMessageExporter;`
	`611`	`+ type CallDispatcher = TestCall;`
`611`	`612`	`}`
`612`	`613`
`613`	`614`	`pub fn fungible_multi_asset(location: MultiLocation, amount: u128) -> MultiAsset {`