`ac9b5eeb31df`

source

pallets/common/src/benchmarking.rs6.0 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#![allow(missing_docs)]1819use sp_std::vec::Vec;20use crate::{Config, CollectionHandle, Pallet};21use pallet_evm::account::CrossAccountId;22use frame_benchmarking::{benchmarks, account};23use up_data_structs::{24	CollectionMode, CollectionFlags, CreateCollectionData, CollectionId, Property, PropertyKey,25	PropertyValue, CollectionPermissions, NestingPermissions, MAX_COLLECTION_NAME_LENGTH,26	MAX_COLLECTION_DESCRIPTION_LENGTH, MAX_TOKEN_PREFIX_LENGTH, MAX_PROPERTIES_PER_ITEM,27};28use frame_support::{29	traits::{Currency, Get},30	pallet_prelude::ConstU32,31	BoundedVec,32};33use core::convert::TryInto;34use sp_runtime::DispatchError;3536const SEED: u32 = 1;3738pub fn create_data<const S: u32>() -> BoundedVec<u8, ConstU32<S>> {39	create_var_data::<S>(S)40}41pub fn create_u16_data<const S: u32>() -> BoundedVec<u16, ConstU32<S>> {42	(0..S)43		.map(|v| (v & 0xffff) as u16)44		.collect::<Vec<_>>()45		.try_into()46		.unwrap()47}48pub fn create_var_data<const S: u32>(size: u32) -> BoundedVec<u8, ConstU32<S>> {49	assert!(50		size <= S,51		"size ({}) should be less within bound ({})",52		size,53		S54	);55	(0..size)56		.map(|v| (v & 0xff) as u8)57		.collect::<Vec<_>>()58		.try_into()59		.unwrap()60}61pub fn property_key(id: usize) -> PropertyKey {62	#[cfg(not(feature = "std"))]63	use alloc::string::ToString;64	let mut data = create_data();65	// No DerefMut available for .fill66	for i in 0..data.len() {67		data[i] = b'0';68	}69	let bytes = id.to_string();70	let len = data.len();71	data[len - bytes.len()..].copy_from_slice(&bytes.as_bytes());72	data73}74pub fn property_value() -> PropertyValue {75	create_data()76}7778pub fn create_collection_raw<T: Config, R>(79	owner: T::CrossAccountId,80	mode: CollectionMode,81	handler: impl FnOnce(82		T::CrossAccountId,83		CreateCollectionData<T::AccountId>,84	) -> Result<CollectionId, DispatchError>,85	cast: impl FnOnce(CollectionHandle<T>) -> R,86) -> Result<R, DispatchError> {87	<T as Config>::Currency::deposit_creating(&owner.as_sub(), T::CollectionCreationPrice::get());88	let name = create_u16_data::<MAX_COLLECTION_NAME_LENGTH>();89	let description = create_u16_data::<MAX_COLLECTION_DESCRIPTION_LENGTH>();90	let token_prefix = create_data::<MAX_TOKEN_PREFIX_LENGTH>();91	handler(92		owner,93		CreateCollectionData {94			mode,95			name,96			description,97			token_prefix,98			permissions: Some(CollectionPermissions {99				nesting: Some(NestingPermissions {100					token_owner: false,101					collection_admin: false,102					restricted: None,103					#[cfg(feature = "runtime-benchmarks")]104					permissive: true,105				}),106				mint_mode: Some(true),107				..Default::default()108			}),109			..Default::default()110		},111	)112	.and_then(CollectionHandle::try_get)113	.map(cast)114}115fn create_collection<T: Config>(116	owner: T::CrossAccountId,117) -> Result<CollectionHandle<T>, DispatchError> {118	create_collection_raw(119		owner,120		CollectionMode::NFT,121		|owner: T::CrossAccountId, data| {122			<Pallet<T>>::init_collection(owner.clone(), owner, data, CollectionFlags::default())123		},124		|h| h,125	)126}127128/// Helper macros, which handles all benchmarking preparation in semi-declarative way129///130/// `name` is a substrate account131/// - name: sub[(id)]132/// `name` is a collection with owner `owner`133/// - name: collection(owner)134/// `name` is a cross account based on substrate135/// - name: cross_sub[(id)]136/// `name` is a cross account, which maps to substrate account `name`137/// - name: cross_from_sub138/// `name` is a cross account, which maps to substrate account `other_name`139/// - name: cross_from_sub(other_name)140#[macro_export]141macro_rules! bench_init {142	($name:ident: sub $(($id:expr))?; $($rest:tt)*) => {143		let $name: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);144		bench_init!($($rest)*);145	};146	($name:ident: collection($owner:ident); $($rest:tt)*) => {147		let $name = create_collection::<T>(T::CrossAccountId::from_sub($owner.clone()))?;148		bench_init!($($rest)*);149	};150	($name:ident: cross; $($rest:tt)*) => {151		let $name = T::CrossAccountId::from_sub($name);152		bench_init!($($rest)*);153	};154	($name:ident: cross_sub $(($id:expr))?; $($rest:tt)*) => {155		let account: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);156		let $name = T::CrossAccountId::from_sub(account);157		bench_init!($($rest)*);158	};159	($name:ident: cross_from_sub; $($rest:tt)*) => {160		let $name = T::CrossAccountId::from_sub($name);161		bench_init!($($rest)*);162	};163	($name:ident: cross_from_sub($from:ident); $($rest:tt)*) => {164		let $name = T::CrossAccountId::from_sub($from);165		bench_init!($($rest)*);166	};167	() => {}168}169170benchmarks! {171	set_collection_properties {172		let b in 0..MAX_PROPERTIES_PER_ITEM;173		bench_init!{174			owner: sub; collection: collection(owner);175			owner: cross_from_sub;176		};177		let props = (0..b).map(|p| Property {178			key: property_key(p as usize),179			value: property_value(),180		}).collect::<Vec<_>>();181	}: {<Pallet<T>>::set_collection_properties(&collection, &owner, props.into_iter())?}182183	delete_collection_properties {184		let b in 0..MAX_PROPERTIES_PER_ITEM;185		bench_init!{186			owner: sub; collection: collection(owner);187			owner: cross_from_sub;188		};189		let props = (0..b).map(|p| Property {190			key: property_key(p as usize),191			value: property_value(),192		}).collect::<Vec<_>>();193		<Pallet<T>>::set_collection_properties(&collection, &owner, props.into_iter())?;194		let to_delete = (0..b).map(|p| property_key(p as usize)).collect::<Vec<_>>();195	}: {<Pallet<T>>::delete_collection_properties(&collection, &owner, to_delete.into_iter())?}196}