[AHM] Vesting

pallets/ah-migrator/Cargo.toml

@@ -29,6 +29,7 @@ pallet-referenda = { workspace = true }
 pallet-scheduler = { workspace = true }
 pallet-staking = { workspace = true }
 pallet-state-trie-migration = { workspace = true }
+pallet-vesting = { workspace = true }
 pallet-treasury = { workspace = true }
 polkadot-parachain-primitives = { workspace = true }
 polkadot-runtime-common = { workspace = true }
@@ -69,6 +70,7 @@ std = [
 	"pallet-staking/std",
 	"pallet-state-trie-migration/std",
 	"pallet-treasury/std",
+	"pallet-vesting/std",
 	"polkadot-parachain-primitives/std",
 	"polkadot-runtime-common/std",
 	"runtime-parachains/std",
@@ -101,6 +103,7 @@ runtime-benchmarks = [
 	"pallet-staking/runtime-benchmarks",
 	"pallet-state-trie-migration/runtime-benchmarks",
 	"pallet-treasury/runtime-benchmarks",
+	"pallet-vesting/runtime-benchmarks",
 	"polkadot-parachain-primitives/runtime-benchmarks",
 	"polkadot-runtime-common/runtime-benchmarks",
 	"runtime-parachains/runtime-benchmarks",
@@ -126,6 +129,7 @@ try-runtime = [
 	"pallet-staking/try-runtime",
 	"pallet-state-trie-migration/try-runtime",
 	"pallet-treasury/try-runtime",
+	"pallet-vesting/try-runtime",
 	"polkadot-runtime-common/try-runtime",
 	"runtime-parachains/try-runtime",
 	"sp-runtime/try-runtime",

pallets/ah-migrator/src/benchmarking.rs

@@ -0,0 +1,118 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! To run these benchmarks, you will need a modified version of `frame-omni-bencher` that can load
+//! snapshots of the relay and asset hub. You can find it on branch `oty-ahm-omni-bencher` of the
+//! SDK. Install it with
+//! `cargo install --path substrate/utils/frame/omni-bencher --profile production`
+//!
+//! ```bash
+//! frame-omni-bencher v1 benchmark pallet --runtime=target/release/wbuild/asset-hub-polkadot-runtime/asset_hub_polkadot_runtime.wasm --pallet "pallet-ah-migrator" --extrinsic "" --snap=ah-polkadot.snap --rc-snap=polkadot.snap
+//! ```
+
+use crate::*;
+use core::str::FromStr;
+use cumulus_primitives_core::{AggregateMessageOrigin, InboundDownwardMessage};
+use frame_benchmarking::v2::*;
+use frame_support::{traits::EnqueueMessage, weights::WeightMeter};
+use frame_system::RawOrigin;
+use pallet_rc_migrator::types::PalletMigration;
+use xcm::VersionedXcm;
+
+#[benchmarks(where T: pallet_balances::Config)]
+mod benchmarks {
+	use super::*;
+
+	#[benchmark]
+	fn receive_multisigs() {
+		verify_snapshot::<T>();
+		let (messages, _cursor) = relay_snapshot(|| {
+			unwrap_no_debug(pallet_rc_migrator::multisig::MultisigMigrator::<T>::migrate_out_many(
+				None,
+				&mut WeightMeter::new(),
+			))
+		});
+
+		#[extrinsic_call]
+		_(RawOrigin::Root, messages);
+
+		// TODO assert event
+	}
+
+	#[benchmark]
+	fn receive_nom_pools_messages_pool_members() {
+		verify_snapshot::<T>();
+		let (messages, _cursor) = relay_snapshot(|| {
+			unwrap_no_debug(pallet_rc_migrator::staking::nom_pools::NomPoolsMigrator::<T>::migrate_many(
+				None,
+				&mut WeightMeter::new(),
+			))
+		});
+
+		#[extrinsic_call]
+		_(RawOrigin::Root, messages);
+
+		// TODO assert event
+	}
+}
+
+/// Unwrap something that does not implement Debug. Otherwise we would need to require
+/// `pallet_rc_migrator::Config` on out runtime `T`.
+pub fn unwrap_no_debug<T, E>(result: Result<T, E>) -> T {
+	match result {
+		Ok(t) => t,
+		Err(_) => panic!("unwrap_no_debug"),
+	}
+}
+
+/// Check that Oliver's account has some balance on AH and Relay.
+///
+/// This serves as sanity check that the snapshots were loaded correctly.
+fn verify_snapshot<T: Config>() {
+	let raw_acc: [u8; 32] =
+		hex::decode("6c9e3102dd2c24274667d416e07570ebce6f20ab80ee3fc9917bf4a7568b8fd2")
+			.unwrap()
+			.try_into()
+			.unwrap();
+	let acc = AccountId32::from(raw_acc);
+	frame_system::Pallet::<T>::reset_events();
+
+	// Sanity check that this is the right account
+	let ah_acc = frame_system::Account::<T>::get(&acc);
+	if ah_acc.data.free == 0 {
+		panic!("No or broken snapshot: account does not have any balance");
+	}
+
+	let key = frame_system::Account::<T>::hashed_key_for(&acc);
+	let raw_acc = relay_snapshot(|| {
+		frame_support::storage::unhashed::get::<
+			pallet_balances::AccountData<<T as pallet_balances::Config>::Balance>,
+		>(key.as_ref())
+	}).unwrap();
+
+	if raw_acc.free == 0 {
+		panic!("No or broken snapshot: account does not have any balance");
+	}
+}
+
+/// Read something from the relay chain snapshot instead of the asset hub one.
+fn relay_snapshot<R, F: FnOnce() -> R>(f: F) -> R {
+	sp_io::storage::get(b"relay_chain_enable");
+	let result = f();
+	sp_io::storage::get(b"relay_chain_disable");
+	result
+}

pallets/ah-migrator/src/lib.rs

@@ -45,6 +45,7 @@ pub mod referenda;
 pub mod scheduler;
 pub mod staking;
 pub mod types;
+pub mod vesting;
 
 pub use pallet::*;
 pub use pallet_rc_migrator::types::ZeroWeightOr;
@@ -73,6 +74,7 @@ use pallet_rc_migrator::{
 		fast_unstake::{FastUnstakeMigrator, RcFastUnstakeMessage},
 		nom_pools::*,
 	},
+	vesting::RcVestingSchedule,
 };
 use pallet_referenda::TrackIdOf;
 use polkadot_runtime_common::claims as pallet_claims;
@@ -100,6 +102,7 @@ pub enum PalletEventName {
 	Indices,
 	FastUnstake,
 	BagsList,
+	Vesting,
 	Bounties,
 }
 
@@ -122,6 +125,7 @@ pub mod pallet {
 		+ pallet_fast_unstake::Config
 		+ pallet_bags_list::Config<pallet_bags_list::Instance1>
 		+ pallet_scheduler::Config
+		+ pallet_vesting::Config
 		+ pallet_indices::Config
 		+ pallet_conviction_voting::Config
 		+ pallet_bounties::Config
@@ -195,6 +199,9 @@ pub mod pallet {
 		FailedToConvertCall,
 		/// Failed to bound a call.
 		FailedToBoundCall,
+		/// Failed to integrate a vesting schedule.
+		FailedToIntegrateVestingSchedule,
+		Unreachable,
 	}
 
 	#[pallet::event]
@@ -344,6 +351,21 @@ pub mod pallet {
 			/// How many scheduler messages failed to integrate.
 			count_bad: u32,
 		},
+		/// Should not happen. Manual intervention by the Fellowship required.
+		///
+		/// Can happen when existing AH and incoming RC vesting schedules have more combined
+		/// entries than allowed. This triggers the merging logic which has henceforth failed
+		/// with the given inner pallet-vesting error.
+		FailedToMergeVestingSchedules {
+			/// The account that failed to merge the schedules.
+			who: AccountId32,
+			/// The first schedule index that failed to merge.
+			schedule1: u32,
+			/// The second schedule index that failed to merge.
+			schedule2: u32,
+			/// The index of the pallet-vesting error that occurred.
+			pallet_vesting_error_index: Option<u8>,
+		},
 		ConvictionVotingMessagesReceived {
 			/// How many conviction voting messages are in the batch.
 			count: u32,
@@ -465,6 +487,16 @@ pub mod pallet {
 		}
 
 		#[pallet::call_index(8)]
+		pub fn receive_vesting_schedules(
+			origin: OriginFor<T>,
+			schedules: Vec<RcVestingSchedule<T>>,
+		) -> DispatchResult {
+			ensure_root(origin)?;
+
+			Self::do_receive_vesting_schedules(schedules).map_err(Into::into)
+		}
+
+		#[pallet::call_index(9)]
 		pub fn receive_fast_unstake_messages(
 			origin: OriginFor<T>,
 			messages: Vec<RcFastUnstakeMessage<T>>,
@@ -475,7 +507,7 @@ pub mod pallet {
 		}
 
 		/// Receive referendum counts, deciding counts, votes for the track queue.
-		#[pallet::call_index(9)]
+		#[pallet::call_index(10)]
 		pub fn receive_referenda_values(
 			origin: OriginFor<T>,
 			referendum_count: u32,
@@ -491,7 +523,7 @@ pub mod pallet {
 		}
 
 		/// Receive referendums from the Relay Chain.
-		#[pallet::call_index(10)]
+		#[pallet::call_index(11)]
 		pub fn receive_referendums(
 			origin: OriginFor<T>,
 			referendums: Vec<(u32, RcReferendumInfoOf<T, ()>)>,
@@ -501,7 +533,7 @@ pub mod pallet {
 			Self::do_receive_referendums(referendums).map_err(Into::into)
 		}
 
-		#[pallet::call_index(11)]
+		#[pallet::call_index(12)]
 		pub fn receive_claims(
 			origin: OriginFor<T>,
 			messages: Vec<RcClaimsMessageOf<T>>,
@@ -511,7 +543,7 @@ pub mod pallet {
 			Self::do_receive_claims(messages).map_err(Into::into)
 		}
 
-		#[pallet::call_index(12)]
+		#[pallet::call_index(13)]
 		pub fn receive_bags_list_messages(
 			origin: OriginFor<T>,
 			messages: Vec<RcBagsListMessage<T>>,
@@ -521,7 +553,7 @@ pub mod pallet {
 			Self::do_receive_bags_list_messages(messages).map_err(Into::into)
 		}
 
-		#[pallet::call_index(13)]
+		#[pallet::call_index(14)]
 		pub fn receive_scheduler_messages(
 			origin: OriginFor<T>,
 			messages: Vec<scheduler::RcSchedulerMessageOf<T>>,
@@ -531,7 +563,7 @@ pub mod pallet {
 			Self::do_receive_scheduler_messages(messages).map_err(Into::into)
 		}
 
-		#[pallet::call_index(14)]
+		#[pallet::call_index(15)]
 		pub fn receive_indices(
 			origin: OriginFor<T>,
 			indices: Vec<RcIndicesIndexOf<T>>,
@@ -541,7 +573,7 @@ pub mod pallet {
 			Self::do_receive_indices(indices).map_err(Into::into)
 		}
 
-		#[pallet::call_index(15)]
+		#[pallet::call_index(16)]
 		pub fn receive_conviction_voting_messages(
 			origin: OriginFor<T>,
 			messages: Vec<RcConvictionVotingMessageOf<T>>,
@@ -551,7 +583,7 @@ pub mod pallet {
 			Self::do_receive_conviction_voting_messages(messages).map_err(Into::into)
 		}
 
-		#[pallet::call_index(16)]
+		#[pallet::call_index(17)]
 		pub fn receive_bounties_messages(
 			origin: OriginFor<T>,
 			messages: Vec<pallet_rc_migrator::bounties::RcBountiesMessageOf<T>>,
@@ -561,7 +593,7 @@ pub mod pallet {
 			Self::do_receive_bounties_messages(messages).map_err(Into::into)
 		}
 
-		#[pallet::call_index(17)]
+		#[pallet::call_index(18)]
 		pub fn receive_asset_rates(
 			origin: OriginFor<T>,
 			rates: Vec<(<T as pallet_asset_rate::Config>::AssetKind, FixedU128)>,