Add claim_assets extrinsic to pallet-xcm (#3403)

If an XCM execution fails or ends with leftover assets, these will be trapped. In order to claim them, a custom XCM has to be executed, with the `ClaimAsset` instruction. However, arbitrary XCM execution is not allowed everywhere yet and XCM itself is still not easy enough to use for users out there with trapped assets. This new extrinsic in `pallet-xcm` will allow these users to easily claim their assets, without concerning themselves with writing arbitrary XCMs. Part of fixing https://github.com/paritytech/polkadot-sdk/issues/3495 --------- Co-authored-by: command-bot <> Co-authored-by: Adrian Catangiu <adrian@parity.io>
2026-06-14 06:21:11 +00:00 · 2024-03-01 08:31:48 +01:00
parent c0e52a9ed6
commit 650886683d
29 changed files with 1521 additions and 1063 deletions
@@ -2336,6 +2336,13 @@ sp_api::impl_runtime_apis! {
 						dest
 					)
 				}
+
+				fn get_asset() -> Asset {
+					Asset {
+						id: AssetId(Location::here()),
+						fun: Fungible(ExistentialDeposit::get()),
+					}
+				}
 			}
 			impl pallet_xcm_benchmarks::Config for Runtime {
 				type XcmConfig = XcmConfig;
@@ -16,10 +16,10 @@

 //! Autogenerated weights for `pallet_xcm`
 //!
-//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 4.0.0-dev
-//! DATE: 2023-11-07, STEPS: `50`, REPEAT: `20`, LOW RANGE: `[]`, HIGH RANGE: `[]`
+//! THIS FILE WAS AUTO-GENERATED USING THE SUBSTRATE BENCHMARK CLI VERSION 32.0.0
+//! DATE: 2024-02-20, STEPS: `50`, REPEAT: `20`, LOW RANGE: `[]`, HIGH RANGE: `[]`
 //! WORST CASE MAP SIZE: `1000000`
-//! HOSTNAME: `runner-yprdrvc7-project-674-concurrent-0`, CPU: `Intel(R) Xeon(R) CPU @ 2.60GHz`
+//! HOSTNAME: `runner-bn-ce5rx-project-674-concurrent-0`, CPU: `Intel(R) Xeon(R) CPU @ 2.60GHz`
 //! WASM-EXECUTION: `Compiled`, CHAIN: `Some("rococo-dev")`, DB CACHE: 1024

 // Executed Command:
@@ -48,10 +48,6 @@ use core::marker::PhantomData;
 /// Weight functions for `pallet_xcm`.
 pub struct WeightInfo<T>(PhantomData<T>);
 impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
-	fn transfer_assets() -> Weight {
-		// TODO: run benchmarks
-		Weight::zero()
-	}
 	/// Storage: `Dmp::DeliveryFeeFactor` (r:1 w:0)
 	/// Proof: `Dmp::DeliveryFeeFactor` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	/// Storage: `XcmPallet::SupportedVersion` (r:1 w:0)
@@ -62,36 +58,80 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn send() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `142`
-		//  Estimated: `3607`
-		// Minimum execution time: 27_328_000 picoseconds.
-		Weight::from_parts(27_976_000, 0)
-			.saturating_add(Weight::from_parts(0, 3607))
+		//  Measured:  `180`
+		//  Estimated: `3645`
+		// Minimum execution time: 25_043_000 picoseconds.
+		Weight::from_parts(25_682_000, 0)
+			.saturating_add(Weight::from_parts(0, 3645))
 			.saturating_add(T::DbWeight::get().reads(4))
 			.saturating_add(T::DbWeight::get().writes(2))
 	}
+	/// Storage: `System::Account` (r:1 w:1)
+	/// Proof: `System::Account` (`max_values`: None, `max_size`: Some(128), added: 2603, mode: `MaxEncodedLen`)
+	/// Storage: `Dmp::DeliveryFeeFactor` (r:1 w:0)
+	/// Proof: `Dmp::DeliveryFeeFactor` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `XcmPallet::SupportedVersion` (r:1 w:0)
+	/// Proof: `XcmPallet::SupportedVersion` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueues` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueues` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueueHeads` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn teleport_assets() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `0`
-		//  Estimated: `0`
-		// Minimum execution time: 16_280_000 picoseconds.
-		Weight::from_parts(16_904_000, 0)
-			.saturating_add(Weight::from_parts(0, 0))
+		//  Measured:  `180`
+		//  Estimated: `3645`
+		// Minimum execution time: 107_570_000 picoseconds.
+		Weight::from_parts(109_878_000, 0)
+			.saturating_add(Weight::from_parts(0, 3645))
+			.saturating_add(T::DbWeight::get().reads(5))
+			.saturating_add(T::DbWeight::get().writes(3))
 	}
+	/// Storage: `System::Account` (r:1 w:1)
+	/// Proof: `System::Account` (`max_values`: None, `max_size`: Some(128), added: 2603, mode: `MaxEncodedLen`)
+	/// Storage: `Dmp::DeliveryFeeFactor` (r:1 w:0)
+	/// Proof: `Dmp::DeliveryFeeFactor` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `XcmPallet::SupportedVersion` (r:1 w:0)
+	/// Proof: `XcmPallet::SupportedVersion` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueues` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueues` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueueHeads` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn reserve_transfer_assets() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `0`
-		//  Estimated: `0`
-		// Minimum execution time: 15_869_000 picoseconds.
-		Weight::from_parts(16_264_000, 0)
-			.saturating_add(Weight::from_parts(0, 0))
+		//  Measured:  `232`
+		//  Estimated: `3697`
+		// Minimum execution time: 106_341_000 picoseconds.
+		Weight::from_parts(109_135_000, 0)
+			.saturating_add(Weight::from_parts(0, 3697))
+			.saturating_add(T::DbWeight::get().reads(5))
+			.saturating_add(T::DbWeight::get().writes(3))
+	}
+	/// Storage: `System::Account` (r:1 w:1)
+	/// Proof: `System::Account` (`max_values`: None, `max_size`: Some(128), added: 2603, mode: `MaxEncodedLen`)
+	/// Storage: `Dmp::DeliveryFeeFactor` (r:1 w:0)
+	/// Proof: `Dmp::DeliveryFeeFactor` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `XcmPallet::SupportedVersion` (r:1 w:0)
+	/// Proof: `XcmPallet::SupportedVersion` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueues` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueues` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	/// Storage: `Dmp::DownwardMessageQueueHeads` (r:1 w:1)
+	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	fn transfer_assets() -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `180`
+		//  Estimated: `3645`
+		// Minimum execution time: 108_372_000 picoseconds.
+		Weight::from_parts(112_890_000, 0)
+			.saturating_add(Weight::from_parts(0, 3645))
+			.saturating_add(T::DbWeight::get().reads(5))
+			.saturating_add(T::DbWeight::get().writes(3))
 	}
 	fn execute() -> Weight {
 		// Proof Size summary in bytes:
 		//  Measured:  `0`
 		//  Estimated: `0`
-		// Minimum execution time: 6_923_000 picoseconds.
-		Weight::from_parts(7_432_000, 0)
+		// Minimum execution time: 6_957_000 picoseconds.
+		Weight::from_parts(7_417_000, 0)
 			.saturating_add(Weight::from_parts(0, 0))
 	}
 	/// Storage: `XcmPallet::SupportedVersion` (r:0 w:1)
@@ -100,8 +140,8 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 		// Proof Size summary in bytes:
 		//  Measured:  `0`
 		//  Estimated: `0`
-		// Minimum execution time: 7_333_000 picoseconds.
-		Weight::from_parts(7_566_000, 0)
+		// Minimum execution time: 7_053_000 picoseconds.
+		Weight::from_parts(7_462_000, 0)
 			.saturating_add(Weight::from_parts(0, 0))
 			.saturating_add(T::DbWeight::get().writes(1))
 	}
@@ -109,8 +149,8 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 		// Proof Size summary in bytes:
 		//  Measured:  `0`
 		//  Estimated: `0`
-		// Minimum execution time: 2_219_000 picoseconds.
-		Weight::from_parts(2_375_000, 0)
+		// Minimum execution time: 1_918_000 picoseconds.
+		Weight::from_parts(2_037_000, 0)
 			.saturating_add(Weight::from_parts(0, 0))
 	}
 	/// Storage: `XcmPallet::VersionNotifiers` (r:1 w:1)
@@ -129,11 +169,11 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 	/// Proof: `XcmPallet::Queries` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn force_subscribe_version_notify() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `142`
-		//  Estimated: `3607`
-		// Minimum execution time: 30_650_000 picoseconds.
-		Weight::from_parts(31_683_000, 0)
-			.saturating_add(Weight::from_parts(0, 3607))
+		//  Measured:  `180`
+		//  Estimated: `3645`
+		// Minimum execution time: 30_417_000 picoseconds.
+		Weight::from_parts(31_191_000, 0)
+			.saturating_add(Weight::from_parts(0, 3645))
 			.saturating_add(T::DbWeight::get().reads(6))
 			.saturating_add(T::DbWeight::get().writes(5))
 	}
@@ -151,11 +191,11 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 	/// Proof: `XcmPallet::Queries` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn force_unsubscribe_version_notify() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `322`
-		//  Estimated: `3787`
-		// Minimum execution time: 37_666_000 picoseconds.
-		Weight::from_parts(38_920_000, 0)
-			.saturating_add(Weight::from_parts(0, 3787))
+		//  Measured:  `360`
+		//  Estimated: `3825`
+		// Minimum execution time: 36_666_000 picoseconds.
+		Weight::from_parts(37_779_000, 0)
+			.saturating_add(Weight::from_parts(0, 3825))
 			.saturating_add(T::DbWeight::get().reads(5))
 			.saturating_add(T::DbWeight::get().writes(4))
 	}
@@ -165,45 +205,45 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 		// Proof Size summary in bytes:
 		//  Measured:  `0`
 		//  Estimated: `0`
-		// Minimum execution time: 2_244_000 picoseconds.
-		Weight::from_parts(2_425_000, 0)
+		// Minimum execution time: 1_869_000 picoseconds.
+		Weight::from_parts(2_003_000, 0)
 			.saturating_add(Weight::from_parts(0, 0))
 			.saturating_add(T::DbWeight::get().writes(1))
 	}
-	/// Storage: `XcmPallet::SupportedVersion` (r:4 w:2)
+	/// Storage: `XcmPallet::SupportedVersion` (r:5 w:2)
 	/// Proof: `XcmPallet::SupportedVersion` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn migrate_supported_version() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `26`
-		//  Estimated: `10916`
-		// Minimum execution time: 14_710_000 picoseconds.
-		Weight::from_parts(15_156_000, 0)
-			.saturating_add(Weight::from_parts(0, 10916))
-			.saturating_add(T::DbWeight::get().reads(4))
+		//  Measured:  `22`
+		//  Estimated: `13387`
+		// Minimum execution time: 16_188_000 picoseconds.
+		Weight::from_parts(16_435_000, 0)
+			.saturating_add(Weight::from_parts(0, 13387))
+			.saturating_add(T::DbWeight::get().reads(5))
 			.saturating_add(T::DbWeight::get().writes(2))
 	}
-	/// Storage: `XcmPallet::VersionNotifiers` (r:4 w:2)
+	/// Storage: `XcmPallet::VersionNotifiers` (r:5 w:2)
 	/// Proof: `XcmPallet::VersionNotifiers` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn migrate_version_notifiers() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `30`
-		//  Estimated: `10920`
-		// Minimum execution time: 14_630_000 picoseconds.
-		Weight::from_parts(15_290_000, 0)
-			.saturating_add(Weight::from_parts(0, 10920))
-			.saturating_add(T::DbWeight::get().reads(4))
+		//  Measured:  `26`
+		//  Estimated: `13391`
+		// Minimum execution time: 16_431_000 picoseconds.
+		Weight::from_parts(16_935_000, 0)
+			.saturating_add(Weight::from_parts(0, 13391))
+			.saturating_add(T::DbWeight::get().reads(5))
 			.saturating_add(T::DbWeight::get().writes(2))
 	}
-	/// Storage: `XcmPallet::VersionNotifyTargets` (r:5 w:0)
+	/// Storage: `XcmPallet::VersionNotifyTargets` (r:6 w:0)
 	/// Proof: `XcmPallet::VersionNotifyTargets` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn already_notified_target() -> Weight {
 		// Proof Size summary in bytes:
 		//  Measured:  `40`
-		//  Estimated: `13405`
-		// Minimum execution time: 16_686_000 picoseconds.
-		Weight::from_parts(17_332_000, 0)
-			.saturating_add(Weight::from_parts(0, 13405))
-			.saturating_add(T::DbWeight::get().reads(5))
+		//  Estimated: `15880`
+		// Minimum execution time: 18_460_000 picoseconds.
+		Weight::from_parts(18_885_000, 0)
+			.saturating_add(Weight::from_parts(0, 15880))
+			.saturating_add(T::DbWeight::get().reads(6))
 	}
 	/// Storage: `XcmPallet::VersionNotifyTargets` (r:2 w:1)
 	/// Proof: `XcmPallet::VersionNotifyTargets` (`max_values`: None, `max_size`: None, mode: `Measured`)
@@ -217,38 +257,38 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn notify_current_targets() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `178`
-		//  Estimated: `6118`
-		// Minimum execution time: 30_180_000 picoseconds.
-		Weight::from_parts(31_351_000, 0)
-			.saturating_add(Weight::from_parts(0, 6118))
+		//  Measured:  `216`
+		//  Estimated: `6156`
+		// Minimum execution time: 29_623_000 picoseconds.
+		Weight::from_parts(30_661_000, 0)
+			.saturating_add(Weight::from_parts(0, 6156))
 			.saturating_add(T::DbWeight::get().reads(6))
 			.saturating_add(T::DbWeight::get().writes(3))
 	}
-	/// Storage: `XcmPallet::VersionNotifyTargets` (r:3 w:0)
+	/// Storage: `XcmPallet::VersionNotifyTargets` (r:4 w:0)
 	/// Proof: `XcmPallet::VersionNotifyTargets` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn notify_target_migration_fail() -> Weight {
 		// Proof Size summary in bytes:
 		//  Measured:  `69`
-		//  Estimated: `8484`
-		// Minimum execution time: 9_624_000 picoseconds.
-		Weight::from_parts(10_029_000, 0)
-			.saturating_add(Weight::from_parts(0, 8484))
-			.saturating_add(T::DbWeight::get().reads(3))
+		//  Estimated: `10959`
+		// Minimum execution time: 12_043_000 picoseconds.
+		Weight::from_parts(12_360_000, 0)
+			.saturating_add(Weight::from_parts(0, 10959))
+			.saturating_add(T::DbWeight::get().reads(4))
 	}
-	/// Storage: `XcmPallet::VersionNotifyTargets` (r:4 w:2)
+	/// Storage: `XcmPallet::VersionNotifyTargets` (r:5 w:2)
 	/// Proof: `XcmPallet::VersionNotifyTargets` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn migrate_version_notify_targets() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `37`
-		//  Estimated: `10927`
-		// Minimum execution time: 15_139_000 picoseconds.
-		Weight::from_parts(15_575_000, 0)
-			.saturating_add(Weight::from_parts(0, 10927))
-			.saturating_add(T::DbWeight::get().reads(4))
+		//  Measured:  `33`
+		//  Estimated: `13398`
+		// Minimum execution time: 16_511_000 picoseconds.
+		Weight::from_parts(17_011_000, 0)
+			.saturating_add(Weight::from_parts(0, 13398))
+			.saturating_add(T::DbWeight::get().reads(5))
 			.saturating_add(T::DbWeight::get().writes(2))
 	}
-	/// Storage: `XcmPallet::VersionNotifyTargets` (r:4 w:2)
+	/// Storage: `XcmPallet::VersionNotifyTargets` (r:5 w:2)
 	/// Proof: `XcmPallet::VersionNotifyTargets` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	/// Storage: `Dmp::DeliveryFeeFactor` (r:1 w:0)
 	/// Proof: `Dmp::DeliveryFeeFactor` (`max_values`: None, `max_size`: None, mode: `Measured`)
@@ -260,12 +300,12 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 	/// Proof: `Dmp::DownwardMessageQueueHeads` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	fn migrate_and_notify_old_targets() -> Weight {
 		// Proof Size summary in bytes:
-		//  Measured:  `182`
-		//  Estimated: `11072`
-		// Minimum execution time: 37_871_000 picoseconds.
-		Weight::from_parts(38_940_000, 0)
-			.saturating_add(Weight::from_parts(0, 11072))
-			.saturating_add(T::DbWeight::get().reads(8))
+		//  Measured:  `216`
+		//  Estimated: `13581`
+		// Minimum execution time: 39_041_000 picoseconds.
+		Weight::from_parts(39_883_000, 0)
+			.saturating_add(Weight::from_parts(0, 13581))
+			.saturating_add(T::DbWeight::get().reads(9))
 			.saturating_add(T::DbWeight::get().writes(4))
 	}
 	/// Storage: `XcmPallet::QueryCounter` (r:1 w:1)
@@ -276,8 +316,8 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 		// Proof Size summary in bytes:
 		//  Measured:  `0`
 		//  Estimated: `1485`
-		// Minimum execution time: 2_732_000 picoseconds.
-		Weight::from_parts(2_892_000, 0)
+		// Minimum execution time: 2_030_000 picoseconds.
+		Weight::from_parts(2_150_000, 0)
 			.saturating_add(Weight::from_parts(0, 1485))
 			.saturating_add(T::DbWeight::get().reads(1))
 			.saturating_add(T::DbWeight::get().writes(2))
@@ -288,10 +328,22 @@ impl<T: frame_system::Config> pallet_xcm::WeightInfo for WeightInfo<T> {
 		// Proof Size summary in bytes:
 		//  Measured:  `7576`
 		//  Estimated: `11041`
-		// Minimum execution time: 23_813_000 picoseconds.
-		Weight::from_parts(24_201_000, 0)
+		// Minimum execution time: 22_615_000 picoseconds.
+		Weight::from_parts(23_008_000, 0)
 			.saturating_add(Weight::from_parts(0, 11041))
 			.saturating_add(T::DbWeight::get().reads(1))
 			.saturating_add(T::DbWeight::get().writes(1))
 	}
+	/// Storage: `XcmPallet::AssetTraps` (r:1 w:1)
+	/// Proof: `XcmPallet::AssetTraps` (`max_values`: None, `max_size`: None, mode: `Measured`)
+	fn claim_assets() -> Weight {
+		// Proof Size summary in bytes:
+		//  Measured:  `23`
+		//  Estimated: `3488`
+		// Minimum execution time: 34_438_000 picoseconds.
+		Weight::from_parts(35_514_000, 0)
+			.saturating_add(Weight::from_parts(0, 3488))
+			.saturating_add(T::DbWeight::get().reads(1))
+			.saturating_add(T::DbWeight::get().writes(1))
+	}
 }