remove test & fix formatting

- as suggested removed test that does not give more purpose
- fixed formatting & docs to be more relevant now

Author: cirko33

Cargo.lock

@@ -1,11 +1,13 @@
 title: Remove failing assertion related to VoterList count mismatch
 doc:
-- audience: Runtime Dev
-  description: PR resolves the error that occurs when VoterList count does not align
-    with sum of Nominators & Validators in bags-list & tests to ensure PendingRebag fills when bags list is locked. This misalignment happens while
-    bags-list is locked & nominations/validations are received. 
+  - audience: Runtime Dev
+    description:
+      Updated bags-list so that on_insert queues items into PendingRebag instead of failing,
+      and removed the invariant that required VoterList's count to equal the combined number
+      of Nominators and Validators. This is safe while bags-list is locked. After unlocking,
+      on_idle drains PendingRebag, and the counts converge back to consistency over time.
 crates:
-- name: pallet-staking-async
-  bump: patch
-- name: pallet-bags-list
-  bump: patch
+  - name: pallet-staking-async
+    bump: patch
+  - name: pallet-bags-list
+    bump: patch

prdoc/pr_10880.prdoc

@@ -40,7 +40,9 @@ pallet-dap = { optional = true, workspace = true }
 anyhow = { workspace = true }
 env_logger = { workspace = true }
 frame-benchmarking = { workspace = true, default-features = true }
-frame-support = { features = ["experimental"], workspace = true, default-features = true }
+frame-support = { features = [
+	"experimental",
+], workspace = true, default-features = true }
 pallet-bags-list = { workspace = true, default-features = true }
 pallet-balances = { workspace = true, default-features = true }
 pallet-dap = { workspace = true, default-features = true }

substrate/frame/staking-async/Cargo.toml

@@ -20,7 +20,9 @@ codec = { features = ["derive"], workspace = true, default-features = true }
 frame = { workspace = true, default-features = true }
 frame-support = { workspace = true, default-features = true }
 log = { workspace = true }
-scale-info = { features = ["derive"], workspace = true, default-features = true }
+scale-info = { features = [
+	"derive",
+], workspace = true, default-features = true }
 sp-core = { workspace = true, default-features = true }
 sp-session = { workspace = true, default-features = true }
 sp-staking = { workspace = true, default-features = true }
@@ -35,7 +37,6 @@ pallet-proxy = { workspace = true, default-features = true }
 
 # pallets that we need in AH
 frame-election-provider-support = { workspace = true, default-features = true }
-pallet-bags-list = { workspace = true, default-features = true }
 pallet-dap = { workspace = true, default-features = true }
 pallet-election-provider-multi-block = { workspace = true, default-features = true }
 pallet-staking-async = { workspace = true, default-features = true }
@@ -52,9 +53,7 @@ pallet-root-offences = { workspace = true, default-features = true }
 pallet-staking = { workspace = true, default-features = true }
 
 [features]
-std = [
-	"log/std",
-]
+std = ["log/std"]
 try-runtime = [
 	"pallet-balances/try-runtime",
 	"pallet-proxy/try-runtime",
@@ -70,7 +69,6 @@ try-runtime = [
 	"frame-support/try-runtime",
 	"frame/try-runtime",
 	"pallet-authorship/try-runtime",
-	"pallet-bags-list/try-runtime",
 	"pallet-election-provider-multi-block/try-runtime",
 	"pallet-offences/try-runtime",
 	"pallet-root-offences/try-runtime",

substrate/frame/staking-async/ahm-test/Cargo.toml

@@ -19,7 +19,7 @@ use crate::shared;
 use frame::testing_prelude::*;
 use frame_election_provider_support::{
 	bounds::{ElectionBounds, ElectionBoundsBuilder},
-	SequentialPhragmen, VoteWeight,
+	SequentialPhragmen,
 };
 use frame_support::{
 	sp_runtime::testing::TestXt,
@@ -54,8 +54,6 @@ construct_runtime! {
 		MultiBlockVerifier: multi_block::verifier,
 		MultiBlockSigned: multi_block::signed,
 		MultiBlockUnsigned: multi_block::unsigned,
-
-		VoterBagsList: pallet_bags_list::<Instance1>,
 		Dap: pallet_dap,
 	}
 }
@@ -85,7 +83,6 @@ pub fn roll_next() {
 	let mut meter = NextPollWeight::take()
 		.map(WeightMeter::with_limit)
 		.unwrap_or_else(System::remaining_block_weight);
-	VoterBagsList::on_idle(next, meter.limit());
 	Staking::on_poll(next, &mut meter);
 	MultiBlock::on_poll(next, &mut meter);
 }
@@ -280,24 +277,6 @@ pub type Hash = <Runtime as frame_system::Config>::Hash;
 pub type BlockNumber = BlockNumberFor<Runtime>;
 pub type BlockWeights = <Runtime as frame_system::Config>::BlockWeights;
 
-pub(crate) const THRESHOLDS: [VoteWeight; 9] = [10, 20, 30, 40, 50, 60, 1_000, 2_000, 10_000];
-
-parameter_types! {
-	pub static BagThresholds: &'static [VoteWeight] = &THRESHOLDS;
-	pub static MaxAutoRebagPerBlock: u32 = 10;
-}
-
-pub type VoterBagsListInstance = pallet_bags_list::Instance1;
-impl pallet_bags_list::Config<VoterBagsListInstance> for Runtime {
-	type RuntimeEvent = RuntimeEvent;
-	type WeightInfo = ();
-	// Staking is the source of truth for voter bags list, since they are not kept up to date.
-	type ScoreProvider = Staking;
-	type BagThresholds = BagThresholds;
-	type MaxAutoRebagPerBlock = MaxAutoRebagPerBlock;
-	type Score = VoteWeight;
-}
-
 #[derive_impl(frame_system::config_preludes::TestDefaultConfig)]
 impl frame_system::Config for Runtime {
 	type Block = MockBlock<Self>;
@@ -491,7 +470,7 @@ impl pallet_staking_async::Config for Runtime {
 	type MaxUnlockingChunks = ConstU32<16>;
 	type NominationsQuota = pallet_staking_async::FixedNominationsQuota<16>;
 
-	type VoterList = VoterBagsList;
+	type VoterList = pallet_staking_async::UseNominatorsAndValidatorsMap<Self>;
 	type TargetList = pallet_staking_async::UseValidatorsMap<Self>;
 
 	type RcClientInterface = RcClient;

substrate/frame/staking-async/ahm-test/src/ah/mock.rs

@@ -17,7 +17,7 @@
 
 use crate::{ah::mock::*, rc, shared};
 use frame::prelude::Perbill;
-use frame_election_provider_support::{SortedListProvider, Weight};
+use frame_election_provider_support::Weight;
 use frame_support::{assert_ok, hypothetically};
 
 use pallet_election_provider_multi_block::{
@@ -1084,36 +1084,6 @@ fn era_lifecycle_test() {
 	});
 }
 
-#[test]
-fn vote_nominate_while_bagslist_is_locked() {
-	ExtBuilder::default().build().execute_with(|| {
-		VoterBagsList::lock();
-
-		assert_ok!(Staking::nominate(RuntimeOrigin::signed(2), vec![3]));
-		assert!(pallet_bags_list::PendingRebag::<T, VoterBagsListInstance>::contains_key(&2));
-		roll_next();
-
-		assert!(pallet_bags_list::PendingRebag::<T, VoterBagsListInstance>::contains_key(&2));
-		VoterBagsList::unlock();
-
-		roll_next();
-		assert!(!pallet_bags_list::PendingRebag::<T, VoterBagsListInstance>::contains_key(&2));
-
-		VoterBagsList::lock();
-
-		assert_ok!(Staking::validate(
-			RuntimeOrigin::signed(2),
-			pallet_staking_async::ValidatorPrefs::default()
-		));
-		assert!(pallet_bags_list::PendingRebag::<T, VoterBagsListInstance>::contains_key(&2));
-
-		VoterBagsList::unlock();
-		roll_next();
-
-		assert!(!pallet_bags_list::PendingRebag::<T, VoterBagsListInstance>::contains_key(&2));
-		assert_ok!(pallet_bags_list::List::<T, VoterBagsListInstance>::get_score(&2));
-	})
-}
 mod poll_operations {
 	use super::*;
 	use pallet_election_provider_multi_block::verifier::{Status, Verifier};

substrate/frame/staking-async/ahm-test/src/ah/test.rs

@@ -1897,13 +1897,12 @@ impl<T: Config> Pallet<T> {
 	}
 
 	/// Invariants:
-	/// * Number of voters in `VoterList` match that of the number of Nominators and Validators in
-	/// the system (validator is both voter and target).
 	/// * Number of targets in `TargetList` matches the number of validators in the system.
 	/// * Current validator count is bounded by the election provider's max winners.
 	fn check_count() -> Result<(), TryRuntimeError> {
 		// When the bags list is locked, nominators and validators may be temporarily
-		// missing from the voter set. `PendingRebag` will later reconcile the mismatch.
+		// missing from the voter set. If `PendingRebag` is enabled, it will later
+		// reconcile the mismatch.
 		crate::log!(
 			debug,
 			"VoterList count: {}, Nominators count: {}, Validators count: {}",

substrate/frame/staking-async/src/pallet/impls.rs

@@ -1043,8 +1043,7 @@ pub mod pallet {
 			assert_eq!(
 				T::VoterList::count(),
 				Nominators::<T>::count() + Validators::<T>::count(),
-				"not all genesis stakers were inserted into sorted list provider, something is
-			wrong."
+				"not all genesis stakers were inserted into sorted list provider, something is wrong." 
 			);
 
 			// now generate the dev stakers, after all else is setup