Merge pull request #279 from paritytech/bump-collator-staking

Upgrade pallet-collator-staking

Author: Moliholy

Cargo.lock

@@ -49,7 +49,7 @@ pallet-nfts = { path = "pallets/nfts", default-features = false }
 pallet-myth-proxy = { path = "pallets/myth-proxy", default-features = false }
 
 # External pallets
-pallet-collator-staking = { git = "https://github.com/blockdeep/pallet-collator-staking.git", tag = "v1.2.2", default-features = false }
+pallet-collator-staking = { git = "https://github.com/blockdeep/pallet-collator-staking.git", tag = "v1.2.3", default-features = false }
 
 # Substrate
 frame-benchmarking = { git = "https://github.com/paritytech/polkadot-sdk", tag = "polkadot-stable2412-1", default-features = false }

Cargo.toml

@@ -6,6 +6,7 @@ extern crate alloc; // Make the WASM binary available.
 #[cfg(feature = "std")]
 include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));
 
+mod migration;
 mod weights;
 pub mod xcm_config;
 
@@ -135,7 +136,7 @@ impl frame_support::traits::OnRuntimeUpgrade for PrepareForMove {
 }
 
 /// Pending migrations to be applied.
-pub type Migrations = ();
+pub type Migrations = (migration::ResetCollatorStakingRewardsRuntimeMigration,);
 
 /// Executive: handles dispatch to the various modules.
 pub type Executive = frame_executive::Executive<
@@ -288,7 +289,7 @@ pub const VERSION: RuntimeVersion = RuntimeVersion {
 	spec_name: alloc::borrow::Cow::Borrowed("muse"),
 	impl_name: alloc::borrow::Cow::Borrowed("muse"),
 	authoring_version: 1,
-	spec_version: 1023,
+	spec_version: 1024,
 	impl_version: 0,
 	apis: RUNTIME_API_VERSIONS,
 	transaction_version: 1,

runtime/testnet/src/lib.rs

@@ -0,0 +1,31 @@
+//! # ResetCollatorStakingRewardsRuntimeMigration
+//!
+//! This migration is responsible for resetting the collator staking rewards.
+//! It ensures that any polluted state pertaining to `pallet-collator-staking` is cleared
+//! from the chain, allowing the new logic in the pallet to take effect without issues.
+//!
+//! The migration clears all per-session rewards and claimable rewards, ensuring
+//! a clean state moving forward. Note this migration must be applied only once.
+
+use crate::Runtime;
+use frame_support::{traits::OnRuntimeUpgrade, weights::Weight};
+use sp_runtime::RuntimeDebug;
+
+#[derive(RuntimeDebug)]
+pub struct ResetCollatorStakingRewardsRuntimeMigration;
+
+impl OnRuntimeUpgrade for ResetCollatorStakingRewardsRuntimeMigration {
+	fn on_runtime_upgrade() -> Weight {
+		log::info!("Starting ResetCollatorStakingRewardsRuntimeMigration...");
+
+		let iterations =
+			pallet_collator_staking::PerSessionRewards::<Runtime>::clear(u32::MAX, None).loops
+				as u64;
+		pallet_collator_staking::ClaimableRewards::<Runtime>::kill();
+
+		log::info!("ResetCollatorStakingRewardsRuntimeMigration completed.");
+
+		<Runtime as frame_system::Config>::DbWeight::get()
+			.reads_writes(iterations, iterations.saturating_add(1))
+	}
+}