Runtime Upgrade ref docs and Single Block Migration example pallet

Cargo.toml

@@ -292,6 +292,7 @@ members = [
 	"substrate/frame/examples/kitchensink",
 	"substrate/frame/examples/offchain-worker",
 	"substrate/frame/examples/split",
+	"substrate/frame/examples/storage-migrations",
 	"substrate/frame/executive",
 	"substrate/frame/fast-unstake",
 	"substrate/frame/glutton",

polkadot/runtime/common/src/assigned_slots/migration.rs

@@ -23,51 +23,62 @@ use frame_support::ensure;
 use sp_std::vec::Vec;
 
 pub mod v1 {
-
 	use super::*;
-	pub struct MigrateToV1<T>(sp_std::marker::PhantomData<T>);
-	impl<T: Config> OnRuntimeUpgrade for MigrateToV1<T> {
-		#[cfg(feature = "try-runtime")]
-		fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
-			let onchain_version = Pallet::<T>::on_chain_storage_version();
-			ensure!(onchain_version < 1, "assigned_slots::MigrateToV1 migration can be deleted");
-			Ok(Default::default())
-		}
 
-		fn on_runtime_upgrade() -> frame_support::weights::Weight {
-			let onchain_version = Pallet::<T>::on_chain_storage_version();
-			if onchain_version < 1 {
-				const MAX_PERMANENT_SLOTS: u32 = 100;
-				const MAX_TEMPORARY_SLOTS: u32 = 100;
+	mod version_unchecked {
+		use super::*;
 
-				<MaxPermanentSlots<T>>::put(MAX_PERMANENT_SLOTS);
-				<MaxTemporarySlots<T>>::put(MAX_TEMPORARY_SLOTS);
-				// Return the weight consumed by the migration.
-				T::DbWeight::get().reads_writes(1, 3)
-			} else {
-				log::info!(target: LOG_TARGET, "MigrateToV1 should be removed");
-				T::DbWeight::get().reads(1)
+		pub struct MigrateV0ToV1<T>(sp_std::marker::PhantomData<T>);
+		impl<T: Config> OnRuntimeUpgrade for MigrateV0ToV1<T> {
+			#[cfg(feature = "try-runtime")]
+			fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
+				let onchain_version = Pallet::<T>::on_chain_storage_version();
+				ensure!(
+					onchain_version < 1,
+					"assigned_slots::MigrateToV1 migration can be deleted"
+				);
+				Ok(Default::default())
 			}
-		}
 
-		#[cfg(feature = "try-runtime")]
-		fn post_upgrade(_state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
-			let onchain_version = Pallet::<T>::on_chain_storage_version();
-			ensure!(onchain_version == 1, "assigned_slots::MigrateToV1 needs to be run");
-			assert_eq!(<MaxPermanentSlots<T>>::get(), 100);
-			assert_eq!(<MaxTemporarySlots<T>>::get(), 100);
-			Ok(())
+			fn on_runtime_upgrade() -> frame_support::weights::Weight {
+				let onchain_version = Pallet::<T>::on_chain_storage_version();
+				if onchain_version < 1 {
+					const MAX_PERMANENT_SLOTS: u32 = 100;
+					const MAX_TEMPORARY_SLOTS: u32 = 100;
+
+					<MaxPermanentSlots<T>>::put(MAX_PERMANENT_SLOTS);
+					<MaxTemporarySlots<T>>::put(MAX_TEMPORARY_SLOTS);
+					// Return the weight consumed by the migration.
+					T::DbWeight::get().reads_writes(1, 3)
+				} else {
+					log::info!(target: LOG_TARGET, "MigrateToV1 should be removed");
+					T::DbWeight::get().reads(1)
+				}
+			}
+
+			#[cfg(feature = "try-runtime")]
+			fn post_upgrade(_state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
+				let onchain_version = Pallet::<T>::on_chain_storage_version();
+				ensure!(onchain_version == 1, "assigned_slots::MigrateToV1 needs to be run");
+				assert_eq!(<MaxPermanentSlots<T>>::get(), 100);
+				assert_eq!(<MaxTemporarySlots<T>>::get(), 100);
+				Ok(())
+			}
 		}
 	}
 
-	/// [`MigrateToV1`] wrapped in a
-	/// [`VersionedMigration`](frame_support::migrations::VersionedMigration), ensuring the
-	/// migration is only performed when on-chain version is 0.
-	pub type VersionCheckedMigrateToV1<T> = frame_support::migrations::VersionedMigration<
-		0,
-		1,
-		MigrateToV1<T>,
-		Pallet<T>,
-		<T as frame_system::Config>::DbWeight,
-	>;
+	pub mod versioned {
+		use super::*;
+
+		/// `version_unchecked::MigrateV0ToV1` wrapped in a
+		/// [`VersionedMigration`](frame_support::migrations::VersionedMigration), ensuring the
+		/// migration is only performed when on-chain version is 0.
+		pub type MigrateV0ToV1<T> = frame_support::migrations::VersionedMigration<
+			0,
+			1,
+			version_unchecked::MigrateV0ToV1<T>,
+			Pallet<T>,
+			<T as frame_system::Config>::DbWeight,
+		>;
+	}
 }

polkadot/runtime/common/src/paras_registrar/migration.rs

@@ -24,47 +24,55 @@ pub struct ParaInfoV1<Account, Balance> {
 	locked: bool,
 }
 
-pub struct VersionUncheckedMigrateToV1<T, UnlockParaIds>(
-	sp_std::marker::PhantomData<(T, UnlockParaIds)>,
-);
-impl<T: Config, UnlockParaIds: Contains<ParaId>> OnRuntimeUpgrade
-	for VersionUncheckedMigrateToV1<T, UnlockParaIds>
-{
-	fn on_runtime_upgrade() -> Weight {
-		let mut count = 0u64;
-		Paras::<T>::translate::<ParaInfoV1<T::AccountId, BalanceOf<T>>, _>(|key, v1| {
-			count.saturating_inc();
-			Some(ParaInfo {
-				manager: v1.manager,
-				deposit: v1.deposit,
-				locked: if UnlockParaIds::contains(&key) { None } else { Some(v1.locked) },
-			})
-		});
+pub mod v1 {
+	use super::*;
 
-		log::info!(target: "runtime::registrar", "Upgraded {} storages to version 1", count);
-		T::DbWeight::get().reads_writes(count, count)
-	}
+	mod version_unchecked {
+		use super::*;
 
-	#[cfg(feature = "try-runtime")]
-	fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
-		Ok((Paras::<T>::iter_keys().count() as u32).encode())
-	}
+		pub struct MigrateV0ToV1<T, UnlockParaIds>(sp_std::marker::PhantomData<(T, UnlockParaIds)>);
+		impl<T: Config, UnlockParaIds: Contains<ParaId>> OnRuntimeUpgrade
+			for MigrateV0ToV1<T, UnlockParaIds>
+		{
+			fn on_runtime_upgrade() -> Weight {
+				let mut count = 0u64;
+				Paras::<T>::translate::<ParaInfoV1<T::AccountId, BalanceOf<T>>, _>(|key, v1| {
+					count.saturating_inc();
+					Some(ParaInfo {
+						manager: v1.manager,
+						deposit: v1.deposit,
+						locked: if UnlockParaIds::contains(&key) { None } else { Some(v1.locked) },
+					})
+				});
+
+				log::info!(target: "runtime::registrar", "Upgraded {} storages to version 1", count);
+				T::DbWeight::get().reads_writes(count, count)
+			}
+
+			#[cfg(feature = "try-runtime")]
+			fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::TryRuntimeError> {
+				Ok((Paras::<T>::iter_keys().count() as u32).encode())
+			}
 
-	#[cfg(feature = "try-runtime")]
-	fn post_upgrade(state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
-		let old_count = u32::decode(&mut &state[..]).expect("Known good");
-		let new_count = Paras::<T>::iter_values().count() as u32;
+			#[cfg(feature = "try-runtime")]
+			fn post_upgrade(state: Vec<u8>) -> Result<(), sp_runtime::TryRuntimeError> {
+				let old_count = u32::decode(&mut &state[..]).expect("Known good");
+				let new_count = Paras::<T>::iter_values().count() as u32;
 
-		ensure!(old_count == new_count, "Paras count should not change");
-		Ok(())
+				ensure!(old_count == new_count, "Paras count should not change");
+				Ok(())
+			}
+		}
 	}
-}
 
-pub type VersionCheckedMigrateToV1<T, UnlockParaIds> =
-	frame_support::migrations::VersionedMigration<
-		0,
-		1,
-		VersionUncheckedMigrateToV1<T, UnlockParaIds>,
-		super::Pallet<T>,
-		<T as frame_system::Config>::DbWeight,
-	>;
+	pub mod versioned {
+		use super::*;
+		pub type MigrateV0ToV1<T, UnlockParaIds> = frame_support::migrations::VersionedMigration<
+			0,
+			1,
+			version_unchecked::MigrateV0ToV1<T, UnlockParaIds>,
+			super::Pallet<T>,
+			<T as frame_system::Config>::DbWeight,
+		>;
+	}
+}

polkadot/runtime/kusama/src/lib.rs

@@ -1727,7 +1727,7 @@ pub mod migrations {
 	/// Unreleased migrations. Add new ones here:
 	pub type Unreleased = (
 		init_state_migration::InitMigrate,
-		pallet_society::migrations::VersionCheckedMigrateToV2<
+		pallet_society::migrations::v2::versioned::MigrateV0ToV2<
 			Runtime,
 			(),
 			past_payouts::PastPayouts,
@@ -1756,7 +1756,7 @@ pub mod migrations {
 
 		parachains_configuration::migration::v9::MigrateToV9<Runtime>,
 		// Migrate parachain info format
-		paras_registrar::migration::VersionCheckedMigrateToV1<Runtime, ParachainsToUnlock>,
+		paras_registrar::migration::v1::versioned::MigrateV0ToV1<Runtime, ParachainsToUnlock>,
 	);
 }
 

polkadot/runtime/kusama/src/past_payouts.rs

@@ -17,7 +17,7 @@
 
 use super::*;
 use hex_literal::hex;
-use pallet_society::migrations::from_raw_past_payouts;
+use pallet_society::migrations::v2::from_raw_past_payouts;
 
 parameter_types! {
 	pub PastPayouts: Vec<(AccountId, Balance)> = from_raw_past_payouts::<Runtime, ()>(vec![

polkadot/runtime/polkadot/src/lib.rs

@@ -1540,7 +1540,7 @@ pub mod migrations {
 
 		parachains_configuration::migration::v9::MigrateToV9<Runtime>,
 		// Migrate parachain info format
-		paras_registrar::migration::VersionCheckedMigrateToV1<Runtime, ParachainsToUnlock>,
+		paras_registrar::migration::v1::versioned::MigrateV0ToV1<Runtime, ParachainsToUnlock>,
 	);
 }
 

polkadot/runtime/rococo/src/lib.rs

@@ -1544,14 +1544,14 @@ pub mod migrations {
 
 	/// Unreleased migrations. Add new ones here:
 	pub type Unreleased = (
-		pallet_society::migrations::VersionCheckedMigrateToV2<Runtime, (), ()>,
+		pallet_society::migrations::v2::versioned::MigrateV0ToV2<Runtime, (), ()>,
 		pallet_im_online::migration::v1::Migration<Runtime>,
 		parachains_configuration::migration::v7::MigrateToV7<Runtime>,
-		assigned_slots::migration::v1::VersionCheckedMigrateToV1<Runtime>,
+		assigned_slots::migration::v1::versioned::MigrateV0ToV1<Runtime>,
 		parachains_scheduler::migration::v1::MigrateToV1<Runtime>,
 		parachains_configuration::migration::v8::MigrateToV8<Runtime>,
 		parachains_configuration::migration::v9::MigrateToV9<Runtime>,
-		paras_registrar::migration::VersionCheckedMigrateToV1<Runtime, ()>,
+		paras_registrar::migration::v1::versioned::MigrateV0ToV1<Runtime, ()>,
 	);
 }
 

polkadot/runtime/westend/src/lib.rs

@@ -1421,12 +1421,12 @@ pub mod migrations {
 	pub type Unreleased = (
 		pallet_im_online::migration::v1::Migration<Runtime>,
 		parachains_configuration::migration::v7::MigrateToV7<Runtime>,
-		assigned_slots::migration::v1::VersionCheckedMigrateToV1<Runtime>,
+		assigned_slots::migration::v1::versioned::MigrateV0ToV1<Runtime>,
 		parachains_scheduler::migration::v1::MigrateToV1<Runtime>,
 		parachains_configuration::migration::v8::MigrateToV8<Runtime>,
 		UpgradeSessionKeys,
 		parachains_configuration::migration::v9::MigrateToV9<Runtime>,
-		paras_registrar::migration::VersionCheckedMigrateToV1<Runtime, ()>,
+		paras_registrar::migration::v1::versioned::MigrateV0ToV1<Runtime, ()>,
 	);
 }