// This file is part of Substrate. // Copyright (C) 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. //! Identity pallet benchmarking. #![cfg(feature = "runtime-benchmarks")] use super::*; use crate::Pallet as Identity; use codec::Encode; use frame_benchmarking::{account, v2::*, whitelisted_caller, BenchmarkError}; use frame_support::{ assert_ok, ensure, traits::{EnsureOrigin, Get, OnFinalize, OnInitialize}, }; use frame_system::RawOrigin; use sp_io::crypto::{sr25519_generate, sr25519_sign}; use sp_runtime::{ traits::{Bounded, IdentifyAccount, One}, MultiSignature, MultiSigner, }; const SEED: u32 = 0; fn assert_has_event(generic_event: ::RuntimeEvent) { frame_system::Pallet::::assert_has_event(generic_event.into()); } fn assert_last_event(generic_event: ::RuntimeEvent) { frame_system::Pallet::::assert_last_event(generic_event.into()); } fn run_to_block(n: frame_system::pallet_prelude::BlockNumberFor) { while frame_system::Pallet::::block_number() < n { crate::Pallet::::on_finalize(frame_system::Pallet::::block_number()); frame_system::Pallet::::on_finalize(frame_system::Pallet::::block_number()); frame_system::Pallet::::set_block_number( frame_system::Pallet::::block_number() + One::one(), ); frame_system::Pallet::::on_initialize(frame_system::Pallet::::block_number()); crate::Pallet::::on_initialize(frame_system::Pallet::::block_number()); } } // Adds `r` registrars to the Identity Pallet. These registrars will have set fees and fields. fn add_registrars(r: u32) -> Result<(), &'static str> { for i in 0..r { let registrar: T::AccountId = account("registrar", i, SEED); let registrar_lookup = T::Lookup::unlookup(registrar.clone()); let _ = T::Currency::make_free_balance_be(®istrar, BalanceOf::::max_value()); let registrar_origin = T::RegistrarOrigin::try_successful_origin() .expect("RegistrarOrigin has no successful origin required for the benchmark"); Identity::::add_registrar(registrar_origin, registrar_lookup)?; Identity::::set_fee(RawOrigin::Signed(registrar.clone()).into(), i, 10u32.into())?; let fields = T::IdentityInformation::all_fields(); Identity::::set_fields(RawOrigin::Signed(registrar.clone()).into(), i, fields)?; } assert_eq!(Registrars::::get().len(), r as usize); Ok(()) } // Create `s` sub-accounts for the identity of `who` and return them. // Each will have 32 bytes of raw data added to it. fn create_sub_accounts( who: &T::AccountId, s: u32, ) -> Result, &'static str> { let mut subs = Vec::new(); let who_origin = RawOrigin::Signed(who.clone()); let data = Data::Raw(vec![0; 32].try_into().unwrap()); for i in 0..s { let sub_account = account("sub", i, SEED); subs.push((sub_account, data.clone())); } // Set identity so `set_subs` does not fail. if IdentityOf::::get(who).is_none() { let _ = T::Currency::make_free_balance_be(who, BalanceOf::::max_value() / 2u32.into()); let info = T::IdentityInformation::create_identity_info(); Identity::::set_identity(who_origin.into(), Box::new(info))?; } Ok(subs) } // Adds `s` sub-accounts to the identity of `who`. Each will have 32 bytes of raw data added to it. // This additionally returns the vector of sub-accounts so it can be modified if needed. fn add_sub_accounts( who: &T::AccountId, s: u32, ) -> Result, &'static str> { let who_origin = RawOrigin::Signed(who.clone()); let subs = create_sub_accounts::(who, s)?; Identity::::set_subs(who_origin.into(), subs.clone())?; Ok(subs) } fn bench_suffix() -> Vec { b"bench".to_vec() } fn bench_username() -> Vec { // len = 24 b"veryfastbenchmarkmachine".to_vec() } fn bounded_username(username: Vec, suffix: Vec) -> Username { let mut full_username = Vec::with_capacity(username.len() + suffix.len() + 1); full_username.extend(username); full_username.extend(b"."); full_username.extend(suffix); Username::::try_from(full_username).expect("test usernames should fit within bounds") } #[benchmarks( where ::AccountId: From, T::OffchainSignature: From, )] mod benchmarks { use super::*; #[benchmark] fn add_registrar(r: Linear<1, { T::MaxRegistrars::get() - 1 }>) -> Result<(), BenchmarkError> { add_registrars::(r)?; ensure!(Registrars::::get().len() as u32 == r, "Registrars not set up correctly."); let origin = T::RegistrarOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?; let account = T::Lookup::unlookup(account("registrar", r + 1, SEED)); #[extrinsic_call] _(origin as T::RuntimeOrigin, account); ensure!(Registrars::::get().len() as u32 == r + 1, "Registrars not added."); Ok(()) } #[benchmark] fn set_identity(r: Linear<1, { T::MaxRegistrars::get() }>) -> Result<(), BenchmarkError> { add_registrars::(r)?; let caller: T::AccountId = whitelisted_caller(); let caller_lookup = T::Lookup::unlookup(caller.clone()); let caller_origin: ::RuntimeOrigin = RawOrigin::Signed(caller.clone()).into(); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); // Add an initial identity let initial_info = T::IdentityInformation::create_identity_info(); Identity::::set_identity(caller_origin.clone(), Box::new(initial_info.clone()))?; // User requests judgement from all the registrars, and they approve for i in 0..r { let registrar: T::AccountId = account("registrar", i, SEED); let _ = T::Lookup::unlookup(registrar.clone()); let balance_to_use = T::Currency::minimum_balance() * 10u32.into(); let _ = T::Currency::make_free_balance_be(®istrar, balance_to_use); Identity::::request_judgement(caller_origin.clone(), i, 10u32.into())?; Identity::::provide_judgement( RawOrigin::Signed(registrar).into(), i, caller_lookup.clone(), Judgement::Reasonable, T::Hashing::hash_of(&initial_info), )?; } #[extrinsic_call] _( RawOrigin::Signed(caller.clone()), Box::new(T::IdentityInformation::create_identity_info()), ); assert_last_event::(Event::::IdentitySet { who: caller }.into()); Ok(()) } // We need to split `set_subs` into two benchmarks to accurately isolate the potential // writes caused by new or old sub accounts. The actual weight should simply be // the sum of these two weights. #[benchmark] fn set_subs_new(s: Linear<0, { T::MaxSubAccounts::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); // Create a new subs vec with sub accounts let subs = create_sub_accounts::(&caller, s)?; ensure!(SubsOf::::get(&caller).1.len() == 0, "Caller already has subs"); #[extrinsic_call] set_subs(RawOrigin::Signed(caller.clone()), subs); ensure!(SubsOf::::get(&caller).1.len() as u32 == s, "Subs not added"); Ok(()) } #[benchmark] fn set_subs_old(p: Linear<0, { T::MaxSubAccounts::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); // Give them p many previous sub accounts. let _ = add_sub_accounts::(&caller, p)?; // Remove all subs. let subs = create_sub_accounts::(&caller, 0)?; ensure!(SubsOf::::get(&caller).1.len() as u32 == p, "Caller does have subs",); #[extrinsic_call] set_subs(RawOrigin::Signed(caller.clone()), subs); ensure!(SubsOf::::get(&caller).1.len() == 0, "Subs not removed"); Ok(()) } #[benchmark] fn clear_identity( r: Linear<1, { T::MaxRegistrars::get() }>, s: Linear<0, { T::MaxSubAccounts::get() }>, ) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let caller_origin = ::RuntimeOrigin::from(RawOrigin::Signed(caller.clone())); let caller_lookup = ::unlookup(caller.clone()); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); // Register the registrars add_registrars::(r)?; // Add sub accounts let _ = add_sub_accounts::(&caller, s)?; // Create their main identity with x additional fields let info = T::IdentityInformation::create_identity_info(); Identity::::set_identity(caller_origin.clone(), Box::new(info.clone()))?; // User requests judgement from all the registrars, and they approve for i in 0..r { let registrar: T::AccountId = account("registrar", i, SEED); let balance_to_use = T::Currency::minimum_balance() * 10u32.into(); let _ = T::Currency::make_free_balance_be(®istrar, balance_to_use); Identity::::request_judgement(caller_origin.clone(), i, 10u32.into())?; Identity::::provide_judgement( RawOrigin::Signed(registrar).into(), i, caller_lookup.clone(), Judgement::Reasonable, T::Hashing::hash_of(&info), )?; } ensure!(IdentityOf::::contains_key(&caller), "Identity does not exist."); #[extrinsic_call] _(RawOrigin::Signed(caller.clone())); ensure!(!IdentityOf::::contains_key(&caller), "Identity not cleared."); Ok(()) } #[benchmark] fn request_judgement(r: Linear<1, { T::MaxRegistrars::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); // Register the registrars add_registrars::(r)?; // Create their main identity with x additional fields let info = T::IdentityInformation::create_identity_info(); let caller_origin = ::RuntimeOrigin::from(RawOrigin::Signed(caller.clone())); Identity::::set_identity(caller_origin.clone(), Box::new(info))?; #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), r - 1, 10u32.into()); assert_last_event::( Event::::JudgementRequested { who: caller, registrar_index: r - 1 }.into(), ); Ok(()) } #[benchmark] fn cancel_request(r: Linear<1, { T::MaxRegistrars::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); // Register the registrars add_registrars::(r)?; // Create their main identity with x additional fields let info = T::IdentityInformation::create_identity_info(); let caller_origin = ::RuntimeOrigin::from(RawOrigin::Signed(caller.clone())); Identity::::set_identity(caller_origin.clone(), Box::new(info))?; Identity::::request_judgement(caller_origin.clone(), r - 1, 10u32.into())?; #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), r - 1); assert_last_event::( Event::::JudgementUnrequested { who: caller, registrar_index: r - 1 }.into(), ); Ok(()) } #[benchmark] fn set_fee(r: Linear<1, { T::MaxRegistrars::get() - 1 }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let caller_lookup = T::Lookup::unlookup(caller.clone()); add_registrars::(r)?; let registrar_origin = T::RegistrarOrigin::try_successful_origin() .expect("RegistrarOrigin has no successful origin required for the benchmark"); Identity::::add_registrar(registrar_origin, caller_lookup)?; let registrars = Registrars::::get(); ensure!(registrars[r as usize].as_ref().unwrap().fee == 0u32.into(), "Fee already set."); #[extrinsic_call] _(RawOrigin::Signed(caller), r, 100u32.into()); let updated_registrars = Registrars::::get(); ensure!( updated_registrars[r as usize].as_ref().unwrap().fee == 100u32.into(), "Fee not changed." ); Ok(()) } #[benchmark] fn set_account_id(r: Linear<1, { T::MaxRegistrars::get() - 1 }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let caller_lookup = T::Lookup::unlookup(caller.clone()); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); add_registrars::(r)?; let registrar_origin = T::RegistrarOrigin::try_successful_origin() .expect("RegistrarOrigin has no successful origin required for the benchmark"); Identity::::add_registrar(registrar_origin, caller_lookup)?; let registrars = Registrars::::get(); ensure!(registrars[r as usize].as_ref().unwrap().account == caller, "id not set."); let new_account = T::Lookup::unlookup(account("new", 0, SEED)); #[extrinsic_call] _(RawOrigin::Signed(caller), r, new_account); let updated_registrars = Registrars::::get(); ensure!( updated_registrars[r as usize].as_ref().unwrap().account == account("new", 0, SEED), "id not changed." ); Ok(()) } #[benchmark] fn set_fields(r: Linear<1, { T::MaxRegistrars::get() - 1 }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let caller_lookup = T::Lookup::unlookup(caller.clone()); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); add_registrars::(r)?; let registrar_origin = T::RegistrarOrigin::try_successful_origin() .expect("RegistrarOrigin has no successful origin required for the benchmark"); Identity::::add_registrar(registrar_origin, caller_lookup)?; let registrars = Registrars::::get(); ensure!( registrars[r as usize].as_ref().unwrap().fields == Default::default(), "fields already set." ); let fields = T::IdentityInformation::all_fields(); #[extrinsic_call] _(RawOrigin::Signed(caller), r, fields); let updated_registrars = Registrars::::get(); ensure!( updated_registrars[r as usize].as_ref().unwrap().fields != Default::default(), "fields not set." ); Ok(()) } #[benchmark] fn provide_judgement( r: Linear<1, { T::MaxRegistrars::get() - 1 }>, ) -> Result<(), BenchmarkError> { // The user let user: T::AccountId = account("user", r, SEED); let user_origin = ::RuntimeOrigin::from(RawOrigin::Signed(user.clone())); let user_lookup = ::unlookup(user.clone()); let _ = T::Currency::make_free_balance_be(&user, BalanceOf::::max_value()); let caller: T::AccountId = whitelisted_caller(); let caller_lookup = T::Lookup::unlookup(caller.clone()); let _ = T::Currency::make_free_balance_be(&caller, BalanceOf::::max_value()); add_registrars::(r)?; let info = T::IdentityInformation::create_identity_info(); let info_hash = T::Hashing::hash_of(&info); Identity::::set_identity(user_origin.clone(), Box::new(info))?; let registrar_origin = T::RegistrarOrigin::try_successful_origin() .expect("RegistrarOrigin has no successful origin required for the benchmark"); Identity::::add_registrar(registrar_origin, caller_lookup)?; Identity::::request_judgement(user_origin, r, 10u32.into())?; #[extrinsic_call] _(RawOrigin::Signed(caller), r, user_lookup, Judgement::Reasonable, info_hash); assert_last_event::( Event::::JudgementGiven { target: user, registrar_index: r }.into(), ); Ok(()) } #[benchmark] fn kill_identity( r: Linear<1, { T::MaxRegistrars::get() }>, s: Linear<0, { T::MaxSubAccounts::get() }>, ) -> Result<(), BenchmarkError> { add_registrars::(r)?; let target: T::AccountId = account("target", 0, SEED); let target_origin: ::RuntimeOrigin = RawOrigin::Signed(target.clone()).into(); let target_lookup = T::Lookup::unlookup(target.clone()); let _ = T::Currency::make_free_balance_be(&target, BalanceOf::::max_value()); let info = T::IdentityInformation::create_identity_info(); Identity::::set_identity(target_origin.clone(), Box::new(info.clone()))?; let _ = add_sub_accounts::(&target, s)?; // User requests judgement from all the registrars, and they approve for i in 0..r { let registrar: T::AccountId = account("registrar", i, SEED); let balance_to_use = T::Currency::minimum_balance() * 10u32.into(); let _ = T::Currency::make_free_balance_be(®istrar, balance_to_use); Identity::::request_judgement(target_origin.clone(), i, 10u32.into())?; Identity::::provide_judgement( RawOrigin::Signed(registrar).into(), i, target_lookup.clone(), Judgement::Reasonable, T::Hashing::hash_of(&info), )?; } ensure!(IdentityOf::::contains_key(&target), "Identity not set"); let origin = T::ForceOrigin::try_successful_origin().map_err(|_| BenchmarkError::Weightless)?; #[extrinsic_call] _(origin as T::RuntimeOrigin, target_lookup); ensure!(!IdentityOf::::contains_key(&target), "Identity not removed"); Ok(()) } #[benchmark] fn add_sub(s: Linear<0, { T::MaxSubAccounts::get() - 1 }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let _ = add_sub_accounts::(&caller, s)?; let sub = account("new_sub", 0, SEED); let data = Data::Raw(vec![0; 32].try_into().unwrap()); ensure!(SubsOf::::get(&caller).1.len() as u32 == s, "Subs not set."); #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), T::Lookup::unlookup(sub), data); ensure!(SubsOf::::get(&caller).1.len() as u32 == s + 1, "Subs not added."); Ok(()) } #[benchmark] fn rename_sub(s: Linear<1, { T::MaxSubAccounts::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let (sub, _) = add_sub_accounts::(&caller, s)?.remove(0); let data = Data::Raw(vec![1; 32].try_into().unwrap()); ensure!(SuperOf::::get(&sub).unwrap().1 != data, "data already set"); #[extrinsic_call] _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub.clone()), data.clone()); ensure!(SuperOf::::get(&sub).unwrap().1 == data, "data not set"); Ok(()) } #[benchmark] fn remove_sub(s: Linear<1, { T::MaxSubAccounts::get() }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let (sub, _) = add_sub_accounts::(&caller, s)?.remove(0); ensure!(SuperOf::::contains_key(&sub), "Sub doesn't exists"); #[extrinsic_call] _(RawOrigin::Signed(caller), T::Lookup::unlookup(sub.clone())); ensure!(!SuperOf::::contains_key(&sub), "Sub not removed"); Ok(()) } #[benchmark] fn quit_sub(s: Linear<0, { T::MaxSubAccounts::get() - 1 }>) -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let sup = account("super", 0, SEED); let _ = add_sub_accounts::(&sup, s)?; let sup_origin = RawOrigin::Signed(sup).into(); Identity::::add_sub( sup_origin, T::Lookup::unlookup(caller.clone()), Data::Raw(vec![0; 32].try_into().unwrap()), )?; ensure!(SuperOf::::contains_key(&caller), "Sub doesn't exists"); #[extrinsic_call] _(RawOrigin::Signed(caller.clone())); ensure!(!SuperOf::::contains_key(&caller), "Sub not removed"); Ok(()) } #[benchmark] fn add_username_authority() -> Result<(), BenchmarkError> { let origin = T::UsernameAuthorityOrigin::try_successful_origin().expect("can generate origin"); let authority: T::AccountId = account("authority", 0, SEED); let authority_lookup = T::Lookup::unlookup(authority.clone()); let suffix = bench_suffix(); let allocation = 10; #[extrinsic_call] _(origin as T::RuntimeOrigin, authority_lookup, suffix, allocation); assert_last_event::(Event::::AuthorityAdded { authority }.into()); Ok(()) } #[benchmark] fn remove_username_authority() -> Result<(), BenchmarkError> { let origin = T::UsernameAuthorityOrigin::try_successful_origin().expect("can generate origin"); let authority: T::AccountId = account("authority", 0, SEED); let authority_lookup = T::Lookup::unlookup(authority.clone()); let suffix = bench_suffix(); let allocation = 10; assert_ok!(Identity::::add_username_authority( origin.clone(), authority_lookup.clone(), suffix, allocation )); #[extrinsic_call] _(origin as T::RuntimeOrigin, authority_lookup); assert_last_event::(Event::::AuthorityRemoved { authority }.into()); Ok(()) } #[benchmark] fn set_username_for() -> Result<(), BenchmarkError> { // Set up a username authority. let auth_origin = T::UsernameAuthorityOrigin::try_successful_origin().expect("can generate origin"); let authority: T::AccountId = account("authority", 0, SEED); let authority_lookup = T::Lookup::unlookup(authority.clone()); let suffix = bench_suffix(); let allocation = 10; Identity::::add_username_authority( auth_origin, authority_lookup, suffix.clone(), allocation, )?; let username = bench_username(); let bounded_username = bounded_username::(username.clone(), suffix.clone()); let encoded_username = Encode::encode(&bounded_username.to_vec()); let public = sr25519_generate(0.into(), None); let who_account: T::AccountId = MultiSigner::Sr25519(public).into_account().into(); let who_lookup = T::Lookup::unlookup(who_account.clone()); let signature = MultiSignature::Sr25519(sr25519_sign(0.into(), &public, &encoded_username).unwrap()); // Verify signature here to avoid surprise errors at runtime assert!(signature.verify(&encoded_username[..], &public.into())); #[extrinsic_call] _(RawOrigin::Signed(authority.clone()), who_lookup, username, Some(signature.into())); assert_has_event::( Event::::UsernameSet { who: who_account.clone(), username: bounded_username.clone(), } .into(), ); assert_has_event::( Event::::PrimaryUsernameSet { who: who_account, username: bounded_username }.into(), ); Ok(()) } #[benchmark] fn accept_username() -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let username = bounded_username::(bench_username(), bench_suffix()); Identity::::queue_acceptance(&caller, username.clone()); #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), username.clone()); assert_last_event::(Event::::UsernameSet { who: caller, username }.into()); Ok(()) } #[benchmark] fn remove_expired_approval() -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let username = bounded_username::(bench_username(), bench_suffix()); Identity::::queue_acceptance(&caller, username.clone()); let expected_expiration = frame_system::Pallet::::block_number() + T::PendingUsernameExpiration::get(); run_to_block::(expected_expiration + One::one()); #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), username); assert_last_event::(Event::::PreapprovalExpired { whose: caller }.into()); Ok(()) } #[benchmark] fn set_primary_username() -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let first_username = bounded_username::(bench_username(), bench_suffix()); let second_username = bounded_username::(b"slowbenchmark".to_vec(), bench_suffix()); // First one will be set as primary. Second will not be. Identity::::insert_username(&caller, first_username); Identity::::insert_username(&caller, second_username.clone()); #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), second_username.clone()); assert_last_event::( Event::::PrimaryUsernameSet { who: caller, username: second_username }.into(), ); Ok(()) } #[benchmark] fn remove_dangling_username() -> Result<(), BenchmarkError> { let caller: T::AccountId = whitelisted_caller(); let first_username = bounded_username::(bench_username(), bench_suffix()); let second_username = bounded_username::(b"slowbenchmark".to_vec(), bench_suffix()); // First one will be set as primary. Second will not be. Identity::::insert_username(&caller, first_username); Identity::::insert_username(&caller, second_username.clone()); // User calls `clear_identity`, leaving their second username as "dangling" Identity::::clear_identity(RawOrigin::Signed(caller.clone()).into())?; #[extrinsic_call] _(RawOrigin::Signed(caller.clone()), second_username.clone()); assert_last_event::( Event::::DanglingUsernameRemoved { who: caller, username: second_username }.into(), ); Ok(()) } impl_benchmark_test_suite!(Identity, crate::tests::new_test_ext(), crate::tests::Test); }