Function pallet_staking::dispatchables::payout_stakers_by_page
source · pub fn payout_stakers_by_page<T: Config>(
validator_stash: T::AccountId,
era: EraIndex,
page: Page,
)
Expand description
Pay out a page of the stakers behind a validator for the given era and page.
validator_stash
is the stash account of the validator.era
may be any era between[current_era - history_depth; current_era]
.page
is the page index of nominators to pay out with value between 0 andnum_nominators / T::MaxExposurePageSize
.
The origin of this call must be Signed. Any account can call this function, even if it is not one of the stakers.
If a validator has more than Config::MaxExposurePageSize
nominators backing
them, then the list of nominators is paged, with each page being capped at
[Config::MaxExposurePageSize
.] If a validator has more than one page of nominators,
the call needs to be made for each page separately in order for all the nominators
backing a validator to receive the reward. The nominators are not sorted across pages
and so it should not be assumed the highest staker would be on the topmost page and vice
versa. If rewards are not claimed in Config::HistoryDepth
eras, they are lost.
§Warning: Doc-Only
This function is an automatically generated, and is doc-only, uncallable
stub. See the real version in
Pallet::payout_stakers_by_page
.