`4091fe1c4f2a`

source

pallets/collator-selection/src/benchmarking.rs11.4 KiBsource history
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617// Original license:18// Copyright (C) 2021 Parity Technologies (UK) Ltd.19// SPDX-License-Identifier: Apache-2.02021// Licensed under the Apache License, Version 2.0 (the "License");22// you may not use this file except in compliance with the License.23// You may obtain a copy of the License at24//25// 	http://www.apache.org/licenses/LICENSE-2.026//27// Unless required by applicable law or agreed to in writing, software28// distributed under the License is distributed on an "AS IS" BASIS,29// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.30// See the License for the specific language governing permissions and31// limitations under the License.3233//! Benchmarking setup for pallet-collator-selection3435use super::*;3637#[allow(unused)]38use crate::Pallet as CollatorSelection;39use frame_benchmarking::{account, benchmarks, impl_benchmark_test_suite, whitelisted_caller};40use frame_support::{41	assert_ok,42	codec::Decode,43	traits::{Currency, EnsureOrigin, Get},44};45use frame_system::{EventRecord, RawOrigin};46use pallet_authorship::EventHandler;47use pallet_session::{self as session, SessionManager};48use pallet_configuration::{49	self as configuration, BalanceOf,50	CollatorSelectionDesiredCollatorsOverride as DesiredCollators,51	CollatorSelectionLicenseBondOverride as LicenseBond,52};53use sp_std::prelude::*;5455const SEED: u32 = 0;5657// TODO: remove if this is given in substrate commit.58macro_rules! whitelist {59	($acc:ident) => {60		frame_benchmarking::benchmarking::add_to_whitelist(61			frame_system::Account::<T>::hashed_key_for(&$acc).into(),62		);63	};64}6566fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {67	let events = frame_system::Pallet::<T>::events();68	let system_event: <T as frame_system::Config>::RuntimeEvent = generic_event.into();69	// compare to the last event record70	let EventRecord { event, .. } = &events[events.len() - 1];71	assert_eq!(event, &system_event);72}7374fn create_funded_user<T: Config>(75	string: &'static str,76	n: u32,77	balance_factor: u32,78) -> T::AccountId {79	let user = account(string, n, SEED);80	let balance = T::Currency::minimum_balance() * balance_factor.into();81	let _ = T::Currency::make_free_balance_be(&user, balance);82	user83}8485fn keys<T: Config + session::Config>(c: u32) -> <T as session::Config>::Keys {86	use rand::{RngCore, SeedableRng};8788	let keys = {89		let mut keys = [0u8; 128];9091		if c > 0 {92			let mut rng = rand::rngs::StdRng::seed_from_u64(c as u64);93			rng.fill_bytes(&mut keys);94		}9596		keys97	};9899	Decode::decode(&mut &keys[..]).unwrap()100}101102fn validator<T: Config + session::Config>(c: u32) -> (T::AccountId, <T as session::Config>::Keys) {103	(create_funded_user::<T>("candidate", c, 1000), keys::<T>(c))104}105106fn register_validators<T: Config + session::Config>(count: u32) -> Vec<T::AccountId> {107	let validators = (0..count).map(|c| validator::<T>(c)).collect::<Vec<_>>();108109	for (who, keys) in validators.clone() {110		<session::Pallet<T>>::set_keys(RawOrigin::Signed(who).into(), keys, Vec::new()).unwrap();111	}112113	validators.into_iter().map(|(who, _)| who).collect()114}115116fn register_invulnerables<T: Config + configuration::Config>(count: u32) {117	let candidates = (0..count)118		.map(|c| account("candidate", c, SEED))119		.collect::<Vec<_>>();120121	for who in candidates {122		<CollatorSelection<T>>::add_invulnerable(T::UpdateOrigin::successful_origin(), who)123			.unwrap();124	}125}126127fn register_candidates<T: Config + configuration::Config>(count: u32) {128	let candidates = (0..count)129		.map(|c| account("candidate", c, SEED))130		.collect::<Vec<_>>();131	/*assert!(132		<LicenseBond<T>>::get() > 0u32.into(),133		"Bond cannot be zero!"134	);*/135136	for who in candidates {137		T::Currency::make_free_balance_be(&who, <LicenseBond<T>>::get() * 2u32.into());138		<CollatorSelection<T>>::get_license(RawOrigin::Signed(who.clone()).into()).unwrap();139		<CollatorSelection<T>>::onboard(RawOrigin::Signed(who).into()).unwrap();140	}141}142143fn get_licenses<T: Config + configuration::Config>(count: u32) {144	let candidates = (0..count)145		.map(|c| account("candidate", c, SEED))146		.collect::<Vec<_>>();147	/*assert!(148		<LicenseBond<T>>::get() > 0u32.into(),149		"Bond cannot be zero!"150	);*/151152	for who in candidates {153		T::Currency::make_free_balance_be(&who, <LicenseBond<T>>::get() * 2u32.into());154		<CollatorSelection<T>>::get_license(RawOrigin::Signed(who.clone()).into()).unwrap();155	}156}157158benchmarks! {159	where_clause { where T: pallet_authorship::Config + session::Config + configuration::Config }160161	add_invulnerable {162		let b in 1 .. T::MaxCollators::get() - 3;163		register_validators::<T>(b);164		register_invulnerables::<T>(b);165166		// log::info!("{} {}", <Invulnerables<T>>::get().len(), b);167168		let new_invulnerable: T::AccountId = whitelisted_caller();169		let bond: BalanceOf<T> = T::Currency::minimum_balance() * 2u32.into();170		T::Currency::make_free_balance_be(&new_invulnerable, bond.clone());171172		<session::Pallet<T>>::set_keys(173			RawOrigin::Signed(new_invulnerable.clone()).into(),174			keys::<T>(b + 1),175			Vec::new()176		).unwrap();177178		let root_origin = T::UpdateOrigin::successful_origin();179	}: {180		assert_ok!(181			<CollatorSelection<T>>::add_invulnerable(root_origin, new_invulnerable.clone())182		);183	}184	verify {185		assert_last_event::<T>(Event::InvulnerableAdded{invulnerable: new_invulnerable}.into());186	}187188	remove_invulnerable {189		let b in 1 .. T::MaxCollators::get();190		register_validators::<T>(b);191		register_invulnerables::<T>(b);192193		let root_origin = T::UpdateOrigin::successful_origin();194		let leaving = <Invulnerables<T>>::get().last().unwrap().clone();195		whitelist!(leaving);196	}: {197		assert_ok!(198			<CollatorSelection<T>>::remove_invulnerable(root_origin, leaving.clone())199		);200	}201	verify {202		assert_last_event::<T>(Event::InvulnerableRemoved{invulnerable: leaving}.into());203	}204205	get_license {206		let c in 1 .. T::MaxCollators::get();207208		<LicenseBond<T>>::put(T::Currency::minimum_balance());209210		register_validators::<T>(c);211		get_licenses::<T>(c);212213		let caller: T::AccountId = whitelisted_caller();214		let bond: BalanceOf<T> = T::Currency::minimum_balance() * 2u32.into();215		T::Currency::make_free_balance_be(&caller, bond.clone());216217		<session::Pallet<T>>::set_keys(218			RawOrigin::Signed(caller.clone()).into(),219			keys::<T>(c + 1),220			Vec::new()221		).unwrap();222223	}: _(RawOrigin::Signed(caller.clone()))224	verify {225		assert_last_event::<T>(Event::LicenseObtained{account_id: caller, deposit: bond / 2u32.into()}.into());226	}227228	// worst case is when we have all the max-candidate slots filled except one, and we fill that229	// one.230	onboard {231		let c in 1 .. 5;232233		<LicenseBond<T>>::put(T::Currency::minimum_balance());234		<DesiredCollators<T>>::put(c + 2);235236		register_validators::<T>(c);237		register_candidates::<T>(c);238239		let caller: T::AccountId = whitelisted_caller();240		let bond: BalanceOf<T> = T::Currency::minimum_balance() * 2u32.into();241		T::Currency::make_free_balance_be(&caller, bond.clone());242243		let origin = RawOrigin::Signed(caller.clone());244245		<session::Pallet<T>>::set_keys(246			origin.clone().into(),247			keys::<T>(c + 1),248			Vec::new()249		).unwrap();250251		assert_ok!(252			<CollatorSelection<T>>::get_license(origin.clone().into())253		);254	}: _(origin)255	verify {256		assert_last_event::<T>(Event::CandidateAdded{account_id: caller}.into());257	}258259	// worst case is the last candidate leaving.260	offboard {261		let c in 1 .. T::MaxCollators::get();262		<LicenseBond<T>>::put(T::Currency::minimum_balance());263		<DesiredCollators<T>>::put(c + 2);264265		register_validators::<T>(c);266		register_candidates::<T>(c);267268		let leaving = <Candidates<T>>::get().last().unwrap().clone();269		whitelist!(leaving);270	}: _(RawOrigin::Signed(leaving.clone()))271	verify {272		assert_last_event::<T>(Event::CandidateRemoved{account_id: leaving}.into());273	}274275	// worst case is the last candidate leaving.276	release_license {277		let c in 1 .. T::MaxCollators::get();278		let bond = T::Currency::minimum_balance();279		<LicenseBond<T>>::put(bond);280		<DesiredCollators<T>>::put(c);281282		register_validators::<T>(c);283		register_candidates::<T>(c);284285		let leaving = <Candidates<T>>::get().last().unwrap().clone();286		whitelist!(leaving);287	}: _(RawOrigin::Signed(leaving.clone()))288	verify {289		assert_last_event::<T>(Event::LicenseReleased{account_id: leaving, deposit_returned: bond}.into());290	}291292	// worst case is the last candidate leaving.293	force_release_license {294		let c in 1 .. T::MaxCollators::get();295		let bond = T::Currency::minimum_balance();296		<LicenseBond<T>>::put(bond);297		<DesiredCollators<T>>::put(c);298299		register_validators::<T>(c);300		register_candidates::<T>(c);301302		let leaving = <Candidates<T>>::get().last().unwrap().clone();303		whitelist!(leaving);304		let origin = T::UpdateOrigin::successful_origin();305	}: {306		assert_ok!(307			<CollatorSelection<T>>::force_release_license(origin, leaving.clone())308		);309	}310	verify {311		assert_last_event::<T>(Event::LicenseReleased{account_id: leaving, deposit_returned: bond}.into());312	}313314	// worst case is paying a non-existing candidate account.315	note_author {316		<LicenseBond<T>>::put(T::Currency::minimum_balance());317		T::Currency::make_free_balance_be(318			&<CollatorSelection<T>>::account_id(),319			T::Currency::minimum_balance() * 4u32.into(),320		);321		let author = account("author", 0, SEED);322		let new_block: T::BlockNumber = 10u32.into();323324		frame_system::Pallet::<T>::set_block_number(new_block);325		assert!(T::Currency::free_balance(&author) == 0u32.into());326	}: {327		<CollatorSelection<T> as EventHandler<_, _>>::note_author(author.clone())328	} verify {329		assert!(T::Currency::free_balance(&author) > 0u32.into());330		assert_eq!(frame_system::Pallet::<T>::block_number(), new_block);331	}332333	// worst case for new session.334	new_session {335		let r in 1 .. T::MaxCollators::get();336		let c in 1 .. T::MaxCollators::get();337338		<LicenseBond<T>>::put(T::Currency::minimum_balance());339		<DesiredCollators<T>>::put(c);340		frame_system::Pallet::<T>::set_block_number(0u32.into());341342		register_validators::<T>(c);343		register_candidates::<T>(c);344345		let new_block: T::BlockNumber = 1800u32.into();346		let zero_block: T::BlockNumber = 0u32.into();347		let candidates = <Candidates<T>>::get();348349		let non_removals = c.saturating_sub(r);350351		for i in 0..c {352			<LastAuthoredBlock<T>>::insert(candidates[i as usize].clone(), zero_block);353		}354355		if non_removals > 0 {356			for i in 0..non_removals {357				<LastAuthoredBlock<T>>::insert(candidates[i as usize].clone(), new_block);358			}359		} else {360			for i in 0..c {361				<LastAuthoredBlock<T>>::insert(candidates[i as usize].clone(), new_block);362			}363		}364365		let pre_length = <Candidates<T>>::get().len();366367		frame_system::Pallet::<T>::set_block_number(new_block);368369		assert!(<Candidates<T>>::get().len() == c as usize);370	}: {371		<CollatorSelection<T> as SessionManager<_>>::new_session(0)372	} verify {373		if c > r {374			assert!(<Candidates<T>>::get().len() < pre_length);375		} else {376			assert!(<Candidates<T>>::get().len() == pre_length);377		}378	}379}380381impl_benchmark_test_suite!(382	CollatorSelection,383	crate::mock::new_test_ext(),384	crate::mock::Test,385);