`504df77ef385`

source

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