git.delta.rocks / unique-network / refs/commits / efa1195717a8

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//! # Common pallet18//!19//! The Common pallet provides functionality for handling collections.20//!21//! ## Overview22//!23//! The Common pallet provides an interface for common collection operations for different collection types24//! (see [CommonCollectionOperations]), as well as a generic dispatcher for these, see [dispatch] module.25//! It also provides this functionality to EVM, see [erc] and [eth] modules.26//!27//! The Common pallet provides functions for:28//!29//! - Setting and approving collection sponsor.30//! - Get\set\delete allow list.31//! - Get\set\delete collection properties.32//! - Get\set\delete collection property permissions.33//! - Get\set\delete token property permissions.34//! - Get\set\delete collection administrators.35//! - Checking access permissions.36//!37//! ### Terminology38//! **Collection sponsor** - For the collection, you can set a sponsor, at whose expense it will39//! be possible to mint tokens.40//!41//! **Allow list** - List of users who have the right to minting tokens.42//!43//! **Collection properties** - Collection properties are simply key-value stores where various44//! metadata can be placed.45//!46//! **Permissions on token properties** - For each property in the token can be set permission47//! to change, see [`PropertyPermission`].48//!49//! **Collection administrator** - For a collection, you can set administrators who have the right50//! to most actions on the collection.5152#![warn(missing_docs)]53#![cfg_attr(not(feature = "std"), no_std)]54extern crate alloc;5556use core::ops::{Deref, DerefMut};57use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};58use sp_std::vec::Vec;59use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};60use evm_coder::ToLog;61use frame_support::{62	dispatch::{DispatchErrorWithPostInfo, DispatchResultWithPostInfo, Weight, PostDispatchInfo},63	ensure,64	traits::{Imbalance, Get, Currency, WithdrawReasons, ExistenceRequirement},65	weights::Pays,66	transactional,67};68use pallet_evm::GasWeightMapping;69use up_data_structs::{70	COLLECTION_NUMBER_LIMIT,71	Collection,72	RpcCollection,73	CollectionFlags,74	RpcCollectionFlags,75	CollectionId,76	CreateItemData,77	MAX_TOKEN_PREFIX_LENGTH,78	COLLECTION_ADMINS_LIMIT,79	TokenId,80	TokenChild,81	CollectionStats,82	MAX_TOKEN_OWNERSHIP,83	CollectionMode,84	NFT_SPONSOR_TRANSFER_TIMEOUT,85	FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,86	REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,87	MAX_SPONSOR_TIMEOUT,88	CUSTOM_DATA_LIMIT,89	CollectionLimits,90	CreateCollectionData,91	SponsorshipState,92	CreateItemExData,93	SponsoringRateLimit,94	budget::Budget,95	PhantomType,96	Property,97	Properties,98	PropertiesPermissionMap,99	PropertyKey,100	PropertyValue,101	PropertyPermission,102	PropertiesError,103	PropertyKeyPermission,104	TokenData,105	TrySetProperty,106	PropertyScope,107	// RMRK108	RmrkCollectionInfo,109	RmrkInstanceInfo,110	RmrkResourceInfo,111	RmrkPropertyInfo,112	RmrkBaseInfo,113	RmrkPartType,114	RmrkBoundedTheme,115	RmrkNftChild,116	CollectionPermissions,117};118119pub use pallet::*;120use sp_core::H160;121use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};122#[cfg(feature = "runtime-benchmarks")]123pub mod benchmarking;124pub mod dispatch;125pub mod erc;126pub mod eth;127pub mod weights;128129/// Weight info.130pub type SelfWeightOf<T> = <T as Config>::WeightInfo;131132/// Collection handle contains information about collection data and id.133/// Also provides functionality to count consumed gas.134///135/// CollectionHandle is used as a generic wrapper for collections of all types.136/// It allows to perform common operations and queries on any collection type,137/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].138#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]139pub struct CollectionHandle<T: Config> {140	/// Collection id141	pub id: CollectionId,142	collection: Collection<T::AccountId>,143	/// Substrate recorder for counting consumed gas144	pub recorder: SubstrateRecorder<T>,145}146147impl<T: Config> WithRecorder<T> for CollectionHandle<T> {148	fn recorder(&self) -> &SubstrateRecorder<T> {149		&self.recorder150	}151	fn into_recorder(self) -> SubstrateRecorder<T> {152		self.recorder153	}154}155156impl<T: Config> CollectionHandle<T> {157	/// Same as [CollectionHandle::new] but with an explicit gas limit.158	pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {159		<CollectionById<T>>::get(id).map(|collection| Self {160			id,161			collection,162			recorder: SubstrateRecorder::new(gas_limit),163		})164	}165166	/// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].167	pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {168		<CollectionById<T>>::get(id).map(|collection| Self {169			id,170			collection,171			recorder,172		})173	}174175	/// Retrives collection data from storage and creates collection handle with default parameters.176	/// If collection not found return `None`177	pub fn new(id: CollectionId) -> Option<Self> {178		Self::new_with_gas_limit(id, u64::MAX)179	}180181	/// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.182	pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {183		Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)184	}185186	/// Consume gas for reading.187	pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {188		self.recorder189			.consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(190				<T as frame_system::Config>::DbWeight::get()191					.read192					.saturating_mul(reads),193			)))194	}195196	/// Consume gas for writing.197	pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {198		self.recorder199			.consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(200				<T as frame_system::Config>::DbWeight::get()201					.write202					.saturating_mul(writes),203			)))204	}205206	/// Consume gas for reading and writing.207	pub fn consume_store_reads_and_writes(208		&self,209		reads: u64,210		writes: u64,211	) -> evm_coder::execution::Result<()> {212		let weight = <T as frame_system::Config>::DbWeight::get();213		let reads = weight.read.saturating_mul(reads);214		let writes = weight.read.saturating_mul(writes);215		self.recorder216			.consume_gas(T::GasWeightMapping::weight_to_gas(Weight::from_ref_time(217				reads.saturating_add(writes),218			)))219	}220221	/// Save collection to storage.222	pub fn save(&self) -> DispatchResult {223		<CollectionById<T>>::insert(self.id, &self.collection);224		Ok(())225	}226227	/// Set collection sponsor.228	///229	/// Unique collections allows sponsoring for certain actions.230	/// This method allows you to set the sponsor of the collection.231	/// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].232	pub fn set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {233		self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor);234		Ok(())235	}236237	/// Confirm sponsorship238	///239	/// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.240	/// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].241	pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> Result<bool, DispatchError> {242		if self.collection.sponsorship.pending_sponsor() != Some(sender) {243			return Ok(false);244		}245246		self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());247		Ok(true)248	}249250	/// Remove collection sponsor.251	pub fn remove_sponsor(&mut self) -> DispatchResult {252		self.collection.sponsorship = SponsorshipState::Disabled;253		Ok(())254	}255256	/// Checks that the collection was created with, and must be operated upon through **Unique API**.257	/// Now check only the `external` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.258	pub fn check_is_internal(&self) -> DispatchResult {259		if self.flags.external {260			return Err(<Error<T>>::CollectionIsExternal)?;261		}262263		Ok(())264	}265266	/// Checks that the collection was created with, and must be operated upon through an **assimilated API**.267	/// Now check only the `external` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.268	pub fn check_is_external(&self) -> DispatchResult {269		if !self.flags.external {270			return Err(<Error<T>>::CollectionIsInternal)?;271		}272273		Ok(())274	}275}276277impl<T: Config> Deref for CollectionHandle<T> {278	type Target = Collection<T::AccountId>;279280	fn deref(&self) -> &Self::Target {281		&self.collection282	}283}284285impl<T: Config> DerefMut for CollectionHandle<T> {286	fn deref_mut(&mut self) -> &mut Self::Target {287		&mut self.collection288	}289}290291impl<T: Config> CollectionHandle<T> {292	/// Checks if the `user` is the owner of the collection.293	pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {294		ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);295		Ok(())296	}297298	/// Returns **true** if the `user` is the owner or administrator of the collection.299	pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {300		*user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))301	}302303	/// Checks if the `user` is the owner or administrator of the collection.304	pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {305		ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);306		Ok(())307	}308309	/// Return **true** if `user` was not allowed to have tokens, and he can ignore such restrictions.310	pub fn ignores_allowance(&self, user: &T::CrossAccountId) -> bool {311		self.limits.owner_can_transfer() && self.is_owner_or_admin(user)312	}313314	/// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.315	pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {316		self.limits.owner_can_transfer() && self.is_owner_or_admin(user)317	}318319	/// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.320	pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {321		ensure!(322			<Allowlist<T>>::get((self.id, user)),323			<Error<T>>::AddressNotInAllowlist324		);325		Ok(())326	}327328	/// Changes collection owner to another account329	/// #### Store read/writes330	/// 1 writes331	fn set_owner_internal(332		&mut self,333		caller: T::CrossAccountId,334		new_owner: T::CrossAccountId,335	) -> DispatchResult {336		self.check_is_owner(&caller)?;337		self.collection.owner = new_owner.as_sub().clone();338		self.save()339	}340}341342#[frame_support::pallet]343pub mod pallet {344	use super::*;345	use pallet_evm::account;346	use dispatch::CollectionDispatch;347	use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};348	use frame_system::pallet_prelude::*;349	use frame_support::traits::Currency;350	use up_data_structs::{TokenId, mapping::TokenAddressMapping};351	use scale_info::TypeInfo;352	use weights::WeightInfo;353354	#[pallet::config]355	pub trait Config:356		frame_system::Config357		+ pallet_evm_coder_substrate::Config358		+ pallet_evm::Config359		+ TypeInfo360		+ account::Config361	{362		/// Weight information for functions of this pallet.363		type WeightInfo: WeightInfo;364365		/// Events compatible with [`frame_system::Config::Event`].366		type Event: IsType<<Self as frame_system::Config>::Event> + From<Event<Self>>;367368		/// Handler of accounts and payment.369		type Currency: Currency<Self::AccountId>;370371		/// Set price to create a collection.372		#[pallet::constant]373		type CollectionCreationPrice: Get<374			<<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,375		>;376377		/// Dispatcher of operations on collections.378		type CollectionDispatch: CollectionDispatch<Self>;379380		/// Account which holds the chain's treasury.381		type TreasuryAccountId: Get<Self::AccountId>;382383		/// Address under which the CollectionHelper contract would be available.384		type ContractAddress: Get<H160>;385386		/// Mapper for token addresses to Ethereum addresses.387		type EvmTokenAddressMapping: TokenAddressMapping<H160>;388389		/// Mapper for token addresses to [`CrossAccountId`].390		type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;391	}392393	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);394395	#[pallet::pallet]396	#[pallet::storage_version(STORAGE_VERSION)]397	#[pallet::generate_store(pub(super) trait Store)]398	pub struct Pallet<T>(_);399400	#[pallet::extra_constants]401	impl<T: Config> Pallet<T> {402		/// Maximum admins per collection.403		pub fn collection_admins_limit() -> u32 {404			COLLECTION_ADMINS_LIMIT405		}406	}407408	#[pallet::event]409	#[pallet::generate_deposit(pub fn deposit_event)]410	pub enum Event<T: Config> {411		/// New collection was created412		CollectionCreated(413			/// Globally unique identifier of newly created collection.414			CollectionId,415			/// [`CollectionMode`] converted into _u8_.416			u8,417			/// Collection owner.418			T::AccountId,419		),420421		/// New collection was destroyed422		CollectionDestroyed(423			/// Globally unique identifier of collection.424			CollectionId,425		),426427		/// New item was created.428		ItemCreated(429			/// Id of the collection where item was created.430			CollectionId,431			/// Id of an item. Unique within the collection.432			TokenId,433			/// Owner of newly created item434			T::CrossAccountId,435			/// Always 1 for NFT436			u128,437		),438439		/// Collection item was burned.440		ItemDestroyed(441			/// Id of the collection where item was destroyed.442			CollectionId,443			/// Identifier of burned NFT.444			TokenId,445			/// Which user has destroyed its tokens.446			T::CrossAccountId,447			/// Amount of token pieces destroed. Always 1 for NFT.448			u128,449		),450451		/// Item was transferred452		Transfer(453			/// Id of collection to which item is belong.454			CollectionId,455			/// Id of an item.456			TokenId,457			/// Original owner of item.458			T::CrossAccountId,459			/// New owner of item.460			T::CrossAccountId,461			/// Amount of token pieces transfered. Always 1 for NFT.462			u128,463		),464465		/// Amount pieces of token owned by `sender` was approved for `spender`.466		Approved(467			/// Id of collection to which item is belong.468			CollectionId,469			/// Id of an item.470			TokenId,471			/// Original owner of item.472			T::CrossAccountId,473			/// Id for which the approval was granted.474			T::CrossAccountId,475			/// Amount of token pieces transfered. Always 1 for NFT.476			u128,477		),478479		/// The colletion property has been added or edited.480		CollectionPropertySet(481			/// Id of collection to which property has been set.482			CollectionId,483			/// The property that was set.484			PropertyKey,485		),486487		/// The property has been deleted.488		CollectionPropertyDeleted(489			/// Id of collection to which property has been deleted.490			CollectionId,491			/// The property that was deleted.492			PropertyKey,493		),494495		/// The token property has been added or edited.496		TokenPropertySet(497			/// Identifier of the collection whose token has the property set.498			CollectionId,499			/// The token for which the property was set.500			TokenId,501			/// The property that was set.502			PropertyKey,503		),504505		/// The token property has been deleted.506		TokenPropertyDeleted(507			/// Identifier of the collection whose token has the property deleted.508			CollectionId,509			/// The token for which the property was deleted.510			TokenId,511			/// The property that was deleted.512			PropertyKey,513		),514515		/// The token property permission of a collection has been set.516		PropertyPermissionSet(517			/// ID of collection to which property permission has been set.518			CollectionId,519			/// The property permission that was set.520			PropertyKey,521		),522	}523524	#[pallet::error]525	pub enum Error<T> {526		/// This collection does not exist.527		CollectionNotFound,528		/// Sender parameter and item owner must be equal.529		MustBeTokenOwner,530		/// No permission to perform action531		NoPermission,532		/// Destroying only empty collections is allowed533		CantDestroyNotEmptyCollection,534		/// Collection is not in mint mode.535		PublicMintingNotAllowed,536		/// Address is not in allow list.537		AddressNotInAllowlist,538539		/// Collection name can not be longer than 63 char.540		CollectionNameLimitExceeded,541		/// Collection description can not be longer than 255 char.542		CollectionDescriptionLimitExceeded,543		/// Token prefix can not be longer than 15 char.544		CollectionTokenPrefixLimitExceeded,545		/// Total collections bound exceeded.546		TotalCollectionsLimitExceeded,547		/// Exceeded max admin count548		CollectionAdminCountExceeded,549		/// Collection limit bounds per collection exceeded550		CollectionLimitBoundsExceeded,551		/// Tried to enable permissions which are only permitted to be disabled552		OwnerPermissionsCantBeReverted,553		/// Collection settings not allowing items transferring554		TransferNotAllowed,555		/// Account token limit exceeded per collection556		AccountTokenLimitExceeded,557		/// Collection token limit exceeded558		CollectionTokenLimitExceeded,559		/// Metadata flag frozen560		MetadataFlagFrozen,561562		/// Item does not exist563		TokenNotFound,564		/// Item is balance not enough565		TokenValueTooLow,566		/// Requested value is more than the approved567		ApprovedValueTooLow,568		/// Tried to approve more than owned569		CantApproveMoreThanOwned,570571		/// Can't transfer tokens to ethereum zero address572		AddressIsZero,573574		/// The operation is not supported575		UnsupportedOperation,576577		/// Insufficient funds to perform an action578		NotSufficientFounds,579580		/// User does not satisfy the nesting rule581		UserIsNotAllowedToNest,582		/// Only tokens from specific collections may nest tokens under this one583		SourceCollectionIsNotAllowedToNest,584585		/// Tried to store more data than allowed in collection field586		CollectionFieldSizeExceeded,587588		/// Tried to store more property data than allowed589		NoSpaceForProperty,590591		/// Tried to store more property keys than allowed592		PropertyLimitReached,593594		/// Property key is too long595		PropertyKeyIsTooLong,596597		/// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed598		InvalidCharacterInPropertyKey,599600		/// Empty property keys are forbidden601		EmptyPropertyKey,602603		/// Tried to access an external collection with an internal API604		CollectionIsExternal,605606		/// Tried to access an internal collection with an external API607		CollectionIsInternal,608	}609610	/// Storage of the count of created collections. Essentially contains the last collection ID.611	#[pallet::storage]612	pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;613614	/// Storage of the count of deleted collections.615	#[pallet::storage]616	pub type DestroyedCollectionCount<T> =617		StorageValue<Value = CollectionId, QueryKind = ValueQuery>;618619	/// Storage of collection info.620	#[pallet::storage]621	pub type CollectionById<T> = StorageMap<622		Hasher = Blake2_128Concat,623		Key = CollectionId,624		Value = Collection<<T as frame_system::Config>::AccountId>,625		QueryKind = OptionQuery,626	>;627628	/// Storage of collection properties.629	#[pallet::storage]630	#[pallet::getter(fn collection_properties)]631	pub type CollectionProperties<T> = StorageMap<632		Hasher = Blake2_128Concat,633		Key = CollectionId,634		Value = Properties,635		QueryKind = ValueQuery,636		OnEmpty = up_data_structs::CollectionProperties,637	>;638639	/// Storage of token property permissions of a collection.640	#[pallet::storage]641	#[pallet::getter(fn property_permissions)]642	pub type CollectionPropertyPermissions<T> = StorageMap<643		Hasher = Blake2_128Concat,644		Key = CollectionId,645		Value = PropertiesPermissionMap,646		QueryKind = ValueQuery,647	>;648649	/// Storage of the amount of collection admins.650	#[pallet::storage]651	pub type AdminAmount<T> = StorageMap<652		Hasher = Blake2_128Concat,653		Key = CollectionId,654		Value = u32,655		QueryKind = ValueQuery,656	>;657658	/// List of collection admins.659	#[pallet::storage]660	pub type IsAdmin<T: Config> = StorageNMap<661		Key = (662			Key<Blake2_128Concat, CollectionId>,663			Key<Blake2_128Concat, T::CrossAccountId>,664		),665		Value = bool,666		QueryKind = ValueQuery,667	>;668669	/// Allowlisted collection users.670	#[pallet::storage]671	pub type Allowlist<T: Config> = StorageNMap<672		Key = (673			Key<Blake2_128Concat, CollectionId>,674			Key<Blake2_128Concat, T::CrossAccountId>,675		),676		Value = bool,677		QueryKind = ValueQuery,678	>;679680	/// Not used by code, exists only to provide some types to metadata.681	#[pallet::storage]682	pub type DummyStorageValue<T: Config> = StorageValue<683		Value = (684			CollectionStats,685			CollectionId,686			TokenId,687			TokenChild,688			PhantomType<(689				TokenData<T::CrossAccountId>,690				RpcCollection<T::AccountId>,691				// RMRK692				RmrkCollectionInfo<T::AccountId>,693				RmrkInstanceInfo<T::AccountId>,694				RmrkResourceInfo,695				RmrkPropertyInfo,696				RmrkBaseInfo<T::AccountId>,697				RmrkPartType,698				RmrkBoundedTheme,699				RmrkNftChild,700			)>,701		),702		QueryKind = OptionQuery,703	>;704705	#[pallet::hooks]706	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {707		fn on_runtime_upgrade() -> Weight {708			StorageVersion::new(1).put::<Pallet<T>>();709710			Weight::zero()711		}712	}713}714715impl<T: Config> Pallet<T> {716	/// Enshure that receiver address is correct.717	///718	/// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.719	pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {720		ensure!(721			&T::CrossAccountId::from_eth(H160([0; 20])) != receiver,722			<Error<T>>::AddressIsZero723		);724		Ok(())725	}726727	/// Get a vector of collection admins.728	pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {729		<IsAdmin<T>>::iter_prefix((collection,))730			.map(|(a, _)| a)731			.collect()732	}733734	/// Get a vector of users allowed to mint tokens.735	pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {736		<Allowlist<T>>::iter_prefix((collection,))737			.map(|(a, _)| a)738			.collect()739	}740741	/// Is `user` allowed to mint token in `collection`.742	pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {743		<Allowlist<T>>::get((collection, user))744	}745746	/// Get statistics of collections.747	pub fn collection_stats() -> CollectionStats {748		let created = <CreatedCollectionCount<T>>::get();749		let destroyed = <DestroyedCollectionCount<T>>::get();750		CollectionStats {751			created: created.0,752			destroyed: destroyed.0,753			alive: created.0 - destroyed.0,754		}755	}756757	/// Get the effective limits for the collection.758	pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {759		let collection = <CollectionById<T>>::get(collection)?;760		let limits = collection.limits;761		let effective_limits = CollectionLimits {762			account_token_ownership_limit: Some(limits.account_token_ownership_limit()),763			sponsored_data_size: Some(limits.sponsored_data_size()),764			sponsored_data_rate_limit: Some(765				limits766					.sponsored_data_rate_limit767					.unwrap_or(SponsoringRateLimit::SponsoringDisabled),768			),769			token_limit: Some(limits.token_limit()),770			sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(771				match collection.mode {772					CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,773					CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,774					CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,775				},776			)),777			sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),778			owner_can_transfer: Some(limits.owner_can_transfer()),779			owner_can_destroy: Some(limits.owner_can_destroy()),780			transfers_enabled: Some(limits.transfers_enabled()),781		};782783		Some(effective_limits)784	}785786	/// Returns information about the `collection` adapted for rpc.787	pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {788		let Collection {789			name,790			description,791			owner,792			mode,793			token_prefix,794			sponsorship,795			limits,796			permissions,797			flags,798		} = <CollectionById<T>>::get(collection)?;799800		let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)801			.into_iter()802			.map(|(key, permission)| PropertyKeyPermission { key, permission })803			.collect();804805		let properties = <CollectionProperties<T>>::get(collection)806			.into_iter()807			.map(|(key, value)| Property { key, value })808			.collect();809810		let permissions = CollectionPermissions {811			access: Some(permissions.access()),812			mint_mode: Some(permissions.mint_mode()),813			nesting: Some(permissions.nesting().clone()),814		};815816		Some(RpcCollection {817			name: name.into_inner(),818			description: description.into_inner(),819			owner,820			mode,821			token_prefix: token_prefix.into_inner(),822			sponsorship,823			limits,824			permissions,825			token_property_permissions,826			properties,827			read_only: flags.external,828829			flags: RpcCollectionFlags {830				foreign: flags.foreign,831				erc721metadata: flags.erc721metadata,832			},833		})834	}835}836837macro_rules! limit_default {838	($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{839		$(840			if let Some($new) = $new.$field {841				let $old = $old.$field($($arg)?);842				let _ = $new;843				let _ = $old;844				$check845			} else {846				$new.$field = $old.$field847			}848		)*849	}};850}851macro_rules! limit_default_clone {852	($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{853		$(854			if let Some($new) = $new.$field.clone() {855				let $old = $old.$field($($arg)?);856				let _ = $new;857				let _ = $old;858				$check859			} else {860				$new.$field = $old.$field.clone()861			}862		)*863	}};864}865866impl<T: Config> Pallet<T> {867	/// Create new collection.868	///869	/// * `owner` - The owner of the collection.870	/// * `data` - Description of the created collection.871	/// * `flags` - Extra flags to store.872	pub fn init_collection(873		owner: T::CrossAccountId,874		payer: T::CrossAccountId,875		data: CreateCollectionData<T::AccountId>,876		flags: CollectionFlags,877	) -> Result<CollectionId, DispatchError> {878		{879			ensure!(880				data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,881				Error::<T>::CollectionTokenPrefixLimitExceeded882			);883		}884885		let created_count = <CreatedCollectionCount<T>>::get()886			.0887			.checked_add(1)888			.ok_or(ArithmeticError::Overflow)?;889		let destroyed_count = <DestroyedCollectionCount<T>>::get().0;890		let id = CollectionId(created_count);891892		// bound Total number of collections893		ensure!(894			created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,895			<Error<T>>::TotalCollectionsLimitExceeded896		);897898		// =========899900		let collection = Collection {901			owner: owner.as_sub().clone(),902			name: data.name,903			mode: data.mode.clone(),904			description: data.description,905			token_prefix: data.token_prefix,906			sponsorship: data907				.pending_sponsor908				.map(SponsorshipState::Unconfirmed)909				.unwrap_or_default(),910			limits: data911				.limits912				.map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))913				.unwrap_or_else(|| Ok(CollectionLimits::default()))?,914			permissions: data915				.permissions916				.map(|permissions| {917					Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)918				})919				.unwrap_or_else(|| Ok(CollectionPermissions::default()))?,920			flags,921		};922923		let mut collection_properties = up_data_structs::CollectionProperties::get();924		collection_properties925			.try_set_from_iter(data.properties.into_iter())926			.map_err(<Error<T>>::from)?;927928		CollectionProperties::<T>::insert(id, collection_properties);929930		let mut token_props_permissions = PropertiesPermissionMap::new();931		token_props_permissions932			.try_set_from_iter(data.token_property_permissions.into_iter())933			.map_err(<Error<T>>::from)?;934935		CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);936937		// Take a (non-refundable) deposit of collection creation938		{939			let mut imbalance =940				<<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();941			imbalance.subsume(942				<<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(943					&T::TreasuryAccountId::get(),944					T::CollectionCreationPrice::get(),945				),946			);947			<T as Config>::Currency::settle(948				payer.as_sub(),949				imbalance,950				WithdrawReasons::TRANSFER,951				ExistenceRequirement::KeepAlive,952			)953			.map_err(|_| Error::<T>::NotSufficientFounds)?;954		}955956		<CreatedCollectionCount<T>>::put(created_count);957		<Pallet<T>>::deposit_event(Event::CollectionCreated(958			id,959			data.mode.id(),960			owner.as_sub().clone(),961		));962		<PalletEvm<T>>::deposit_log(963			erc::CollectionHelpersEvents::CollectionCreated {964				owner: *owner.as_eth(),965				collection_id: eth::collection_id_to_address(id),966			}967			.to_log(T::ContractAddress::get()),968		);969		<CollectionById<T>>::insert(id, collection);970		Ok(id)971	}972973	/// Destroy collection.974	///975	/// * `collection` - Collection handler.976	/// * `sender` - The owner or administrator of the collection.977	pub fn destroy_collection(978		collection: CollectionHandle<T>,979		sender: &T::CrossAccountId,980	) -> DispatchResult {981		ensure!(982			collection.limits.owner_can_destroy(),983			<Error<T>>::NoPermission,984		);985		collection.check_is_owner(sender)?;986987		let destroyed_collections = <DestroyedCollectionCount<T>>::get()988			.0989			.checked_add(1)990			.ok_or(ArithmeticError::Overflow)?;991992		// =========993994		<DestroyedCollectionCount<T>>::put(destroyed_collections);995		<CollectionById<T>>::remove(collection.id);996		<AdminAmount<T>>::remove(collection.id);997		let _ = <IsAdmin<T>>::clear_prefix((collection.id,), u32::MAX, None);998		let _ = <Allowlist<T>>::clear_prefix((collection.id,), u32::MAX, None);999		<CollectionProperties<T>>::remove(collection.id);10001001		<Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));1002		Ok(())1003	}10041005	/// Set collection property.1006	///1007	/// * `collection` - Collection handler.1008	/// * `sender` - The owner or administrator of the collection.1009	/// * `property` - The property to set.1010	pub fn set_collection_property(1011		collection: &CollectionHandle<T>,1012		sender: &T::CrossAccountId,1013		property: Property,1014	) -> DispatchResult {1015		collection.check_is_owner_or_admin(sender)?;10161017		CollectionProperties::<T>::try_mutate(collection.id, |properties| {1018			let property = property.clone();1019			properties.try_set(property.key, property.value)1020		})1021		.map_err(<Error<T>>::from)?;10221023		Self::deposit_event(Event::CollectionPropertySet(collection.id, property.key));10241025		Ok(())1026	}10271028	/// Set scouped collection property.1029	///1030	/// * `collection_id` - ID of the collection for which the property is being set.1031	/// * `scope` - Property scope.1032	/// * `property` - The property to set.1033	pub fn set_scoped_collection_property(1034		collection_id: CollectionId,1035		scope: PropertyScope,1036		property: Property,1037	) -> DispatchResult {1038		CollectionProperties::<T>::try_mutate(collection_id, |properties| {1039			properties.try_scoped_set(scope, property.key, property.value)1040		})1041		.map_err(<Error<T>>::from)?;10421043		Ok(())1044	}10451046	/// Set scouped collection properties.1047	///1048	/// * `collection_id` - ID of the collection for which the properties is being set.1049	/// * `scope` - Property scope.1050	/// * `properties` - The properties to set.1051	pub fn set_scoped_collection_properties(1052		collection_id: CollectionId,1053		scope: PropertyScope,1054		properties: impl Iterator<Item = Property>,1055	) -> DispatchResult {1056		CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1057			stored_properties.try_scoped_set_from_iter(scope, properties)1058		})1059		.map_err(<Error<T>>::from)?;10601061		Ok(())1062	}10631064	/// Set collection properties.1065	///1066	/// * `collection` - Collection handler.1067	/// * `sender` - The owner or administrator of the collection.1068	/// * `properties` - The properties to set.1069	#[transactional]1070	pub fn set_collection_properties(1071		collection: &CollectionHandle<T>,1072		sender: &T::CrossAccountId,1073		properties: Vec<Property>,1074	) -> DispatchResult {1075		for property in properties {1076			Self::set_collection_property(collection, sender, property)?;1077		}10781079		Ok(())1080	}10811082	/// Delete collection property.1083	///1084	/// * `collection` - Collection handler.1085	/// * `sender` - The owner or administrator of the collection.1086	/// * `property` - The property to delete.1087	pub fn delete_collection_property(1088		collection: &CollectionHandle<T>,1089		sender: &T::CrossAccountId,1090		property_key: PropertyKey,1091	) -> DispatchResult {1092		collection.check_is_owner_or_admin(sender)?;10931094		CollectionProperties::<T>::try_mutate(collection.id, |properties| {1095			properties.remove(&property_key)1096		})1097		.map_err(<Error<T>>::from)?;10981099		Self::deposit_event(Event::CollectionPropertyDeleted(1100			collection.id,1101			property_key,1102		));11031104		Ok(())1105	}11061107	/// Delete collection properties.1108	///1109	/// * `collection` - Collection handler.1110	/// * `sender` - The owner or administrator of the collection.1111	/// * `properties` - The properties to delete.1112	#[transactional]1113	pub fn delete_collection_properties(1114		collection: &CollectionHandle<T>,1115		sender: &T::CrossAccountId,1116		property_keys: Vec<PropertyKey>,1117	) -> DispatchResult {1118		for key in property_keys {1119			Self::delete_collection_property(collection, sender, key)?;1120		}11211122		Ok(())1123	}11241125	/// Set collection propetry permission without any checks.1126	///1127	/// Used for migrations.1128	///1129	/// * `collection` - Collection handler.1130	/// * `property_permissions` - Property permissions.1131	pub fn set_property_permission_unchecked(1132		collection: CollectionId,1133		property_permission: PropertyKeyPermission,1134	) -> DispatchResult {1135		<CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1136			permissions.try_set(property_permission.key, property_permission.permission)1137		})1138		.map_err(<Error<T>>::from)?;1139		Ok(())1140	}11411142	/// Set collection property permission.1143	///1144	/// * `collection` - Collection handler.1145	/// * `sender` - The owner or administrator of the collection.1146	/// * `property_permission` - Property permission.1147	pub fn set_property_permission(1148		collection: &CollectionHandle<T>,1149		sender: &T::CrossAccountId,1150		property_permission: PropertyKeyPermission,1151	) -> DispatchResult {1152		Self::set_scoped_property_permission(1153			collection,1154			sender,1155			PropertyScope::None,1156			property_permission,1157		)1158	}11591160	/// Set collection property permission with scope.1161	///1162	/// * `collection` - Collection handler.1163	/// * `sender` - The owner or administrator of the collection.1164	/// * `scope` - Property scope.1165	/// * `property_permission` - Property permission.1166	pub fn set_scoped_property_permission(1167		collection: &CollectionHandle<T>,1168		sender: &T::CrossAccountId,1169		scope: PropertyScope,1170		property_permission: PropertyKeyPermission,1171	) -> DispatchResult {1172		collection.check_is_owner_or_admin(sender)?;11731174		let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1175		let current_permission = all_permissions.get(&property_permission.key);1176		if matches![1177			current_permission,1178			Some(PropertyPermission { mutable: false, .. })1179		] {1180			return Err(<Error<T>>::NoPermission.into());1181		}11821183		CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1184			let property_permission = property_permission.clone();1185			permissions.try_scoped_set(1186				scope,1187				property_permission.key,1188				property_permission.permission,1189			)1190		})1191		.map_err(<Error<T>>::from)?;11921193		Self::deposit_event(Event::PropertyPermissionSet(1194			collection.id,1195			property_permission.key,1196		));11971198		Ok(())1199	}12001201	/// Set token property permission.1202	///1203	/// * `collection` - Collection handler.1204	/// * `sender` - The owner or administrator of the collection.1205	/// * `property_permissions` - Property permissions.1206	#[transactional]1207	pub fn set_token_property_permissions(1208		collection: &CollectionHandle<T>,1209		sender: &T::CrossAccountId,1210		property_permissions: Vec<PropertyKeyPermission>,1211	) -> DispatchResult {1212		Self::set_scoped_token_property_permissions(1213			collection,1214			sender,1215			PropertyScope::None,1216			property_permissions,1217		)1218	}12191220	/// Set token property permission with scope.1221	///1222	/// * `collection` - Collection handler.1223	/// * `sender` - The owner or administrator of the collection.1224	/// * `scope` - Property scope.1225	/// * `property_permissions` - Property permissions.1226	#[transactional]1227	pub fn set_scoped_token_property_permissions(1228		collection: &CollectionHandle<T>,1229		sender: &T::CrossAccountId,1230		scope: PropertyScope,1231		property_permissions: Vec<PropertyKeyPermission>,1232	) -> DispatchResult {1233		for prop_pemission in property_permissions {1234			Self::set_scoped_property_permission(collection, sender, scope, prop_pemission)?;1235		}12361237		Ok(())1238	}12391240	/// Get collection property.1241	pub fn get_collection_property(1242		collection_id: CollectionId,1243		key: &PropertyKey,1244	) -> Option<PropertyValue> {1245		Self::collection_properties(collection_id).get(key).cloned()1246	}12471248	/// Convert byte vector to property key vector.1249	pub fn bytes_keys_to_property_keys(1250		keys: Vec<Vec<u8>>,1251	) -> Result<Vec<PropertyKey>, DispatchError> {1252		keys.into_iter()1253			.map(|key| -> Result<PropertyKey, DispatchError> {1254				key.try_into()1255					.map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1256			})1257			.collect::<Result<Vec<PropertyKey>, DispatchError>>()1258	}12591260	/// Get properties according to given keys.1261	pub fn filter_collection_properties(1262		collection_id: CollectionId,1263		keys: Option<Vec<PropertyKey>>,1264	) -> Result<Vec<Property>, DispatchError> {1265		let properties = Self::collection_properties(collection_id);12661267		let properties = keys1268			.map(|keys| {1269				keys.into_iter()1270					.filter_map(|key| {1271						properties.get(&key).map(|value| Property {1272							key,1273							value: value.clone(),1274						})1275					})1276					.collect()1277			})1278			.unwrap_or_else(|| {1279				properties1280					.into_iter()1281					.map(|(key, value)| Property { key, value })1282					.collect()1283			});12841285		Ok(properties)1286	}12871288	/// Get property permissions according to given keys.1289	pub fn filter_property_permissions(1290		collection_id: CollectionId,1291		keys: Option<Vec<PropertyKey>>,1292	) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1293		let permissions = Self::property_permissions(collection_id);12941295		let key_permissions = keys1296			.map(|keys| {1297				keys.into_iter()1298					.filter_map(|key| {1299						permissions1300							.get(&key)1301							.map(|permission| PropertyKeyPermission {1302								key,1303								permission: permission.clone(),1304							})1305					})1306					.collect()1307			})1308			.unwrap_or_else(|| {1309				permissions1310					.into_iter()1311					.map(|(key, permission)| PropertyKeyPermission { key, permission })1312					.collect()1313			});13141315		Ok(key_permissions)1316	}13171318	/// Toggle `user` participation in the `collection`'s allow list.1319	/// #### Store read/writes1320	/// 1 writes1321	pub fn toggle_allowlist(1322		collection: &CollectionHandle<T>,1323		sender: &T::CrossAccountId,1324		user: &T::CrossAccountId,1325		allowed: bool,1326	) -> DispatchResult {1327		collection.check_is_owner_or_admin(sender)?;13281329		// =========13301331		if allowed {1332			<Allowlist<T>>::insert((collection.id, user), true);1333		} else {1334			<Allowlist<T>>::remove((collection.id, user));1335		}13361337		Ok(())1338	}13391340	/// Toggle `user` participation in the `collection`'s admin list.1341	/// #### Store read/writes1342	/// 2 writes1343	pub fn toggle_admin(1344		collection: &CollectionHandle<T>,1345		sender: &T::CrossAccountId,1346		user: &T::CrossAccountId,1347		admin: bool,1348	) -> DispatchResult {1349		collection.check_is_owner(sender)?;13501351		let was_admin = <IsAdmin<T>>::get((collection.id, user));1352		if was_admin == admin {1353			return Ok(());1354		}1355		let amount = <AdminAmount<T>>::get(collection.id);13561357		if admin {1358			let amount = amount1359				.checked_add(1)1360				.ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1361			ensure!(1362				amount <= Self::collection_admins_limit(),1363				<Error<T>>::CollectionAdminCountExceeded,1364			);13651366			// =========13671368			<AdminAmount<T>>::insert(collection.id, amount);1369			<IsAdmin<T>>::insert((collection.id, user), true);1370		} else {1371			<AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1372			<IsAdmin<T>>::remove((collection.id, user));1373		}13741375		Ok(())1376	}13771378	/// Merge set fields from `new_limit` to `old_limit`.1379	pub fn clamp_limits(1380		mode: CollectionMode,1381		old_limit: &CollectionLimits,1382		mut new_limit: CollectionLimits,1383	) -> Result<CollectionLimits, DispatchError> {1384		let limits = old_limit;1385		limit_default!(old_limit, new_limit,1386			account_token_ownership_limit => ensure!(1387				new_limit <= MAX_TOKEN_OWNERSHIP,1388				<Error<T>>::CollectionLimitBoundsExceeded,1389			),1390			sponsored_data_size => ensure!(1391				new_limit <= CUSTOM_DATA_LIMIT,1392				<Error<T>>::CollectionLimitBoundsExceeded,1393			),13941395			sponsored_data_rate_limit => {},1396			token_limit => ensure!(1397				old_limit >= new_limit && new_limit > 0,1398				<Error<T>>::CollectionTokenLimitExceeded1399			),14001401			sponsor_transfer_timeout(match mode {1402				CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1403				CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1404				CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1405			}) => ensure!(1406				new_limit <= MAX_SPONSOR_TIMEOUT,1407				<Error<T>>::CollectionLimitBoundsExceeded,1408			),1409			sponsor_approve_timeout => {},1410			owner_can_transfer => ensure!(1411				!limits.owner_can_transfer_instaled() ||1412				old_limit || !new_limit,1413				<Error<T>>::OwnerPermissionsCantBeReverted,1414			),1415			owner_can_destroy => ensure!(1416				old_limit || !new_limit,1417				<Error<T>>::OwnerPermissionsCantBeReverted,1418			),1419			transfers_enabled => {},1420		);1421		Ok(new_limit)1422	}14231424	/// Merge set fields from `new_permission` to `old_permission`.1425	pub fn clamp_permissions(1426		_mode: CollectionMode,1427		old_permission: &CollectionPermissions,1428		mut new_permission: CollectionPermissions,1429	) -> Result<CollectionPermissions, DispatchError> {1430		limit_default_clone!(old_permission, new_permission,1431			access => {},1432			mint_mode => {},1433			nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1434		);1435		Ok(new_permission)1436	}1437}14381439/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1440#[macro_export]1441macro_rules! unsupported {1442	($runtime:path) => {1443		Err($crate::Error::<$runtime>::UnsupportedOperation.into())1444	};1445}14461447/// Return weights for various worst-case operations.1448pub trait CommonWeightInfo<CrossAccountId> {1449	/// Weight of item creation.1450	fn create_item() -> Weight;14511452	/// Weight of items creation.1453	fn create_multiple_items(amount: &[CreateItemData]) -> Weight;14541455	/// Weight of items creation.1456	fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;14571458	/// The weight of the burning item.1459	fn burn_item() -> Weight;14601461	/// Property setting weight.1462	///1463	/// * `amount`- The number of properties to set.1464	fn set_collection_properties(amount: u32) -> Weight;14651466	/// Collection property deletion weight.1467	///1468	/// * `amount`- The number of properties to set.1469	fn delete_collection_properties(amount: u32) -> Weight;14701471	/// Token property setting weight.1472	///1473	/// * `amount`- The number of properties to set.1474	fn set_token_properties(amount: u32) -> Weight;14751476	/// Token property deletion weight.1477	///1478	/// * `amount`- The number of properties to delete.1479	fn delete_token_properties(amount: u32) -> Weight;14801481	/// Token property permissions set weight.1482	///1483	/// * `amount`- The number of property permissions to set.1484	fn set_token_property_permissions(amount: u32) -> Weight;14851486	/// Transfer price of the token or its parts.1487	fn transfer() -> Weight;14881489	/// The price of setting the permission of the operation from another user.1490	fn approve() -> Weight;14911492	/// Transfer price from another user.1493	fn transfer_from() -> Weight;14941495	/// The price of burning a token from another user.1496	fn burn_from() -> Weight;14971498	/// Differs from burn_item in case of Fungible and Refungible, as it should burn1499	/// whole users's balance.1500	///1501	/// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1502	fn burn_recursively_self_raw() -> Weight;15031504	/// Cost of iterating over `amount` children while burning, without counting child burning itself.1505	///1506	/// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1507	fn burn_recursively_breadth_raw(amount: u32) -> Weight;15081509	/// The price of recursive burning a token.1510	///1511	/// `max_selfs` - The maximum burning weight of the token itself.1512	/// `max_breadth` - The maximum number of nested tokens to burn.1513	fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1514		Self::burn_recursively_self_raw()1515			.saturating_mul(max_selfs.max(1) as u64)1516			.saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1517	}15181519	/// The price of retrieving token owner1520	fn token_owner() -> Weight;1521}15221523/// Weight info extension trait for refungible pallet.1524pub trait RefungibleExtensionsWeightInfo {1525	/// Weight of token repartition.1526	fn repartition() -> Weight;1527}15281529/// Common collection operations.1530///1531/// It wraps methods in Fungible, Nonfungible and Refungible pallets1532/// and adds weight info.1533pub trait CommonCollectionOperations<T: Config> {1534	/// Create token.1535	///1536	/// * `sender` - The user who mint the token and pays for the transaction.1537	/// * `to` - The user who will own the token.1538	/// * `data` - Token data.1539	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1540	fn create_item(1541		&self,1542		sender: T::CrossAccountId,1543		to: T::CrossAccountId,1544		data: CreateItemData,1545		nesting_budget: &dyn Budget,1546	) -> DispatchResultWithPostInfo;15471548	/// Create multiple tokens.1549	///1550	/// * `sender` - The user who mint the token and pays for the transaction.1551	/// * `to` - The user who will own the token.1552	/// * `data` - Token data.1553	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1554	fn create_multiple_items(1555		&self,1556		sender: T::CrossAccountId,1557		to: T::CrossAccountId,1558		data: Vec<CreateItemData>,1559		nesting_budget: &dyn Budget,1560	) -> DispatchResultWithPostInfo;15611562	/// Create multiple tokens.1563	///1564	/// * `sender` - The user who mint the token and pays for the transaction.1565	/// * `to` - The user who will own the token.1566	/// * `data` - Token data.1567	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1568	fn create_multiple_items_ex(1569		&self,1570		sender: T::CrossAccountId,1571		data: CreateItemExData<T::CrossAccountId>,1572		nesting_budget: &dyn Budget,1573	) -> DispatchResultWithPostInfo;15741575	/// Burn token.1576	///1577	/// * `sender` - The user who owns the token.1578	/// * `token` - Token id that will burned.1579	/// * `amount` - The number of parts of the token that will be burned.1580	fn burn_item(1581		&self,1582		sender: T::CrossAccountId,1583		token: TokenId,1584		amount: u128,1585	) -> DispatchResultWithPostInfo;15861587	/// Burn token and all nested tokens recursievly.1588	///1589	/// * `sender` - The user who owns the token.1590	/// * `token` - Token id that will burned.1591	/// * `self_budget` - The budget that can be spent on burning tokens.1592	/// * `breadth_budget` - The budget that can be spent on burning nested tokens.1593	fn burn_item_recursively(1594		&self,1595		sender: T::CrossAccountId,1596		token: TokenId,1597		self_budget: &dyn Budget,1598		breadth_budget: &dyn Budget,1599	) -> DispatchResultWithPostInfo;16001601	/// Set collection properties.1602	///1603	/// * `sender` - Must be either the owner of the collection or its admin.1604	/// * `properties` - Properties to be set.1605	fn set_collection_properties(1606		&self,1607		sender: T::CrossAccountId,1608		properties: Vec<Property>,1609	) -> DispatchResultWithPostInfo;16101611	/// Delete collection properties.1612	///1613	/// * `sender` - Must be either the owner of the collection or its admin.1614	/// * `properties` - The properties to be removed.1615	fn delete_collection_properties(1616		&self,1617		sender: &T::CrossAccountId,1618		property_keys: Vec<PropertyKey>,1619	) -> DispatchResultWithPostInfo;16201621	/// Set token properties.1622	///1623	/// The appropriate [`PropertyPermission`] for the token property1624	/// must be set with [`Self::set_token_property_permissions`].1625	///1626	/// * `sender` - Must be either the owner of the token or its admin.1627	/// * `token_id` - The token for which the properties are being set.1628	/// * `properties` - Properties to be set.1629	/// * `budget` - Budget for setting properties.1630	fn set_token_properties(1631		&self,1632		sender: T::CrossAccountId,1633		token_id: TokenId,1634		properties: Vec<Property>,1635		budget: &dyn Budget,1636	) -> DispatchResultWithPostInfo;16371638	/// Remove token properties.1639	///1640	/// The appropriate [`PropertyPermission`] for the token property1641	/// must be set with [`Self::set_token_property_permissions`].1642	///1643	/// * `sender` - Must be either the owner of the token or its admin.1644	/// * `token_id` - The token for which the properties are being remove.1645	/// * `property_keys` - Keys to remove corresponding properties.1646	/// * `budget` - Budget for removing properties.1647	fn delete_token_properties(1648		&self,1649		sender: T::CrossAccountId,1650		token_id: TokenId,1651		property_keys: Vec<PropertyKey>,1652		budget: &dyn Budget,1653	) -> DispatchResultWithPostInfo;16541655	/// Set token property permissions.1656	///1657	/// * `sender` - Must be either the owner of the token or its admin.1658	/// * `token_id` - The token for which the properties are being set.1659	/// * `property_permissions` - Property permissions to be set.1660	/// * `budget` - Budget for setting properties.1661	fn set_token_property_permissions(1662		&self,1663		sender: &T::CrossAccountId,1664		property_permissions: Vec<PropertyKeyPermission>,1665	) -> DispatchResultWithPostInfo;16661667	/// Transfer amount of token pieces.1668	///1669	/// * `sender` - Donor user.1670	/// * `to` - Recepient user.1671	/// * `token` - The token of which parts are being sent.1672	/// * `amount` - The number of parts of the token that will be transferred.1673	/// * `budget` - The maximum budget that can be spent on the transfer.1674	fn transfer(1675		&self,1676		sender: T::CrossAccountId,1677		to: T::CrossAccountId,1678		token: TokenId,1679		amount: u128,1680		budget: &dyn Budget,1681	) -> DispatchResultWithPostInfo;16821683	/// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].1684	///1685	/// * `sender` - The user who grants access to the token.1686	/// * `spender` - The user to whom the rights are granted.1687	/// * `token` - The token to which access is granted.1688	/// * `amount` - The amount of pieces that another user can dispose of.1689	fn approve(1690		&self,1691		sender: T::CrossAccountId,1692		spender: T::CrossAccountId,1693		token: TokenId,1694		amount: u128,1695	) -> DispatchResultWithPostInfo;16961697	/// Send parts of a token owned by another user.1698	///1699	/// Before calling this method, you must grant rights to the calling user via [`Self::approve`].1700	///1701	/// * `sender` - The user who must have access to the token (see [`Self::approve`]).1702	/// * `from` - The user who owns the token.1703	/// * `to` - Recepient user.1704	/// * `token` - The token of which parts are being sent.1705	/// * `amount` - The number of parts of the token that will be transferred.1706	/// * `budget` - The maximum budget that can be spent on the transfer.1707	fn transfer_from(1708		&self,1709		sender: T::CrossAccountId,1710		from: T::CrossAccountId,1711		to: T::CrossAccountId,1712		token: TokenId,1713		amount: u128,1714		budget: &dyn Budget,1715	) -> DispatchResultWithPostInfo;17161717	/// Burn parts of a token owned by another user.1718	///1719	/// Before calling this method, you must grant rights to the calling user via [`Self::approve`].1720	///1721	/// * `sender` - The user who must have access to the token (see [`Self::approve`]).1722	/// * `from` - The user who owns the token.1723	/// * `token` - The token of which parts are being sent.1724	/// * `amount` - The number of parts of the token that will be transferred.1725	/// * `budget` - The maximum budget that can be spent on the burn.1726	fn burn_from(1727		&self,1728		sender: T::CrossAccountId,1729		from: T::CrossAccountId,1730		token: TokenId,1731		amount: u128,1732		budget: &dyn Budget,1733	) -> DispatchResultWithPostInfo;17341735	/// Check permission to nest token.1736	///1737	/// * `sender` - The user who initiated the check.1738	/// * `from` - The token that is checked for embedding.1739	/// * `under` - Token under which to check.1740	/// * `budget` - The maximum budget that can be spent on the check.1741	fn check_nesting(1742		&self,1743		sender: T::CrossAccountId,1744		from: (CollectionId, TokenId),1745		under: TokenId,1746		budget: &dyn Budget,1747	) -> DispatchResult;17481749	/// Nest one token into another.1750	///1751	/// * `under` - Token holder.1752	/// * `to_nest` - Nested token.1753	fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));17541755	/// Unnest token.1756	///1757	/// * `under` - Token holder.1758	/// * `to_nest` - Token to unnest.1759	fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));17601761	/// Get all user tokens.1762	///1763	/// * `account` - Account for which you need to get tokens.1764	fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;17651766	/// Get all the tokens in the collection.1767	fn collection_tokens(&self) -> Vec<TokenId>;17681769	/// Check if the token exists.1770	///1771	/// * `token` - Id token to check.1772	fn token_exists(&self, token: TokenId) -> bool;17731774	/// Get the id of the last minted token.1775	fn last_token_id(&self) -> TokenId;17761777	/// Get the owner of the token.1778	///1779	/// * `token` - The token for which you need to find out the owner.1780	fn token_owner(&self, token: TokenId) -> Option<T::CrossAccountId>;17811782	/// Returns 10 tokens owners in no particular order.1783	///1784	/// * `token` - The token for which you need to find out the owners.1785	fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;17861787	/// Get the value of the token property by key.1788	///1789	/// * `token` - Token with the property to get.1790	/// * `key` - Property name.1791	fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;17921793	/// Get a set of token properties by key vector.1794	///1795	/// * `token` - Token with the property to get.1796	/// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),1797	/// then all properties are returned.1798	fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;17991800	/// Amount of unique collection tokens1801	fn total_supply(&self) -> u32;18021803	/// Amount of different tokens account has.1804	///1805	/// * `account` - The account for which need to get the balance.1806	fn account_balance(&self, account: T::CrossAccountId) -> u32;18071808	/// Amount of specific token account have.1809	fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;18101811	/// Amount of token pieces1812	fn total_pieces(&self, token: TokenId) -> Option<u128>;18131814	/// Get the number of parts of the token that a trusted user can manage.1815	///1816	/// * `sender` - Trusted user.1817	/// * `spender` - Owner of the token.1818	/// * `token` - The token for which to get the value.1819	fn allowance(1820		&self,1821		sender: T::CrossAccountId,1822		spender: T::CrossAccountId,1823		token: TokenId,1824	) -> u128;18251826	/// Get extension for RFT collection.1827	fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;1828}18291830/// Extension for RFT collection.1831pub trait RefungibleExtensions<T>1832where1833	T: Config,1834{1835	/// Change the number of parts of the token.1836	///1837	/// When the value changes down, this function is equivalent to burning parts of the token.1838	///1839	/// * `sender` - The user calling the repartition operation. Must be the owner of the token.1840	/// * `token` - The token for which you want to change the number of parts.1841	/// * `amount` - The new value of the parts of the token.1842	fn repartition(1843		&self,1844		sender: &T::CrossAccountId,1845		token: TokenId,1846		amount: u128,1847	) -> DispatchResultWithPostInfo;1848}18491850/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].1851///1852/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.1853pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {1854	let post_info = PostDispatchInfo {1855		actual_weight: Some(weight),1856		pays_fee: Pays::Yes,1857	};1858	match res {1859		Ok(()) => Ok(post_info),1860		Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),1861	}1862}18631864impl<T: Config> From<PropertiesError> for Error<T> {1865	fn from(error: PropertiesError) -> Self {1866		match error {1867			PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,1868			PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,1869			PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,1870			PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,1871			PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,1872		}1873	}1874}