// This file is part of Substrate. // Copyright (C) 2018-2021 Parity Technologies (UK) Ltd. // SPDX-License-Identifier: Apache-2.0 // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //! Test utilities use crate::*; use crate as staking; use frame_support::{ assert_ok, parameter_types, traits::{Currency, FindAuthor, Get, OnFinalize, OnInitialize, OneSessionHandler}, weights::constants::RocksDbWeight, IterableStorageMap, StorageDoubleMap, StorageMap, StorageValue, }; use sp_core::H256; use sp_io; use sp_runtime::{ curve::PiecewiseLinear, testing::{Header, TestXt, UintAuthorityId}, traits::{IdentityLookup, Zero}, }; use sp_staking::offence::{OffenceDetails, OnOffenceHandler}; use std::{cell::RefCell, collections::HashSet}; use frame_election_provider_support::onchain; pub const INIT_TIMESTAMP: u64 = 30_000; pub const BLOCK_TIME: u64 = 1000; /// The AccountId alias in this test module. pub(crate) type AccountId = u64; pub(crate) type AccountIndex = u64; pub(crate) type BlockNumber = u64; pub(crate) type Balance = u128; thread_local! { static SESSION: RefCell<(Vec, HashSet)> = RefCell::new(Default::default()); } /// Another session handler struct to test on_disabled. pub struct OtherSessionHandler; impl OneSessionHandler for OtherSessionHandler { type Key = UintAuthorityId; fn on_genesis_session<'a, I: 'a>(_: I) where I: Iterator, AccountId: 'a {} fn on_new_session<'a, I: 'a>(_: bool, validators: I, _: I,) where I: Iterator, AccountId: 'a { SESSION.with(|x| { *x.borrow_mut() = ( validators.map(|x| x.0.clone()).collect(), HashSet::new(), ) }); } fn on_disabled(validator_index: usize) { SESSION.with(|d| { let mut d = d.borrow_mut(); let value = d.0[validator_index]; d.1.insert(value); }) } } impl sp_runtime::BoundToRuntimeAppPublic for OtherSessionHandler { type Public = UintAuthorityId; } pub fn is_disabled(controller: AccountId) -> bool { let stash = Staking::ledger(&controller).unwrap().stash; SESSION.with(|d| d.borrow().1.contains(&stash)) } type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic; type Block = frame_system::mocking::MockBlock; frame_support::construct_runtime!( pub enum Test where Block = Block, NodeBlock = Block, UncheckedExtrinsic = UncheckedExtrinsic, { System: frame_system::{Pallet, Call, Config, Storage, Event}, Timestamp: pallet_timestamp::{Pallet, Call, Storage, Inherent}, Balances: pallet_balances::{Pallet, Call, Storage, Config, Event}, Staking: staking::{Pallet, Call, Config, Storage, Event}, Session: pallet_session::{Pallet, Call, Storage, Event, Config}, } ); /// Author of block is always 11 pub struct Author11; impl FindAuthor for Author11 { fn find_author<'a, I>(_digests: I) -> Option where I: 'a + IntoIterator, { Some(11) } } parameter_types! { pub const BlockHashCount: u64 = 250; pub BlockWeights: frame_system::limits::BlockWeights = frame_system::limits::BlockWeights::simple_max( frame_support::weights::constants::WEIGHT_PER_SECOND * 2 ); pub const MaxLocks: u32 = 1024; pub static SessionsPerEra: SessionIndex = 3; pub static ExistentialDeposit: Balance = 1; pub static SlashDeferDuration: EraIndex = 0; pub static Period: BlockNumber = 5; pub static Offset: BlockNumber = 0; } impl frame_system::Config for Test { type BaseCallFilter = (); type BlockWeights = (); type BlockLength = (); type DbWeight = RocksDbWeight; type Origin = Origin; type Index = AccountIndex; type BlockNumber = BlockNumber; type Call = Call; type Hash = H256; type Hashing = ::sp_runtime::traits::BlakeTwo256; type AccountId = AccountId; type Lookup = IdentityLookup; type Header = Header; type Event = Event; type BlockHashCount = BlockHashCount; type Version = (); type PalletInfo = PalletInfo; type AccountData = pallet_balances::AccountData; type OnNewAccount = (); type OnKilledAccount = (); type SystemWeightInfo = (); type SS58Prefix = (); } impl pallet_balances::Config for Test { type MaxLocks = MaxLocks; type Balance = Balance; type Event = Event; type DustRemoval = (); type ExistentialDeposit = ExistentialDeposit; type AccountStore = System; type WeightInfo = (); } parameter_types! { pub const UncleGenerations: u64 = 0; pub const DisabledValidatorsThreshold: Perbill = Perbill::from_percent(25); } sp_runtime::impl_opaque_keys! { pub struct SessionKeys { pub other: OtherSessionHandler, } } impl pallet_session::Config for Test { type SessionManager = pallet_session::historical::NoteHistoricalRoot; type Keys = SessionKeys; type ShouldEndSession = pallet_session::PeriodicSessions; type SessionHandler = (OtherSessionHandler,); type Event = Event; type ValidatorId = AccountId; type ValidatorIdOf = crate::StashOf; type DisabledValidatorsThreshold = DisabledValidatorsThreshold; type NextSessionRotation = pallet_session::PeriodicSessions; type WeightInfo = (); } impl pallet_session::historical::Config for Test { type FullIdentification = crate::Exposure; type FullIdentificationOf = crate::ExposureOf; } impl pallet_authorship::Config for Test { type FindAuthor = Author11; type UncleGenerations = UncleGenerations; type FilterUncle = (); type EventHandler = Module; } parameter_types! { pub const MinimumPeriod: u64 = 5; } impl pallet_timestamp::Config for Test { type Moment = u64; type OnTimestampSet = (); type MinimumPeriod = MinimumPeriod; type WeightInfo = (); } pallet_staking_reward_curve::build! { const I_NPOS: PiecewiseLinear<'static> = curve!( min_inflation: 0_025_000, max_inflation: 0_100_000, ideal_stake: 0_500_000, falloff: 0_050_000, max_piece_count: 40, test_precision: 0_005_000, ); } parameter_types! { pub const BondingDuration: EraIndex = 3; pub const RewardCurve: &'static PiecewiseLinear<'static> = &I_NPOS; pub const MaxNominatorRewardedPerValidator: u32 = 64; } thread_local! { pub static REWARD_REMAINDER_UNBALANCED: RefCell = RefCell::new(0); } pub struct RewardRemainderMock; impl OnUnbalanced> for RewardRemainderMock { fn on_nonzero_unbalanced(amount: NegativeImbalanceOf) { REWARD_REMAINDER_UNBALANCED.with(|v| { *v.borrow_mut() += amount.peek(); }); drop(amount); } } impl onchain::Config for Test { type AccountId = AccountId; type BlockNumber = BlockNumber; type BlockWeights = BlockWeights; type Accuracy = Perbill; type DataProvider = Staking; } impl Config for Test { type Currency = Balances; type UnixTime = Timestamp; type CurrencyToVote = frame_support::traits::SaturatingCurrencyToVote; type RewardRemainder = RewardRemainderMock; type Event = Event; type Slash = (); type Reward = (); type SessionsPerEra = SessionsPerEra; type SlashDeferDuration = SlashDeferDuration; type SlashCancelOrigin = frame_system::EnsureRoot; type BondingDuration = BondingDuration; type SessionInterface = Self; type EraPayout = ConvertCurve; type NextNewSession = Session; type MaxNominatorRewardedPerValidator = MaxNominatorRewardedPerValidator; type ElectionProvider = onchain::OnChainSequentialPhragmen; type WeightInfo = (); } impl frame_system::offchain::SendTransactionTypes for Test where Call: From, { type OverarchingCall = Call; type Extrinsic = Extrinsic; } pub type Extrinsic = TestXt; pub struct ExtBuilder { validator_pool: bool, nominate: bool, validator_count: u32, minimum_validator_count: u32, fair: bool, num_validators: Option, invulnerables: Vec, has_stakers: bool, initialize_first_session: bool, } impl Default for ExtBuilder { fn default() -> Self { Self { validator_pool: false, nominate: true, validator_count: 2, minimum_validator_count: 0, fair: true, num_validators: None, invulnerables: vec![], has_stakers: true, initialize_first_session: true, } } } impl ExtBuilder { pub fn existential_deposit(self, existential_deposit: Balance) -> Self { EXISTENTIAL_DEPOSIT.with(|v| *v.borrow_mut() = existential_deposit); self } pub fn validator_pool(mut self, validator_pool: bool) -> Self { self.validator_pool = validator_pool; self } pub fn nominate(mut self, nominate: bool) -> Self { self.nominate = nominate; self } pub fn validator_count(mut self, count: u32) -> Self { self.validator_count = count; self } pub fn minimum_validator_count(mut self, count: u32) -> Self { self.minimum_validator_count = count; self } pub fn slash_defer_duration(self, eras: EraIndex) -> Self { SLASH_DEFER_DURATION.with(|v| *v.borrow_mut() = eras); self } pub fn fair(mut self, is_fair: bool) -> Self { self.fair = is_fair; self } pub fn num_validators(mut self, num_validators: u32) -> Self { self.num_validators = Some(num_validators); self } pub fn invulnerables(mut self, invulnerables: Vec) -> Self { self.invulnerables = invulnerables; self } pub fn session_per_era(self, length: SessionIndex) -> Self { SESSIONS_PER_ERA.with(|v| *v.borrow_mut() = length); self } pub fn period(self, length: BlockNumber) -> Self { PERIOD.with(|v| *v.borrow_mut() = length); self } pub fn has_stakers(mut self, has: bool) -> Self { self.has_stakers = has; self } pub fn initialize_first_session(mut self, init: bool) -> Self { self.initialize_first_session = init; self } pub fn offset(self, offset: BlockNumber) -> Self { OFFSET.with(|v| *v.borrow_mut() = offset); self } pub fn build(self) -> sp_io::TestExternalities { sp_tracing::try_init_simple(); let mut storage = frame_system::GenesisConfig::default() .build_storage::() .unwrap(); let balance_factor = if ExistentialDeposit::get() > 1 { 256 } else { 1 }; let num_validators = self.num_validators.unwrap_or(self.validator_count); // Check that the number of validators is sensible. assert!(num_validators <= 8); let validators = (0..num_validators) .map(|x| ((x + 1) * 10 + 1) as AccountId) .collect::>(); let _ = pallet_balances::GenesisConfig:: { balances: vec![ (1, 10 * balance_factor), (2, 20 * balance_factor), (3, 300 * balance_factor), (4, 400 * balance_factor), (10, balance_factor), (11, balance_factor * 1000), (20, balance_factor), (21, balance_factor * 2000), (30, balance_factor), (31, balance_factor * 2000), (40, balance_factor), (41, balance_factor * 2000), (50, balance_factor), (51, balance_factor * 2000), (60, balance_factor), (61, balance_factor * 2000), (70, balance_factor), (71, balance_factor * 2000), (80, balance_factor), (81, balance_factor * 2000), (100, 2000 * balance_factor), (101, 2000 * balance_factor), // This allows us to have a total_payout different from 0. (999, 1_000_000_000_000), ], }.assimilate_storage(&mut storage); let mut stakers = vec![]; if self.has_stakers { let stake_21 = if self.fair { 1000 } else { 2000 }; let stake_31 = if self.validator_pool { balance_factor * 1000 } else { 1 }; let status_41 = if self.validator_pool { StakerStatus::::Validator } else { StakerStatus::::Idle }; let nominated = if self.nominate { vec![11, 21] } else { vec![] }; stakers = vec![ // (stash, controller, staked_amount, status) (11, 10, balance_factor * 1000, StakerStatus::::Validator), (21, 20, stake_21, StakerStatus::::Validator), (31, 30, stake_31, StakerStatus::::Validator), (41, 40, balance_factor * 1000, status_41), // nominator (101, 100, balance_factor * 500, StakerStatus::::Nominator(nominated)) ]; } let _ = staking::GenesisConfig::{ stakers: stakers, validator_count: self.validator_count, minimum_validator_count: self.minimum_validator_count, invulnerables: self.invulnerables, slash_reward_fraction: Perbill::from_percent(10), ..Default::default() } .assimilate_storage(&mut storage); let _ = pallet_session::GenesisConfig:: { keys: validators.iter().map(|x| ( *x, *x, SessionKeys { other: UintAuthorityId(*x as u64) } )).collect(), }.assimilate_storage(&mut storage); let mut ext = sp_io::TestExternalities::from(storage); ext.execute_with(|| { let validators = Session::validators(); SESSION.with(|x| *x.borrow_mut() = (validators.clone(), HashSet::new())); }); if self.initialize_first_session { // We consider all test to start after timestamp is initialized This must be ensured by // having `timestamp::on_initialize` called before `staking::on_initialize`. Also, if // session length is 1, then it is already triggered. ext.execute_with(|| { System::set_block_number(1); Session::on_initialize(1); Staking::on_initialize(1); Timestamp::set_timestamp(INIT_TIMESTAMP); }); } ext } pub fn build_and_execute(self, test: impl FnOnce() -> ()) { let mut ext = self.build(); ext.execute_with(test); ext.execute_with(post_conditions); } } fn post_conditions() { check_nominators(); check_exposures(); check_ledgers(); } fn check_ledgers() { // check the ledger of all stakers. Bonded::::iter().for_each(|(_, ctrl)| assert_ledger_consistent(ctrl)) } fn check_exposures() { // a check per validator to ensure the exposure struct is always sane. let era = active_era(); ErasStakers::::iter_prefix_values(era).for_each(|expo| { assert_eq!( expo.total as u128, expo.own as u128 + expo.others.iter().map(|e| e.value as u128).sum::(), "wrong total exposure.", ); }) } fn check_nominators() { // a check per nominator to ensure their entire stake is correctly distributed. Will only kick- // in if the nomination was submitted before the current era. let era = active_era(); >::iter() .filter_map(|(nominator, nomination)| if nomination.submitted_in > era { Some(nominator) } else { None }) .for_each(|nominator| { // must be bonded. assert_is_stash(nominator); let mut sum = 0; Session::validators() .iter() .map(|v| Staking::eras_stakers(era, v)) .for_each(|e| { let individual = e.others.iter().filter(|e| e.who == nominator).collect::>(); let len = individual.len(); match len { 0 => { /* not supporting this validator at all. */ }, 1 => sum += individual[0].value, _ => panic!("nominator cannot back a validator more than once."), }; }); let nominator_stake = Staking::slashable_balance_of(&nominator); // a nominator cannot over-spend. assert!( nominator_stake >= sum, "failed: Nominator({}) stake({}) >= sum divided({})", nominator, nominator_stake, sum, ); let diff = nominator_stake - sum; assert!(diff < 100); }); } fn assert_is_stash(acc: AccountId) { assert!(Staking::bonded(&acc).is_some(), "Not a stash."); } fn assert_ledger_consistent(ctrl: AccountId) { // ensures ledger.total == ledger.active + sum(ledger.unlocking). let ledger = Staking::ledger(ctrl).expect("Not a controller."); let real_total: Balance = ledger .unlocking .iter() .fold(ledger.active, |a, c| a + c.value); assert_eq!(real_total, ledger.total); assert!( ledger.active >= Balances::minimum_balance() || ledger.active == 0, "{}: active ledger amount ({}) must be greater than ED {}", ctrl, ledger.active, Balances::minimum_balance() ); } pub(crate) fn active_era() -> EraIndex { Staking::active_era().unwrap().index } pub(crate) fn current_era() -> EraIndex { Staking::current_era().unwrap() } pub(crate) fn bond_validator(stash: AccountId, ctrl: AccountId, val: Balance) { let _ = Balances::make_free_balance_be(&stash, val); let _ = Balances::make_free_balance_be(&ctrl, val); assert_ok!(Staking::bond( Origin::signed(stash), ctrl, val, RewardDestination::Controller, )); assert_ok!(Staking::validate( Origin::signed(ctrl), ValidatorPrefs::default() )); } pub(crate) fn bond_nominator( stash: AccountId, ctrl: AccountId, val: Balance, target: Vec, ) { let _ = Balances::make_free_balance_be(&stash, val); let _ = Balances::make_free_balance_be(&ctrl, val); assert_ok!(Staking::bond( Origin::signed(stash), ctrl, val, RewardDestination::Controller, )); assert_ok!(Staking::nominate(Origin::signed(ctrl), target)); } /// Progress to the given block, triggering session and era changes as we progress. /// /// This will finalize the previous block, initialize up to the given block, essentially simulating /// a block import/propose process where we first initialize the block, then execute some stuff (not /// in the function), and then finalize the block. pub(crate) fn run_to_block(n: BlockNumber) { Staking::on_finalize(System::block_number()); for b in (System::block_number() + 1)..=n { System::set_block_number(b); Session::on_initialize(b); Staking::on_initialize(b); Timestamp::set_timestamp(System::block_number() * BLOCK_TIME + INIT_TIMESTAMP); if b != n { Staking::on_finalize(System::block_number()); } } } /// Progresses from the current block number (whatever that may be) to the `P * session_index + 1`. pub(crate) fn start_session(session_index: SessionIndex) { let end: u64 = if Offset::get().is_zero() { (session_index as u64) * Period::get() } else { Offset::get() + (session_index.saturating_sub(1) as u64) * Period::get() }; run_to_block(end); // session must have progressed properly. assert_eq!( Session::current_index(), session_index, "current session index = {}, expected = {}", Session::current_index(), session_index, ); } /// Go one session forward. pub(crate) fn advance_session() { let current_index = Session::current_index(); start_session(current_index + 1); } /// Progress until the given era. pub(crate) fn start_active_era(era_index: EraIndex) { start_session((era_index * >::get()).into()); assert_eq!(active_era(), era_index); // One way or another, current_era must have changed before the active era, so they must match // at this point. assert_eq!(current_era(), active_era()); } pub(crate) fn current_total_payout_for_duration(duration: u64) -> Balance { let (payout, _rest) = ::EraPayout::era_payout( Staking::eras_total_stake(active_era()), Balances::total_issuance(), duration, ); assert!(payout > 0); payout } pub(crate) fn maximum_payout_for_duration(duration: u64) -> Balance { let (payout, rest) = ::EraPayout::era_payout( Staking::eras_total_stake(active_era()), Balances::total_issuance(), duration, ); payout + rest } /// Time it takes to finish a session. /// /// Note, if you see `time_per_session() - BLOCK_TIME`, it is fine. This is because we set the /// timestamp after on_initialize, so the timestamp is always one block old. pub(crate) fn time_per_session() -> u64 { Period::get() * BLOCK_TIME } /// Time it takes to finish an era. /// /// Note, if you see `time_per_era() - BLOCK_TIME`, it is fine. This is because we set the /// timestamp after on_initialize, so the timestamp is always one block old. pub(crate) fn time_per_era() -> u64 { time_per_session() * SessionsPerEra::get() as u64 } /// Time that will be calculated for the reward per era. pub(crate) fn reward_time_per_era() -> u64 { time_per_era() - BLOCK_TIME } pub(crate) fn reward_all_elected() { let rewards = ::SessionInterface::validators() .into_iter() .map(|v| (v, 1)); >::reward_by_ids(rewards) } pub(crate) fn validator_controllers() -> Vec { Session::validators() .into_iter() .map(|s| Staking::bonded(&s).expect("no controller for validator")) .collect() } pub(crate) fn on_offence_in_era( offenders: &[OffenceDetails< AccountId, pallet_session::historical::IdentificationTuple, >], slash_fraction: &[Perbill], era: EraIndex, ) { let bonded_eras = crate::BondedEras::get(); for &(bonded_era, start_session) in bonded_eras.iter() { if bonded_era == era { let _ = Staking::on_offence(offenders, slash_fraction, start_session).unwrap(); return; } else if bonded_era > era { break; } } if Staking::active_era().unwrap().index == era { let _ = Staking::on_offence( offenders, slash_fraction, Staking::eras_start_session_index(era).unwrap() ).unwrap(); } else { panic!("cannot slash in era {}", era); } } pub(crate) fn on_offence_now( offenders: &[OffenceDetails>], slash_fraction: &[Perbill], ) { let now = Staking::active_era().unwrap().index; on_offence_in_era(offenders, slash_fraction, now) } pub(crate) fn add_slash(who: &AccountId) { on_offence_now( &[ OffenceDetails { offender: (who.clone(), Staking::eras_stakers(active_era(), who.clone())), reporters: vec![], }, ], &[Perbill::from_percent(10)], ); } /// Make all validator and nominator request their payment pub(crate) fn make_all_reward_payment(era: EraIndex) { let validators_with_reward = ErasRewardPoints::::get(era).individual.keys().cloned().collect::>(); // reward validators for validator_controller in validators_with_reward.iter().filter_map(Staking::bonded) { let ledger = >::get(&validator_controller).unwrap(); assert_ok!(Staking::payout_stakers( Origin::signed(1337), ledger.stash, era )); } } #[macro_export] macro_rules! assert_session_era { ($session:expr, $era:expr) => { assert_eq!( Session::current_index(), $session, "wrong session {} != {}", Session::current_index(), $session, ); assert_eq!( Staking::current_era().unwrap(), $era, "wrong current era {} != {}", Staking::current_era().unwrap(), $era, ); }; } pub(crate) fn staking_events() -> Vec> { System::events().into_iter().map(|r| r.event).filter_map(|e| { if let Event::staking(inner) = e { Some(inner) } else { None } }).collect() } pub(crate) fn balances(who: &AccountId) -> (Balance, Balance) { (Balances::free_balance(who), Balances::reserved_balance(who)) }