Add storage bounds for pallet staking and clean up deprecated non paged exposure storages

cumulus/parachains/integration-tests/emulated/chains/relays/westend/src/genesis.rs

@@ -19,7 +19,7 @@ use sp_authority_discovery::AuthorityId as AuthorityDiscoveryId;
 use sp_consensus_babe::AuthorityId as BabeId;
 use sp_consensus_beefy::ecdsa_crypto::AuthorityId as BeefyId;
 use sp_core::storage::Storage;
-use sp_runtime::Perbill;
+use sp_runtime::{BoundedVec, Perbill};
 
 // Polkadot
 use polkadot_primitives::{AssignmentId, ValidatorId};
@@ -86,7 +86,13 @@ pub fn genesis() -> Storage {
 				.iter()
 				.map(|x| (x.0.clone(), x.1.clone(), STASH, pallet_staking::StakerStatus::Validator))
 				.collect(),
-			invulnerables: validators::initial_authorities().iter().map(|x| x.0.clone()).collect(),
+			invulnerables: BoundedVec::try_from(
+				validators::initial_authorities()
+					.iter()
+					.map(|x| x.0.clone())
+					.collect::<Vec<_>>(),
+			)
+			.expect("Limit for staking invulnerables must be less than initial authorities."),
 			force_era: pallet_staking::Forcing::ForceNone,
 			slash_reward_fraction: Perbill::from_percent(10),
 			..Default::default()

polkadot/runtime/common/src/lib.rs

@@ -230,7 +230,6 @@ impl<T: pallet_session::Config> OneSessionHandler<T::AccountId>
 /// A reasonable benchmarking config for staking pallet.
 pub struct StakingBenchmarkingConfig;
 impl pallet_staking::BenchmarkingConfig for StakingBenchmarkingConfig {
-	type MaxValidators = ConstU32<1000>;
 	type MaxNominators = ConstU32<1000>;
 }
 

polkadot/runtime/common/src/try_runtime.rs

@@ -36,7 +36,7 @@ where
 
 	let all_stakers = Ledger::<T>::iter().map(|(ctrl, l)| (ctrl, l.stash)).collect::<BTreeSet<_>>();
 	let mut all_exposed = BTreeSet::new();
-	ErasStakers::<T>::iter().for_each(|(_, val, expo)| {
+	ErasStakersPaged::<T>::iter().for_each(|((_era, val, _page), expo)| {
 		all_exposed.insert(val);
 		all_exposed.extend(expo.others.iter().map(|ie| ie.who.clone()))
 	});

polkadot/runtime/parachains/src/disputes/slashing.rs

@@ -83,17 +83,6 @@ const DEFENSIVE_PROOF: &'static str = "disputes module should bail on old sessio
 #[cfg(feature = "runtime-benchmarks")]
 pub mod benchmarking;
 
-/// The benchmarking configuration.
-pub trait BenchmarkingConfiguration {
-	const MAX_VALIDATORS: u32;
-}
-
-pub struct BenchConfig<const M: u32>;
-
-impl<const M: u32> BenchmarkingConfiguration for BenchConfig<M> {
-	const MAX_VALIDATORS: u32 = M;
-}
-
 /// An offence that is filed when a series of validators lost a dispute.
 #[derive(TypeInfo)]
 #[cfg_attr(feature = "std", derive(Clone, PartialEq, Eq))]
@@ -400,9 +389,6 @@ pub mod pallet {
 
 		/// Weight information for extrinsics in this pallet.
 		type WeightInfo: WeightInfo;
-
-		/// Benchmarking configuration.
-		type BenchmarkingConfig: BenchmarkingConfiguration;
 	}
 
 	#[pallet::pallet]

polkadot/runtime/parachains/src/disputes/slashing/benchmarking.rs

@@ -29,11 +29,6 @@ use sp_session::MembershipProof;
 // Candidate hash of the disputed candidate.
 const CANDIDATE_HASH: CandidateHash = CandidateHash(Hash::zero());
 
-// Simplify getting the value in the benchmark
-pub const fn max_validators_for<T: super::Config>() -> u32 {
-	<<T>::BenchmarkingConfig as BenchmarkingConfiguration>::MAX_VALIDATORS
-}
-
 pub trait Config:
 	pallet_session::Config
 	+ pallet_session::historical::Config
@@ -148,7 +143,9 @@ mod benchmarks {
 	use super::*;
 
 	#[benchmark]
-	fn report_dispute_lost_unsigned(n: Linear<4, { max_validators_for::<T>() }>) {
+	fn report_dispute_lost_unsigned(
+		n: Linear<4, { <T as pallet_staking::Config>::MaxValidatorsCount::get() - 1 }>,
+	) {
 		let (session_index, key_owner_proof, validator_id) = setup_validator_set::<T>(n);
 
 		// submit a single `ForInvalid` dispute for a past session.

polkadot/runtime/rococo/src/lib.rs

@@ -1184,7 +1184,6 @@ impl parachains_slashing::Config for Runtime {
 		ReportLongevity,
 	>;
 	type WeightInfo = parachains_slashing::TestWeightInfo;
-	type BenchmarkingConfig = parachains_slashing::BenchConfig<200>;
 }
 
 parameter_types! {

polkadot/runtime/test-runtime/src/lib.rs

@@ -340,6 +340,7 @@ parameter_types! {
 	pub storage SessionsPerEra: SessionIndex = 6;
 	// 28 eras for unbonding (7 days).
 	pub storage BondingDuration: sp_staking::EraIndex = 28;
+	pub storage MaxBondedEras: u32 = (BondingDuration::get() as u32) + 1;
 	// 27 eras in which slashes can be cancelled (a bit less than 7 days).
 	pub storage SlashDeferDuration: sp_staking::EraIndex = 27;
 	pub const RewardCurve: &'static PiecewiseLinear<'static> = &REWARD_CURVE;
@@ -376,6 +377,7 @@ impl pallet_staking::Config for Runtime {
 	type Reward = ();
 	type SessionsPerEra = SessionsPerEra;
 	type BondingDuration = BondingDuration;
+	type MaxBondedEras = MaxBondedEras;
 	type SlashDeferDuration = SlashDeferDuration;
 	type AdminOrigin = frame_system::EnsureNever<()>;
 	type SessionInterface = Self;
@@ -396,6 +398,10 @@ impl pallet_staking::Config for Runtime {
 	type EventListeners = ();
 	type WeightInfo = ();
 	type DisablingStrategy = pallet_staking::UpToLimitWithReEnablingDisablingStrategy;
+	type MaxInvulnerables = ConstU32<20>;
+	type MaxRewardPagesPerValidator = ConstU32<20>;
+	type MaxValidatorsCount = ConstU32<300>;
+	type MaxDisabledValidators = ConstU32<100>;
 }
 
 parameter_types! {
@@ -550,7 +556,6 @@ impl parachains_slashing::Config for Runtime {
 		ReportLongevity,
 	>;
 	type WeightInfo = parachains_disputes::slashing::TestWeightInfo;
-	type BenchmarkingConfig = parachains_slashing::BenchConfig<1000>;
 }
 
 impl parachains_paras_inherent::Config for Runtime {

polkadot/runtime/westend/src/genesis_config_presets.rs

@@ -33,7 +33,7 @@ use sp_consensus_grandpa::AuthorityId as GrandpaId;
 use sp_core::{crypto::get_public_from_string_or_panic, sr25519};
 use sp_genesis_builder::PresetId;
 use sp_keyring::Sr25519Keyring;
-use sp_runtime::Perbill;
+use sp_runtime::{BoundedVec, Perbill};
 use westend_runtime_constants::currency::UNITS as WND;
 
 /// Helper function to generate stash, controller and session key from seed
@@ -202,7 +202,10 @@ fn westend_testnet_genesis(
 				.iter()
 				.map(|x| (x.0.clone(), x.0.clone(), STASH, StakerStatus::<AccountId>::Validator))
 				.collect::<Vec<_>>(),
-			invulnerables: initial_authorities.iter().map(|x| x.0.clone()).collect::<Vec<_>>(),
+			invulnerables: BoundedVec::try_from(
+				initial_authorities.iter().map(|x| x.0.clone()).collect::<Vec<_>>()
+			)
+			.expect("Too many invulnerable validators!"),
 			force_era: Forcing::NotForcing,
 			slash_reward_fraction: Perbill::from_percent(10),
 		},
@@ -373,7 +376,10 @@ fn westend_staging_testnet_config_genesis() -> serde_json::Value {
 				.iter()
 				.map(|x| (x.0.clone(), x.0.clone(), STASH, StakerStatus::<AccountId>::Validator))
 				.collect::<Vec<_>>(),
-			invulnerables: initial_authorities.iter().map(|x| x.0.clone()).collect::<Vec<_>>(),
+			invulnerables: BoundedVec::try_from(
+				initial_authorities.iter().map(|x| x.0.clone()).collect::<Vec<_>>()
+			)
+			.expect("Too many invulnerable validators!"),
 			force_era: Forcing::ForceNone,
 			slash_reward_fraction: Perbill::from_percent(10),
 		},

polkadot/runtime/westend/src/lib.rs

@@ -287,6 +287,14 @@ pub mod dynamic_params {
 		#[codec(index = 4)]
 		pub static UseAuctionSlots: bool = false;
 	}
+
+	#[dynamic_pallet_params]
+	#[codec(index = 1)]
+	pub mod staking {
+		/// Maximum number of validators allowed.
+		#[codec(index = 0)]
+		pub static MaxValidatorsCount: u32 = 300;
+	}
 }
 
 #[cfg(feature = "runtime-benchmarks")]
@@ -319,6 +327,7 @@ impl EnsureOriginWithArg<RuntimeOrigin, RuntimeParametersKey> for DynamicParamet
 
 		match key {
 			Inflation(_) => frame_system::ensure_root(origin.clone()),
+			Staking(_) => frame_system::ensure_root(origin.clone()),
 		}
 		.map_err(|_| origin)
 	}
@@ -716,6 +725,7 @@ parameter_types! {
 	pub const SessionsPerEra: SessionIndex = prod_or_fast!(6, 1);
 	// 2 eras for unbonding (12 hours).
 	pub const BondingDuration: sp_staking::EraIndex = 2;
+	pub const MaxBondedEras: u32 = (BondingDuration::get() as u32) + 1;
 	// 1 era in which slashes can be cancelled (6 hours).
 	pub const SlashDeferDuration: sp_staking::EraIndex = 1;
 	pub const MaxExposurePageSize: u32 = 64;
@@ -738,6 +748,7 @@ impl pallet_staking::Config for Runtime {
 	type Reward = ();
 	type SessionsPerEra = SessionsPerEra;
 	type BondingDuration = BondingDuration;
+	type MaxBondedEras = MaxBondedEras;
 	type SlashDeferDuration = SlashDeferDuration;
 	type AdminOrigin = EitherOf<EnsureRoot<AccountId>, StakingAdmin>;
 	type SessionInterface = Self;
@@ -756,6 +767,10 @@ impl pallet_staking::Config for Runtime {
 	type EventListeners = (NominationPools, DelegatedStaking);
 	type WeightInfo = weights::pallet_staking::WeightInfo<Runtime>;
 	type DisablingStrategy = pallet_staking::UpToLimitWithReEnablingDisablingStrategy;
+	type MaxInvulnerables = frame_support::traits::ConstU32<20>;
+	type MaxRewardPagesPerValidator = frame_support::traits::ConstU32<20>;
+	type MaxValidatorsCount = dynamic_params::staking::MaxValidatorsCount;
+	type MaxDisabledValidators = ConstU32<100>;
 }
 
 impl pallet_fast_unstake::Config for Runtime {
@@ -1417,7 +1432,6 @@ impl parachains_slashing::Config for Runtime {
 		ReportLongevity,
 	>;
 	type WeightInfo = weights::polkadot_runtime_parachains_disputes_slashing::WeightInfo<Runtime>;
-	type BenchmarkingConfig = parachains_slashing::BenchConfig<300>;
 }
 
 parameter_types! {
@@ -1841,6 +1855,7 @@ pub mod migrations {
 		parachains_shared::migration::MigrateToV1<Runtime>,
 		parachains_scheduler::migration::MigrateV2ToV3<Runtime>,
 		pallet_staking::migrations::v16::MigrateV15ToV16<Runtime>,
+		pallet_staking::migrations::v17::MigrateV16ToV17<Runtime>,
 		// permanent
 		pallet_xcm::migration::MigrateToLatestXcmVersion<Runtime>,
 	);

polkadot/runtime/westend/src/weights/pallet_fast_unstake.rs

@@ -108,8 +108,6 @@ impl<T: frame_system::Config> pallet_fast_unstake::WeightInfo for WeightInfo<T>
 	/// Proof Skipped: ElectionProviderMultiPhase CurrentPhase (max_values: Some(1), max_size: None, mode: Measured)
 	/// Storage: Staking CurrentEra (r:1 w:0)
 	/// Proof: Staking CurrentEra (max_values: Some(1), max_size: Some(4), added: 499, mode: MaxEncodedLen)
-	/// Storage: Staking ErasStakers (r:257 w:0)
-	/// Proof Skipped: Staking ErasStakers (max_values: None, max_size: None, mode: Measured)
 	/// The range of component `v` is `[1, 256]`.
 	/// The range of component `b` is `[1, 64]`.
 	fn on_idle_check(v: u32, b: u32, ) -> Weight {

polkadot/runtime/westend/src/weights/pallet_staking.rs

@@ -488,8 +488,6 @@ impl<T: frame_system::Config> pallet_staking::WeightInfo for WeightInfo<T> {
 	/// Proof: `Staking::Bonded` (`max_values`: None, `max_size`: Some(72), added: 2547, mode: `MaxEncodedLen`)
 	/// Storage: `Staking::Ledger` (r:65 w:65)
 	/// Proof: `Staking::Ledger` (`max_values`: None, `max_size`: Some(1091), added: 3566, mode: `MaxEncodedLen`)
-	/// Storage: `Staking::ErasStakersClipped` (r:1 w:0)
-	/// Proof: `Staking::ErasStakersClipped` (`max_values`: None, `max_size`: None, mode: `Measured`)
 	/// Storage: `Staking::ErasStakersOverview` (r:1 w:0)
 	/// Proof: `Staking::ErasStakersOverview` (`max_values`: None, `max_size`: Some(92), added: 2567, mode: `MaxEncodedLen`)
 	/// Storage: `Staking::ClaimedRewards` (r:1 w:1)

prdoc/pr_6445.prdoc

@@ -0,0 +1,51 @@
+title: Add storage bounds for pallet `staking` and clean up deprecated non paged exposure storages
+doc:
+- audience: Runtime Dev
+  description: |-
+    This is part of #6289 and necessary for the Asset Hub migration.
+
+    Building on the observations and suggestions from #255 .
+
+    **Changes**
+
+    - Add `MaxInvulnerables` to bound `Invulnerables` Vec -> `BoundedVec`.
+        - Set to constant 20 in the pallet (must be >= 17 for backward compatibility of runtime `westend`).
+    - Add `MaxDisabledValidators` to bound `DisabledValidators` Vec -> `BoundedVec`
+        - Set to constant 100 in the pallet (it should be <= 1/3 * `MaxValidatorsCount` according to the current disabling strategy)
+    - Remove `ErasStakers` and `ErasStakersClipped` (see #433 )
+        - They were deprecated in v14 and could have been removed since staking era 1504 (now it's > 1600)
+        - Completing the task from #5986
+    - Use `MaxExposurePageSize` to bound  `ErasStakersPaged` mapping to exposure pages: each `ExposurePage.others` Vec is turned into a `WeakBoundedVec` to allow easy and quick changes to this bound
+    - Add `MaxBondedEras` to bound `BondedEras` Vec -> `BoundedVec`
+        - Set to `BondingDuration::get() + 1` everywhere to include both time interval endpoints in [`current_era - BondingDuration::get()`, `current_era`]. Notice that this was done manually in every test and runtime.
+    - Add `MaxRewardPagesPerValidator` to bound `ClaimedRewards` Vec of pages -> `WeakBoundedVec`
+        - Set to constant 20 in the pallet. The vector of pages is now a `WeakBoundedVec` to allow easy and quick changes to this parameter
+    - Remove `MaxValidatorsCount` optional storage item to add `MaxValidatorsCount` mandatory config parameter
+        -  Using it to to bound `EraRewardPoints.individual` BTreeMap -> `BoundedBTreeMap`;
+        -  Set to dynamic parameter in runtime westend so that changing it should not require migrations for it
+
+crates:
+- name: pallet-staking
+  bump: major
+- name: westend-runtime
+  bump: minor
+- name: sp-staking
+  bump: minor
+- name: polkadot-runtime-common
+  bump: patch
+- name: pallet-fast-unstake
+  bump: patch
+- name: pallet-babe
+  bump: patch
+- name: pallet-beefy
+  bump: patch
+- name: pallet-delegated-staking
+  bump: patch
+- name: pallet-grandpa
+  bump: patch
+- name: pallet-root-offences
+  bump: patch
+- name: polkadot-runtime-parachains
+  bump: major
+- name: rococo-runtime
+  bump: patch

substrate/bin/node/cli/tests/res/default_genesis_config.json

@@ -30,7 +30,6 @@
     "stakers": [],
     "minNominatorBond": 0,
     "minValidatorBond": 0,
-    "maxValidatorCount": null,
     "maxNominatorCount": null
   },
   "session": {

substrate/bin/node/runtime/src/lib.rs

@@ -694,6 +694,7 @@ pallet_staking_reward_curve::build! {
 parameter_types! {
 	pub const SessionsPerEra: sp_staking::SessionIndex = 6;
 	pub const BondingDuration: sp_staking::EraIndex = 24 * 28;
+	pub const MaxBondedEras: u32 = (BondingDuration::get() as u32) + 1;
 	pub const SlashDeferDuration: sp_staking::EraIndex = 24 * 7; // 1/4 the bonding duration.
 	pub const RewardCurve: &'static PiecewiseLinear<'static> = &REWARD_CURVE;
 	pub const MaxNominators: u32 = 64;
@@ -708,7 +709,6 @@ const MAX_QUOTA_NOMINATIONS: u32 = 16;
 pub struct StakingBenchmarkingConfig;
 impl pallet_staking::BenchmarkingConfig for StakingBenchmarkingConfig {
 	type MaxNominators = ConstU32<1000>;
-	type MaxValidators = ConstU32<1000>;
 }
 
 impl pallet_staking::Config for Runtime {
@@ -722,6 +722,7 @@ impl pallet_staking::Config for Runtime {
 	type Reward = (); // rewards are minted from the void
 	type SessionsPerEra = SessionsPerEra;
 	type BondingDuration = BondingDuration;
+	type MaxBondedEras = MaxBondedEras;
 	type SlashDeferDuration = SlashDeferDuration;
 	/// A super-majority of the council can cancel the slash.
 	type AdminOrigin = EitherOfDiverse<
@@ -745,6 +746,10 @@ impl pallet_staking::Config for Runtime {
 	type WeightInfo = pallet_staking::weights::SubstrateWeight<Runtime>;
 	type BenchmarkingConfig = StakingBenchmarkingConfig;
 	type DisablingStrategy = pallet_staking::UpToLimitWithReEnablingDisablingStrategy;
+	type MaxInvulnerables = ConstU32<20>;
+	type MaxRewardPagesPerValidator = ConstU32<20>;
+	type MaxValidatorsCount = ConstU32<300>;
+	type MaxDisabledValidators = ConstU32<100>;
 }
 
 impl pallet_fast_unstake::Config for Runtime {

substrate/bin/node/testing/src/genesis.rs

@@ -24,7 +24,7 @@ use kitchensink_runtime::{
 	RuntimeGenesisConfig, SessionConfig, SocietyConfig, StakerStatus, StakingConfig,
 };
 use sp_keyring::Ed25519Keyring;
-use sp_runtime::Perbill;
+use sp_runtime::{BoundedVec, Perbill};
 
 /// Create genesis runtime configuration for tests.
 pub fn config() -> RuntimeGenesisConfig {
@@ -65,7 +65,8 @@ pub fn config_endowed(extra_endowed: Vec<AccountId>) -> RuntimeGenesisConfig {
 			validator_count: 3,
 			minimum_validator_count: 0,
 			slash_reward_fraction: Perbill::from_percent(10),
-			invulnerables: vec![alice(), bob(), charlie()],
+			invulnerables: BoundedVec::try_from(vec![alice(), bob(), charlie()])
+				.expect("Too many invulnerable validators!"),
 			..Default::default()
 		},
 		society: SocietyConfig { pot: 0 },

substrate/frame/babe/src/mock.rs

@@ -39,7 +39,7 @@ use sp_runtime::{
 	impl_opaque_keys,
 	testing::{Digest, DigestItem, Header, TestXt},
 	traits::{Header as _, OpaqueKeys},
-	BuildStorage, Perbill,
+	BoundedVec, BuildStorage, Perbill,
 };
 use sp_staking::{EraIndex, SessionIndex};
 
@@ -141,6 +141,7 @@ pallet_staking_reward_curve::build! {
 parameter_types! {
 	pub const SessionsPerEra: SessionIndex = 3;
 	pub const BondingDuration: EraIndex = 3;
+	pub const MaxBondedEras: u32 = (BondingDuration::get() as u32) + 1;
 	pub const RewardCurve: &'static PiecewiseLinear<'static> = &REWARD_CURVE;
 	pub static ElectionsBounds: ElectionBounds = ElectionBoundsBuilder::default().build();
 }
@@ -160,6 +161,7 @@ impl pallet_staking::Config for Test {
 	type Currency = Balances;
 	type SessionsPerEra = SessionsPerEra;
 	type BondingDuration = BondingDuration;
+	type MaxBondedEras = MaxBondedEras;
 	type AdminOrigin = frame_system::EnsureRoot<Self::AccountId>;
 	type SessionInterface = Self;
 	type UnixTime = pallet_timestamp::Pallet<Test>;
@@ -342,7 +344,7 @@ pub fn new_test_ext_raw_authorities(authorities: Vec<AuthorityId>) -> sp_io::Tes
 		validator_count: 8,
 		force_era: pallet_staking::Forcing::ForceNew,
 		minimum_validator_count: 0,
-		invulnerables: vec![],
+		invulnerables: BoundedVec::new(),
 		..Default::default()
 	};