difftreelog
refactor hide permissive unless benchmarking
in: master
5 files changed
pallets/common/src/benchmarking.rsdiffbeforeafterboth1// 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 collection_admin: false,100 restricted: None,101 permissive: true,102 }),103 mint_mode: Some(true),104 ..Default::default()105 }),106 ..Default::default()107 },108 )109 .and_then(CollectionHandle::try_get)110 .map(cast)111}112fn create_collection<T: Config>(113 owner: T::CrossAccountId,114) -> Result<CollectionHandle<T>, DispatchError> {115 create_collection_raw(116 owner,117 CollectionMode::NFT,118 |owner, data| <Pallet<T>>::init_collection(owner, data, true),119 |h| h,120 )121}122123/// Helper macros, which handles all benchmarking preparation in semi-declarative way124///125/// `name` is a substrate account126/// - name: sub[(id)]127/// `name` is a collection with owner `owner`128/// - name: collection(owner)129/// `name` is a cross account based on substrate130/// - name: cross_sub[(id)]131/// `name` is a cross account, which maps to substrate account `name`132/// - name: cross_from_sub133/// `name` is a cross account, which maps to substrate account `other_name`134/// - name: cross_from_sub(other_name)135#[macro_export]136macro_rules! bench_init {137 ($name:ident: sub $(($id:expr))?; $($rest:tt)*) => {138 let $name: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);139 bench_init!($($rest)*);140 };141 ($name:ident: collection($owner:ident); $($rest:tt)*) => {142 let $name = create_collection::<T>(T::CrossAccountId::from_sub($owner.clone()))?;143 bench_init!($($rest)*);144 };145 ($name:ident: cross; $($rest:tt)*) => {146 let $name = T::CrossAccountId::from_sub($name);147 bench_init!($($rest)*);148 };149 ($name:ident: cross_sub $(($id:expr))?; $($rest:tt)*) => {150 let account: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);151 let $name = T::CrossAccountId::from_sub(account);152 bench_init!($($rest)*);153 };154 ($name:ident: cross_from_sub; $($rest:tt)*) => {155 let $name = T::CrossAccountId::from_sub($name);156 bench_init!($($rest)*);157 };158 ($name:ident: cross_from_sub($from:ident); $($rest:tt)*) => {159 let $name = T::CrossAccountId::from_sub($from);160 bench_init!($($rest)*);161 };162 () => {}163}164165benchmarks! {166 set_collection_properties {167 let b in 0..MAX_PROPERTIES_PER_ITEM;168 bench_init!{169 owner: sub; collection: collection(owner);170 owner: cross_from_sub;171 };172 let props = (0..b).map(|p| Property {173 key: property_key(p as usize),174 value: property_value(),175 }).collect::<Vec<_>>();176 }: {<Pallet<T>>::set_collection_properties(&collection, &owner, props)?}177178 delete_collection_properties {179 let b in 0..MAX_PROPERTIES_PER_ITEM;180 bench_init!{181 owner: sub; collection: collection(owner);182 owner: cross_from_sub;183 };184 let props = (0..b).map(|p| Property {185 key: property_key(p as usize),186 value: property_value(),187 }).collect::<Vec<_>>();188 <Pallet<T>>::set_collection_properties(&collection, &owner, props)?;189 let to_delete = (0..b).map(|p| property_key(p as usize)).collect::<Vec<_>>();190 }: {<Pallet<T>>::delete_collection_properties(&collection, &owner, to_delete)?}191}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 collection_admin: false,100 restricted: None,101 #[cfg(feature = "runtime-benchmarks")]102 permissive: true,103 }),104 mint_mode: Some(true),105 ..Default::default()106 }),107 ..Default::default()108 },109 )110 .and_then(CollectionHandle::try_get)111 .map(cast)112}113fn create_collection<T: Config>(114 owner: T::CrossAccountId,115) -> Result<CollectionHandle<T>, DispatchError> {116 create_collection_raw(117 owner,118 CollectionMode::NFT,119 |owner, data| <Pallet<T>>::init_collection(owner, data, true),120 |h| h,121 )122}123124/// Helper macros, which handles all benchmarking preparation in semi-declarative way125///126/// `name` is a substrate account127/// - name: sub[(id)]128/// `name` is a collection with owner `owner`129/// - name: collection(owner)130/// `name` is a cross account based on substrate131/// - name: cross_sub[(id)]132/// `name` is a cross account, which maps to substrate account `name`133/// - name: cross_from_sub134/// `name` is a cross account, which maps to substrate account `other_name`135/// - name: cross_from_sub(other_name)136#[macro_export]137macro_rules! bench_init {138 ($name:ident: sub $(($id:expr))?; $($rest:tt)*) => {139 let $name: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);140 bench_init!($($rest)*);141 };142 ($name:ident: collection($owner:ident); $($rest:tt)*) => {143 let $name = create_collection::<T>(T::CrossAccountId::from_sub($owner.clone()))?;144 bench_init!($($rest)*);145 };146 ($name:ident: cross; $($rest:tt)*) => {147 let $name = T::CrossAccountId::from_sub($name);148 bench_init!($($rest)*);149 };150 ($name:ident: cross_sub $(($id:expr))?; $($rest:tt)*) => {151 let account: T::AccountId = account(stringify!($name), 0 $(+ $id)?, SEED);152 let $name = T::CrossAccountId::from_sub(account);153 bench_init!($($rest)*);154 };155 ($name:ident: cross_from_sub; $($rest:tt)*) => {156 let $name = T::CrossAccountId::from_sub($name);157 bench_init!($($rest)*);158 };159 ($name:ident: cross_from_sub($from:ident); $($rest:tt)*) => {160 let $name = T::CrossAccountId::from_sub($from);161 bench_init!($($rest)*);162 };163 () => {}164}165166benchmarks! {167 set_collection_properties {168 let b in 0..MAX_PROPERTIES_PER_ITEM;169 bench_init!{170 owner: sub; collection: collection(owner);171 owner: cross_from_sub;172 };173 let props = (0..b).map(|p| Property {174 key: property_key(p as usize),175 value: property_value(),176 }).collect::<Vec<_>>();177 }: {<Pallet<T>>::set_collection_properties(&collection, &owner, props)?}178179 delete_collection_properties {180 let b in 0..MAX_PROPERTIES_PER_ITEM;181 bench_init!{182 owner: sub; collection: collection(owner);183 owner: cross_from_sub;184 };185 let props = (0..b).map(|p| Property {186 key: property_key(p as usize),187 value: property_value(),188 }).collect::<Vec<_>>();189 <Pallet<T>>::set_collection_properties(&collection, &owner, props)?;190 let to_delete = (0..b).map(|p| property_key(p as usize)).collect::<Vec<_>>();191 }: {<Pallet<T>>::delete_collection_properties(&collection, &owner, to_delete)?}192}pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -1212,14 +1212,7 @@
limit_default_clone!(old_limit, new_limit,
access => {},
mint_mode => {},
- nesting => {
- #[cfg(not(feature = "runtime-benchmarks"))]
- ensure!(
- // Permissive is only allowed for tests and internal usage of chain for now
- old_limit.permissive || !new_limit.permissive,
- <Error<T>>::NoPermission,
- )
- },
+ nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },
);
Ok(new_limit)
}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -1038,7 +1038,13 @@
nesting_budget: &dyn Budget,
) -> DispatchResult {
let nesting = handle.permissions.nesting();
- if nesting.permissive {
+
+ #[cfg(not(feature = "runtime-benchmarks"))]
+ let permissive = false;
+ #[cfg(feature = "runtime-benchmarks")]
+ let permissive = nesting.permissive;
+
+ if permissive {
// Pass
} else if nesting.token_owner
&& <PalletStructure<T>>::check_indirectly_owned(
pallets/proxy-rmrk-core/src/lib.rsdiffbeforeafterboth--- a/pallets/proxy-rmrk-core/src/lib.rs
+++ b/pallets/proxy-rmrk-core/src/lib.rs
@@ -205,7 +205,7 @@
token_owner: true,
collection_admin: false,
restricted: None,
-
+ #[cfg(feature = "runtime-benchmarks")]
permissive: false,
}),
..Default::default()
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -454,7 +454,7 @@
token_owner: false,
collection_admin: false,
restricted: None,
-
+ #[cfg(feature = "runtime-benchmarks")]
permissive: false,
};
self.nesting.as_ref().unwrap_or(&DEFAULT)
@@ -499,6 +499,7 @@
/// If set - only tokens from specified collections can be nested
pub restricted: Option<OwnerRestrictedSet>,
+ #[cfg(feature = "runtime-benchmarks")]
/// Anyone can nest tokens, mutually exclusive with `token_owner`, `admin`
pub permissive: bool,
}