add migrate_commit_reveal_2

Author: JohnReedV

pallets/subtensor/src/macros/hooks.rs

@@ -70,7 +70,9 @@ mod hooks {
                 // Storage version v8 -> v9
                 .saturating_add(migrations::migrate_fix_total_coldkey_stake::migrate_fix_total_coldkey_stake::<T>())
                 // Migrate Delegate Ids on chain
-                .saturating_add(migrations::migrate_chain_identity::migrate_set_hotkey_identities::<T>());
+                .saturating_add(migrations::migrate_chain_identity::migrate_set_hotkey_identities::<T>())
+                // Migrate Commit-Reval 2.0
+                .saturating_add(migrations::migrate_commit_reveal_v2::migrate_commit_reveal_2::<T>());
             weight
         }
 

pallets/subtensor/src/migrations/migrate_commit_reveal_v2.rs

@@ -0,0 +1,82 @@
+use super::*;
+use crate::HasMigrationRun;
+use frame_support::{traits::Get, weights::Weight};
+use scale_info::prelude::string::String;
+use sp_io::{storage::clear_prefix, KillStorageResult};
+
+pub fn migrate_commit_reveal_2<T: Config>() -> Weight {
+    let migration_name = b"migrate_commit_reveal_2".to_vec();
+    let mut weight = T::DbWeight::get().reads(1);
+
+    if HasMigrationRun::<T>::get(&migration_name) {
+        log::info!(
+            "Migration '{:?}' has already run. Skipping.",
+            migration_name
+        );
+        return weight;
+    }
+
+    log::info!(
+        "Running migration '{}'",
+        String::from_utf8_lossy(&migration_name)
+    );
+
+    // ------------------------------
+    // Step 1: Remove WeightCommitRevealInterval entries
+    // ------------------------------
+
+    const WEIGHT_COMMIT_REVEAL_INTERVAL_PREFIX: &[u8] =
+        b"pallet_subtensor::WeightCommitRevealInterval";
+    let removal_results = clear_prefix(WEIGHT_COMMIT_REVEAL_INTERVAL_PREFIX, Some(u32::MAX));
+
+    let removed_entries_count = match removal_results {
+        KillStorageResult::AllRemoved(removed) => removed as u64,
+        KillStorageResult::SomeRemaining(removed) => {
+            log::info!("Failed To Remove Some Items During migrate_commit_reveal_v2",);
+            removed as u64
+        }
+    };
+
+    weight = weight.saturating_add(T::DbWeight::get().writes(removed_entries_count));
+
+    log::info!(
+        "Removed {:?} entries from WeightCommitRevealInterval.",
+        removed_entries_count
+    );
+
+    // ------------------------------
+    // Step 2: Remove WeightCommits entries
+    // ------------------------------
+
+    const WEIGHT_COMMITS_PREFIX: &[u8] = b"pallet_subtensor::WeightCommits";
+    let removal_results_commits = clear_prefix(WEIGHT_COMMITS_PREFIX, Some(u32::MAX));
+
+    let removed_commits_entries = match removal_results_commits {
+        KillStorageResult::AllRemoved(removed) => removed as u64,
+        KillStorageResult::SomeRemaining(removed) => {
+            log::info!("Failed To Remove Some Items During migrate_commit_reveal_v2",);
+            removed as u64
+        }
+    };
+
+    weight = weight.saturating_add(T::DbWeight::get().writes(removed_commits_entries));
+
+    log::info!(
+        "Removed {} entries from WeightCommits.",
+        removed_commits_entries
+    );
+
+    // ------------------------------
+    // Step 3: Mark Migration as Completed
+    // ------------------------------
+
+    HasMigrationRun::<T>::insert(&migration_name, true);
+    weight = weight.saturating_add(T::DbWeight::get().writes(1));
+
+    log::info!(
+        "Migration '{:?}' completed successfully.",
+        String::from_utf8_lossy(&migration_name)
+    );
+
+    weight
+}

pallets/subtensor/src/migrations/mod.rs

@@ -1,5 +1,6 @@
 use super::*;
 pub mod migrate_chain_identity;
+pub mod migrate_commit_reveal_v2;
 pub mod migrate_create_root_network;
 pub mod migrate_delete_subnet_21;
 pub mod migrate_delete_subnet_3;

pallets/subtensor/tests/migration.rs

@@ -1,10 +1,18 @@
 #![allow(unused, clippy::indexing_slicing, clippy::panic, clippy::unwrap_used)]
 mod mock;
-use frame_support::{assert_ok, weights::Weight};
+use codec::{Decode, Encode};
+use frame_support::{
+    assert_ok,
+    storage::unhashed::{get_raw, put_raw},
+    traits::{StorageInstance, StoredMap},
+    weights::Weight,
+    StorageHasher, Twox64Concat,
+};
 use frame_system::Config;
 use mock::*;
 use pallet_subtensor::*;
-use sp_core::U256;
+use sp_core::{H256, U256};
+use sp_runtime::traits::Zero;
 
 #[test]
 fn test_initialise_ti() {
@@ -430,3 +438,79 @@ fn run_migration_and_check(migration_name: &'static str) -> frame_support::weigh
     // Return the weight of the executed migration
     weight
 }
+
+#[test]
+fn test_migrate_commit_reveal_2() {
+    new_test_ext(1).execute_with(|| {
+        // ------------------------------
+        // Step 1: Simulate Old Storage Entries
+        // ------------------------------
+        const MIGRATION_NAME: &str = "migrate_commit_reveal_2";
+        const WEIGHT_COMMIT_REVEAL_INTERVAL_PREFIX: &[u8] =
+            b"pallet_subtensor::WeightCommitRevealInterval";
+        const WEIGHT_COMMITS_PREFIX: &[u8] = b"pallet_subtensor::WeightCommits";
+
+        let netuid: u16 = 1;
+        let interval_value: u64 = 50u64;
+
+        let mut interval_key = WEIGHT_COMMIT_REVEAL_INTERVAL_PREFIX.to_vec();
+        interval_key.extend_from_slice(&netuid.encode());
+
+        put_raw(&interval_key, &interval_value.encode());
+
+        let test_account: U256 = U256::from(1);
+
+        let mut commit_key = WEIGHT_COMMITS_PREFIX.to_vec();
+        commit_key.extend_from_slice(&Twox64Concat::hash(&netuid.encode()));
+        commit_key.extend_from_slice(&Twox64Concat::hash(&test_account.encode()));
+
+        let commit_value: (H256, u64) = (H256::from_low_u64_be(42), 100);
+        put_raw(&commit_key, &commit_value.encode());
+
+        let stored_interval = get_raw(&interval_key).expect("Expected to get a value");
+        assert_eq!(
+            u64::decode(&mut &stored_interval[..]).expect("Failed to decode interval value"),
+            interval_value
+        );
+
+        let stored_commit = get_raw(&commit_key).expect("Expected to get a value");
+        assert_eq!(
+            <(H256, u64)>::decode(&mut &stored_commit[..]).expect("Failed to decode commit value"),
+            commit_value
+        );
+
+        assert!(
+            !HasMigrationRun::<Test>::get(MIGRATION_NAME.as_bytes().to_vec()),
+            "Migration should not have run yet"
+        );
+
+        // ------------------------------
+        // Step 2: Run the Migration
+        // ------------------------------
+        let weight =
+            pallet_subtensor::migrations::migrate_commit_reveal_v2::migrate_commit_reveal_2::<Test>(
+            );
+
+        assert!(
+            HasMigrationRun::<Test>::get(MIGRATION_NAME.as_bytes().to_vec()),
+            "Migration should be marked as run"
+        );
+
+        // ------------------------------
+        // Step 3: Verify Migration Effects
+        // ------------------------------
+        let stored_interval_after = get_raw(&interval_key);
+        assert!(
+            stored_interval_after.is_none(),
+            "WeightCommitRevealInterval should be cleared"
+        );
+
+        let stored_commit_after = get_raw(&commit_key);
+        assert!(
+            stored_commit_after.is_none(),
+            "WeightCommits entry should be cleared"
+        );
+
+        assert!(!weight.is_zero(), "Migration weight should be non-zero");
+    });
+}