This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
[NPoS] Unlimited number of nominators eligible for Rewards payout #13498
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -196,7 +196,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type UnixTime = pallet_timestamp::Pallet<Test>; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
|
There was a problem hiding this comment. Would there be any issues making these There was a problem hiding this comment. An update, I want to bound EraStakersPaged and ClaimedRewards with these two values and boundedVec needs to be bounded by a u32 value. I will undo the changes to make it u16. |
||
| type OffendingValidatorsThreshold = OffendingValidatorsThreshold; | ||
| type NextNewSession = Session; | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -437,7 +437,7 @@ fn report_equivocation_current_session_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(1, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -478,7 +478,7 @@ fn report_equivocation_current_session_works() { | |
| assert_eq!(Balances::total_balance(&offending_validator_id), 10_000_000 - 10_000); | ||
| assert_eq!(Staking::slashable_balance_of(&offending_validator_id), 0); | ||
| assert_eq!( | ||
| Staking::eras_stakers(2, &offending_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
|
|
||
|
|
@@ -491,7 +491,7 @@ fn report_equivocation_current_session_works() { | |
| assert_eq!(Balances::total_balance(validator), 10_000_000); | ||
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
| assert_eq!( | ||
| Staking::eras_stakers(2, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -550,7 +550,7 @@ fn report_equivocation_old_session_works() { | |
| assert_eq!(Balances::total_balance(&offending_validator_id), 10_000_000 - 10_000); | ||
| assert_eq!(Staking::slashable_balance_of(&offending_validator_id), 0); | ||
| assert_eq!( | ||
| Staking::eras_stakers(3, &offending_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
| }) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -219,7 +219,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type UnixTime = pallet_timestamp::Pallet<Test>; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type OffendingValidatorsThreshold = OffendingValidatorsThreshold; | ||
| type NextNewSession = Session; | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -277,7 +277,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(1, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -315,7 +315,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Balances::total_balance(&equivocation_validator_id), 10_000_000 - 10_000); | ||
| assert_eq!(Staking::slashable_balance_of(&equivocation_validator_id), 0); | ||
| assert_eq!( | ||
| Staking::eras_stakers(2, &equivocation_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
|
|
||
|
|
@@ -329,7 +329,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(2, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -365,7 +365,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(2, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -399,7 +399,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Balances::total_balance(&equivocation_validator_id), 10_000_000 - 10_000); | ||
| assert_eq!(Staking::slashable_balance_of(&equivocation_validator_id), 0); | ||
| assert_eq!( | ||
| Staking::eras_stakers(3, &equivocation_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
|
|
||
|
|
@@ -413,7 +413,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(3, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -74,7 +74,7 @@ fn setup_staking<T: Config>(v: u32, until: EraIndex) { | |
| .collect::<Vec<_>>(); | ||
|
|
||
| for era in 0..=until { | ||
| let others = (0..T::Staking::max_exposure_page_size()) | ||
rossbulat marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .map(|s| { | ||
| let who = frame_benchmarking::account::<T::AccountId>("nominator", era, s); | ||
| let value = ed; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -139,10 +139,6 @@ pub mod pallet { | |
| /// Maximum value for `ErasToCheckPerBlock`. This should be as close as possible, but more | ||
| /// than the actual value, in order to have accurate benchmarks. | ||
| type MaxErasToCheckPerBlock: Get<u32>; | ||
| } | ||
|
|
||
| /// The current "head of the queue" being unstaked. | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -150,7 +150,8 @@ impl pallet_staking::Config for Runtime { | |
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = (); | ||
| type HistoryDepth = ConstU32<84>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type OffendingValidatorsThreshold = (); | ||
| type ElectionProvider = MockElection; | ||
| type GenesisElectionProvider = Self::ElectionProvider; | ||
|
|
@@ -190,8 +191,6 @@ impl fast_unstake::Config for Runtime { | |
| type BatchSize = BatchSize; | ||
| type WeightInfo = (); | ||
| type MaxErasToCheckPerBlock = ConstU32<16>; | ||
| } | ||
|
|
||
| type Block = frame_system::mocking::MockBlock<Runtime>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -200,7 +200,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type UnixTime = pallet_timestamp::Pallet<Test>; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type OffendingValidatorsThreshold = OffendingValidatorsThreshold; | ||
| type NextNewSession = Session; | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -333,7 +333,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(1, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -371,7 +371,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Balances::total_balance(&equivocation_validator_id), 10_000_000 - 10_000); | ||
| assert_eq!(Staking::slashable_balance_of(&equivocation_validator_id), 0); | ||
| assert_eq!( | ||
| Staking::eras_stakers(2, &equivocation_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
|
|
||
|
|
@@ -385,7 +385,7 @@ fn report_equivocation_current_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(2, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -417,7 +417,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(2, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
@@ -450,7 +450,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(&equivocation_validator_id), 0); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(3, &equivocation_validator_id), | ||
| pallet_staking::Exposure { total: 0, own: 0, others: vec![] }, | ||
| ); | ||
|
|
||
|
|
@@ -464,7 +464,7 @@ fn report_equivocation_old_set_works() { | |
| assert_eq!(Staking::slashable_balance_of(validator), 10_000); | ||
|
|
||
| assert_eq!( | ||
| Staking::eras_stakers(3, &validator), | ||
| pallet_staking::Exposure { total: 10_000, own: 10_000, others: vec![] }, | ||
| ); | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -111,7 +111,8 @@ impl pallet_staking::Config for Runtime { | |
| type SessionInterface = (); | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = (); | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type OffendingValidatorsThreshold = (); | ||
| type ElectionProvider = | ||
| frame_election_provider_support::NoElection<(AccountId, BlockNumber, Staking, ())>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -153,6 +153,11 @@ impl sp_staking::StakingInterface for StakingMock { | |
| fn set_current_era(_era: EraIndex) { | ||
| unimplemented!("method currently not used in testing") | ||
| } | ||
|
|
||
| #[cfg(feature = "runtime-benchmarks")] | ||
| fn max_exposure_page_size() -> sp_staking::PageIndex { | ||
| unimplemented!("method currently not used in testing") | ||
| } | ||
| } | ||
|
|
||
| impl frame_system::Config for Runtime { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -125,7 +125,8 @@ impl pallet_staking::Config for Runtime { | |
| type SessionInterface = (); | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = (); | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type OffendingValidatorsThreshold = (); | ||
| type ElectionProvider = | ||
| frame_election_provider_support::NoElection<(AccountId, BlockNumber, Staking, ())>; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -174,7 +174,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = Session; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type OffendingValidatorsThreshold = (); | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
| type GenesisElectionProvider = Self::ElectionProvider; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -111,7 +111,7 @@ pub mod pallet { | |
| .clone() | ||
| .into_iter() | ||
| .map(|(o, _)| OffenceDetails::<T> { | ||
| offender: (o.clone(), Staking::<T>::eras_stakers(now, &o)), | ||
| reporters: vec![], | ||
| }) | ||
| .collect()) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -188,7 +188,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = Session; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type OffendingValidatorsThreshold = OffendingValidatorsThreshold; | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
| type GenesisElectionProvider = Self::ElectionProvider; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -176,7 +176,8 @@ impl pallet_staking::Config for Test { | |
| type SessionInterface = Self; | ||
| type EraPayout = pallet_staking::ConvertCurve<RewardCurve>; | ||
| type NextNewSession = Session; | ||
| type MaxExposurePageCount = ConstU32<1>; | ||
| type MaxExposurePageSize = ConstU32<64>; | ||
| type OffendingValidatorsThreshold = (); | ||
| type ElectionProvider = onchain::OnChainExecution<OnChainSeqPhragmen>; | ||
| type GenesisElectionProvider = Self::ElectionProvider; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is loosely based | ||
| on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). We maintain a | ||
| single integer version number for staking pallet to keep track of all storage | ||
| migrations. | ||
|
|
||
| ## [v14] | ||
|
|
||
| ### Added | ||
|
|
||
| - New item `ErasStakersPaged` that keeps up to `MaxExposurePageSize` | ||
| individual nominator exposures by era, validator and page. | ||
| - New item `ErasStakersOverview` complementary to `ErasStakersPaged` which keeps | ||
| state of own and total stake of the validator across pages. | ||
| - New item `ClaimedRewards` to support paged rewards payout. | ||
|
|
||
| ### Deprecated | ||
|
|
||
| - `ErasStakersClipped` is deprecated and may be removed after 84 eras. | ||
| - `ErasStakers` is deprecated and may be removed after 84 eras. | ||
| - Field `claimed_rewards` in item `Ledger` is renamed | ||
| to `legacy_claimed_rewards` and may be removed after 84 eras. | ||
|
|
||
| [v14]: https://github.com/paritytech/substrate/pull/13498 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -88,11 +88,11 @@ An account can become a nominator via the [`nominate`](https://docs.rs/pallet-st | |
| The **reward and slashing** procedure is the core of the Staking module, attempting to _embrace | ||
| valid behavior_ while _punishing any misbehavior or lack of availability_. | ||
|
|
||
| Rewards must be claimed for each era before it gets too old by [`HistoryDepth`] using the | ||
| `payout_stakers` call. Any account can call `payout_stakers`, which pays the reward to the | ||
Ank4n marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| validator as well as its nominators. Rewards are paged to maximum of [`Config::MaxExposurePageSize`] | ||
| nominators per page. Each page of staker payout needs to be called separately to ensure all nominators are | ||
| paid. This is to limit the i/o cost to mutate storage for each nominator's account. | ||
|
|
||
| Slashing can occur at any point in time, once misbehavior is reported. Once slashing is | ||
| determined, a value is deducted from the balance of the validator and all the nominators who | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,10 +15,12 @@ targets = ["x86_64-unknown-linux-gnu"] | |
| [dependencies] | ||
| codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] } | ||
| sp-api = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/api" } | ||
| sp-staking = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/staking" } | ||
|
|
||
| [features] | ||
| default = ["std"] | ||
| std = [ | ||
| "codec/std", | ||
| "sp-api/std", | ||
| "sp-staking/std", | ||
| ] | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
now's your last time to ask yourself: is the (legacy) name
eras_stakersactually good? shoudl we not use the oppurtunity and rename it to something better? :DThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have a strong opinion here.
On one hand, since this is meant for backward compatibility and all similar storage items are named similarly (eras_stakers, eras_stakers_paged, eras_stakers_overview ...), it makes sense to keep a similar name.
We could call it
eras_exposureas well but then we are exposing a new term (exposure) outside staking world which may be just an internal concept.Eras Stakersmight not be such a bad public name (staker info for the era).Do you have a name suggestion?