git.delta.rocks / unique-network / refs/commits / 2a76b29e0532

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	CollectionId,74	CreateItemData,75	MAX_TOKEN_PREFIX_LENGTH,76	COLLECTION_ADMINS_LIMIT,77	TokenId,78	TokenChild,79	CollectionStats,80	MAX_TOKEN_OWNERSHIP,81	CollectionMode,82	NFT_SPONSOR_TRANSFER_TIMEOUT,83	FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,84	REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,85	MAX_SPONSOR_TIMEOUT,86	CUSTOM_DATA_LIMIT,87	CollectionLimits,88	CreateCollectionData,89	SponsorshipState,90	CreateItemExData,91	SponsoringRateLimit,92	budget::Budget,93	PhantomType,94	Property,95	Properties,96	PropertiesPermissionMap,97	PropertyKey,98	PropertyValue,99	PropertyPermission,100	PropertiesError,101	PropertyKeyPermission,102	TokenData,103	TrySetProperty,104	PropertyScope,105	// RMRK106	RmrkCollectionInfo,107	RmrkInstanceInfo,108	RmrkResourceInfo,109	RmrkPropertyInfo,110	RmrkBaseInfo,111	RmrkPartType,112	RmrkBoundedTheme,113	RmrkNftChild,114	CollectionPermissions,115	SchemaVersion,116};117118pub use pallet::*;119use sp_core::H160;120use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};121#[cfg(feature = "runtime-benchmarks")]122pub mod benchmarking;123pub mod dispatch;124pub mod erc;125pub mod eth;126pub mod weights;127128/// Weight info.129pub type SelfWeightOf<T> = <T as Config>::WeightInfo;130131/// Collection handle contains information about collection data and id.132/// Also provides functionality to count consumed gas.133///134/// CollectionHandle is used as a generic wrapper for collections of all types.135/// It allows to perform common operations and queries on any collection type,136/// both completely general for all, as well as their respective implementations of [`CommonCollectionOperations`].137#[must_use = "Should call submit_logs or save, otherwise some data will be lost for evm side"]138pub struct CollectionHandle<T: Config> {139	/// Collection id140	pub id: CollectionId,141	collection: Collection<T::AccountId>,142	/// Substrate recorder for counting consumed gas143	pub recorder: SubstrateRecorder<T>,144}145146impl<T: Config> WithRecorder<T> for CollectionHandle<T> {147	fn recorder(&self) -> &SubstrateRecorder<T> {148		&self.recorder149	}150	fn into_recorder(self) -> SubstrateRecorder<T> {151		self.recorder152	}153}154155impl<T: Config> CollectionHandle<T> {156	/// Same as [CollectionHandle::new] but with an explicit gas limit.157	pub fn new_with_gas_limit(id: CollectionId, gas_limit: u64) -> Option<Self> {158		<CollectionById<T>>::get(id).map(|collection| Self {159			id,160			collection,161			recorder: SubstrateRecorder::new(gas_limit),162		})163	}164165	/// Same as [CollectionHandle::new] but with an existed [`SubstrateRecorder`].166	pub fn new_with_recorder(id: CollectionId, recorder: SubstrateRecorder<T>) -> Option<Self> {167		<CollectionById<T>>::get(id).map(|collection| Self {168			id,169			collection,170			recorder,171		})172	}173174	/// Retrives collection data from storage and creates collection handle with default parameters.175	/// If collection not found return `None`176	pub fn new(id: CollectionId) -> Option<Self> {177		Self::new_with_gas_limit(id, u64::MAX)178	}179180	/// Same as [`CollectionHandle::new`] but if collection not found [CollectionNotFound](Error::CollectionNotFound) returned.181	pub fn try_get(id: CollectionId) -> Result<Self, DispatchError> {182		Ok(Self::new(id).ok_or(<Error<T>>::CollectionNotFound)?)183	}184185	/// Consume gas for reading.186	pub fn consume_store_reads(&self, reads: u64) -> evm_coder::execution::Result<()> {187		self.recorder188			.consume_gas(T::GasWeightMapping::weight_to_gas(189				<T as frame_system::Config>::DbWeight::get()190					.read191					.saturating_mul(reads),192			))193	}194195	/// Consume gas for writing.196	pub fn consume_store_writes(&self, writes: u64) -> evm_coder::execution::Result<()> {197		self.recorder198			.consume_gas(T::GasWeightMapping::weight_to_gas(199				<T as frame_system::Config>::DbWeight::get()200					.write201					.saturating_mul(writes),202			))203	}204205	/// Save collection to storage.206	pub fn save(self) -> DispatchResult {207		<CollectionById<T>>::insert(self.id, self.collection);208		Ok(())209	}210211	/// Set collection sponsor.212	///213	/// Unique collections allows sponsoring for certain actions.214	/// This method allows you to set the sponsor of the collection.215	/// In order for sponsorship to become active, it must be confirmed through [`Self::confirm_sponsorship`].216	pub fn set_sponsor(&mut self, sponsor: T::AccountId) -> DispatchResult {217		self.collection.sponsorship = SponsorshipState::Unconfirmed(sponsor);218		Ok(())219	}220221	/// Confirm sponsorship222	///223	/// In order for the sponsorship to become active, the user set as the sponsor must confirm their participation.224	/// Before confirming sponsorship, the user must be specified as the sponsor of the collection via [`Self::set_sponsor`].225	pub fn confirm_sponsorship(&mut self, sender: &T::AccountId) -> Result<bool, DispatchError> {226		if self.collection.sponsorship.pending_sponsor() != Some(sender) {227			return Ok(false);228		}229230		self.collection.sponsorship = SponsorshipState::Confirmed(sender.clone());231		Ok(true)232	}233234	/// Checks that the collection was created with, and must be operated upon through **Unique API**.235	/// Now check only the `external_collection` flag and if it's **true**, then return [`Error::CollectionIsExternal`] error.236	pub fn check_is_internal(&self) -> DispatchResult {237		if self.external_collection {238			return Err(<Error<T>>::CollectionIsExternal)?;239		}240241		Ok(())242	}243244	/// Checks that the collection was created with, and must be operated upon through an **assimilated API**.245	/// Now check only the `external_collection` flag and if it's **false**, then return [`Error::CollectionIsInternal`] error.246	pub fn check_is_external(&self) -> DispatchResult {247		if !self.external_collection {248			return Err(<Error<T>>::CollectionIsInternal)?;249		}250251		Ok(())252	}253}254255impl<T: Config> Deref for CollectionHandle<T> {256	type Target = Collection<T::AccountId>;257258	fn deref(&self) -> &Self::Target {259		&self.collection260	}261}262263impl<T: Config> DerefMut for CollectionHandle<T> {264	fn deref_mut(&mut self) -> &mut Self::Target {265		&mut self.collection266	}267}268269impl<T: Config> CollectionHandle<T> {270	/// Checks if the `user` is the owner of the collection.271	pub fn check_is_owner(&self, user: &T::CrossAccountId) -> DispatchResult {272		ensure!(*user.as_sub() == self.owner, <Error<T>>::NoPermission);273		Ok(())274	}275276	/// Returns **true** if the `user` is the owner or administrator of the collection.277	pub fn is_owner_or_admin(&self, user: &T::CrossAccountId) -> bool {278		*user.as_sub() == self.owner || <IsAdmin<T>>::get((self.id, user))279	}280281	/// Checks if the `user` is the owner or administrator of the collection.282	pub fn check_is_owner_or_admin(&self, user: &T::CrossAccountId) -> DispatchResult {283		ensure!(self.is_owner_or_admin(user), <Error<T>>::NoPermission);284		Ok(())285	}286287	/// Return **true** if `user` was not allowed to have tokens, and he can ignore such restrictions.288	pub fn ignores_allowance(&self, user: &T::CrossAccountId) -> bool {289		self.limits.owner_can_transfer() && self.is_owner_or_admin(user)290	}291292	/// Return **true** if `user` does not have enough token parts, and he can ignore such restrictions.293	pub fn ignores_owned_amount(&self, user: &T::CrossAccountId) -> bool {294		self.limits.owner_can_transfer() && self.is_owner_or_admin(user)295	}296297	/// Checks if the user is in the allow list. If not [Error::AddressNotInAllowlist] returns.298	pub fn check_allowlist(&self, user: &T::CrossAccountId) -> DispatchResult {299		ensure!(300			<Allowlist<T>>::get((self.id, user)),301			<Error<T>>::AddressNotInAllowlist302		);303		Ok(())304	}305}306307#[frame_support::pallet]308pub mod pallet {309	use super::*;310	use pallet_evm::account;311	use dispatch::CollectionDispatch;312	use frame_support::{Blake2_128Concat, pallet_prelude::*, storage::Key, traits::StorageVersion};313	use frame_system::pallet_prelude::*;314	use frame_support::traits::Currency;315	use up_data_structs::{TokenId, mapping::TokenAddressMapping};316	use scale_info::TypeInfo;317	use weights::WeightInfo;318319	#[pallet::config]320	pub trait Config:321		frame_system::Config322		+ pallet_evm_coder_substrate::Config323		+ pallet_evm::Config324		+ TypeInfo325		+ account::Config326	{327		/// Weight information for functions of this pallet.328		type WeightInfo: WeightInfo;329330		/// Events compatible with [`frame_system::Config::Event`].331		type Event: IsType<<Self as frame_system::Config>::Event> + From<Event<Self>>;332333		/// Handler of accounts and payment.334		type Currency: Currency<Self::AccountId>;335336		/// Set price to create a collection.337		#[pallet::constant]338		type CollectionCreationPrice: Get<339			<<Self as Config>::Currency as Currency<Self::AccountId>>::Balance,340		>;341342		/// Dispatcher of operations on collections.343		type CollectionDispatch: CollectionDispatch<Self>;344345		/// Account which holds the chain's treasury.346		type TreasuryAccountId: Get<Self::AccountId>;347348		/// Address under which the CollectionHelper contract would be available.349		type ContractAddress: Get<H160>;350351		/// Mapper for token addresses to Ethereum addresses.352		type EvmTokenAddressMapping: TokenAddressMapping<H160>;353354		/// Mapper for token addresses to [`CrossAccountId`].355		type CrossTokenAddressMapping: TokenAddressMapping<Self::CrossAccountId>;356	}357358	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);359360	#[pallet::pallet]361	#[pallet::storage_version(STORAGE_VERSION)]362	#[pallet::generate_store(pub(super) trait Store)]363	pub struct Pallet<T>(_);364365	#[pallet::extra_constants]366	impl<T: Config> Pallet<T> {367		/// Maximum admins per collection.368		pub fn collection_admins_limit() -> u32 {369			COLLECTION_ADMINS_LIMIT370		}371	}372373	#[pallet::event]374	#[pallet::generate_deposit(pub fn deposit_event)]375	pub enum Event<T: Config> {376		/// New collection was created377		CollectionCreated(378			/// Globally unique identifier of newly created collection.379			CollectionId,380			/// [`CollectionMode`] converted into _u8_.381			u8,382			/// Collection owner.383			T::AccountId,384		),385386		/// New collection was destroyed387		CollectionDestroyed(388			/// Globally unique identifier of collection.389			CollectionId,390		),391392		/// New item was created.393		ItemCreated(394			/// Id of the collection where item was created.395			CollectionId,396			/// Id of an item. Unique within the collection.397			TokenId,398			/// Owner of newly created item399			T::CrossAccountId,400			/// Always 1 for NFT401			u128,402		),403404		/// Collection item was burned.405		ItemDestroyed(406			/// Id of the collection where item was destroyed.407			CollectionId,408			/// Identifier of burned NFT.409			TokenId,410			/// Which user has destroyed its tokens.411			T::CrossAccountId,412			/// Amount of token pieces destroed. Always 1 for NFT.413			u128,414		),415416		/// Item was transferred417		Transfer(418			/// Id of collection to which item is belong.419			CollectionId,420			/// Id of an item.421			TokenId,422			/// Original owner of item.423			T::CrossAccountId,424			/// New owner of item.425			T::CrossAccountId,426			/// Amount of token pieces transfered. Always 1 for NFT.427			u128,428		),429430		/// Amount pieces of token owned by `sender` was approved for `spender`.431		Approved(432			/// Id of collection to which item is belong.433			CollectionId,434			/// Id of an item.435			TokenId,436			/// Original owner of item.437			T::CrossAccountId,438			/// Id for which the approval was granted.439			T::CrossAccountId,440			/// Amount of token pieces transfered. Always 1 for NFT.441			u128,442		),443444		/// The colletion property has been added or edited.445		CollectionPropertySet(446			/// Id of collection to which property has been set.447			CollectionId,448			/// The property that was set.449			PropertyKey,450		),451452		/// The property has been deleted.453		CollectionPropertyDeleted(454			/// Id of collection to which property has been deleted.455			CollectionId,456			/// The property that was deleted.457			PropertyKey,458		),459460		/// The token property has been added or edited.461		TokenPropertySet(462			/// Identifier of the collection whose token has the property set.463			CollectionId,464			/// The token for which the property was set.465			TokenId,466			/// The property that was set.467			PropertyKey,468		),469470		/// The token property has been deleted.471		TokenPropertyDeleted(472			/// Identifier of the collection whose token has the property deleted.473			CollectionId,474			/// The token for which the property was deleted.475			TokenId,476			/// The property that was deleted.477			PropertyKey,478		),479480		/// The token property permission of a collection has been set.481		PropertyPermissionSet(482			/// ID of collection to which property permission has been set.483			CollectionId,484			/// The property permission that was set.485			PropertyKey,486		),487	}488489	#[pallet::error]490	pub enum Error<T> {491		/// This collection does not exist.492		CollectionNotFound,493		/// Sender parameter and item owner must be equal.494		MustBeTokenOwner,495		/// No permission to perform action496		NoPermission,497		/// Destroying only empty collections is allowed498		CantDestroyNotEmptyCollection,499		/// Collection is not in mint mode.500		PublicMintingNotAllowed,501		/// Address is not in allow list.502		AddressNotInAllowlist,503504		/// Collection name can not be longer than 63 char.505		CollectionNameLimitExceeded,506		/// Collection description can not be longer than 255 char.507		CollectionDescriptionLimitExceeded,508		/// Token prefix can not be longer than 15 char.509		CollectionTokenPrefixLimitExceeded,510		/// Total collections bound exceeded.511		TotalCollectionsLimitExceeded,512		/// Exceeded max admin count513		CollectionAdminCountExceeded,514		/// Collection limit bounds per collection exceeded515		CollectionLimitBoundsExceeded,516		/// Tried to enable permissions which are only permitted to be disabled517		OwnerPermissionsCantBeReverted,518		/// Collection settings not allowing items transferring519		TransferNotAllowed,520		/// Account token limit exceeded per collection521		AccountTokenLimitExceeded,522		/// Collection token limit exceeded523		CollectionTokenLimitExceeded,524		/// Metadata flag frozen525		MetadataFlagFrozen,526527		/// Item does not exist528		TokenNotFound,529		/// Item is balance not enough530		TokenValueTooLow,531		/// Requested value is more than the approved532		ApprovedValueTooLow,533		/// Tried to approve more than owned534		CantApproveMoreThanOwned,535536		/// Can't transfer tokens to ethereum zero address537		AddressIsZero,538		/// Target collection doesn't support this operation539		UnsupportedOperation,540541		/// Insufficient funds to perform an action542		NotSufficientFounds,543544		/// User does not satisfy the nesting rule545		UserIsNotAllowedToNest,546		/// Only tokens from specific collections may nest tokens under this one547		SourceCollectionIsNotAllowedToNest,548549		/// Tried to store more data than allowed in collection field550		CollectionFieldSizeExceeded,551552		/// Tried to store more property data than allowed553		NoSpaceForProperty,554555		/// Tried to store more property keys than allowed556		PropertyLimitReached,557558		/// Property key is too long559		PropertyKeyIsTooLong,560561		/// Only ASCII letters, digits, and symbols `_`, `-`, and `.` are allowed562		InvalidCharacterInPropertyKey,563564		/// Empty property keys are forbidden565		EmptyPropertyKey,566567		/// Tried to access an external collection with an internal API568		CollectionIsExternal,569570		/// Tried to access an internal collection with an external API571		CollectionIsInternal,572	}573574	/// Storage of the count of created collections. Essentially contains the last collection ID.575	#[pallet::storage]576	pub type CreatedCollectionCount<T> = StorageValue<Value = CollectionId, QueryKind = ValueQuery>;577578	/// Storage of the count of deleted collections.579	#[pallet::storage]580	pub type DestroyedCollectionCount<T> =581		StorageValue<Value = CollectionId, QueryKind = ValueQuery>;582583	/// Storage of collection info.584	#[pallet::storage]585	pub type CollectionById<T> = StorageMap<586		Hasher = Blake2_128Concat,587		Key = CollectionId,588		Value = Collection<<T as frame_system::Config>::AccountId>,589		QueryKind = OptionQuery,590	>;591592	/// Storage of collection properties.593	#[pallet::storage]594	#[pallet::getter(fn collection_properties)]595	pub type CollectionProperties<T> = StorageMap<596		Hasher = Blake2_128Concat,597		Key = CollectionId,598		Value = Properties,599		QueryKind = ValueQuery,600		OnEmpty = up_data_structs::CollectionProperties,601	>;602603	/// Storage of token property permissions of a collection.604	#[pallet::storage]605	#[pallet::getter(fn property_permissions)]606	pub type CollectionPropertyPermissions<T> = StorageMap<607		Hasher = Blake2_128Concat,608		Key = CollectionId,609		Value = PropertiesPermissionMap,610		QueryKind = ValueQuery,611	>;612613	/// Storage of the amount of collection admins.614	#[pallet::storage]615	pub type AdminAmount<T> = StorageMap<616		Hasher = Blake2_128Concat,617		Key = CollectionId,618		Value = u32,619		QueryKind = ValueQuery,620	>;621622	/// List of collection admins.623	#[pallet::storage]624	pub type IsAdmin<T: Config> = StorageNMap<625		Key = (626			Key<Blake2_128Concat, CollectionId>,627			Key<Blake2_128Concat, T::CrossAccountId>,628		),629		Value = bool,630		QueryKind = ValueQuery,631	>;632633	/// Allowlisted collection users.634	#[pallet::storage]635	pub type Allowlist<T: Config> = StorageNMap<636		Key = (637			Key<Blake2_128Concat, CollectionId>,638			Key<Blake2_128Concat, T::CrossAccountId>,639		),640		Value = bool,641		QueryKind = ValueQuery,642	>;643644	/// Not used by code, exists only to provide some types to metadata.645	#[pallet::storage]646	pub type DummyStorageValue<T: Config> = StorageValue<647		Value = (648			CollectionStats,649			CollectionId,650			TokenId,651			TokenChild,652			PhantomType<(653				TokenData<T::CrossAccountId>,654				RpcCollection<T::AccountId>,655				// RMRK656				RmrkCollectionInfo<T::AccountId>,657				RmrkInstanceInfo<T::AccountId>,658				RmrkResourceInfo,659				RmrkPropertyInfo,660				RmrkBaseInfo<T::AccountId>,661				RmrkPartType,662				RmrkBoundedTheme,663				RmrkNftChild,664			)>,665		),666		QueryKind = OptionQuery,667	>;668669	#[pallet::hooks]670	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {671		fn on_runtime_upgrade() -> Weight {672			StorageVersion::new(1).put::<Pallet<T>>();673674			0675		}676	}677}678679impl<T: Config> Pallet<T> {680	/// Enshure that receiver address is correct.681	///682	/// Ethereum receiver 0x0000000000000000000000000000000000000000 is reserved, and shouldn't own tokens.683	pub fn ensure_correct_receiver(receiver: &T::CrossAccountId) -> DispatchResult {684		ensure!(685			&T::CrossAccountId::from_eth(H160([0; 20])) != receiver,686			<Error<T>>::AddressIsZero687		);688		Ok(())689	}690691	/// Get a vector of collection admins.692	pub fn adminlist(collection: CollectionId) -> Vec<T::CrossAccountId> {693		<IsAdmin<T>>::iter_prefix((collection,))694			.map(|(a, _)| a)695			.collect()696	}697698	/// Get a vector of users allowed to mint tokens.699	pub fn allowlist(collection: CollectionId) -> Vec<T::CrossAccountId> {700		<Allowlist<T>>::iter_prefix((collection,))701			.map(|(a, _)| a)702			.collect()703	}704705	/// Is `user` allowed to mint token in `collection`.706	pub fn allowed(collection: CollectionId, user: T::CrossAccountId) -> bool {707		<Allowlist<T>>::get((collection, user))708	}709710	/// Get statistics of collections.711	pub fn collection_stats() -> CollectionStats {712		let created = <CreatedCollectionCount<T>>::get();713		let destroyed = <DestroyedCollectionCount<T>>::get();714		CollectionStats {715			created: created.0,716			destroyed: destroyed.0,717			alive: created.0 - destroyed.0,718		}719	}720721	/// Get the effective limits for the collection.722	pub fn effective_collection_limits(collection: CollectionId) -> Option<CollectionLimits> {723		let collection = <CollectionById<T>>::get(collection);724		if collection.is_none() {725			return None;726		}727728		let collection = collection.unwrap();729		let limits = collection.limits;730		let effective_limits = CollectionLimits {731			account_token_ownership_limit: Some(limits.account_token_ownership_limit()),732			sponsored_data_size: Some(limits.sponsored_data_size()),733			sponsored_data_rate_limit: Some(734				limits735					.sponsored_data_rate_limit736					.unwrap_or(SponsoringRateLimit::SponsoringDisabled),737			),738			token_limit: Some(limits.token_limit()),739			sponsor_transfer_timeout: Some(limits.sponsor_transfer_timeout(740				match collection.mode {741					CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,742					CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,743					CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,744				},745			)),746			sponsor_approve_timeout: Some(limits.sponsor_approve_timeout()),747			owner_can_transfer: Some(limits.owner_can_transfer()),748			owner_can_destroy: Some(limits.owner_can_destroy()),749			transfers_enabled: Some(limits.transfers_enabled()),750		};751752		Some(effective_limits)753	}754755	/// Returns information about the `collection` adapted for rpc.756	pub fn rpc_collection(collection: CollectionId) -> Option<RpcCollection<T::AccountId>> {757		let Collection {758			name,759			description,760			owner,761			mode,762			token_prefix,763			sponsorship,764			limits,765			permissions,766			external_collection,767		} = <CollectionById<T>>::get(collection)?;768769		let token_property_permissions = <CollectionPropertyPermissions<T>>::get(collection)770			.into_iter()771			.map(|(key, permission)| PropertyKeyPermission { key, permission })772			.collect();773774		let properties = <CollectionProperties<T>>::get(collection)775			.into_iter()776			.map(|(key, value)| Property { key, value })777			.collect();778779		let permissions = CollectionPermissions {780			access: Some(permissions.access()),781			mint_mode: Some(permissions.mint_mode()),782			nesting: Some(permissions.nesting().clone()),783		};784785		Some(RpcCollection {786			name: name.into_inner(),787			description: description.into_inner(),788			owner,789			mode,790			token_prefix: token_prefix.into_inner(),791			sponsorship,792			limits,793			permissions,794			token_property_permissions,795			properties,796			read_only: external_collection,797		})798	}799}800801macro_rules! limit_default {802	($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{803		$(804			if let Some($new) = $new.$field {805				let $old = $old.$field($($arg)?);806				let _ = $new;807				let _ = $old;808				$check809			} else {810				$new.$field = $old.$field811			}812		)*813	}};814}815macro_rules! limit_default_clone {816	($old:ident, $new:ident, $($field:ident $(($arg:expr))? => $check:expr),* $(,)?) => {{817		$(818			if let Some($new) = $new.$field.clone() {819				let $old = $old.$field($($arg)?);820				let _ = $new;821				let _ = $old;822				$check823			} else {824				$new.$field = $old.$field.clone()825			}826		)*827	}};828}829830impl<T: Config> Pallet<T> {831	/// Create new collection.832	///833	/// * `owner` - The owner of the collection.834	/// * `data` - Description of the created collection.835	/// * `is_external` - Marks that collection managet by not "Unique network".836	pub fn init_collection(837		owner: T::CrossAccountId,838		data: CreateCollectionData<T::AccountId>,839		is_external: bool,840	) -> Result<CollectionId, DispatchError> {841		{842			ensure!(843				data.token_prefix.len() <= MAX_TOKEN_PREFIX_LENGTH as usize,844				Error::<T>::CollectionTokenPrefixLimitExceeded845			);846		}847848		let created_count = <CreatedCollectionCount<T>>::get()849			.0850			.checked_add(1)851			.ok_or(ArithmeticError::Overflow)?;852		let destroyed_count = <DestroyedCollectionCount<T>>::get().0;853		let id = CollectionId(created_count);854855		// bound Total number of collections856		ensure!(857			created_count - destroyed_count <= COLLECTION_NUMBER_LIMIT,858			<Error<T>>::TotalCollectionsLimitExceeded859		);860861		// =========862863		let collection = Collection {864			owner: owner.as_sub().clone(),865			name: data.name,866			mode: data.mode.clone(),867			description: data.description,868			token_prefix: data.token_prefix,869			sponsorship: data870				.pending_sponsor871				.map(SponsorshipState::Unconfirmed)872				.unwrap_or_default(),873			limits: data874				.limits875				.map(|limits| Self::clamp_limits(data.mode.clone(), &Default::default(), limits))876				.unwrap_or_else(|| Ok(CollectionLimits::default()))?,877			permissions: data878				.permissions879				.map(|permissions| {880					Self::clamp_permissions(data.mode.clone(), &Default::default(), permissions)881				})882				.unwrap_or_else(|| Ok(CollectionPermissions::default()))?,883			external_collection: is_external,884		};885886		let mut collection_properties = up_data_structs::CollectionProperties::get();887		collection_properties888			.try_set_from_iter(data.properties.into_iter())889			.map_err(<Error<T>>::from)?;890891		CollectionProperties::<T>::insert(id, collection_properties);892893		let mut token_props_permissions = PropertiesPermissionMap::new();894		token_props_permissions895			.try_set_from_iter(data.token_property_permissions.into_iter())896			.map_err(<Error<T>>::from)?;897898		CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);899900		// Take a (non-refundable) deposit of collection creation901		{902			let mut imbalance =903				<<<T as Config>::Currency as Currency<T::AccountId>>::PositiveImbalance>::zero();904			imbalance.subsume(905				<<T as Config>::Currency as Currency<T::AccountId>>::deposit_creating(906					&T::TreasuryAccountId::get(),907					T::CollectionCreationPrice::get(),908				),909			);910			<T as Config>::Currency::settle(911				owner.as_sub(),912				imbalance,913				WithdrawReasons::TRANSFER,914				ExistenceRequirement::KeepAlive,915			)916			.map_err(|_| Error::<T>::NotSufficientFounds)?;917		}918919		<CreatedCollectionCount<T>>::put(created_count);920		<Pallet<T>>::deposit_event(Event::CollectionCreated(921			id,922			data.mode.id(),923			owner.as_sub().clone(),924		));925		<PalletEvm<T>>::deposit_log(926			erc::CollectionHelpersEvents::CollectionCreated {927				owner: *owner.as_eth(),928				collection_id: eth::collection_id_to_address(id),929			}930			.to_log(T::ContractAddress::get()),931		);932		<CollectionById<T>>::insert(id, collection);933		Ok(id)934	}935936	/// Destroy collection.937	///938	/// * `collection` - Collection handler.939	/// * `sender` - The owner or administrator of the collection.940	pub fn destroy_collection(941		collection: CollectionHandle<T>,942		sender: &T::CrossAccountId,943	) -> DispatchResult {944		ensure!(945			collection.limits.owner_can_destroy(),946			<Error<T>>::NoPermission,947		);948		collection.check_is_owner(sender)?;949950		let destroyed_collections = <DestroyedCollectionCount<T>>::get()951			.0952			.checked_add(1)953			.ok_or(ArithmeticError::Overflow)?;954955		// =========956957		<DestroyedCollectionCount<T>>::put(destroyed_collections);958		<CollectionById<T>>::remove(collection.id);959		<AdminAmount<T>>::remove(collection.id);960		<IsAdmin<T>>::remove_prefix((collection.id,), None);961		<Allowlist<T>>::remove_prefix((collection.id,), None);962		<CollectionProperties<T>>::remove(collection.id);963964		<Pallet<T>>::deposit_event(Event::CollectionDestroyed(collection.id));965		Ok(())966	}967968	/// Set collection property.969	///970	/// * `collection` - Collection handler.971	/// * `sender` - The owner or administrator of the collection.972	/// * `property` - The property to set.973	pub fn set_collection_property(974		collection: &CollectionHandle<T>,975		sender: &T::CrossAccountId,976		property: Property,977	) -> DispatchResult {978		collection.check_is_owner_or_admin(sender)?;979980		CollectionProperties::<T>::try_mutate(collection.id, |properties| {981			let property = property.clone();982			properties.try_set(property.key, property.value)983		})984		.map_err(<Error<T>>::from)?;985986		Self::deposit_event(Event::CollectionPropertySet(collection.id, property.key));987988		Ok(())989	}990991	/// Set scouped collection property.992	///993	/// * `collection_id` - ID of the collection for which the property is being set.994	/// * `scope` - Property scope.995	/// * `property` - The property to set.996	pub fn set_scoped_collection_property(997		collection_id: CollectionId,998		scope: PropertyScope,999		property: Property,1000	) -> DispatchResult {1001		CollectionProperties::<T>::try_mutate(collection_id, |properties| {1002			properties.try_scoped_set(scope, property.key, property.value)1003		})1004		.map_err(<Error<T>>::from)?;10051006		Ok(())1007	}10081009	/// Set scouped collection properties.1010	///1011	/// * `collection_id` - ID of the collection for which the properties is being set.1012	/// * `scope` - Property scope.1013	/// * `properties` - The properties to set.1014	pub fn set_scoped_collection_properties(1015		collection_id: CollectionId,1016		scope: PropertyScope,1017		properties: impl Iterator<Item = Property>,1018	) -> DispatchResult {1019		CollectionProperties::<T>::try_mutate(collection_id, |stored_properties| {1020			stored_properties.try_scoped_set_from_iter(scope, properties)1021		})1022		.map_err(<Error<T>>::from)?;10231024		Ok(())1025	}10261027	/// Set collection properties.1028	///1029	/// * `collection` - Collection handler.1030	/// * `sender` - The owner or administrator of the collection.1031	/// * `properties` - The properties to set.1032	#[transactional]1033	pub fn set_collection_properties(1034		collection: &CollectionHandle<T>,1035		sender: &T::CrossAccountId,1036		properties: Vec<Property>,1037	) -> DispatchResult {1038		for property in properties {1039			Self::set_collection_property(collection, sender, property)?;1040		}10411042		Ok(())1043	}10441045	/// Delete collection property.1046	///1047	/// * `collection` - Collection handler.1048	/// * `sender` - The owner or administrator of the collection.1049	/// * `property` - The property to delete.1050	pub fn delete_collection_property(1051		collection: &CollectionHandle<T>,1052		sender: &T::CrossAccountId,1053		property_key: PropertyKey,1054	) -> DispatchResult {1055		collection.check_is_owner_or_admin(sender)?;10561057		CollectionProperties::<T>::try_mutate(collection.id, |properties| {1058			properties.remove(&property_key)1059		})1060		.map_err(<Error<T>>::from)?;10611062		Self::deposit_event(Event::CollectionPropertyDeleted(1063			collection.id,1064			property_key,1065		));10661067		Ok(())1068	}10691070	/// Delete collection properties.1071	///1072	/// * `collection` - Collection handler.1073	/// * `sender` - The owner or administrator of the collection.1074	/// * `properties` - The properties to delete.1075	#[transactional]1076	pub fn delete_collection_properties(1077		collection: &CollectionHandle<T>,1078		sender: &T::CrossAccountId,1079		property_keys: Vec<PropertyKey>,1080	) -> DispatchResult {1081		for key in property_keys {1082			Self::delete_collection_property(collection, sender, key)?;1083		}10841085		Ok(())1086	}10871088	/// Set collection propetry permission without any checks.1089	///1090	/// Used for migrations.1091	///1092	/// * `collection` - Collection handler.1093	/// * `property_permissions` - Property permissions.1094	pub fn set_property_permission_unchecked(1095		collection: CollectionId,1096		property_permission: PropertyKeyPermission,1097	) -> DispatchResult {1098		<CollectionPropertyPermissions<T>>::try_mutate(collection, |permissions| {1099			permissions.try_set(property_permission.key, property_permission.permission)1100		})1101		.map_err(<Error<T>>::from)?;1102		Ok(())1103	}11041105	/// Set collection property permission.1106	///1107	/// * `collection` - Collection handler.1108	/// * `sender` - The owner or administrator of the collection.1109	/// * `property_permission` - Property permission.1110	pub fn set_property_permission(1111		collection: &CollectionHandle<T>,1112		sender: &T::CrossAccountId,1113		property_permission: PropertyKeyPermission,1114	) -> DispatchResult {1115		collection.check_is_owner_or_admin(sender)?;11161117		let all_permissions = CollectionPropertyPermissions::<T>::get(collection.id);1118		let current_permission = all_permissions.get(&property_permission.key);1119		if matches![1120			current_permission,1121			Some(PropertyPermission { mutable: false, .. })1122		] {1123			return Err(<Error<T>>::NoPermission.into());1124		}11251126		CollectionPropertyPermissions::<T>::try_mutate(collection.id, |permissions| {1127			let property_permission = property_permission.clone();1128			permissions.try_set(property_permission.key, property_permission.permission)1129		})1130		.map_err(<Error<T>>::from)?;11311132		Self::deposit_event(Event::PropertyPermissionSet(1133			collection.id,1134			property_permission.key,1135		));11361137		Ok(())1138	}11391140	/// Set token property permission.1141	///1142	/// * `collection` - Collection handler.1143	/// * `sender` - The owner or administrator of the collection.1144	/// * `property_permissions` - Property permissions.1145	#[transactional]1146	pub fn set_token_property_permissions(1147		collection: &CollectionHandle<T>,1148		sender: &T::CrossAccountId,1149		property_permissions: Vec<PropertyKeyPermission>,1150	) -> DispatchResult {1151		for prop_pemission in property_permissions {1152			Self::set_property_permission(collection, sender, prop_pemission)?;1153		}11541155		Ok(())1156	}11571158	/// Get collection property.1159	pub fn get_collection_property(1160		collection_id: CollectionId,1161		key: &PropertyKey,1162	) -> Option<PropertyValue> {1163		Self::collection_properties(collection_id).get(key).cloned()1164	}11651166	/// Convert byte vector to property key vector.1167	pub fn bytes_keys_to_property_keys(1168		keys: Vec<Vec<u8>>,1169	) -> Result<Vec<PropertyKey>, DispatchError> {1170		keys.into_iter()1171			.map(|key| -> Result<PropertyKey, DispatchError> {1172				key.try_into()1173					.map_err(|_| <Error<T>>::PropertyKeyIsTooLong.into())1174			})1175			.collect::<Result<Vec<PropertyKey>, DispatchError>>()1176	}11771178	/// Get properties according to given keys.1179	pub fn filter_collection_properties(1180		collection_id: CollectionId,1181		keys: Option<Vec<PropertyKey>>,1182	) -> Result<Vec<Property>, DispatchError> {1183		let properties = Self::collection_properties(collection_id);11841185		let properties = keys1186			.map(|keys| {1187				keys.into_iter()1188					.filter_map(|key| {1189						properties.get(&key).map(|value| Property {1190							key,1191							value: value.clone(),1192						})1193					})1194					.collect()1195			})1196			.unwrap_or_else(|| {1197				properties1198					.into_iter()1199					.map(|(key, value)| Property { key, value })1200					.collect()1201			});12021203		Ok(properties)1204	}12051206	/// Get property permissions according to given keys.1207	pub fn filter_property_permissions(1208		collection_id: CollectionId,1209		keys: Option<Vec<PropertyKey>>,1210	) -> Result<Vec<PropertyKeyPermission>, DispatchError> {1211		let permissions = Self::property_permissions(collection_id);12121213		let key_permissions = keys1214			.map(|keys| {1215				keys.into_iter()1216					.filter_map(|key| {1217						permissions1218							.get(&key)1219							.map(|permission| PropertyKeyPermission {1220								key,1221								permission: permission.clone(),1222							})1223					})1224					.collect()1225			})1226			.unwrap_or_else(|| {1227				permissions1228					.into_iter()1229					.map(|(key, permission)| PropertyKeyPermission { key, permission })1230					.collect()1231			});12321233		Ok(key_permissions)1234	}12351236	/// Toggle `user` participation in the `collection`'s allow list.1237	pub fn toggle_allowlist(1238		collection: &CollectionHandle<T>,1239		sender: &T::CrossAccountId,1240		user: &T::CrossAccountId,1241		allowed: bool,1242	) -> DispatchResult {1243		collection.check_is_owner_or_admin(sender)?;12441245		// =========12461247		if allowed {1248			<Allowlist<T>>::insert((collection.id, user), true);1249		} else {1250			<Allowlist<T>>::remove((collection.id, user));1251		}12521253		Ok(())1254	}12551256	/// Toggle `user` participation in the `collection`'s admin list.1257	pub fn toggle_admin(1258		collection: &CollectionHandle<T>,1259		sender: &T::CrossAccountId,1260		user: &T::CrossAccountId,1261		admin: bool,1262	) -> DispatchResult {1263		collection.check_is_owner(sender)?;12641265		let was_admin = <IsAdmin<T>>::get((collection.id, user));1266		if was_admin == admin {1267			return Ok(());1268		}1269		let amount = <AdminAmount<T>>::get(collection.id);12701271		if admin {1272			let amount = amount1273				.checked_add(1)1274				.ok_or(<Error<T>>::CollectionAdminCountExceeded)?;1275			ensure!(1276				amount <= Self::collection_admins_limit(),1277				<Error<T>>::CollectionAdminCountExceeded,1278			);12791280			// =========12811282			<AdminAmount<T>>::insert(collection.id, amount);1283			<IsAdmin<T>>::insert((collection.id, user), true);1284		} else {1285			<AdminAmount<T>>::insert(collection.id, amount.saturating_sub(1));1286			<IsAdmin<T>>::remove((collection.id, user));1287		}12881289		Ok(())1290	}12911292	/// Merge set fields from `new_limit` to `old_limit`.1293	pub fn clamp_limits(1294		mode: CollectionMode,1295		old_limit: &CollectionLimits,1296		mut new_limit: CollectionLimits,1297	) -> Result<CollectionLimits, DispatchError> {1298		let limits = old_limit;1299		limit_default!(old_limit, new_limit,1300			account_token_ownership_limit => ensure!(1301				new_limit <= MAX_TOKEN_OWNERSHIP,1302				<Error<T>>::CollectionLimitBoundsExceeded,1303			),1304			sponsored_data_size => ensure!(1305				new_limit <= CUSTOM_DATA_LIMIT,1306				<Error<T>>::CollectionLimitBoundsExceeded,1307			),13081309			sponsored_data_rate_limit => {},1310			token_limit => ensure!(1311				old_limit >= new_limit && new_limit > 0,1312				<Error<T>>::CollectionTokenLimitExceeded1313			),13141315			sponsor_transfer_timeout(match mode {1316				CollectionMode::NFT => NFT_SPONSOR_TRANSFER_TIMEOUT,1317				CollectionMode::Fungible(_) => FUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1318				CollectionMode::ReFungible => REFUNGIBLE_SPONSOR_TRANSFER_TIMEOUT,1319			}) => ensure!(1320				new_limit <= MAX_SPONSOR_TIMEOUT,1321				<Error<T>>::CollectionLimitBoundsExceeded,1322			),1323			sponsor_approve_timeout => {},1324			owner_can_transfer => ensure!(1325				!limits.owner_can_transfer_instaled() ||1326				old_limit || !new_limit,1327				<Error<T>>::OwnerPermissionsCantBeReverted,1328			),1329			owner_can_destroy => ensure!(1330				old_limit || !new_limit,1331				<Error<T>>::OwnerPermissionsCantBeReverted,1332			),1333			transfers_enabled => {},1334		);1335		Ok(new_limit)1336	}13371338	/// Merge set fields from `new_permission` to `old_permission`.1339	pub fn clamp_permissions(1340		_mode: CollectionMode,1341		old_permission: &CollectionPermissions,1342		mut new_permission: CollectionPermissions,1343	) -> Result<CollectionPermissions, DispatchError> {1344		limit_default_clone!(old_permission, new_permission,1345			access => {},1346			mint_mode => {},1347			nesting => { /* todo check for permissive, if only it gets out of benchmarks */ },1348		);1349		Ok(new_permission)1350	}1351}13521353/// Indicates unsupported methods by returning [Error::UnsupportedOperation].1354#[macro_export]1355macro_rules! unsupported {1356	() => {1357		Err(<Error<T>>::UnsupportedOperation.into())1358	};1359}13601361/// Return weights for various worst-case operations.1362pub trait CommonWeightInfo<CrossAccountId> {1363	/// Weight of item creation.1364	fn create_item() -> Weight;13651366	/// Weight of items creation.1367	fn create_multiple_items(amount: &[CreateItemData]) -> Weight;13681369	/// Weight of items creation.1370	fn create_multiple_items_ex(cost: &CreateItemExData<CrossAccountId>) -> Weight;13711372	/// The weight of the burning item.1373	fn burn_item() -> Weight;13741375	/// Property setting weight.1376	///1377	/// * `amount`- The number of properties to set.1378	fn set_collection_properties(amount: u32) -> Weight;13791380	/// Collection property deletion weight.1381	///1382	/// * `amount`- The number of properties to set.1383	fn delete_collection_properties(amount: u32) -> Weight;13841385	/// Token property setting weight.1386	///1387	/// * `amount`- The number of properties to set.1388	fn set_token_properties(amount: u32) -> Weight;13891390	/// Token property deletion weight.1391	///1392	/// * `amount`- The number of properties to delete.1393	fn delete_token_properties(amount: u32) -> Weight;13941395	/// Token property permissions set weight.1396	///1397	/// * `amount`- The number of property permissions to set.1398	fn set_token_property_permissions(amount: u32) -> Weight;13991400	/// Transfer price of the token or its parts.1401	fn transfer() -> Weight;14021403	/// The price of setting the permission of the operation from another user.1404	fn approve() -> Weight;14051406	/// Transfer price from another user.1407	fn transfer_from() -> Weight;14081409	/// The price of burning a token from another user.1410	fn burn_from() -> Weight;14111412	/// Differs from burn_item in case of Fungible and Refungible, as it should burn1413	/// whole users's balance.1414	///1415	/// This method shouldn't be used directly, as it doesn't count breadth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1416	fn burn_recursively_self_raw() -> Weight;14171418	/// Cost of iterating over `amount` children while burning, without counting child burning itself.1419	///1420	/// This method shouldn't be used directly, as it doesn't count depth price, use [burn_recursively](CommonWeightInfo::burn_recursively) instead1421	fn burn_recursively_breadth_raw(amount: u32) -> Weight;14221423	/// The price of recursive burning a token.1424	///1425	/// `max_selfs` - The maximum burning weight of the token itself.1426	/// `max_breadth` - The maximum number of nested tokens to burn.1427	fn burn_recursively(max_selfs: u32, max_breadth: u32) -> Weight {1428		Self::burn_recursively_self_raw()1429			.saturating_mul(max_selfs.max(1) as u64)1430			.saturating_add(Self::burn_recursively_breadth_raw(max_breadth))1431	}1432}14331434/// Weight info extension trait for refungible pallet.1435pub trait RefungibleExtensionsWeightInfo {1436	/// Weight of token repartition.1437	fn repartition() -> Weight;1438}14391440/// Common collection operations.1441///1442/// It wraps methods in Fungible, Nonfungible and Refungible pallets1443/// and adds weight info.1444pub trait CommonCollectionOperations<T: Config> {1445	/// Create token.1446	///1447	/// * `sender` - The user who mint the token and pays for the transaction.1448	/// * `to` - The user who will own the token.1449	/// * `data` - Token data.1450	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1451	fn create_item(1452		&self,1453		sender: T::CrossAccountId,1454		to: T::CrossAccountId,1455		data: CreateItemData,1456		nesting_budget: &dyn Budget,1457	) -> DispatchResultWithPostInfo;14581459	/// Create multiple tokens.1460	///1461	/// * `sender` - The user who mint the token and pays for the transaction.1462	/// * `to` - The user who will own the token.1463	/// * `data` - Token data.1464	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1465	fn create_multiple_items(1466		&self,1467		sender: T::CrossAccountId,1468		to: T::CrossAccountId,1469		data: Vec<CreateItemData>,1470		nesting_budget: &dyn Budget,1471	) -> DispatchResultWithPostInfo;14721473	/// Create multiple tokens.1474	///1475	/// * `sender` - The user who mint the token and pays for the transaction.1476	/// * `to` - The user who will own the token.1477	/// * `data` - Token data.1478	/// * `nesting_budget` - A budget that can be spent on nesting tokens.1479	fn create_multiple_items_ex(1480		&self,1481		sender: T::CrossAccountId,1482		data: CreateItemExData<T::CrossAccountId>,1483		nesting_budget: &dyn Budget,1484	) -> DispatchResultWithPostInfo;14851486	/// Burn token.1487	///1488	/// * `sender` - The user who owns the token.1489	/// * `token` - Token id that will burned.1490	/// * `amount` - The number of parts of the token that will be burned.1491	fn burn_item(1492		&self,1493		sender: T::CrossAccountId,1494		token: TokenId,1495		amount: u128,1496	) -> DispatchResultWithPostInfo;14971498	/// Burn token and all nested tokens recursievly.1499	///1500	/// * `sender` - The user who owns the token.1501	/// * `token` - Token id that will burned.1502	/// * `self_budget` - The budget that can be spent on burning tokens.1503	/// * `breadth_budget` - The budget that can be spent on burning nested tokens.1504	fn burn_item_recursively(1505		&self,1506		sender: T::CrossAccountId,1507		token: TokenId,1508		self_budget: &dyn Budget,1509		breadth_budget: &dyn Budget,1510	) -> DispatchResultWithPostInfo;15111512	/// Set collection properties.1513	///1514	/// * `sender` - Must be either the owner of the collection or its admin.1515	/// * `properties` - Properties to be set.1516	fn set_collection_properties(1517		&self,1518		sender: T::CrossAccountId,1519		properties: Vec<Property>,1520	) -> DispatchResultWithPostInfo;15211522	/// Delete collection properties.1523	///1524	/// * `sender` - Must be either the owner of the collection or its admin.1525	/// * `properties` - The properties to be removed.1526	fn delete_collection_properties(1527		&self,1528		sender: &T::CrossAccountId,1529		property_keys: Vec<PropertyKey>,1530	) -> DispatchResultWithPostInfo;15311532	/// Set token properties.1533	///1534	/// The appropriate [`PropertyPermission`] for the token property1535	/// must be set with [`Self::set_token_property_permissions`].1536	///1537	/// * `sender` - Must be either the owner of the token or its admin.1538	/// * `token_id` - The token for which the properties are being set.1539	/// * `properties` - Properties to be set.1540	/// * `budget` - Budget for setting properties.1541	fn set_token_properties(1542		&self,1543		sender: T::CrossAccountId,1544		token_id: TokenId,1545		properties: Vec<Property>,1546		budget: &dyn Budget,1547	) -> DispatchResultWithPostInfo;15481549	/// Remove token properties.1550	///1551	/// The appropriate [`PropertyPermission`] for the token property1552	/// must be set with [`Self::set_token_property_permissions`].1553	///1554	/// * `sender` - Must be either the owner of the token or its admin.1555	/// * `token_id` - The token for which the properties are being remove.1556	/// * `property_keys` - Keys to remove corresponding properties.1557	/// * `budget` - Budget for removing properties.1558	fn delete_token_properties(1559		&self,1560		sender: T::CrossAccountId,1561		token_id: TokenId,1562		property_keys: Vec<PropertyKey>,1563		budget: &dyn Budget,1564	) -> DispatchResultWithPostInfo;15651566	/// Set token property permissions.1567	///1568	/// * `sender` - Must be either the owner of the token or its admin.1569	/// * `token_id` - The token for which the properties are being set.1570	/// * `properties` - Properties to be set.1571	/// * `budget` - Budget for setting properties.1572	fn set_token_property_permissions(1573		&self,1574		sender: &T::CrossAccountId,1575		property_permissions: Vec<PropertyKeyPermission>,1576	) -> DispatchResultWithPostInfo;15771578	/// Transfer amount of token pieces.1579	///1580	/// * `sender` - Donor user.1581	/// * `to` - Recepient user.1582	/// * `token` - The token of which parts are being sent.1583	/// * `amount` - The number of parts of the token that will be transferred.1584	/// * `budget` - The maximum budget that can be spent on the transfer.1585	fn transfer(1586		&self,1587		sender: T::CrossAccountId,1588		to: T::CrossAccountId,1589		token: TokenId,1590		amount: u128,1591		budget: &dyn Budget,1592	) -> DispatchResultWithPostInfo;15931594	/// Grant access to another account to transfer parts of the token owned by the calling user via [Self::transfer_from].1595	///1596	/// * `sender` - The user who grants access to the token.1597	/// * `spender` - The user to whom the rights are granted.1598	/// * `token` - The token to which access is granted.1599	/// * `amount` - The amount of pieces that another user can dispose of.1600	fn approve(1601		&self,1602		sender: T::CrossAccountId,1603		spender: T::CrossAccountId,1604		token: TokenId,1605		amount: u128,1606	) -> DispatchResultWithPostInfo;16071608	/// Send parts of a token owned by another user.1609	///1610	/// Before calling this method, you must grant rights to the calling user via [`Self::approve`].1611	///1612	/// * `sender` - The user who must have access to the token (see [`Self::approve`]).1613	/// * `from` - The user who owns the token.1614	/// * `to` - Recepient user.1615	/// * `token` - The token of which parts are being sent.1616	/// * `amount` - The number of parts of the token that will be transferred.1617	/// * `budget` - The maximum budget that can be spent on the transfer.1618	fn transfer_from(1619		&self,1620		sender: T::CrossAccountId,1621		from: T::CrossAccountId,1622		to: T::CrossAccountId,1623		token: TokenId,1624		amount: u128,1625		budget: &dyn Budget,1626	) -> DispatchResultWithPostInfo;16271628	/// Burn parts of a token owned by another user.1629	///1630	/// Before calling this method, you must grant rights to the calling user via [`Self::approve`].1631	///1632	/// * `sender` - The user who must have access to the token (see [`Self::approve`]).1633	/// * `from` - The user who owns the token.1634	/// * `token` - The token of which parts are being sent.1635	/// * `amount` - The number of parts of the token that will be transferred.1636	/// * `budget` - The maximum budget that can be spent on the burn.1637	fn burn_from(1638		&self,1639		sender: T::CrossAccountId,1640		from: T::CrossAccountId,1641		token: TokenId,1642		amount: u128,1643		budget: &dyn Budget,1644	) -> DispatchResultWithPostInfo;16451646	/// Check permission to nest token.1647	///1648	/// * `sender` - The user who initiated the check.1649	/// * `from` - The token that is checked for embedding.1650	/// * `under` - Token under which to check.1651	/// * `budget` - The maximum budget that can be spent on the check.1652	fn check_nesting(1653		&self,1654		sender: T::CrossAccountId,1655		from: (CollectionId, TokenId),1656		under: TokenId,1657		budget: &dyn Budget,1658	) -> DispatchResult;16591660	/// Nest one token into another.1661	///1662	/// * `under` - Token holder.1663	/// * `to_nest` - Nested token.1664	fn nest(&self, under: TokenId, to_nest: (CollectionId, TokenId));16651666	/// Unnest token.1667	///1668	/// * `under` - Token holder.1669	/// * `to_nest` - Token to unnest.1670	fn unnest(&self, under: TokenId, to_nest: (CollectionId, TokenId));16711672	/// Get all user tokens.1673	///1674	/// * `account` - Account for which you need to get tokens.1675	fn account_tokens(&self, account: T::CrossAccountId) -> Vec<TokenId>;16761677	/// Get all the tokens in the collection.1678	fn collection_tokens(&self) -> Vec<TokenId>;16791680	/// Check if the token exists.1681	///1682	/// * `token` - Id token to check.1683	fn token_exists(&self, token: TokenId) -> bool;16841685	/// Get the id of the last minted token.1686	fn last_token_id(&self) -> TokenId;16871688	/// Get the owner of the token.1689	///1690	/// * `token` - The token for which you need to find out the owner.1691	fn token_owner(&self, token: TokenId) -> Option<T::CrossAccountId>;16921693	/// Returns 10 tokens owners in no particular order.1694	///1695	/// * `token` - The token for which you need to find out the owners.1696	fn token_owners(&self, token: TokenId) -> Vec<T::CrossAccountId>;16971698	/// Get the value of the token property by key.1699	///1700	/// * `token` - Token with the property to get.1701	/// * `key` - Property name.1702	fn token_property(&self, token_id: TokenId, key: &PropertyKey) -> Option<PropertyValue>;17031704	/// Get a set of token properties by key vector.1705	///1706	/// * `token` - Token with the property to get.1707	/// * `keys` - Vector of property keys. If this parameter is [None](sp_std::result::Result),1708	/// then all properties are returned.1709	fn token_properties(&self, token: TokenId, keys: Option<Vec<PropertyKey>>) -> Vec<Property>;17101711	/// Amount of unique collection tokens1712	fn total_supply(&self) -> u32;17131714	/// Amount of different tokens account has.1715	///1716	/// * `account` - The account for which need to get the balance.1717	fn account_balance(&self, account: T::CrossAccountId) -> u32;17181719	/// Amount of specific token account have.1720	fn balance(&self, account: T::CrossAccountId, token: TokenId) -> u128;17211722	/// Amount of token pieces1723	fn total_pieces(&self, token: TokenId) -> Option<u128>;17241725	/// Get the number of parts of the token that a trusted user can manage.1726	///1727	/// * `sender` - Trusted user.1728	/// * `spender` - Owner of the token.1729	/// * `token` - The token for which to get the value.1730	fn allowance(1731		&self,1732		sender: T::CrossAccountId,1733		spender: T::CrossAccountId,1734		token: TokenId,1735	) -> u128;17361737	/// Get extension for RFT collection.1738	fn refungible_extensions(&self) -> Option<&dyn RefungibleExtensions<T>>;1739}17401741/// Extension for RFT collection.1742pub trait RefungibleExtensions<T>1743where1744	T: Config,1745{1746	/// Change the number of parts of the token.1747	///1748	/// When the value changes down, this function is equivalent to burning parts of the token.1749	///1750	/// * `sender` - The user calling the repartition operation. Must be the owner of the token.1751	/// * `token` - The token for which you want to change the number of parts.1752	/// * `amount` - The new value of the parts of the token.1753	fn repartition(1754		&self,1755		sender: &T::CrossAccountId,1756		token: TokenId,1757		amount: u128,1758	) -> DispatchResultWithPostInfo;1759}17601761/// Merge [`DispatchResult`] with [`Weight`] into [`DispatchResultWithPostInfo`].1762///1763/// Used for [`CommonCollectionOperations`] implementations and flexible enough to do so.1764pub fn with_weight(res: DispatchResult, weight: Weight) -> DispatchResultWithPostInfo {1765	let post_info = PostDispatchInfo {1766		actual_weight: Some(weight),1767		pays_fee: Pays::Yes,1768	};1769	match res {1770		Ok(()) => Ok(post_info),1771		Err(error) => Err(DispatchErrorWithPostInfo { post_info, error }),1772	}1773}17741775impl<T: Config> From<PropertiesError> for Error<T> {1776	fn from(error: PropertiesError) -> Self {1777		match error {1778			PropertiesError::NoSpaceForProperty => Self::NoSpaceForProperty,1779			PropertiesError::PropertyLimitReached => Self::PropertyLimitReached,1780			PropertiesError::InvalidCharacterInPropertyKey => Self::InvalidCharacterInPropertyKey,1781			PropertiesError::PropertyKeyIsTooLong => Self::PropertyKeyIsTooLong,1782			PropertiesError::EmptyPropertyKey => Self::EmptyPropertyKey,1783		}1784	}1785}