feat: add migrations from 2.0.0 (#428)

DylanVerstraete · web-flow · commit 6b464668bb41 · 2022-09-01T16:30:22.000+02:00
diff --git a/substrate-node/pallets/pallet-smart-contract/src/contract_migration.rs b/substrate-node/pallets/pallet-smart-contract/src/contract_migration.rs
@@ -120,6 +120,15 @@ pub fn migrate_to_version_4<T: Config>() -> frame_support::weights::Weight {
         let mut migrated_count = 0;
         // We transform the storage values from the old into the new format.
         Contracts::<T>::translate::<deprecated::ContractV3, _>(|k, ctr| {
+            // Don't map deleted contracts
+            if matches!(ctr.state, types::ContractState::Deleted(_)) {
+                info!(
+                    "contract with id: {:?} in state delete, skipping...",
+                    ctr.contract_id
+                );
+                return None;
+            }
+
             // dummy default
             let rc = types::RentContract { node_id: 0 };
 
@@ -175,8 +184,8 @@ pub fn migrate_to_version_4<T: Config>() -> frame_support::weights::Weight {
 
                             match public_ips_list.try_push(new_ip) {
                                 Ok(()) => (),
-                                Err(err) => {
-                                    error!("error while pushing ip to contract ip list: {:?}", err);
+                                Err(_) => {
+                                    error!("error while pushing ip to contract ip list");
                                     should_free_ip = true;
                                     continue;
                                 }
diff --git a/substrate-node/pallets/pallet-tfgrid/src/farm.rs b/substrate-node/pallets/pallet-tfgrid/src/farm.rs
@@ -60,11 +60,13 @@ impl<T: Config> Clone for FarmName<T> {
     }
 }
 
-pub fn replace_farm_name_spaces_with_underscores(input: &[u8]) -> Vec<u8> {
+pub fn replace_farm_name_invalid_characters(input: &[u8]) -> Vec<u8> {
     input
         .iter()
         .map(|c| match c {
             b' ' => b'_',
+            b'\'' => b'-',
+            b';' => b'_',
             _ => *c,
         })
         .collect()
diff --git a/substrate-node/pallets/pallet-tfgrid/src/grid_migration.rs b/substrate-node/pallets/pallet-tfgrid/src/grid_migration.rs
@@ -2,10 +2,10 @@ use super::Config;
 use super::PubConfigOf;
 use super::*;
 use super::{InterfaceIp, InterfaceOf, PublicIpOf};
-use frame_support::BoundedVec;
 use frame_support::{
     traits::{ConstU32, Get},
     weights::Weight,
+    BoundedVec,
 };
 use log::info;
 use sp_std::collections::btree_map::BTreeMap;
@@ -230,6 +230,7 @@ pub fn migrate_farms<T: Config>() -> frame_support::weights::Weight {
     info!(" >>> Migrating farms storage...");
 
     let mut migrated_count = 0;
+    let mut generated_farm_names: u32 = 0;
     // We transform the storage values from the old into the new format.
     Farms::<T>::translate::<deprecated::FarmV3, _>(|k, farm| {
         info!("     Migrated farm for {:?}...", k);
@@ -248,14 +249,30 @@ pub fn migrate_farms<T: Config>() -> frame_support::weights::Weight {
             }
         }
 
-        let replaced_farm_name = farm::replace_farm_name_spaces_with_underscores(&farm.name);
-        let name = match <T as Config>::FarmName::try_from(replaced_farm_name) {
-            Ok(n) => n,
-            Err(_) => {
-                info!("invalid farm name, skipping updating farm {:?} ...", k);
-                return None;
-            }
-        };
+        let mut farm_name = farm.name;
+        let truncated = farm_name.len() > <T as Config>::MaxFarmNameLength::get() as usize;
+        if truncated {
+            info!("farm name length exceeded, truncating farm name");
+            farm_name.truncate(<T as Config>::MaxFarmNameLength::get() as usize);
+        }
+
+        let mut replaced_farm_name = farm::replace_farm_name_invalid_characters(&farm_name);
+        let name =
+            <T as Config>::FarmName::try_from(replaced_farm_name.clone()).unwrap_or_else(|_| {
+                info!("generating farm name for farm: {:?}", farm.id);
+                replaced_farm_name = b"change_me_".to_vec();
+                let first = ((generated_farm_names / 26) + b'a' as u32) as u8;
+                let second = ((generated_farm_names % 26) + b'a' as u32) as u8;
+                replaced_farm_name.extend_from_slice(&[first, second]);
+                generated_farm_names += 1;
+                <T as Config>::FarmName::try_from(replaced_farm_name.clone()).unwrap()
+            });
+
+        if replaced_farm_name != farm_name || truncated {
+            info!("farm name changed, reworking storage");
+            FarmIdByName::<T>::remove(&farm_name);
+            FarmIdByName::<T>::insert(replaced_farm_name, farm.id);
+        }
 
         let new_farm = Farm {
             version: 4,
diff --git a/substrate-node/runtime/src/lib.rs b/substrate-node/runtime/src/lib.rs
@@ -52,6 +52,7 @@ pub use sp_runtime::{Perbill, Permill};
 use pallet_transaction_payment::CurrencyAdapter;
 
 pub mod impls;
+mod migrations;
 
 /// Import the template pallet.
 pub use pallet_tfgrid;
@@ -756,6 +757,7 @@ pub type Executive = frame_executive::Executive<
     Runtime,
     AllPalletsWithSystem,
     (
+        migrations::CustomOnRuntimeUpgrades,
         pallet_smart_contract::contract_migration::v5::ContractMigrationV5<Runtime>,
         pallet_tfgrid::grid_migration::v7::GridMigration<Runtime>,
         pallet_tfgrid::nodes_migration::v7patch::NodesMigration<Runtime>,
diff --git a/substrate-node/runtime/src/migrations.rs b/substrate-node/runtime/src/migrations.rs
@@ -0,0 +1,174 @@
+use super::*;
+
+pub struct RemoveCollectiveFlip;
+impl frame_support::traits::OnRuntimeUpgrade for RemoveCollectiveFlip {
+    fn on_runtime_upgrade() -> Weight {
+        use frame_support::storage::migration;
+        // Remove the storage value `RandomMaterial` from removed pallet `RandomnessCollectiveFlip`
+        migration::remove_storage_prefix(b"RandomnessCollectiveFlip", b"RandomMaterial", b"");
+        <Runtime as frame_system::Config>::DbWeight::get().writes(1)
+    }
+}
+
+/// Migrate from `PalletVersion` to the new `StorageVersion`
+pub struct MigratePalletVersionToStorageVersion;
+impl frame_support::traits::OnRuntimeUpgrade for MigratePalletVersionToStorageVersion {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        frame_support::migrations::migrate_from_pallet_version_to_storage_version::<
+            AllPalletsWithSystem,
+        >(&RocksDbWeight::get())
+    }
+}
+
+impl frame_system::migrations::V2ToV3 for Runtime {
+    type Pallet = System;
+    type AccountId = AccountId;
+    type Index = Index;
+    type AccountData = pallet_balances::AccountData<Balance>;
+}
+
+pub struct SystemToTripleRefCount;
+impl frame_support::traits::OnRuntimeUpgrade for SystemToTripleRefCount {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        frame_system::migrations::migrate_from_dual_to_triple_ref_count::<Runtime, Runtime>()
+    }
+}
+
+pub struct GrandpaStoragePrefixMigration;
+impl frame_support::traits::OnRuntimeUpgrade for GrandpaStoragePrefixMigration {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        use frame_support::traits::PalletInfo;
+        let name = <Runtime as frame_system::Config>::PalletInfo::name::<Grandpa>()
+            .expect("grandpa is part of pallets in construct_runtime, so it has a name; qed");
+        pallet_grandpa::migrations::v4::migrate::<Runtime, &str>(name)
+    }
+}
+
+const COUNCIL_OLD_PREFIX: &str = "Instance1Collective";
+/// Migrate from `Instance1Collective` to the new pallet prefix `Council`
+pub struct CouncilStoragePrefixMigration;
+impl frame_support::traits::OnRuntimeUpgrade for CouncilStoragePrefixMigration {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        pallet_collective::migrations::v4::migrate::<Runtime, Council, _>(COUNCIL_OLD_PREFIX)
+    }
+
+    #[cfg(feature = "try-runtime")]
+    fn pre_upgrade() -> Result<(), &'static str> {
+        pallet_collective::migrations::v4::pre_migrate::<Council, _>(COUNCIL_OLD_PREFIX);
+        Ok(())
+    }
+
+    #[cfg(feature = "try-runtime")]
+    fn post_upgrade() -> Result<(), &'static str> {
+        pallet_collective::migrations::v4::post_migrate::<Council, _>(COUNCIL_OLD_PREFIX);
+        Ok(())
+    }
+}
+
+const COUNCIL_MEMBERSHIP_OLD_PREFIX: &str = "Instance1Membership";
+/// Migrate from `Instance1Membership` to the new pallet prefix `TechnicalMembership`
+pub struct CouncilMembershipStoragePrefixMigration;
+impl frame_support::traits::OnRuntimeUpgrade for CouncilMembershipStoragePrefixMigration {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        use frame_support::traits::PalletInfo;
+        let name = <Runtime as frame_system::Config>::PalletInfo::name::<CouncilMembership>()
+            .expect("CouncilMembership is part of runtime, so it has a name; qed");
+        pallet_membership::migrations::v4::migrate::<Runtime, CouncilMembership, _>(
+            COUNCIL_MEMBERSHIP_OLD_PREFIX,
+            name,
+        )
+    }
+
+    #[cfg(feature = "try-runtime")]
+    fn pre_upgrade() -> Result<(), &'static str> {
+        use frame_support::traits::PalletInfo;
+        let name = <Runtime as frame_system::Config>::PalletInfo::name::<CouncilMembership>()
+            .expect("CouncilMembership is part of runtime, so it has a name; qed");
+        pallet_membership::migrations::v4::pre_migrate::<CouncilMembership, _>(
+            COUNCIL_MEMBERSHIP_OLD_PREFIX,
+            name,
+        );
+        Ok(())
+    }
+
+    #[cfg(feature = "try-runtime")]
+    fn post_upgrade() -> Result<(), &'static str> {
+        use frame_support::traits::PalletInfo;
+        let name = <Runtime as frame_system::Config>::PalletInfo::name::<CouncilMembership>()
+            .expect("CouncilMembership is part of runtime, so it has a name; qed");
+        pallet_membership::migrations::v4::post_migrate::<CouncilMembership, _>(
+            COUNCIL_MEMBERSHIP_OLD_PREFIX,
+            name,
+        );
+        Ok(())
+    }
+}
+
+pub struct PalletTftPriceStoragePrefixMigration;
+impl frame_support::traits::OnRuntimeUpgrade for PalletTftPriceStoragePrefixMigration {
+    fn on_runtime_upgrade() -> frame_support::weights::Weight {
+        use frame_support::storage::migration;
+
+        // Remove storage prefixes and all related items
+        // The storage for pallet tft price has changed from U64F64 to u32
+        migration::remove_storage_prefix(b"TftPriceModule", b"TftPrice", b"");
+        migration::remove_storage_prefix(b"TftPriceModule", b"AverageTftPrice", b"");
+        pallet_tft_price::TftPriceHistory::<Runtime>::remove_all(None);
+        pallet_tft_price::BufferRange::<Runtime>::put((0, 0));
+
+        // Reinsert some default values
+        pallet_tft_price::TftPrice::<Runtime>::put(45);
+        pallet_tft_price::AverageTftPrice::<Runtime>::put(45);
+
+        <Runtime as frame_system::Config>::DbWeight::get().writes(2)
+    }
+}
+
+use frame_support::{traits::OnRuntimeUpgrade, weights::Weight};
+pub struct CustomOnRuntimeUpgrades;
+impl OnRuntimeUpgrade for CustomOnRuntimeUpgrades {
+    fn on_runtime_upgrade() -> Weight {
+        let mut weight = 0;
+
+        // 1. RemoveCollectiveFlip
+        frame_support::log::info!("🔍️ RemoveCollectiveFlip start");
+        weight += <RemoveCollectiveFlip as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 RemoveCollectiveFlip end");
+
+        // 2. MigratePalletVersionToStorageVersion
+        frame_support::log::info!("🔍️ MigratePalletVersionToStorageVersion start");
+        weight += <MigratePalletVersionToStorageVersion as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 MigratePalletVersionToStorageVersion end");
+
+        // 3. GrandpaStoragePrefixMigration
+        frame_support::log::info!("🔍️ GrandpaStoragePrefixMigration start");
+        frame_support::traits::StorageVersion::new(0).put::<Grandpa>();
+        weight += <GrandpaStoragePrefixMigration as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 GrandpaStoragePrefixMigration end");
+
+        // 4. SystemToTripleRefCount
+        frame_support::log::info!("🔍️ SystemToTripleRefCount start");
+        weight += <SystemToTripleRefCount as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 SystemToTripleRefCount end");
+
+        // 5. CouncilStoragePrefixMigration
+        frame_support::log::info!("🔍️ CouncilStoragePrefixMigration start");
+        frame_support::traits::StorageVersion::new(0).put::<Council>();
+        weight += <CouncilStoragePrefixMigration as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 CouncilStoragePrefixMigration end");
+
+        // 6. CouncilMembershipStoragePrefixMigration
+        frame_support::log::info!("🔍️ CouncilMembershipStoragePrefixMigration start");
+        frame_support::traits::StorageVersion::new(0).put::<CouncilMembership>();
+        weight +=
+            <CouncilMembershipStoragePrefixMigration as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 CouncilMembershipStoragePrefixMigration end");
+
+        // 7. PalletTftPriceStoragePrefixMigration
+        frame_support::log::info!("🔍️ PalletTftPriceStoragePrefixMigration start");
+        weight += <PalletTftPriceStoragePrefixMigration as OnRuntimeUpgrade>::on_runtime_upgrade();
+        frame_support::log::info!("🚀 PalletTftPriceStoragePrefixMigration end");
+
+        weight
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -60,11 +60,13 @@ impl<T: Config> Clone for FarmName<T> {`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`
`63`		`-pub fn replace_farm_name_spaces_with_underscores(input: &[u8]) -> Vec<u8> {`
	`63`	`+pub fn replace_farm_name_invalid_characters(input: &[u8]) -> Vec<u8> {`
`64`	`64`	`input`
`65`	`65`	`.iter()`
`66`	`66`	`.map(\|c\| match c {`
`67`	`67`	`b' ' => b'_',`
	`68`	`+ b'\'' => b'-',`
	`69`	`+ b';' => b'_',`
`68`	`70`	`_ => *c,`
`69`	`71`	`})`
`70`	`72`	`.collect()`