// This file is part of Substrate. // Copyright (C) 2020 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. //! Staking pallet benchmarking. use super::*; use crate::Module as Staking; use testing_utils::*; use sp_runtime::{traits::{Dispatchable, One}}; use frame_system::RawOrigin; pub use frame_benchmarking::{benchmarks, account}; const SEED: u32 = 0; const MAX_SPANS: u32 = 100; const MAX_VALIDATORS: u32 = 1000; const MAX_SLASHES: u32 = 1000; // Add slashing spans to a user account. Not relevant for actual use, only to benchmark // read and write operations. fn add_slashing_spans(who: &T::AccountId, spans: u32) { if spans == 0 { return } // For the first slashing span, we initialize let mut slashing_spans = crate::slashing::SlashingSpans::new(0); SpanSlash::::insert((who, 0), crate::slashing::SpanRecord::default()); for i in 1 .. spans { assert!(slashing_spans.end_span(i)); SpanSlash::::insert((who, i), crate::slashing::SpanRecord::default()); } SlashingSpans::::insert(who, slashing_spans); } // This function generates one validator being nominated by n nominators, and returns the validator // stash account. It also starts an era and creates pending payouts. pub fn create_validator_with_nominators(n: u32, upper_bound: u32) -> Result { let mut points_total = 0; let mut points_individual = Vec::new(); MinimumValidatorCount::put(0); let (v_stash, v_controller) = create_stash_controller::(0, 100)?; let validator_prefs = ValidatorPrefs { commission: Perbill::from_percent(50), }; Staking::::validate(RawOrigin::Signed(v_controller.clone()).into(), validator_prefs)?; let stash_lookup: ::Source = T::Lookup::unlookup(v_stash.clone()); points_total += 10; points_individual.push((v_stash.clone(), 10)); // Give the validator n nominators, but keep total users in the system the same. for i in 0 .. upper_bound { let (_n_stash, n_controller) = create_stash_controller::(u32::max_value() - i, 100)?; if i < n { Staking::::nominate(RawOrigin::Signed(n_controller.clone()).into(), vec![stash_lookup.clone()])?; } } ValidatorCount::put(1); // Start a new Era let new_validators = Staking::::new_era(SessionIndex::one()).unwrap(); assert!(new_validators.len() == 1); // Give Era Points let reward = EraRewardPoints:: { total: points_total, individual: points_individual.into_iter().collect(), }; let current_era = CurrentEra::get().unwrap(); ErasRewardPoints::::insert(current_era, reward); // Create reward pool let total_payout = T::Currency::minimum_balance() * 1000.into(); >::insert(current_era, total_payout); Ok(v_stash) } benchmarks! { _{ // User account seed let u in 0 .. 1000 => (); } bond { let u in ...; let stash = create_funded_user::("stash", u, 100); let controller = create_funded_user::("controller", u, 100); let controller_lookup: ::Source = T::Lookup::unlookup(controller.clone()); let reward_destination = RewardDestination::Staked; let amount = T::Currency::minimum_balance() * 10.into(); }: _(RawOrigin::Signed(stash.clone()), controller_lookup, amount, reward_destination) verify { assert!(Bonded::::contains_key(stash)); assert!(Ledger::::contains_key(controller)); } bond_extra { let u in ...; let (stash, controller) = create_stash_controller::(u, 100)?; let max_additional = T::Currency::minimum_balance() * 10.into(); let ledger = Ledger::::get(&controller).ok_or("ledger not created before")?; let original_bonded: BalanceOf = ledger.active; }: _(RawOrigin::Signed(stash), max_additional) verify { let ledger = Ledger::::get(&controller).ok_or("ledger not created after")?; let new_bonded: BalanceOf = ledger.active; assert!(original_bonded < new_bonded); } unbond { let u in ...; let (_, controller) = create_stash_controller::(u, 100)?; let amount = T::Currency::minimum_balance() * 10.into(); let ledger = Ledger::::get(&controller).ok_or("ledger not created before")?; let original_bonded: BalanceOf = ledger.active; }: _(RawOrigin::Signed(controller.clone()), amount) verify { let ledger = Ledger::::get(&controller).ok_or("ledger not created after")?; let new_bonded: BalanceOf = ledger.active; assert!(original_bonded > new_bonded); } // Withdraw only updates the ledger withdraw_unbonded_update { // Slashing Spans let s in 0 .. MAX_SPANS; let (stash, controller) = create_stash_controller::(0, 100)?; add_slashing_spans::(&stash, s); let amount = T::Currency::minimum_balance() * 5.into(); // Half of total Staking::::unbond(RawOrigin::Signed(controller.clone()).into(), amount)?; CurrentEra::put(EraIndex::max_value()); let ledger = Ledger::::get(&controller).ok_or("ledger not created before")?; let original_total: BalanceOf = ledger.total; }: withdraw_unbonded(RawOrigin::Signed(controller.clone()), s) verify { let ledger = Ledger::::get(&controller).ok_or("ledger not created after")?; let new_total: BalanceOf = ledger.total; assert!(original_total > new_total); } // Worst case scenario, everything is removed after the bonding duration withdraw_unbonded_kill { // Slashing Spans let s in 0 .. MAX_SPANS; let (stash, controller) = create_stash_controller::(0, 100)?; add_slashing_spans::(&stash, s); let amount = T::Currency::minimum_balance() * 10.into(); Staking::::unbond(RawOrigin::Signed(controller.clone()).into(), amount)?; CurrentEra::put(EraIndex::max_value()); let ledger = Ledger::::get(&controller).ok_or("ledger not created before")?; let original_total: BalanceOf = ledger.total; }: withdraw_unbonded(RawOrigin::Signed(controller.clone()), s) verify { assert!(!Ledger::::contains_key(controller)); } validate { let u in ...; let (stash, controller) = create_stash_controller::(u, 100)?; let prefs = ValidatorPrefs::default(); }: _(RawOrigin::Signed(controller), prefs) verify { assert!(Validators::::contains_key(stash)); } // Worst case scenario, MAX_NOMINATIONS nominate { let n in 1 .. MAX_NOMINATIONS as u32; let (stash, controller) = create_stash_controller::(n + 1, 100)?; let validators = create_validators::(n, 100)?; }: _(RawOrigin::Signed(controller), validators) verify { assert!(Nominators::::contains_key(stash)); } chill { let u in ...; let (_, controller) = create_stash_controller::(u, 100)?; }: _(RawOrigin::Signed(controller)) set_payee { let u in ...; let (stash, controller) = create_stash_controller::(u, 100)?; assert_eq!(Payee::::get(&stash), RewardDestination::Staked); }: _(RawOrigin::Signed(controller), RewardDestination::Controller) verify { assert_eq!(Payee::::get(&stash), RewardDestination::Controller); } set_controller { let u in ...; let (stash, _) = create_stash_controller::(u, 100)?; let new_controller = create_funded_user::("new_controller", u, 100); let new_controller_lookup = T::Lookup::unlookup(new_controller.clone()); }: _(RawOrigin::Signed(stash), new_controller_lookup) verify { assert!(Ledger::::contains_key(&new_controller)); } set_validator_count { let c in 0 .. MAX_VALIDATORS; }: _(RawOrigin::Root, c) verify { assert_eq!(ValidatorCount::get(), c); } force_no_eras { let i in 0 .. 1; }: _(RawOrigin::Root) verify { assert_eq!(ForceEra::get(), Forcing::ForceNone); } force_new_era {let i in 0 .. 1; }: _(RawOrigin::Root) verify { assert_eq!(ForceEra::get(), Forcing::ForceNew); } force_new_era_always { let i in 0 .. 1; }: _(RawOrigin::Root) verify { assert_eq!(ForceEra::get(), Forcing::ForceAlways); } // Worst case scenario, the list of invulnerables is very long. set_invulnerables { let v in 0 .. MAX_VALIDATORS; let mut invulnerables = Vec::new(); for i in 0 .. v { invulnerables.push(account("invulnerable", i, SEED)); } }: _(RawOrigin::Root, invulnerables) verify { assert_eq!(Invulnerables::::get().len(), v as usize); } force_unstake { // Slashing Spans let s in 0 .. MAX_SPANS; let (stash, controller) = create_stash_controller::(0, 100)?; add_slashing_spans::(&stash, s); }: _(RawOrigin::Root, stash, s) verify { assert!(!Ledger::::contains_key(&controller)); } cancel_deferred_slash { let s in 1 .. MAX_SLASHES; let mut unapplied_slashes = Vec::new(); let era = EraIndex::one(); for _ in 0 .. MAX_SLASHES { unapplied_slashes.push(UnappliedSlash::>::default()); } UnappliedSlashes::::insert(era, &unapplied_slashes); let slash_indices: Vec = (0 .. s).collect(); }: _(RawOrigin::Root, era, slash_indices) verify { assert_eq!(UnappliedSlashes::::get(&era).len(), (MAX_SLASHES - s) as usize); } payout_stakers { let n in 1 .. T::MaxNominatorRewardedPerValidator::get() as u32; let validator = create_validator_with_nominators::(n, T::MaxNominatorRewardedPerValidator::get() as u32)?; let current_era = CurrentEra::get().unwrap(); let caller = account("caller", 0, SEED); let balance_before = T::Currency::free_balance(&validator); }: _(RawOrigin::Signed(caller), validator.clone(), current_era) verify { // Validator has been paid! let balance_after = T::Currency::free_balance(&validator); assert!(balance_before < balance_after); } rebond { let l in 1 .. MAX_UNLOCKING_CHUNKS as u32; let (_, controller) = create_stash_controller::(u, 100)?; let mut staking_ledger = Ledger::::get(controller.clone()).unwrap(); let unlock_chunk = UnlockChunk::> { value: 1.into(), era: EraIndex::zero(), }; for _ in 0 .. l { staking_ledger.unlocking.push(unlock_chunk.clone()) } Ledger::::insert(controller.clone(), staking_ledger.clone()); let original_bonded: BalanceOf = staking_ledger.active; }: _(RawOrigin::Signed(controller.clone()), (l + 100).into()) verify { let ledger = Ledger::::get(&controller).ok_or("ledger not created after")?; let new_bonded: BalanceOf = ledger.active; assert!(original_bonded < new_bonded); } set_history_depth { let e in 1 .. 100; HistoryDepth::put(e); CurrentEra::put(e); for i in 0 .. e { >::insert(i, T::AccountId::default(), Exposure::>::default()); >::insert(i, T::AccountId::default(), Exposure::>::default()); >::insert(i, T::AccountId::default(), ValidatorPrefs::default()); >::insert(i, BalanceOf::::one()); >::insert(i, EraRewardPoints::::default()); >::insert(i, BalanceOf::::one()); ErasStartSessionIndex::insert(i, i); } }: _(RawOrigin::Root, EraIndex::zero(), u32::max_value()) verify { assert_eq!(HistoryDepth::get(), 0); } reap_stash { let s in 1 .. MAX_SPANS; let (stash, controller) = create_stash_controller::(0, 100)?; add_slashing_spans::(&stash, s); T::Currency::make_free_balance_be(&stash, 0.into()); }: _(RawOrigin::Signed(controller), stash.clone(), s) verify { assert!(!Bonded::::contains_key(&stash)); } new_era { let v in 1 .. 10; let n in 1 .. 100; MinimumValidatorCount::put(0); create_validators_with_nominators_for_era::(v, n, MAX_NOMINATIONS, false, None)?; let session_index = SessionIndex::one(); }: { let validators = Staking::::new_era(session_index).ok_or("`new_era` failed")?; assert!(validators.len() == v as usize); } do_slash { let l in 1 .. MAX_UNLOCKING_CHUNKS as u32; let (stash, controller) = create_stash_controller::(0, 100)?; let mut staking_ledger = Ledger::::get(controller.clone()).unwrap(); let unlock_chunk = UnlockChunk::> { value: 1.into(), era: EraIndex::zero(), }; for _ in 0 .. l { staking_ledger.unlocking.push(unlock_chunk.clone()) } Ledger::::insert(controller.clone(), staking_ledger.clone()); let slash_amount = T::Currency::minimum_balance() * 10.into(); let balance_before = T::Currency::free_balance(&stash); }: { crate::slashing::do_slash::( &stash, slash_amount, &mut BalanceOf::::zero(), &mut NegativeImbalanceOf::::zero() ); } verify { let balance_after = T::Currency::free_balance(&stash); assert!(balance_before > balance_after); } payout_all { let v in 1 .. 10; let n in 1 .. 100; MinimumValidatorCount::put(0); create_validators_with_nominators_for_era::(v, n, MAX_NOMINATIONS, false, None)?; // Start a new Era let new_validators = Staking::::new_era(SessionIndex::one()).unwrap(); assert!(new_validators.len() == v as usize); let current_era = CurrentEra::get().unwrap(); let mut points_total = 0; let mut points_individual = Vec::new(); let mut payout_calls = Vec::new(); for validator in new_validators.iter() { points_total += 10; points_individual.push((validator.clone(), 10)); payout_calls.push(Call::::payout_stakers(validator.clone(), current_era)) } // Give Era Points let reward = EraRewardPoints:: { total: points_total, individual: points_individual.into_iter().collect(), }; ErasRewardPoints::::insert(current_era, reward); // Create reward pool let total_payout = T::Currency::minimum_balance() * 1000.into(); >::insert(current_era, total_payout); let caller: T::AccountId = account("caller", 0, SEED); }: { for call in payout_calls { call.dispatch(RawOrigin::Signed(caller.clone()).into())?; } } // This benchmark create `v` validators intent, `n` nominators intent, each nominator nominate // MAX_NOMINATIONS in the set of the first `w` validators. // It builds a solution with `w` winners composed of nominated validators randomly nominated, // `a` assignment with MAX_NOMINATIONS. submit_solution_initial { // number of validator intent let v in 1000 .. 2000; // number of nominator intent let n in 1000 .. 2000; // number of assignments. Basically, number of active nominators. let a in 200 .. 500; // number of winners, also ValidatorCount let w in 16 .. 100; ensure!(w as usize >= MAX_NOMINATIONS, "doesn't support lower value"); let winners = create_validators_with_nominators_for_era::( v, n, MAX_NOMINATIONS, false, Some(w), )?; // needed for the solution to be generates. assert!(>::create_stakers_snapshot().0); // set number of winners ValidatorCount::put(w); // create a assignments in total for the w winners. let (winners, assignments) = create_assignments_for_offchain::(a, winners)?; let ( winners, compact, score, size ) = offchain_election::prepare_submission::(assignments, winners, false).unwrap(); // needed for the solution to be accepted >::put(ElectionStatus::Open(T::BlockNumber::from(1u32))); let era = >::current_era().unwrap_or(0); let caller: T::AccountId = account("caller", n, SEED); }: { let result = >::submit_election_solution( RawOrigin::Signed(caller.clone()).into(), winners, compact, score.clone(), era, size, ); assert!(result.is_ok()); } verify { // new solution has been accepted. assert_eq!(>::queued_score().unwrap(), score); } // same as submit_solution_initial but we place a very weak solution on chian first. submit_solution_better { // number of validator intent let v in 1000 .. 2000; // number of nominator intent let n in 1000 .. 2000; // number of assignments. Basically, number of active nominators. let a in 200 .. 500; // number of winners, also ValidatorCount let w in 16 .. 100; ensure!(w as usize >= MAX_NOMINATIONS, "doesn't support lower value"); let winners = create_validators_with_nominators_for_era::( v, n, MAX_NOMINATIONS, false, Some(w), )?; // needed for the solution to be generates. assert!(>::create_stakers_snapshot().0); // set number of winners ValidatorCount::put(w); // create a assignments in total for the w winners. let (winners, assignments) = create_assignments_for_offchain::(a, winners)?; let single_winner = winners[0].0.clone(); let ( winners, compact, score, size ) = offchain_election::prepare_submission::(assignments, winners, false).unwrap(); // needed for the solution to be accepted >::put(ElectionStatus::Open(T::BlockNumber::from(1u32))); let era = >::current_era().unwrap_or(0); let caller: T::AccountId = account("caller", n, SEED); // submit a very bad solution on-chain { // this is needed to fool the chain to accept this solution. ValidatorCount::put(1); let (winners, compact, score, size) = get_single_winner_solution::(single_winner)?; assert!( >::submit_election_solution( RawOrigin::Signed(caller.clone()).into(), winners, compact, score.clone(), era, size, ).is_ok()); // new solution has been accepted. assert_eq!(>::queued_score().unwrap(), score); ValidatorCount::put(w); } }: { let result = >::submit_election_solution( RawOrigin::Signed(caller.clone()).into(), winners, compact, score.clone(), era, size, ); assert!(result.is_ok()); } verify { // new solution has been accepted. assert_eq!(>::queued_score().unwrap(), score); } // This will be early rejected based on the score. submit_solution_weaker { // number of validator intent let v in 1000 .. 2000; // number of nominator intent let n in 1000 .. 2000; MinimumValidatorCount::put(0); create_validators_with_nominators_for_era::(v, n, MAX_NOMINATIONS, false, None)?; // needed for the solution to be generates. assert!(>::create_stakers_snapshot().0); // needed for the solution to be accepted >::put(ElectionStatus::Open(T::BlockNumber::from(1u32))); let caller: T::AccountId = account("caller", n, SEED); let era = >::current_era().unwrap_or(0); // submit a seq-phragmen with all the good stuff on chain. { let (winners, compact, score, size) = get_seq_phragmen_solution::(true); assert!( >::submit_election_solution( RawOrigin::Signed(caller.clone()).into(), winners, compact, score.clone(), era, size, ).is_ok() ); // new solution has been accepted. assert_eq!(>::queued_score().unwrap(), score); } // prepare a bad solution. This will be very early rejected. let (winners, compact, score, size) = get_weak_solution::(true); }: { assert!( >::submit_election_solution( RawOrigin::Signed(caller.clone()).into(), winners, compact, score.clone(), era, size, ).is_err() ); } } #[cfg(test)] mod tests { use super::*; use crate::mock::{ExtBuilder, Test, Balances, Staking, Origin}; use frame_support::assert_ok; #[test] fn create_validators_with_nominators_for_era_works() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { let v = 10; let n = 100; create_validators_with_nominators_for_era::(v, n, MAX_NOMINATIONS, false, None) .unwrap(); let count_validators = Validators::::iter().count(); let count_nominators = Nominators::::iter().count(); assert_eq!(count_validators, v as usize); assert_eq!(count_nominators, n as usize); }); } #[test] fn create_validator_with_nominators_works() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { let n = 10; let validator_stash = create_validator_with_nominators::( n, ::MaxNominatorRewardedPerValidator::get() as u32, ).unwrap(); let current_era = CurrentEra::get().unwrap(); let original_free_balance = Balances::free_balance(&validator_stash); assert_ok!(Staking::payout_stakers(Origin::signed(1337), validator_stash, current_era)); let new_free_balance = Balances::free_balance(&validator_stash); assert!(original_free_balance < new_free_balance); }); } #[test] fn add_slashing_spans_works() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { let n = 10; let validator_stash = create_validator_with_nominators::( n, ::MaxNominatorRewardedPerValidator::get() as u32, ).unwrap(); // Add 20 slashing spans let num_of_slashing_spans = 20; add_slashing_spans::(&validator_stash, num_of_slashing_spans); let slashing_spans = SlashingSpans::::get(&validator_stash).unwrap(); assert_eq!(slashing_spans.iter().count(), num_of_slashing_spans as usize); for i in 0 .. num_of_slashing_spans { assert!(SpanSlash::::contains_key((&validator_stash, i))); } // Test everything is cleaned up assert_ok!(Staking::kill_stash(&validator_stash, num_of_slashing_spans)); assert!(SlashingSpans::::get(&validator_stash).is_none()); for i in 0 .. num_of_slashing_spans { assert!(!SpanSlash::::contains_key((&validator_stash, i))); } }); } #[test] fn test_payout_all() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { let v = 10; let n = 100; let selected_benchmark = SelectedBenchmark::payout_all; let c = vec![(frame_benchmarking::BenchmarkParameter::v, v), (frame_benchmarking::BenchmarkParameter::n, n)]; let closure_to_benchmark = >::instance( &selected_benchmark, &c ).unwrap(); assert_ok!(closure_to_benchmark()); }); } #[test] fn test_benchmarks() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { assert_ok!(test_benchmark_bond::()); assert_ok!(test_benchmark_bond_extra::()); assert_ok!(test_benchmark_unbond::()); assert_ok!(test_benchmark_withdraw_unbonded_update::()); assert_ok!(test_benchmark_withdraw_unbonded_kill::()); assert_ok!(test_benchmark_validate::()); assert_ok!(test_benchmark_nominate::()); assert_ok!(test_benchmark_chill::()); assert_ok!(test_benchmark_set_payee::()); assert_ok!(test_benchmark_set_controller::()); assert_ok!(test_benchmark_set_validator_count::()); assert_ok!(test_benchmark_force_no_eras::()); assert_ok!(test_benchmark_force_new_era::()); assert_ok!(test_benchmark_force_new_era_always::()); assert_ok!(test_benchmark_set_invulnerables::()); assert_ok!(test_benchmark_force_unstake::()); assert_ok!(test_benchmark_cancel_deferred_slash::()); assert_ok!(test_benchmark_payout_stakers::()); assert_ok!(test_benchmark_rebond::()); assert_ok!(test_benchmark_set_history_depth::()); assert_ok!(test_benchmark_reap_stash::()); assert_ok!(test_benchmark_new_era::()); assert_ok!(test_benchmark_do_slash::()); assert_ok!(test_benchmark_payout_all::()); // only run one of them to same time on the CI. ignore the other two. assert_ok!(test_benchmark_submit_solution_initial::()); }); } #[test] #[ignore] fn test_benchmarks_offchain() { ExtBuilder::default().has_stakers(false).build().execute_with(|| { assert_ok!(test_benchmark_submit_solution_better::()); assert_ok!(test_benchmark_submit_solution_weaker::()); }); } }