[Feature] StakeTracker P1 - VotersList

Cargo.toml

@@ -142,6 +142,7 @@ members = [
 	"frame/session/benchmarking",
 	"frame/society",
 	"frame/staking",
+	"frame/stake-tracker",
 	"frame/staking/reward-curve",
 	"frame/staking/reward-fn",
 	"frame/staking/runtime-api",

bin/node/runtime/Cargo.toml

@@ -101,6 +101,7 @@ pallet-salary = { version = "4.0.0-dev", default-features = false, path = "../..
 pallet-session = { version = "4.0.0-dev", features = [ "historical" ], path = "../../../frame/session", default-features = false }
 pallet-session-benchmarking = { version = "4.0.0-dev", path = "../../../frame/session/benchmarking", default-features = false, optional = true }
 pallet-staking = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking" }
+pallet-stake-tracker = { version = "4.0.0-dev", default-features = false, path = "../../../frame/stake-tracker" }
 pallet-staking-reward-curve = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking/reward-curve" }
 pallet-staking-runtime-api = { version = "4.0.0-dev", default-features = false, path = "../../../frame/staking/runtime-api" }
 pallet-state-trie-migration = { version = "4.0.0-dev", default-features = false, path = "../../../frame/state-trie-migration" }
@@ -184,6 +185,7 @@ std = [
 	"sp-runtime/std",
 	"sp-staking/std",
 	"pallet-staking/std",
+	"pallet-stake-tracker/std",
 	"pallet-staking-runtime-api/std",
 	"pallet-state-trie-migration/std",
 	"pallet-salary/std",
@@ -326,6 +328,7 @@ try-runtime = [
 	"pallet-salary/try-runtime",
 	"pallet-session/try-runtime",
 	"pallet-staking/try-runtime",
+	"pallet-stake-tracker/try-runtime",
 	"pallet-state-trie-migration/try-runtime",
 	"pallet-scheduler/try-runtime",
 	"pallet-society/try-runtime",

bin/node/runtime/src/lib.rs

@@ -586,14 +586,21 @@ impl pallet_staking::Config for Runtime {
 	type OffendingValidatorsThreshold = OffendingValidatorsThreshold;
 	type ElectionProvider = ElectionProviderMultiPhase;
 	type GenesisElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>;
-	type VoterList = VoterList;
+	type VoterList = pallet_stake_tracker::TrackedList<AccountId, VoterList>;
 	// This a placeholder, to be introduced in the next PR as an instance of bags-list
 	type TargetList = pallet_staking::UseValidatorsMap<Self>;
 	type MaxUnlockingChunks = ConstU32<32>;
 	type HistoryDepth = HistoryDepth;
 	type OnStakerSlash = NominationPools;
 	type WeightInfo = pallet_staking::weights::SubstrateWeight<Runtime>;
 	type BenchmarkingConfig = StakingBenchmarkingConfig;
+	type EventListeners = StakeTracker;
+}
+
+impl pallet_stake_tracker::Config for Runtime {
+	type Currency = Balances;
+	type Staking = Staking;
+	type VoterList = VoterList;
 }
 
 impl pallet_fast_unstake::Config for Runtime {
@@ -1763,6 +1770,7 @@ construct_runtime!(
 		AssetTxPayment: pallet_asset_tx_payment,
 		ElectionProviderMultiPhase: pallet_election_provider_multi_phase,
 		Staking: pallet_staking,
+		StakeTracker: pallet_stake_tracker,
 		Session: pallet_session,
 		Democracy: pallet_democracy,
 		Council: pallet_collective::<Instance1>,

frame/babe/src/mock.rs

@@ -208,6 +208,7 @@ impl pallet_staking::Config for Test {
 	type OnStakerSlash = ();
 	type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
 	type WeightInfo = ();
+	type EventListeners = ();
 }
 
 impl pallet_offences::Config for Test {

frame/bags-list/remote-tests/Cargo.toml

@@ -16,6 +16,7 @@ targets = ["x86_64-unknown-linux-gnu"]
 # frame
 pallet-staking = { path = "../../staking", version = "4.0.0-dev" }
 pallet-bags-list = { path = "../../bags-list", version = "4.0.0-dev", features = ["fuzz"] }
+
 frame-election-provider-support = { path = "../../election-provider-support", version = "4.0.0-dev" }
 frame-system = { path = "../../system", version = "4.0.0-dev" }
 frame-support = { path = "../../support", version = "4.0.0-dev" }

frame/bags-list/remote-tests/src/lib.rs

@@ -17,7 +17,7 @@
 
 //! Utilities for remote-testing pallet-bags-list.
 
-use frame_election_provider_support::ScoreProvider;
+use frame_election_provider_support::{ScoreProvider, SortedListProvider};
 use pallet_bags_list::Instance1;
 use sp_std::prelude::*;
 
@@ -51,7 +51,6 @@ pub fn display_and_check_bags<Runtime: RuntimeT<Instance1>>(
 	currency_unit: u64,
 	currency_name: &'static str,
 ) {
-	use frame_election_provider_support::SortedListProvider;
 	use frame_support::traits::Get;
 
 	let min_nominator_bond = <pallet_staking::MinNominatorBond<Runtime>>::get();

frame/bags-list/remote-tests/src/migration.rs

@@ -17,6 +17,7 @@
 //! Test to check the migration of the voter bag.
 
 use crate::{RuntimeT, LOG_TARGET};
+use frame_election_provider_support::SortedListProvider;
 use frame_support::traits::PalletInfoAccess;
 use pallet_staking::Nominators;
 use remote_externalities::{Builder, Mode, OnlineConfig};
@@ -48,7 +49,6 @@ pub async fn execute<Runtime, Block>(
 		let pre_migrate_nominator_count = <Nominators<Runtime>>::iter().count() as u32;
 		log::info!(target: LOG_TARGET, "Nominator count: {}", pre_migrate_nominator_count);
 
-		use frame_election_provider_support::SortedListProvider;
 		// run the actual migration
 		let moved = <Runtime as pallet_staking::Config>::VoterList::unsafe_regenerate(
 			pallet_staking::Nominators::<Runtime>::iter().map(|(n, _)| n),

frame/bags-list/src/lib.rs

@@ -328,45 +328,35 @@ impl<T: Config<I>, I: 'static> SortedListProvider<T::AccountId> for Pallet<T, I>
 		List::<T, I>::contains(id)
 	}
 
-	fn on_insert(id: T::AccountId, score: T::Score) -> Result<(), ListError> {
-		List::<T, I>::insert(id, score)
-	}
-
 	fn get_score(id: &T::AccountId) -> Result<T::Score, ListError> {
 		List::<T, I>::get_score(id)
 	}
 
-	fn on_update(id: &T::AccountId, new_score: T::Score) -> Result<(), ListError> {
-		Pallet::<T, I>::do_rebag(id, new_score).map(|_| ())
+	#[cfg(feature = "try-runtime")]
+	fn try_state() -> Result<(), &'static str> {
+		Self::do_try_state()
 	}
 
-	fn on_remove(id: &T::AccountId) -> Result<(), ListError> {
-		List::<T, I>::remove(id)
+	fn on_insert(id: T::AccountId, score: T::Score) -> Result<(), ListError> {
+		List::<T, I>::insert(id, score)
 	}
 
-	fn unsafe_regenerate(
-		all: impl IntoIterator<Item = T::AccountId>,
-		score_of: Box<dyn Fn(&T::AccountId) -> T::Score>,
-	) -> u32 {
-		// NOTE: This call is unsafe for the same reason as SortedListProvider::unsafe_regenerate.
-		// I.e. because it can lead to many storage accesses.
-		// So it is ok to call it as caller must ensure the conditions.
-		List::<T, I>::unsafe_regenerate(all, score_of)
+	fn on_update(id: &T::AccountId, new_score: T::Score) -> Result<(), ListError> {
+		Pallet::<T, I>::do_rebag(id, new_score).map(|_| ())
 	}
 
-	#[cfg(feature = "try-runtime")]
-	fn try_state() -> Result<(), &'static str> {
-		Self::do_try_state()
+	fn on_remove(id: &T::AccountId) -> Result<(), ListError> {
+		List::<T, I>::remove(id)
 	}
 
-	fn unsafe_clear() {
-		// NOTE: This call is unsafe for the same reason as SortedListProvider::unsafe_clear.
-		// I.e. because it can lead to many storage accesses.
-		// So it is ok to call it as caller must ensure the conditions.
-		List::<T, I>::unsafe_clear()
-	}
+	frame_election_provider_support::runtime_benchmarks_or_test_enabled! {
+		fn unsafe_clear() {
+			// NOTE: This call is unsafe for the same reason as SortedListProvider::unsafe_clear.
+			// I.e. because it can lead to many storage accesses.
+			// So it is ok to call it as caller must ensure the conditions.
+			List::<T, I>::unsafe_clear()
+		}
 
-	frame_election_provider_support::runtime_benchmarks_enabled! {
 		fn score_update_worst_case(who: &T::AccountId, is_increase: bool) -> Self::Score {
 			use frame_support::traits::Get as _;
 			let thresholds = T::BagThresholds::get();
@@ -388,6 +378,16 @@ impl<T: Config<I>, I: 'static> SortedListProvider<T::AccountId> for Pallet<T, I>
 			}
 		}
 	}
+
+	fn unsafe_regenerate(
+		all: impl IntoIterator<Item = T::AccountId>,
+		score_of: Box<dyn Fn(&T::AccountId) -> T::Score>,
+	) -> u32 {
+		// NOTE: This call is unsafe for the same reason as SortedListProvider::unsafe_regenerate.
+		// I.e. because it can lead to many storage accesses.
+		// So it is ok to call it as caller must ensure the conditions.
+		List::<T, I>::unsafe_regenerate(all, score_of)
+	}
 }
 
 impl<T: Config<I>, I: 'static> ScoreProvider<T::AccountId> for Pallet<T, I> {

frame/beefy/src/mock.rs

@@ -231,6 +231,7 @@ impl pallet_staking::Config for Test {
 	type OnStakerSlash = ();
 	type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
 	type WeightInfo = ();
+	type EventListeners = ();
 }
 
 impl pallet_offences::Config for Test {

frame/election-provider-support/src/lib.rs

@@ -476,10 +476,10 @@ where
 /// This is generic over `AccountId` and it can represent a validator, a nominator, or any other
 /// entity.
 ///
-/// The scores (see [`Self::Score`]) are ascending, the higher, the better.
-///
 /// Something that implements this trait will do a best-effort sort over ids, and thus can be
 /// used on the implementing side of [`ElectionDataProvider`].
+///
+/// The scores (see [`Self::Score`]) are ascending, the higher, the better.
 pub trait SortedListProvider<AccountId> {
 	/// The list's error type.
 	type Error: sp_std::fmt::Debug;
@@ -501,6 +501,13 @@ pub trait SortedListProvider<AccountId> {
 	/// Return true if the list already contains `id`.
 	fn contains(id: &AccountId) -> bool;
 
+	/// Get the score of `id`.
+	fn get_score(id: &AccountId) -> Result<Self::Score, Self::Error>;
+
+	/// Check internal state of list. Only meant for debugging.
+	#[cfg(feature = "try-runtime")]
+	fn try_state() -> Result<(), &'static str>;
+
 	/// Hook for inserting a new id.
 	///
 	/// Implementation should return an error if duplicate item is being inserted.
@@ -513,9 +520,6 @@ pub trait SortedListProvider<AccountId> {
 	/// Returns `Ok(())` iff it successfully updates an item, an `Err(_)` otherwise.
 	fn on_update(id: &AccountId, score: Self::Score) -> Result<(), Self::Error>;
 
-	/// Get the score of `id`.
-	fn get_score(id: &AccountId) -> Result<Self::Score, Self::Error>;
-
 	/// Same as `on_update`, but incorporate some increased score.
 	fn on_increase(id: &AccountId, additional: Self::Score) -> Result<(), Self::Error> {
 		let old_score = Self::get_score(id)?;
@@ -560,16 +564,13 @@ pub trait SortedListProvider<AccountId> {
 	///
 	/// This function should never be called in production settings because it can lead to an
 	/// unbounded amount of storage accesses.
+	#[cfg(any(feature = "runtime-benchmarks", test))]
 	fn unsafe_clear();
 
-	/// Check internal state of the list. Only meant for debugging.
-	#[cfg(feature = "try-runtime")]
-	fn try_state() -> Result<(), &'static str>;
-
 	/// If `who` changes by the returned amount they are guaranteed to have a worst case change
 	/// in their list position.
-	#[cfg(feature = "runtime-benchmarks")]
-	fn score_update_worst_case(_who: &AccountId, _is_increase: bool) -> Self::Score;
+	#[cfg(any(feature = "runtime-benchmarks", test))]
+	fn score_update_worst_case(who: &AccountId, is_increase: bool) -> Self::Score;
 }
 
 /// Something that can provide the `Score` of an account. Similar to [`ElectionProvider`] and
@@ -675,3 +676,4 @@ pub type BoundedSupportsOf<E> = BoundedSupports<
 
 sp_core::generate_feature_enabled_macro!(runtime_benchmarks_enabled, feature = "runtime-benchmarks", $);
 sp_core::generate_feature_enabled_macro!(runtime_benchmarks_or_fuzz_enabled, any(feature = "runtime-benchmarks", feature = "fuzzing"), $);
+sp_core::generate_feature_enabled_macro!(runtime_benchmarks_or_test_enabled, any(feature = "runtime-benchmarks", test), $);

frame/fast-unstake/src/mock.rs

@@ -160,6 +160,7 @@ impl pallet_staking::Config for Runtime {
 	type OnStakerSlash = ();
 	type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
 	type WeightInfo = ();
+	type EventListeners = ();
 }
 
 pub struct BalanceToU256;

frame/grandpa/src/mock.rs

@@ -212,6 +212,7 @@ impl pallet_staking::Config for Test {
 	type OnStakerSlash = ();
 	type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
 	type WeightInfo = ();
+	type EventListeners = ();
 }
 
 impl pallet_offences::Config for Test {

frame/nomination-pools/benchmarking/Cargo.toml

@@ -24,6 +24,7 @@ frame-support = { version = "4.0.0-dev", default-features = false, path = "../..
 frame-system = { version = "4.0.0-dev", default-features = false, path = "../../system" }
 pallet-bags-list = { version = "4.0.0-dev", default-features = false, path = "../../bags-list" }
 pallet-staking = { version = "4.0.0-dev", default-features = false, path = "../../staking" }
+pallet-stake-tracker = { version = "4.0.0-dev", default-features = false, path = "../../stake-tracker" }
 pallet-nomination-pools = { version = "1.0.0", default-features = false, path = "../" }
 
 # Substrate Primitives

frame/nomination-pools/benchmarking/src/lib.rs

@@ -684,12 +684,12 @@ frame_benchmarking::benchmarks! {
 			.collect();
 
 		assert_ok!(T::Staking::nominate(&pool_account, validators));
-		assert!(T::Staking::nominations(Pools::<T>::create_bonded_account(1)).is_some());
+		assert!(T::Staking::nominations(&Pools::<T>::create_bonded_account(1)).is_some());
 
 		whitelist_account!(depositor);
 	}:_(RuntimeOrigin::Signed(depositor.clone()), 1)
 	verify {
-		assert!(T::Staking::nominations(Pools::<T>::create_bonded_account(1)).is_none());
+		assert!(T::Staking::nominations(&Pools::<T>::create_bonded_account(1)).is_none());
 	}
 
 	set_commission {

frame/nomination-pools/benchmarking/src/mock.rs

@@ -123,6 +123,13 @@ impl pallet_staking::Config for Runtime {
 	type OnStakerSlash = Pools;
 	type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
 	type WeightInfo = ();
+	type EventListeners = StakeTracker;
+}
+
+impl pallet_stake_tracker::Config for Runtime {
+	type Currency = Balances;
+	type Staking = Staking;
+	type VoterList = VoterList;
 }
 
 parameter_types! {
@@ -188,6 +195,7 @@ frame_support::construct_runtime!(
 		Staking: pallet_staking::{Pallet, Call, Config<T>, Storage, Event<T>},
 		VoterList: pallet_bags_list::<Instance1>::{Pallet, Call, Storage, Event<T>},
 		Pools: pallet_nomination_pools::{Pallet, Call, Storage, Event<T>},
+		StakeTracker: pallet_stake_tracker::{Pallet, Storage},
 	}
 );