`91e514bdbb72`

source

pallets/nonfungible/src/lib.rs43.0 KiBsource history
1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//!   Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//!   an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//!   it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//!   attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//!   with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//!   Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96	BoundedVec, ensure, fail, transactional,97	storage::with_transaction,98	pallet_prelude::DispatchResultWithPostInfo,99	pallet_prelude::Weight,100	dispatch::{PostDispatchInfo, Pays},101};102use up_data_structs::{103	AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,104	CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,105	PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,106	TokenChild, AuxPropertyValue, PropertiesPermissionMap,107};108use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};109use pallet_common::{110	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,111	eth::collection_id_to_address, erc::CollectionHelpersEvents,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::{H160, Get};116use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};117use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};118use core::ops::Deref;119use codec::{Encode, Decode, MaxEncodedLen};120use scale_info::TypeInfo;121122pub use pallet::*;123use weights::WeightInfo;124#[cfg(feature = "runtime-benchmarks")]125pub mod benchmarking;126pub mod common;127pub mod erc;128pub mod weights;129130pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::Config>::CrossAccountId>;131pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;132133/// Token data, stored independently from other data used to describe it134/// for the convenience of database access. Notably contains the owner account address.135#[struct_versioning::versioned(version = 2, upper)]136#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]137pub struct ItemData<CrossAccountId> {138	#[version(..2)]139	pub const_data: BoundedVec<u8, CustomDataLimit>,140141	#[version(..2)]142	pub variable_data: BoundedVec<u8, CustomDataLimit>,143144	pub owner: CrossAccountId,145}146147#[frame_support::pallet]148pub mod pallet {149	use super::*;150	use frame_support::{151		Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,152	};153	use frame_system::pallet_prelude::*;154	use up_data_structs::{CollectionId, TokenId};155	use super::weights::WeightInfo;156157	#[pallet::error]158	pub enum Error<T> {159		/// Not Nonfungible item data used to mint in Nonfungible collection.160		NotNonfungibleDataUsedToMintFungibleCollectionToken,161		/// Used amount > 1 with NFT162		NonfungibleItemsHaveNoAmount,163		/// Unable to burn NFT with children164		CantBurnNftWithChildren,165	}166167	#[pallet::config]168	pub trait Config:169		frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config170	{171		type WeightInfo: WeightInfo;172	}173174	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);175176	#[pallet::pallet]177	#[pallet::storage_version(STORAGE_VERSION)]178	#[pallet::generate_store(pub(super) trait Store)]179	pub struct Pallet<T>(_);180181	/// Total amount of minted tokens in a collection.182	#[pallet::storage]183	pub type TokensMinted<T: Config> =184		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;185186	/// Amount of burnt tokens in a collection.187	#[pallet::storage]188	pub type TokensBurnt<T: Config> =189		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;190191	/// Token data, used to partially describe a token.192	#[pallet::storage]193	pub type TokenData<T: Config> = StorageNMap<194		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),195		Value = ItemData<T::CrossAccountId>,196		QueryKind = OptionQuery,197	>;198199	/// Map of key-value pairs, describing the metadata of a token.200	#[pallet::storage]201	#[pallet::getter(fn token_properties)]202	pub type TokenProperties<T: Config> = StorageNMap<203		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),204		Value = Properties,205		QueryKind = ValueQuery,206		OnEmpty = up_data_structs::TokenProperties,207	>;208209	/// Custom data of a token that is serialized to bytes,210	/// primarily reserved for on-chain operations,211	/// normally obscured from the external users.212	///213	/// Auxiliary properties are slightly different from214	/// usual [`TokenProperties`] due to an unlimited number215	/// and separately stored and written-to key-value pairs.216	///217	/// Currently used to store RMRK data.218	#[pallet::storage]219	#[pallet::getter(fn token_aux_property)]220	pub type TokenAuxProperties<T: Config> = StorageNMap<221		Key = (222			Key<Twox64Concat, CollectionId>,223			Key<Twox64Concat, TokenId>,224			Key<Twox64Concat, PropertyScope>,225			Key<Twox64Concat, PropertyKey>,226		),227		Value = AuxPropertyValue,228		QueryKind = OptionQuery,229	>;230231	/// Used to enumerate tokens owned by account.232	#[pallet::storage]233	pub type Owned<T: Config> = StorageNMap<234		Key = (235			Key<Twox64Concat, CollectionId>,236			Key<Blake2_128Concat, T::CrossAccountId>,237			Key<Twox64Concat, TokenId>,238		),239		Value = bool,240		QueryKind = ValueQuery,241	>;242243	/// Used to enumerate token's children.244	#[pallet::storage]245	#[pallet::getter(fn token_children)]246	pub type TokenChildren<T: Config> = StorageNMap<247		Key = (248			Key<Twox64Concat, CollectionId>,249			Key<Twox64Concat, TokenId>,250			Key<Twox64Concat, (CollectionId, TokenId)>,251		),252		Value = bool,253		QueryKind = ValueQuery,254	>;255256	/// Amount of tokens owned by an account in a collection.257	#[pallet::storage]258	pub type AccountBalance<T: Config> = StorageNMap<259		Key = (260			Key<Twox64Concat, CollectionId>,261			Key<Blake2_128Concat, T::CrossAccountId>,262		),263		Value = u32,264		QueryKind = ValueQuery,265	>;266267	/// Allowance set by a token owner for another user to perform one of certain transactions on a token.268	#[pallet::storage]269	pub type Allowance<T: Config> = StorageNMap<270		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),271		Value = T::CrossAccountId,272		QueryKind = OptionQuery,273	>;274275	/// Operator set by a wallet owner that could perform certain transactions on all tokens in the wallet.276	#[pallet::storage]277	pub type CollectionAllowance<T: Config> = StorageNMap<278		Key = (279			Key<Twox64Concat, CollectionId>,280			Key<Blake2_128Concat, T::CrossAccountId>,281			Key<Blake2_128Concat, T::CrossAccountId>,282		),283		Value = bool,284		QueryKind = ValueQuery,285	>;286287	/// Upgrade from the old schema to properties.288	#[pallet::hooks]289	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {290		fn on_runtime_upgrade() -> Weight {291			StorageVersion::new(1).put::<Pallet<T>>();292293			Weight::zero()294		}295	}296}297298pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);299impl<T: Config> NonfungibleHandle<T> {300	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {301		Self(inner)302	}303	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {304		self.0305	}306	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {307		&mut self.0308	}309}310311impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {312	fn recorder(&self) -> &SubstrateRecorder<T> {313		self.0.recorder()314	}315	fn into_recorder(self) -> SubstrateRecorder<T> {316		self.0.into_recorder()317	}318}319impl<T: Config> Deref for NonfungibleHandle<T> {320	type Target = pallet_common::CollectionHandle<T>;321322	fn deref(&self) -> &Self::Target {323		&self.0324	}325}326327impl<T: Config> Pallet<T> {328	/// Get number of NFT tokens in collection.329	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {330		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)331	}332333	/// Check that NFT token exists.334	///335	/// - `token`: Token ID.336	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {337		<TokenData<T>>::contains_key((collection.id, token))338	}339340	/// Set the token property with the scope.341	///342	/// - `property`: Contains key-value pair.343	pub fn set_scoped_token_property(344		collection_id: CollectionId,345		token_id: TokenId,346		scope: PropertyScope,347		property: Property,348	) -> DispatchResult {349		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {350			properties.try_scoped_set(scope, property.key, property.value)351		})352		.map_err(<CommonError<T>>::from)?;353354		Ok(())355	}356357	/// Batch operation to set multiple properties with the same scope.358	pub fn set_scoped_token_properties(359		collection_id: CollectionId,360		token_id: TokenId,361		scope: PropertyScope,362		properties: impl Iterator<Item = Property>,363	) -> DispatchResult {364		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {365			stored_properties.try_scoped_set_from_iter(scope, properties)366		})367		.map_err(<CommonError<T>>::from)?;368369		Ok(())370	}371372	/// Add or edit auxiliary data for the property.373	///374	/// - `f`: function that adds or edits auxiliary data.375	pub fn try_mutate_token_aux_property<R, E>(376		collection_id: CollectionId,377		token_id: TokenId,378		scope: PropertyScope,379		key: PropertyKey,380		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,381	) -> Result<R, E> {382		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)383	}384385	/// Remove auxiliary data for the property.386	pub fn remove_token_aux_property(387		collection_id: CollectionId,388		token_id: TokenId,389		scope: PropertyScope,390		key: PropertyKey,391	) {392		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));393	}394395	/// Get all auxiliary data in a given scope.396	///397	/// Returns iterator over Property Key - Data pairs.398	pub fn iterate_token_aux_properties(399		collection_id: CollectionId,400		token_id: TokenId,401		scope: PropertyScope,402	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {403		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))404	}405406	/// Get ID of the last minted token407	pub fn current_token_id(collection_id: CollectionId) -> TokenId {408		TokenId(<TokensMinted<T>>::get(collection_id))409	}410}411412// unchecked calls skips any permission checks413impl<T: Config> Pallet<T> {414	/// Create NFT collection415	///416	/// `init_collection` will take non-refundable deposit for collection creation.417	///418	/// - `data`: Contains settings for collection limits and permissions.419	pub fn init_collection(420		owner: T::CrossAccountId,421		payer: T::CrossAccountId,422		data: CreateCollectionData<T::AccountId>,423		flags: CollectionFlags,424	) -> Result<CollectionId, DispatchError> {425		<PalletCommon<T>>::init_collection(owner, payer, data, flags)426	}427428	/// Destroy NFT collection429	///430	/// `destroy_collection` will throw error if collection contains any tokens.431	/// Only owner can destroy collection.432	pub fn destroy_collection(433		collection: NonfungibleHandle<T>,434		sender: &T::CrossAccountId,435	) -> DispatchResult {436		let id = collection.id;437438		if Self::collection_has_tokens(id) {439			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());440		}441442		// =========443444		PalletCommon::destroy_collection(collection.0, sender)?;445446		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);447		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);448		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);449		<TokensMinted<T>>::remove(id);450		<TokensBurnt<T>>::remove(id);451		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);452		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);453		let _ = <CollectionAllowance<T>>::clear_prefix((id,), u32::MAX, None);454		Ok(())455	}456457	/// Burn NFT token458	///459	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token460	/// if the token is nested.461	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.462	/// Also removes all corresponding properties and auxiliary properties.463	///464	/// - `token`: Token that should be burned465	/// - `collection`: Collection that contains the token466	pub fn burn(467		collection: &NonfungibleHandle<T>,468		sender: &T::CrossAccountId,469		token: TokenId,470	) -> DispatchResult {471		let token_data =472			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;473		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);474475		if collection.permissions.access() == AccessMode::AllowList {476			collection.check_allowlist(sender)?;477		}478479		if Self::token_has_children(collection.id, token) {480			return Err(<Error<T>>::CantBurnNftWithChildren.into());481		}482483		let burnt = <TokensBurnt<T>>::get(collection.id)484			.checked_add(1)485			.ok_or(ArithmeticError::Overflow)?;486487		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))488			.checked_sub(1)489			.ok_or(ArithmeticError::Overflow)?;490491		// =========492493		if balance == 0 {494			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));495		} else {496			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);497		}498499		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);500501		<Owned<T>>::remove((collection.id, &token_data.owner, token));502		<TokensBurnt<T>>::insert(collection.id, burnt);503		<TokenData<T>>::remove((collection.id, token));504		<TokenProperties<T>>::remove((collection.id, token));505		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);506		let old_spender = <Allowance<T>>::take((collection.id, token));507508		if let Some(old_spender) = old_spender {509			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(510				collection.id,511				token,512				token_data.owner.clone(),513				old_spender,514				0,515			));516		}517518		<PalletEvm<T>>::deposit_log(519			ERC721Events::Transfer {520				from: *token_data.owner.as_eth(),521				to: H160::default(),522				token_id: token.into(),523			}524			.to_log(collection_id_to_address(collection.id)),525		);526		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(527			collection.id,528			token,529			token_data.owner,530			1,531		));532		Ok(())533	}534535	/// Same as [`burn`] but burns all the tokens that are nested in the token first536	///537	/// - `self_budget`: Limit for searching children in depth.538	/// - `breadth_budget`: Limit of breadth of searching children.539	///540	/// [`burn`]: struct.Pallet.html#method.burn541	#[transactional]542	pub fn burn_recursively(543		collection: &NonfungibleHandle<T>,544		sender: &T::CrossAccountId,545		token: TokenId,546		self_budget: &dyn Budget,547		breadth_budget: &dyn Budget,548	) -> DispatchResultWithPostInfo {549		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);550551		let current_token_account =552			T::CrossTokenAddressMapping::token_to_address(collection.id, token);553554		let mut weight = Weight::zero();555556		// This method is transactional, if user in fact doesn't have permissions to remove token -557		// tokens removed here will be restored after rejected transaction558		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {559			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);560			let PostDispatchInfo { actual_weight, .. } =561				<PalletStructure<T>>::burn_item_recursively(562					current_token_account.clone(),563					collection,564					token,565					self_budget,566					breadth_budget,567				)?;568			if let Some(actual_weight) = actual_weight {569				weight = weight.saturating_add(actual_weight);570			}571		}572573		Self::burn(collection, sender, token)?;574		DispatchResultWithPostInfo::Ok(PostDispatchInfo {575			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),576			pays_fee: Pays::Yes,577		})578	}579580	/// A batch operation to add, edit or remove properties for a token.581	/// It sets or removes a token's properties according to582	/// `properties_updates` contents:583	/// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`584	/// * removes a property under the <key> if the value is `None` `(<key>, None)`.585	///586	/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.587	/// - `is_token_create`: Indicates that method is called during token initialization.588	///   Allows to bypass ownership check.589	///590	/// All affected properties should have `mutable` permission591	/// to be **deleted** or to be **set more than once**,592	/// and the sender should have permission to edit those properties.593	///594	/// This function fires an event for each property change.595	/// In case of an error, all the changes (including the events) will be reverted596	/// since the function is transactional.597	#[transactional]598	fn modify_token_properties(599		collection: &NonfungibleHandle<T>,600		sender: &T::CrossAccountId,601		token_id: TokenId,602		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,603		is_token_create: bool,604		nesting_budget: &dyn Budget,605	) -> DispatchResult {606		let mut collection_admin_status = None;607		let mut token_owner_result = None;608609		let mut is_collection_admin =610			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));611612		let mut is_token_owner = || {613			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {614				let is_owned = <PalletStructure<T>>::check_indirectly_owned(615					sender.clone(),616					collection.id,617					token_id,618					None,619					nesting_budget,620				)?;621622				Ok(is_owned)623			})624		};625626		let mut stored_properties = <TokenProperties<T>>::get((collection.id, token_id));627		let permissions = <PalletCommon<T>>::property_permissions(collection.id);628629		for (key, value) in properties_updates {630			let permission = permissions631				.get(&key)632				.cloned()633				.unwrap_or_else(PropertyPermission::none);634635			let is_property_exists = stored_properties.get(&key).is_some();636637			match permission {638				PropertyPermission { mutable: false, .. } if is_property_exists => {639					return Err(<CommonError<T>>::NoPermission.into());640				}641642				PropertyPermission {643					collection_admin,644					token_owner,645					..646				} => {647					//TODO: investigate threats during public minting.648					if is_token_create && (collection_admin || token_owner) && value.is_some() {649						// Pass650					} else if collection_admin && is_collection_admin() {651						// Pass652					} else if token_owner && is_token_owner()? {653						// Pass654					} else {655						fail!(<CommonError<T>>::NoPermission);656					}657				}658			}659660			match value {661				Some(value) => {662					stored_properties663						.try_set(key.clone(), value)664						.map_err(<CommonError<T>>::from)?;665666					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(667						collection.id,668						token_id,669						key,670					));671				}672				None => {673					stored_properties674						.remove(&key)675						.map_err(<CommonError<T>>::from)?;676677					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(678						collection.id,679						token_id,680						key,681					));682				}683			}684685			<PalletEvm<T>>::deposit_log(686				CollectionHelpersEvents::TokenChanged {687					collection_id: collection_id_to_address(collection.id),688					token_id: token_id.into(),689				}690				.to_log(T::ContractAddress::get()),691			);692		}693694		<TokenProperties<T>>::set((collection.id, token_id), stored_properties);695696		Ok(())697	}698699	/// Batch operation to add or edit properties for the token700	///701	/// Same as [`modify_token_properties`] but doesn't allow to remove properties702	///703	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties704	pub fn set_token_properties(705		collection: &NonfungibleHandle<T>,706		sender: &T::CrossAccountId,707		token_id: TokenId,708		properties: impl Iterator<Item = Property>,709		is_token_create: bool,710		nesting_budget: &dyn Budget,711	) -> DispatchResult {712		Self::modify_token_properties(713			collection,714			sender,715			token_id,716			properties.map(|p| (p.key, Some(p.value))),717			is_token_create,718			nesting_budget,719		)720	}721722	/// Add or edit single property for the token723	///724	/// Calls [`set_token_properties`] internally725	///726	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties727	pub fn set_token_property(728		collection: &NonfungibleHandle<T>,729		sender: &T::CrossAccountId,730		token_id: TokenId,731		property: Property,732		nesting_budget: &dyn Budget,733	) -> DispatchResult {734		let is_token_create = false;735736		Self::set_token_properties(737			collection,738			sender,739			token_id,740			[property].into_iter(),741			is_token_create,742			nesting_budget,743		)744	}745746	/// Batch operation to remove properties from the token747	///748	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties749	///750	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties751	pub fn delete_token_properties(752		collection: &NonfungibleHandle<T>,753		sender: &T::CrossAccountId,754		token_id: TokenId,755		property_keys: impl Iterator<Item = PropertyKey>,756		nesting_budget: &dyn Budget,757	) -> DispatchResult {758		let is_token_create = false;759760		Self::modify_token_properties(761			collection,762			sender,763			token_id,764			property_keys.into_iter().map(|key| (key, None)),765			is_token_create,766			nesting_budget,767		)768	}769770	/// Remove single property from the token771	///772	/// Calls [`delete_token_properties`] internally773	///774	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties775	pub fn delete_token_property(776		collection: &NonfungibleHandle<T>,777		sender: &T::CrossAccountId,778		token_id: TokenId,779		property_key: PropertyKey,780		nesting_budget: &dyn Budget,781	) -> DispatchResult {782		Self::delete_token_properties(783			collection,784			sender,785			token_id,786			[property_key].into_iter(),787			nesting_budget,788		)789	}790791	/// Add or edit properties for the collection792	pub fn set_collection_properties(793		collection: &NonfungibleHandle<T>,794		sender: &T::CrossAccountId,795		properties: Vec<Property>,796	) -> DispatchResult {797		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())798	}799800	/// Remove properties from the collection801	pub fn delete_collection_properties(802		collection: &CollectionHandle<T>,803		sender: &T::CrossAccountId,804		property_keys: Vec<PropertyKey>,805	) -> DispatchResult {806		<PalletCommon<T>>::delete_collection_properties(807			collection,808			sender,809			property_keys.into_iter(),810		)811	}812813	/// Set property permissions for the token.814	///815	/// Sender should be the owner or admin of token's collection.816	pub fn set_token_property_permissions(817		collection: &CollectionHandle<T>,818		sender: &T::CrossAccountId,819		property_permissions: Vec<PropertyKeyPermission>,820	) -> DispatchResult {821		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)822	}823824	/// Set property permissions for the token with scope.825	///826	/// Sender should be the owner or admin of token's collection.827	pub fn set_scoped_token_property_permissions(828		collection: &CollectionHandle<T>,829		sender: &T::CrossAccountId,830		scope: PropertyScope,831		property_permissions: Vec<PropertyKeyPermission>,832	) -> DispatchResult {833		<PalletCommon<T>>::set_scoped_token_property_permissions(834			collection,835			sender,836			scope,837			property_permissions,838		)839	}840841	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {842		<PalletCommon<T>>::property_permissions(collection_id)843	}844845	pub fn check_token_immediate_ownership(846		collection: &NonfungibleHandle<T>,847		token: TokenId,848		possible_owner: &T::CrossAccountId,849	) -> DispatchResult {850		let token_data =851			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;852		ensure!(853			&token_data.owner == possible_owner,854			<CommonError<T>>::NoPermission855		);856		Ok(())857	}858859	/// Transfer NFT token from one account to another.860	///861	/// `from` account stops being the owner and `to` account becomes the owner of the token.862	/// If `to` is token than `to` becomes owner of the token and the token become nested.863	/// Unnests token from previous parent if it was nested before.864	/// Removes allowance for the token if there was any.865	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.866	///867	/// - `nesting_budget`: Limit for token nesting depth868	pub fn transfer(869		collection: &NonfungibleHandle<T>,870		from: &T::CrossAccountId,871		to: &T::CrossAccountId,872		token: TokenId,873		nesting_budget: &dyn Budget,874	) -> DispatchResult {875		ensure!(876			collection.limits.transfers_enabled(),877			<CommonError<T>>::TransferNotAllowed878		);879880		let token_data =881			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;882		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);883884		if collection.permissions.access() == AccessMode::AllowList {885			collection.check_allowlist(from)?;886			collection.check_allowlist(to)?;887		}888		<PalletCommon<T>>::ensure_correct_receiver(to)?;889890		let balance_from = <AccountBalance<T>>::get((collection.id, from))891			.checked_sub(1)892			.ok_or(<CommonError<T>>::TokenValueTooLow)?;893		let balance_to = if from != to {894			let balance_to = <AccountBalance<T>>::get((collection.id, to))895				.checked_add(1)896				.ok_or(ArithmeticError::Overflow)?;897898			ensure!(899				balance_to < collection.limits.account_token_ownership_limit(),900				<CommonError<T>>::AccountTokenLimitExceeded,901			);902903			Some(balance_to)904		} else {905			None906		};907908		<PalletStructure<T>>::nest_if_sent_to_token(909			from.clone(),910			to,911			collection.id,912			token,913			nesting_budget,914		)?;915916		// =========917918		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);919920		<TokenData<T>>::insert(921			(collection.id, token),922			ItemData {923				owner: to.clone(),924				..token_data925			},926		);927928		if let Some(balance_to) = balance_to {929			// from != to930			if balance_from == 0 {931				<AccountBalance<T>>::remove((collection.id, from));932			} else {933				<AccountBalance<T>>::insert((collection.id, from), balance_from);934			}935			<AccountBalance<T>>::insert((collection.id, to), balance_to);936			<Owned<T>>::remove((collection.id, from, token));937			<Owned<T>>::insert((collection.id, to, token), true);938		}939		Self::set_allowance_unchecked(collection, from, token, None, true);940941		<PalletEvm<T>>::deposit_log(942			ERC721Events::Transfer {943				from: *from.as_eth(),944				to: *to.as_eth(),945				token_id: token.into(),946			}947			.to_log(collection_id_to_address(collection.id)),948		);949		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(950			collection.id,951			token,952			from.clone(),953			to.clone(),954			1,955		));956		Ok(())957	}958959	/// Batch operation to mint multiple NFT tokens.960	///961	/// The sender should be the owner/admin of the collection or collection should be configured962	/// to allow public minting.963	/// Throws if amount of tokens reached it's limit for the collection or if caller reached964	/// token ownership limit.965	///966	/// - `data`: Contains list of token properties and users who will become the owners of the967	///   corresponging tokens.968	/// - `nesting_budget`: Limit for token nesting depth969	pub fn create_multiple_items(970		collection: &NonfungibleHandle<T>,971		sender: &T::CrossAccountId,972		data: Vec<CreateItemData<T>>,973		nesting_budget: &dyn Budget,974	) -> DispatchResult {975		if !collection.is_owner_or_admin(sender) {976			ensure!(977				collection.permissions.mint_mode(),978				<CommonError<T>>::PublicMintingNotAllowed979			);980			collection.check_allowlist(sender)?;981982			for item in data.iter() {983				collection.check_allowlist(&item.owner)?;984			}985		}986987		for data in data.iter() {988			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;989		}990991		let first_token = <TokensMinted<T>>::get(collection.id);992		let tokens_minted = first_token993			.checked_add(data.len() as u32)994			.ok_or(ArithmeticError::Overflow)?;995		ensure!(996			tokens_minted <= collection.limits.token_limit(),997			<CommonError<T>>::CollectionTokenLimitExceeded998		);9991000		let mut balances = BTreeMap::new();1001		for data in &data {1002			let balance = balances1003				.entry(&data.owner)1004				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));1005			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;10061007			ensure!(1008				*balance <= collection.limits.account_token_ownership_limit(),1009				<CommonError<T>>::AccountTokenLimitExceeded,1010			);1011		}10121013		for (i, data) in data.iter().enumerate() {1014			let token = TokenId(first_token + i as u32 + 1);10151016			<PalletStructure<T>>::check_nesting(1017				sender.clone(),1018				&data.owner,1019				collection.id,1020				token,1021				nesting_budget,1022			)?;1023		}10241025		// =========10261027		with_transaction(|| {1028			for (i, data) in data.iter().enumerate() {1029				let token = first_token + i as u32 + 1;10301031				<TokenData<T>>::insert(1032					(collection.id, token),1033					ItemData {1034						// const_data: data.const_data.clone(),1035						owner: data.owner.clone(),1036					},1037				);10381039				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1040					&data.owner,1041					collection.id,1042					TokenId(token),1043				);10441045				if let Err(e) = Self::set_token_properties(1046					collection,1047					sender,1048					TokenId(token),1049					data.properties.clone().into_iter(),1050					true,1051					nesting_budget,1052				) {1053					return TransactionOutcome::Rollback(Err(e));1054				}1055			}1056			TransactionOutcome::Commit(Ok(()))1057		})?;10581059		<TokensMinted<T>>::insert(collection.id, tokens_minted);1060		for (account, balance) in balances {1061			<AccountBalance<T>>::insert((collection.id, account), balance);1062		}1063		for (i, data) in data.into_iter().enumerate() {1064			let token = first_token + i as u32 + 1;1065			<Owned<T>>::insert((collection.id, &data.owner, token), true);10661067			<PalletEvm<T>>::deposit_log(1068				ERC721Events::Transfer {1069					from: H160::default(),1070					to: *data.owner.as_eth(),1071					token_id: token.into(),1072				}1073				.to_log(collection_id_to_address(collection.id)),1074			);1075			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1076				collection.id,1077				TokenId(token),1078				data.owner.clone(),1079				1,1080			));1081		}1082		Ok(())1083	}10841085	pub fn set_allowance_unchecked(1086		collection: &NonfungibleHandle<T>,1087		sender: &T::CrossAccountId,1088		token: TokenId,1089		spender: Option<&T::CrossAccountId>,1090		assume_implicit_eth: bool,1091	) {1092		if let Some(spender) = spender {1093			let old_spender = <Allowance<T>>::get((collection.id, token));1094			<Allowance<T>>::insert((collection.id, token), spender);1095			// In ERC721 there is only one possible approved user of token, so we set1096			// approved user to spender1097			<PalletEvm<T>>::deposit_log(1098				ERC721Events::Approval {1099					owner: *sender.as_eth(),1100					approved: *spender.as_eth(),1101					token_id: token.into(),1102				}1103				.to_log(collection_id_to_address(collection.id)),1104			);1105			// In Unique chain, any token can have any amount of approved users, so we need to1106			// set allowance of old owner to 0, and allowance of new owner to 11107			if old_spender.as_ref() != Some(spender) {1108				if let Some(old_owner) = old_spender {1109					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1110						collection.id,1111						token,1112						sender.clone(),1113						old_owner,1114						0,1115					));1116				}1117				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1118					collection.id,1119					token,1120					sender.clone(),1121					spender.clone(),1122					1,1123				));1124			}1125		} else {1126			let old_spender = <Allowance<T>>::take((collection.id, token));1127			if !assume_implicit_eth {1128				// In ERC721 there is only one possible approved user of token, so we set1129				// approved user to zero address1130				<PalletEvm<T>>::deposit_log(1131					ERC721Events::Approval {1132						owner: *sender.as_eth(),1133						approved: H160::default(),1134						token_id: token.into(),1135					}1136					.to_log(collection_id_to_address(collection.id)),1137				);1138			}1139			// In Unique chain, any token can have any amount of approved users, so we need to1140			// set allowance of old owner to 01141			if let Some(old_spender) = old_spender {1142				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1143					collection.id,1144					token,1145					sender.clone(),1146					old_spender,1147					0,1148				));1149			}1150		}1151	}11521153	/// Set allowance for the spender to `transfer` or `burn` sender's token.1154	///1155	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1156	pub fn set_allowance(1157		collection: &NonfungibleHandle<T>,1158		sender: &T::CrossAccountId,1159		token: TokenId,1160		spender: Option<&T::CrossAccountId>,1161	) -> DispatchResult {1162		if collection.permissions.access() == AccessMode::AllowList {1163			collection.check_allowlist(sender)?;1164			if let Some(spender) = spender {1165				collection.check_allowlist(spender)?;1166			}1167		}11681169		if let Some(spender) = spender {1170			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1171		}11721173		let token_data =1174			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1175		if &token_data.owner != sender {1176			ensure!(1177				collection.ignores_owned_amount(sender),1178				<CommonError<T>>::CantApproveMoreThanOwned1179			);1180		}11811182		// =========11831184		Self::set_allowance_unchecked(collection, sender, token, spender, false);1185		Ok(())1186	}11871188	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1189	///1190	/// - `from`: Address of sender's eth mirror.1191	/// - `to`: Adress of spender.1192	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1193	pub fn set_allowance_from(1194		collection: &NonfungibleHandle<T>,1195		sender: &T::CrossAccountId,1196		from: &T::CrossAccountId,1197		token: TokenId,1198		to: Option<&T::CrossAccountId>,1199	) -> DispatchResult {1200		if collection.permissions.access() == AccessMode::AllowList {1201			collection.check_allowlist(sender)?;1202			collection.check_allowlist(from)?;1203			if let Some(to) = to {1204				collection.check_allowlist(to)?;1205			}1206		}12071208		if let Some(to) = to {1209			<PalletCommon<T>>::ensure_correct_receiver(to)?;1210		}12111212		ensure!(1213			sender.conv_eq(from),1214			<CommonError<T>>::AddressIsNotEthMirror1215		);12161217		let token_data =1218			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1219		if token_data.owner != *from {1220			ensure!(1221				collection.limits.owner_can_transfer()1222					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1223				<CommonError<T>>::CantApproveMoreThanOwned1224			);1225		}12261227		// =========12281229		Self::set_allowance_unchecked(collection, from, token, to, false);1230		Ok(())1231	}12321233	/// Checks allowance for the spender to use the token.1234	fn check_allowed(1235		collection: &NonfungibleHandle<T>,1236		spender: &T::CrossAccountId,1237		from: &T::CrossAccountId,1238		token: TokenId,1239		nesting_budget: &dyn Budget,1240	) -> DispatchResult {1241		if spender.conv_eq(from) {1242			return Ok(());1243		}1244		if collection.permissions.access() == AccessMode::AllowList {1245			// `from`, `to` checked in [`transfer`]1246			collection.check_allowlist(spender)?;1247		}12481249		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1250			return Ok(());1251		}12521253		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1254			ensure!(1255				<PalletStructure<T>>::check_indirectly_owned(1256					spender.clone(),1257					source.0,1258					source.1,1259					None,1260					nesting_budget1261				)?,1262				<CommonError<T>>::ApprovedValueTooLow,1263			);1264			return Ok(());1265		}1266		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1267			return Ok(());1268		}1269		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1270			return Ok(());1271		}1272		ensure!(1273			collection.ignores_allowance(spender),1274			<CommonError<T>>::ApprovedValueTooLow1275		);1276		Ok(())1277	}12781279	/// Transfer NFT token from one account to another.1280	///1281	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1282	/// The owner should set allowance for the spender to transfer token.1283	///1284	/// [`transfer`]: struct.Pallet.html#method.transfer1285	pub fn transfer_from(1286		collection: &NonfungibleHandle<T>,1287		spender: &T::CrossAccountId,1288		from: &T::CrossAccountId,1289		to: &T::CrossAccountId,1290		token: TokenId,1291		nesting_budget: &dyn Budget,1292	) -> DispatchResult {1293		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12941295		// =========12961297		// Allowance is reset in [`transfer`]1298		Self::transfer(collection, from, to, token, nesting_budget)1299	}13001301	/// Burn NFT token for `from` account.1302	///1303	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1304	/// set allowance for the spender to burn token.1305	///1306	/// [`burn`]: struct.Pallet.html#method.burn1307	pub fn burn_from(1308		collection: &NonfungibleHandle<T>,1309		spender: &T::CrossAccountId,1310		from: &T::CrossAccountId,1311		token: TokenId,1312		nesting_budget: &dyn Budget,1313	) -> DispatchResult {1314		Self::check_allowed(collection, spender, from, token, nesting_budget)?;13151316		// =========13171318		Self::burn(collection, from, token)1319	}13201321	/// Check that `from` token could be nested in `under` token.1322	///1323	pub fn check_nesting(1324		handle: &NonfungibleHandle<T>,1325		sender: T::CrossAccountId,1326		from: (CollectionId, TokenId),1327		under: TokenId,1328		nesting_budget: &dyn Budget,1329	) -> DispatchResult {1330		let nesting = handle.permissions.nesting();13311332		#[cfg(not(feature = "runtime-benchmarks"))]1333		let permissive = false;1334		#[cfg(feature = "runtime-benchmarks")]1335		let permissive = nesting.permissive;13361337		if permissive {1338			// Pass1339		} else if nesting.token_owner1340			&& <PalletStructure<T>>::check_indirectly_owned(1341				sender.clone(),1342				handle.id,1343				under,1344				Some(from),1345				nesting_budget,1346			)? {1347			// Pass1348		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1349			// Pass1350		} else {1351			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1352		}13531354		if let Some(whitelist) = &nesting.restricted {1355			ensure!(1356				whitelist.contains(&from.0),1357				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1358			);1359		}1360		Ok(())1361	}13621363	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1364		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1365	}13661367	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1368		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1369	}13701371	fn collection_has_tokens(collection_id: CollectionId) -> bool {1372		<TokenData<T>>::iter_prefix((collection_id,))1373			.next()1374			.is_some()1375	}13761377	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1378		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1379			.next()1380			.is_some()1381	}13821383	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1384		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1385			.map(|((child_collection_id, child_id), _)| TokenChild {1386				collection: child_collection_id,1387				token: child_id,1388			})1389			.collect()1390	}13911392	/// Mint single NFT token.1393	///1394	/// Delegated to [`create_multiple_items`]1395	///1396	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1397	pub fn create_item(1398		collection: &NonfungibleHandle<T>,1399		sender: &T::CrossAccountId,1400		data: CreateItemData<T>,1401		nesting_budget: &dyn Budget,1402	) -> DispatchResult {1403		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1404	}14051406	/// Sets or unsets the approval of a given operator.1407	///1408	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1409	/// - `owner`: Token owner1410	/// - `operator`: Operator1411	/// - `approve`: Should operator status be granted or revoked?1412	pub fn set_allowance_for_all(1413		collection: &NonfungibleHandle<T>,1414		owner: &T::CrossAccountId,1415		operator: &T::CrossAccountId,1416		approve: bool,1417	) -> DispatchResult {1418		if collection.permissions.access() == AccessMode::AllowList {1419			collection.check_allowlist(owner)?;1420			collection.check_allowlist(operator)?;1421		}14221423		<PalletCommon<T>>::ensure_correct_receiver(operator)?;14241425		// =========14261427		<CollectionAllowance<T>>::insert((collection.id, owner, operator), approve);1428		<PalletEvm<T>>::deposit_log(1429			ERC721Events::ApprovalForAll {1430				owner: *owner.as_eth(),1431				operator: *operator.as_eth(),1432				approved: approve,1433			}1434			.to_log(collection_id_to_address(collection.id)),1435		);1436		<PalletCommon<T>>::deposit_event(CommonEvent::ApprovedForAll(1437			collection.id,1438			owner.clone(),1439			operator.clone(),1440			approve,1441		));1442		Ok(())1443	}14441445	/// Tells whether the given `owner` approves the `operator`.1446	pub fn allowance_for_all(1447		collection: &NonfungibleHandle<T>,1448		owner: &T::CrossAccountId,1449		operator: &T::CrossAccountId,1450	) -> bool {1451		<CollectionAllowance<T>>::get((collection.id, owner, operator))1452	}14531454	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1455		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1456			properties.recompute_consumed_space();1457		});14581459		Ok(())1460	}1461}