A0-4581: Storage migration for CommitteeManagement pallet (#1892)

Co-authored-by: Michal Swietek <[email protected]>

Cargo.toml

@@ -14,7 +14,6 @@ members = [
     "pallets/elections",
     "pallets/committee-management",
     "pallets/operations",
-    "pallets/support",
     "primitives",
     "rate-limiter",
 ]
@@ -185,5 +184,4 @@ pallet-aleph-runtime-api = { path = "pallets/aleph-runtime-api", default-feature
 pallet-committee-management = { path = "pallets/committee-management", default-features = false }
 pallet-elections = { path = "pallets/elections", default-features = false }
 pallet-operations = { path = "pallets/operations", default-features = false }
-pallets-support = { path = "pallets/support", default-features = false }
 primitives = { path = "primitives", default-features = false }

bin/runtime/src/lib.rs

@@ -1033,6 +1033,8 @@ pub type SignedBlock = generic::SignedBlock<Block>;
 /// BlockId type as expected by this runtime.
 pub type BlockId = generic::BlockId<Block>;
 
+pub type Migration = pallet_committee_management::migration::v2::Migration<Runtime>;
+
 /// Executive: handles dispatch to the various modules.
 pub type Executive = frame_executive::Executive<
     Runtime,

pallets/aleph/src/lib.rs

@@ -104,7 +104,7 @@ pub mod pallet {
 
     #[pallet::storage]
     #[pallet::getter(fn authorities)]
-    pub(super) type Authorities<T: Config> = StorageValue<_, Vec<T::AuthorityId>, ValueQuery>;
+    pub type Authorities<T: Config> = StorageValue<_, Vec<T::AuthorityId>, ValueQuery>;
 
     #[pallet::storage]
     #[pallet::getter(fn next_authorities)]

pallets/committee-management/Cargo.toml

@@ -28,7 +28,6 @@ sp-std = { workspace = true }
 
 pallet-aleph = { workspace = true }
 pallet-elections = { workspace = true }
-pallets-support = { workspace = true }
 primitives = { workspace = true }
 
 [features]
@@ -52,7 +51,6 @@ std = [
     "sp-staking/std",
     "sp-std/std",
     "primitives/std",
-    "pallets-support/std",
     "pallet-aleph/std",
     "pallet-elections/std",
 ]

pallets/committee-management/src/lib.rs

@@ -5,6 +5,7 @@ extern crate core;
 
 mod impls;
 mod manager;
+pub mod migration;
 #[cfg(test)]
 mod mock;
 #[cfg(test)]
@@ -51,7 +52,7 @@ impl Get<Perquintill> for DefaultLenientThreshold {
     }
 }
 
-const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);
+const STORAGE_VERSION: StorageVersion = StorageVersion::new(2);
 pub(crate) const LOG_TARGET: &str = "pallet-committee-management";
 
 #[frame_support::pallet]

pallets/committee-management/src/migration.rs

@@ -0,0 +1,114 @@
+use frame_support::{
+    pallet_prelude::{PalletInfoAccess, StorageVersion, ValueQuery, Weight},
+    storage_alias,
+    traits::OnRuntimeUpgrade,
+};
+use log::info;
+use parity_scale_codec::Decode;
+use primitives::{ProductionBanConfig as ProductionBanConfigStruct, SessionValidators};
+use sp_std::vec::Vec;
+
+use crate::{CurrentAndNextSessionValidators, CurrentAndNextSessionValidatorsStorage};
+
+/// Ensure that the current pallet storage version matches `version`.
+pub fn ensure_storage_version<P: PalletInfoAccess>(version: u16) -> Result<(), &'static str> {
+    if StorageVersion::get::<P>() == StorageVersion::new(version) {
+        Ok(())
+    } else {
+        Err("Bad storage version")
+    }
+}
+
+pub mod v2 {
+    use frame_support::traits::Get;
+
+    use super::*;
+    use crate::{Config, Pallet, ProductionBanConfig, LOG_TARGET};
+
+    const OLD_VERSION: u16 = 1;
+    const NEW_VERSION: u16 = 2;
+
+    #[derive(Decode)]
+    pub struct SessionValidatorsLegacy<T> {
+        pub committee: Vec<T>,
+        pub non_committee: Vec<T>,
+    }
+
+    #[derive(Decode)]
+    pub struct CurrentAndNextSessionValidatorsLegacy<T> {
+        pub next: SessionValidatorsLegacy<T>,
+        pub current: SessionValidatorsLegacy<T>,
+    }
+
+    #[storage_alias]
+    type BanConfig<T: Config> = StorageValue<Pallet<T>, ProductionBanConfigStruct, ValueQuery>;
+
+    pub struct Migration<T>(sp_std::marker::PhantomData<T>);
+
+    impl<T: Config + pallet_aleph::Config> OnRuntimeUpgrade for Migration<T> {
+        fn on_runtime_upgrade() -> Weight {
+            if StorageVersion::get::<Pallet<T>>() != StorageVersion::new(OLD_VERSION) {
+                log::info!(
+                    target: LOG_TARGET,
+                    "Skipping migrations from STORAGE_VERSION 1 to 2 for pallet committee-management."
+                );
+                return T::DbWeight::get().reads(1);
+            };
+
+            let reads = 4; // StorageVersion, CurrentAndNextSessionValidatorsStorage, NextFinalityCommittee,  BanConfig
+            let mut writes = 2; // StorageVersion, ProductionBanConfig
+            info!(target: LOG_TARGET, "Running migration from STORAGE_VERSION 1 to 2 for pallet committee-management.");
+
+            let res = CurrentAndNextSessionValidatorsStorage::<T>::translate::<
+                CurrentAndNextSessionValidatorsLegacy<T::AccountId>,
+                _,
+            >(|current_validators_legacy| {
+                let current_validators_legacy =
+                    current_validators_legacy.expect("This storage exists");
+
+                let finalizers = pallet_aleph::NextFinalityCommittee::<T>::get();
+                let current_validators = SessionValidators {
+                    producers: current_validators_legacy.current.committee,
+                    finalizers: finalizers.clone(), // we use next finalizers as it's hard to get current but we won't need them in current session.
+                    non_committee: current_validators_legacy.current.non_committee,
+                };
+                let next_validators = SessionValidators {
+                    producers: current_validators_legacy.next.committee,
+                    finalizers,
+                    non_committee: current_validators_legacy.next.non_committee,
+                };
+
+                Some(CurrentAndNextSessionValidators {
+                    current: current_validators,
+                    next: next_validators,
+                })
+            });
+            if res.is_ok() {
+                writes += 1;
+            } else {
+                log::error!(target: LOG_TARGET, "Could not migrate CurrentAndNextSessionValidatorsStorage.");
+            };
+
+            let ban_config = BanConfig::<T>::get();
+            ProductionBanConfig::<T>::put(ban_config);
+            BanConfig::<T>::kill();
+
+            StorageVersion::new(NEW_VERSION).put::<Pallet<T>>();
+            info!(target: LOG_TARGET, "Finished migration from STORAGE_VERSION 1 to 2 for pallet committee-management.");
+
+            T::DbWeight::get().reads(reads) + T::DbWeight::get().writes(writes)
+        }
+
+        #[cfg(feature = "try-runtime")]
+        fn pre_upgrade() -> Result<Vec<u8>, sp_runtime::DispatchError> {
+            ensure_storage_version::<Pallet<T>>(OLD_VERSION)?;
+
+            Ok(Vec::new())
+        }
+
+        #[cfg(feature = "try-runtime")]
+        fn post_upgrade(_: Vec<u8>) -> Result<(), sp_runtime::DispatchError> {
+            Ok(ensure_storage_version::<Pallet<T>>(NEW_VERSION)?)
+        }
+    }
+}

pallets/elections/Cargo.toml

@@ -25,7 +25,6 @@ sp-runtime = { workspace = true }
 sp-staking = { workspace = true }
 sp-std = { workspace = true }
 
-pallets-support = { workspace = true }
 primitives = { workspace = true }
 
 [features]
@@ -47,7 +46,6 @@ std = [
     "sp-staking/std",
     "primitives/std",
     "sp-io/std",
-    "pallets-support/std",
 ]
 try-runtime = [
     "frame-support/try-runtime",