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

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,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,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::H160;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	/// Upgrade from the old schema to properties.276	#[pallet::hooks]277	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {278		fn on_runtime_upgrade() -> Weight {279			StorageVersion::new(1).put::<Pallet<T>>();280281			Weight::zero()282		}283	}284}285286pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);287impl<T: Config> NonfungibleHandle<T> {288	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {289		Self(inner)290	}291	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {292		self.0293	}294	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {295		&mut self.0296	}297}298299impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {300	fn recorder(&self) -> &SubstrateRecorder<T> {301		self.0.recorder()302	}303	fn into_recorder(self) -> SubstrateRecorder<T> {304		self.0.into_recorder()305	}306}307impl<T: Config> Deref for NonfungibleHandle<T> {308	type Target = pallet_common::CollectionHandle<T>;309310	fn deref(&self) -> &Self::Target {311		&self.0312	}313}314315impl<T: Config> Pallet<T> {316	/// Get number of NFT tokens in collection.317	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {318		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)319	}320321	/// Check that NFT token exists.322	///323	/// - `token`: Token ID.324	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {325		<TokenData<T>>::contains_key((collection.id, token))326	}327328	/// Set the token property with the scope.329	///330	/// - `property`: Contains key-value pair.331	pub fn set_scoped_token_property(332		collection_id: CollectionId,333		token_id: TokenId,334		scope: PropertyScope,335		property: Property,336	) -> DispatchResult {337		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {338			properties.try_scoped_set(scope, property.key, property.value)339		})340		.map_err(<CommonError<T>>::from)?;341342		Ok(())343	}344345	/// Batch operation to set multiple properties with the same scope.346	pub fn set_scoped_token_properties(347		collection_id: CollectionId,348		token_id: TokenId,349		scope: PropertyScope,350		properties: impl Iterator<Item = Property>,351	) -> DispatchResult {352		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {353			stored_properties.try_scoped_set_from_iter(scope, properties)354		})355		.map_err(<CommonError<T>>::from)?;356357		Ok(())358	}359360	/// Add or edit auxiliary data for the property.361	///362	/// - `f`: function that adds or edits auxiliary data.363	pub fn try_mutate_token_aux_property<R, E>(364		collection_id: CollectionId,365		token_id: TokenId,366		scope: PropertyScope,367		key: PropertyKey,368		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,369	) -> Result<R, E> {370		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)371	}372373	/// Remove auxiliary data for the property.374	pub fn remove_token_aux_property(375		collection_id: CollectionId,376		token_id: TokenId,377		scope: PropertyScope,378		key: PropertyKey,379	) {380		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));381	}382383	/// Get all auxiliary data in a given scope.384	///385	/// Returns iterator over Property Key - Data pairs.386	pub fn iterate_token_aux_properties(387		collection_id: CollectionId,388		token_id: TokenId,389		scope: PropertyScope,390	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {391		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))392	}393394	/// Get ID of the last minted token395	pub fn current_token_id(collection_id: CollectionId) -> TokenId {396		TokenId(<TokensMinted<T>>::get(collection_id))397	}398}399400// unchecked calls skips any permission checks401impl<T: Config> Pallet<T> {402	/// Create NFT collection403	///404	/// `init_collection` will take non-refundable deposit for collection creation.405	///406	/// - `data`: Contains settings for collection limits and permissions.407	pub fn init_collection(408		owner: T::CrossAccountId,409		payer: T::CrossAccountId,410		data: CreateCollectionData<T::AccountId>,411		flags: CollectionFlags,412	) -> Result<CollectionId, DispatchError> {413		<PalletCommon<T>>::init_collection(owner, payer, data, flags)414	}415416	/// Destroy NFT collection417	///418	/// `destroy_collection` will throw error if collection contains any tokens.419	/// Only owner can destroy collection.420	pub fn destroy_collection(421		collection: NonfungibleHandle<T>,422		sender: &T::CrossAccountId,423	) -> DispatchResult {424		let id = collection.id;425426		if Self::collection_has_tokens(id) {427			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());428		}429430		// =========431432		PalletCommon::destroy_collection(collection.0, sender)?;433434		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);435		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);436		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);437		<TokensMinted<T>>::remove(id);438		<TokensBurnt<T>>::remove(id);439		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);440		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);441		Ok(())442	}443444	/// Burn NFT token445	///446	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token447	/// if the token is nested.448	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.449	/// Also removes all corresponding properties and auxiliary properties.450	///451	/// - `token`: Token that should be burned452	/// - `collection`: Collection that contains the token453	pub fn burn(454		collection: &NonfungibleHandle<T>,455		sender: &T::CrossAccountId,456		token: TokenId,457	) -> DispatchResult {458		let token_data =459			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;460		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);461462		if collection.permissions.access() == AccessMode::AllowList {463			collection.check_allowlist(sender)?;464		}465466		if Self::token_has_children(collection.id, token) {467			return Err(<Error<T>>::CantBurnNftWithChildren.into());468		}469470		let burnt = <TokensBurnt<T>>::get(collection.id)471			.checked_add(1)472			.ok_or(ArithmeticError::Overflow)?;473474		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))475			.checked_sub(1)476			.ok_or(ArithmeticError::Overflow)?;477478		// =========479480		if balance == 0 {481			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));482		} else {483			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);484		}485486		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);487488		<Owned<T>>::remove((collection.id, &token_data.owner, token));489		<TokensBurnt<T>>::insert(collection.id, burnt);490		<TokenData<T>>::remove((collection.id, token));491		<TokenProperties<T>>::remove((collection.id, token));492		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);493		let old_spender = <Allowance<T>>::take((collection.id, token));494495		if let Some(old_spender) = old_spender {496			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(497				collection.id,498				token,499				token_data.owner.clone(),500				old_spender,501				0,502			));503		}504505		<PalletEvm<T>>::deposit_log(506			ERC721Events::Transfer {507				from: *token_data.owner.as_eth(),508				to: H160::default(),509				token_id: token.into(),510			}511			.to_log(collection_id_to_address(collection.id)),512		);513		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(514			collection.id,515			token,516			token_data.owner,517			1,518		));519		Ok(())520	}521522	/// Same as [`burn`] but burns all the tokens that are nested in the token first523	///524	/// - `self_budget`: Limit for searching children in depth.525	/// - `breadth_budget`: Limit of breadth of searching children.526	///527	/// [`burn`]: struct.Pallet.html#method.burn528	#[transactional]529	pub fn burn_recursively(530		collection: &NonfungibleHandle<T>,531		sender: &T::CrossAccountId,532		token: TokenId,533		self_budget: &dyn Budget,534		breadth_budget: &dyn Budget,535	) -> DispatchResultWithPostInfo {536		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);537538		let current_token_account =539			T::CrossTokenAddressMapping::token_to_address(collection.id, token);540541		let mut weight = Weight::zero();542543		// This method is transactional, if user in fact doesn't have permissions to remove token -544		// tokens removed here will be restored after rejected transaction545		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {546			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);547			let PostDispatchInfo { actual_weight, .. } =548				<PalletStructure<T>>::burn_item_recursively(549					current_token_account.clone(),550					collection,551					token,552					self_budget,553					breadth_budget,554				)?;555			if let Some(actual_weight) = actual_weight {556				weight = weight.saturating_add(actual_weight);557			}558		}559560		Self::burn(collection, sender, token)?;561		DispatchResultWithPostInfo::Ok(PostDispatchInfo {562			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),563			pays_fee: Pays::Yes,564		})565	}566567	/// Batch operation to add, edit or remove properties for the token568	///569	/// All affected properties should have mutable permission and sender should have570	/// permission to edit those properties.571	///572	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.573	/// - `is_token_create`: Indicates that method is called during token initialization.574	///   Allows to bypass ownership check.575	#[transactional]576	fn modify_token_properties(577		collection: &NonfungibleHandle<T>,578		sender: &T::CrossAccountId,579		token_id: TokenId,580		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,581		is_token_create: bool,582		nesting_budget: &dyn Budget,583	) -> DispatchResult {584		let mut collection_admin_status = None;585		let mut token_owner_result = None;586587		let mut is_collection_admin =588			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));589590		let mut is_token_owner = || {591			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {592				let is_owned = <PalletStructure<T>>::check_indirectly_owned(593					sender.clone(),594					collection.id,595					token_id,596					None,597					nesting_budget,598				)?;599600				Ok(is_owned)601			})602		};603604		for (key, value) in properties {605			let permission = <PalletCommon<T>>::property_permissions(collection.id)606				.get(&key)607				.cloned()608				.unwrap_or_else(PropertyPermission::none);609610			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))611				.get(&key)612				.is_some();613614			match permission {615				PropertyPermission { mutable: false, .. } if is_property_exists => {616					return Err(<CommonError<T>>::NoPermission.into());617				}618619				PropertyPermission {620					collection_admin,621					token_owner,622					..623				} => {624					//TODO: investigate threats during public minting.625					if is_token_create && (collection_admin || token_owner) && value.is_some() {626						// Pass627					} else if collection_admin && is_collection_admin() {628						// Pass629					} else if token_owner && is_token_owner()? {630						// Pass631					} else {632						fail!(<CommonError<T>>::NoPermission);633					}634				}635			}636637			match value {638				Some(value) => {639					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {640						properties.try_set(key.clone(), value)641					})642					.map_err(<CommonError<T>>::from)?;643644					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(645						collection.id,646						token_id,647						key,648					));649				}650				None => {651					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {652						properties.remove(&key)653					})654					.map_err(<CommonError<T>>::from)?;655656					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(657						collection.id,658						token_id,659						key,660					));661				}662			}663		}664665		Ok(())666	}667668	/// Batch operation to add or edit properties for the token669	///670	/// Same as [`modify_token_properties`] but doesn't allow to remove properties671	///672	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties673	pub fn set_token_properties(674		collection: &NonfungibleHandle<T>,675		sender: &T::CrossAccountId,676		token_id: TokenId,677		properties: impl Iterator<Item = Property>,678		is_token_create: bool,679		nesting_budget: &dyn Budget,680	) -> DispatchResult {681		Self::modify_token_properties(682			collection,683			sender,684			token_id,685			properties.map(|p| (p.key, Some(p.value))),686			is_token_create,687			nesting_budget,688		)689	}690691	/// Add or edit single property for the token692	///693	/// Calls [`set_token_properties`] internally694	///695	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties696	pub fn set_token_property(697		collection: &NonfungibleHandle<T>,698		sender: &T::CrossAccountId,699		token_id: TokenId,700		property: Property,701		nesting_budget: &dyn Budget,702	) -> DispatchResult {703		let is_token_create = false;704705		Self::set_token_properties(706			collection,707			sender,708			token_id,709			[property].into_iter(),710			is_token_create,711			nesting_budget,712		)713	}714715	/// Batch operation to remove properties from the token716	///717	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties718	///719	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties720	pub fn delete_token_properties(721		collection: &NonfungibleHandle<T>,722		sender: &T::CrossAccountId,723		token_id: TokenId,724		property_keys: impl Iterator<Item = PropertyKey>,725		nesting_budget: &dyn Budget,726	) -> DispatchResult {727		let is_token_create = false;728729		Self::modify_token_properties(730			collection,731			sender,732			token_id,733			property_keys.into_iter().map(|key| (key, None)),734			is_token_create,735			nesting_budget,736		)737	}738739	/// Remove single property from the token740	///741	/// Calls [`delete_token_properties`] internally742	///743	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties744	pub fn delete_token_property(745		collection: &NonfungibleHandle<T>,746		sender: &T::CrossAccountId,747		token_id: TokenId,748		property_key: PropertyKey,749		nesting_budget: &dyn Budget,750	) -> DispatchResult {751		Self::delete_token_properties(752			collection,753			sender,754			token_id,755			[property_key].into_iter(),756			nesting_budget,757		)758	}759760	/// Add or edit properties for the collection761	pub fn set_collection_properties(762		collection: &NonfungibleHandle<T>,763		sender: &T::CrossAccountId,764		properties: Vec<Property>,765	) -> DispatchResult {766		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)767	}768769	/// Remove properties from the collection770	pub fn delete_collection_properties(771		collection: &CollectionHandle<T>,772		sender: &T::CrossAccountId,773		property_keys: Vec<PropertyKey>,774	) -> DispatchResult {775		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)776	}777778	/// Set property permissions for the token.779	///780	/// Sender should be the owner or admin of token's collection.781	pub fn set_token_property_permissions(782		collection: &CollectionHandle<T>,783		sender: &T::CrossAccountId,784		property_permissions: Vec<PropertyKeyPermission>,785	) -> DispatchResult {786		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)787	}788789	/// Set property permissions for the token with scope.790	///791	/// Sender should be the owner or admin of token's collection.792	pub fn set_scoped_token_property_permissions(793		collection: &CollectionHandle<T>,794		sender: &T::CrossAccountId,795		scope: PropertyScope,796		property_permissions: Vec<PropertyKeyPermission>,797	) -> DispatchResult {798		<PalletCommon<T>>::set_scoped_token_property_permissions(799			collection,800			sender,801			scope,802			property_permissions,803		)804	}805806	/// Set property permissions for the collection.807	///808	/// Sender should be the owner or admin of the collection.809	pub fn set_property_permission(810		collection: &CollectionHandle<T>,811		sender: &T::CrossAccountId,812		permission: PropertyKeyPermission,813	) -> DispatchResult {814		<PalletCommon<T>>::set_property_permission(collection, sender, permission)815	}816817	pub fn check_token_immediate_ownership(818		collection: &NonfungibleHandle<T>,819		token: TokenId,820		possible_owner: &T::CrossAccountId,821	) -> DispatchResult {822		let token_data =823			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;824		ensure!(825			&token_data.owner == possible_owner,826			<CommonError<T>>::NoPermission827		);828		Ok(())829	}830831	/// Transfer NFT token from one account to another.832	///833	/// `from` account stops being the owner and `to` account becomes the owner of the token.834	/// If `to` is token than `to` becomes owner of the token and the token become nested.835	/// Unnests token from previous parent if it was nested before.836	/// Removes allowance for the token if there was any.837	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.838	///839	/// - `nesting_budget`: Limit for token nesting depth840	pub fn transfer(841		collection: &NonfungibleHandle<T>,842		from: &T::CrossAccountId,843		to: &T::CrossAccountId,844		token: TokenId,845		nesting_budget: &dyn Budget,846	) -> DispatchResult {847		ensure!(848			collection.limits.transfers_enabled(),849			<CommonError<T>>::TransferNotAllowed850		);851852		let token_data =853			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;854		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);855856		if collection.permissions.access() == AccessMode::AllowList {857			collection.check_allowlist(from)?;858			collection.check_allowlist(to)?;859		}860		<PalletCommon<T>>::ensure_correct_receiver(to)?;861862		let balance_from = <AccountBalance<T>>::get((collection.id, from))863			.checked_sub(1)864			.ok_or(<CommonError<T>>::TokenValueTooLow)?;865		let balance_to = if from != to {866			let balance_to = <AccountBalance<T>>::get((collection.id, to))867				.checked_add(1)868				.ok_or(ArithmeticError::Overflow)?;869870			ensure!(871				balance_to < collection.limits.account_token_ownership_limit(),872				<CommonError<T>>::AccountTokenLimitExceeded,873			);874875			Some(balance_to)876		} else {877			None878		};879880		<PalletStructure<T>>::nest_if_sent_to_token(881			from.clone(),882			to,883			collection.id,884			token,885			nesting_budget,886		)?;887888		// =========889890		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);891892		<TokenData<T>>::insert(893			(collection.id, token),894			ItemData {895				owner: to.clone(),896				..token_data897			},898		);899900		if let Some(balance_to) = balance_to {901			// from != to902			if balance_from == 0 {903				<AccountBalance<T>>::remove((collection.id, from));904			} else {905				<AccountBalance<T>>::insert((collection.id, from), balance_from);906			}907			<AccountBalance<T>>::insert((collection.id, to), balance_to);908			<Owned<T>>::remove((collection.id, from, token));909			<Owned<T>>::insert((collection.id, to, token), true);910		}911		Self::set_allowance_unchecked(collection, from, token, None, true);912913		<PalletEvm<T>>::deposit_log(914			ERC721Events::Transfer {915				from: *from.as_eth(),916				to: *to.as_eth(),917				token_id: token.into(),918			}919			.to_log(collection_id_to_address(collection.id)),920		);921		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(922			collection.id,923			token,924			from.clone(),925			to.clone(),926			1,927		));928		Ok(())929	}930931	/// Batch operation to mint multiple NFT tokens.932	///933	/// The sender should be the owner/admin of the collection or collection should be configured934	/// to allow public minting.935	/// Throws if amount of tokens reached it's limit for the collection or if caller reached936	/// token ownership limit.937	///938	/// - `data`: Contains list of token properties and users who will become the owners of the939	///   corresponging tokens.940	/// - `nesting_budget`: Limit for token nesting depth941	pub fn create_multiple_items(942		collection: &NonfungibleHandle<T>,943		sender: &T::CrossAccountId,944		data: Vec<CreateItemData<T>>,945		nesting_budget: &dyn Budget,946	) -> DispatchResult {947		if !collection.is_owner_or_admin(sender) {948			ensure!(949				collection.permissions.mint_mode(),950				<CommonError<T>>::PublicMintingNotAllowed951			);952			collection.check_allowlist(sender)?;953954			for item in data.iter() {955				collection.check_allowlist(&item.owner)?;956			}957		}958959		for data in data.iter() {960			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;961		}962963		let first_token = <TokensMinted<T>>::get(collection.id);964		let tokens_minted = first_token965			.checked_add(data.len() as u32)966			.ok_or(ArithmeticError::Overflow)?;967		ensure!(968			tokens_minted <= collection.limits.token_limit(),969			<CommonError<T>>::CollectionTokenLimitExceeded970		);971972		let mut balances = BTreeMap::new();973		for data in &data {974			let balance = balances975				.entry(&data.owner)976				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));977			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;978979			ensure!(980				*balance <= collection.limits.account_token_ownership_limit(),981				<CommonError<T>>::AccountTokenLimitExceeded,982			);983		}984985		for (i, data) in data.iter().enumerate() {986			let token = TokenId(first_token + i as u32 + 1);987988			<PalletStructure<T>>::check_nesting(989				sender.clone(),990				&data.owner,991				collection.id,992				token,993				nesting_budget,994			)?;995		}996997		// =========998999		with_transaction(|| {1000			for (i, data) in data.iter().enumerate() {1001				let token = first_token + i as u32 + 1;10021003				<TokenData<T>>::insert(1004					(collection.id, token),1005					ItemData {1006						// const_data: data.const_data.clone(),1007						owner: data.owner.clone(),1008					},1009				);10101011				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1012					&data.owner,1013					collection.id,1014					TokenId(token),1015				);10161017				if let Err(e) = Self::set_token_properties(1018					collection,1019					sender,1020					TokenId(token),1021					data.properties.clone().into_iter(),1022					true,1023					nesting_budget,1024				) {1025					return TransactionOutcome::Rollback(Err(e));1026				}1027			}1028			TransactionOutcome::Commit(Ok(()))1029		})?;10301031		<TokensMinted<T>>::insert(collection.id, tokens_minted);1032		for (account, balance) in balances {1033			<AccountBalance<T>>::insert((collection.id, account), balance);1034		}1035		for (i, data) in data.into_iter().enumerate() {1036			let token = first_token + i as u32 + 1;1037			<Owned<T>>::insert((collection.id, &data.owner, token), true);10381039			<PalletEvm<T>>::deposit_log(1040				ERC721Events::Transfer {1041					from: H160::default(),1042					to: *data.owner.as_eth(),1043					token_id: token.into(),1044				}1045				.to_log(collection_id_to_address(collection.id)),1046			);1047			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1048				collection.id,1049				TokenId(token),1050				data.owner.clone(),1051				1,1052			));1053		}1054		Ok(())1055	}10561057	pub fn set_allowance_unchecked(1058		collection: &NonfungibleHandle<T>,1059		sender: &T::CrossAccountId,1060		token: TokenId,1061		spender: Option<&T::CrossAccountId>,1062		assume_implicit_eth: bool,1063	) {1064		if let Some(spender) = spender {1065			let old_spender = <Allowance<T>>::get((collection.id, token));1066			<Allowance<T>>::insert((collection.id, token), spender);1067			// In ERC721 there is only one possible approved user of token, so we set1068			// approved user to spender1069			<PalletEvm<T>>::deposit_log(1070				ERC721Events::Approval {1071					owner: *sender.as_eth(),1072					approved: *spender.as_eth(),1073					token_id: token.into(),1074				}1075				.to_log(collection_id_to_address(collection.id)),1076			);1077			// In Unique chain, any token can have any amount of approved users, so we need to1078			// set allowance of old owner to 0, and allowance of new owner to 11079			if old_spender.as_ref() != Some(spender) {1080				if let Some(old_owner) = old_spender {1081					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1082						collection.id,1083						token,1084						sender.clone(),1085						old_owner,1086						0,1087					));1088				}1089				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1090					collection.id,1091					token,1092					sender.clone(),1093					spender.clone(),1094					1,1095				));1096			}1097		} else {1098			let old_spender = <Allowance<T>>::take((collection.id, token));1099			if !assume_implicit_eth {1100				// In ERC721 there is only one possible approved user of token, so we set1101				// approved user to zero address1102				<PalletEvm<T>>::deposit_log(1103					ERC721Events::Approval {1104						owner: *sender.as_eth(),1105						approved: H160::default(),1106						token_id: token.into(),1107					}1108					.to_log(collection_id_to_address(collection.id)),1109				);1110			}1111			// In Unique chain, any token can have any amount of approved users, so we need to1112			// set allowance of old owner to 01113			if let Some(old_spender) = old_spender {1114				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1115					collection.id,1116					token,1117					sender.clone(),1118					old_spender,1119					0,1120				));1121			}1122		}1123	}11241125	/// Set allowance for the spender to `transfer` or `burn` sender's token.1126	///1127	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1128	pub fn set_allowance(1129		collection: &NonfungibleHandle<T>,1130		sender: &T::CrossAccountId,1131		token: TokenId,1132		spender: Option<&T::CrossAccountId>,1133	) -> DispatchResult {1134		if collection.permissions.access() == AccessMode::AllowList {1135			collection.check_allowlist(sender)?;1136			if let Some(spender) = spender {1137				collection.check_allowlist(spender)?;1138			}1139		}11401141		if let Some(spender) = spender {1142			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1143		}11441145		let token_data =1146			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1147		if &token_data.owner != sender {1148			ensure!(1149				collection.ignores_owned_amount(sender),1150				<CommonError<T>>::CantApproveMoreThanOwned1151			);1152		}11531154		// =========11551156		Self::set_allowance_unchecked(collection, sender, token, spender, false);1157		Ok(())1158	}11591160	/// Checks allowance for the spender to use the token.1161	fn check_allowed(1162		collection: &NonfungibleHandle<T>,1163		spender: &T::CrossAccountId,1164		from: &T::CrossAccountId,1165		token: TokenId,1166		nesting_budget: &dyn Budget,1167	) -> DispatchResult {1168		if spender.conv_eq(from) {1169			return Ok(());1170		}1171		if collection.permissions.access() == AccessMode::AllowList {1172			// `from`, `to` checked in [`transfer`]1173			collection.check_allowlist(spender)?;1174		}11751176		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1177			return Ok(());1178		}11791180		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1181			ensure!(1182				<PalletStructure<T>>::check_indirectly_owned(1183					spender.clone(),1184					source.0,1185					source.1,1186					None,1187					nesting_budget1188				)?,1189				<CommonError<T>>::ApprovedValueTooLow,1190			);1191			return Ok(());1192		}1193		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1194			return Ok(());1195		}1196		ensure!(1197			collection.ignores_allowance(spender),1198			<CommonError<T>>::ApprovedValueTooLow1199		);1200		Ok(())1201	}12021203	/// Transfer NFT token from one account to another.1204	///1205	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1206	/// The owner should set allowance for the spender to transfer token.1207	///1208	/// [`transfer`]: struct.Pallet.html#method.transfer1209	pub fn transfer_from(1210		collection: &NonfungibleHandle<T>,1211		spender: &T::CrossAccountId,1212		from: &T::CrossAccountId,1213		to: &T::CrossAccountId,1214		token: TokenId,1215		nesting_budget: &dyn Budget,1216	) -> DispatchResult {1217		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12181219		// =========12201221		// Allowance is reset in [`transfer`]1222		Self::transfer(collection, from, to, token, nesting_budget)1223	}12241225	/// Burn NFT token for `from` account.1226	///1227	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1228	/// set allowance for the spender to burn token.1229	///1230	/// [`burn`]: struct.Pallet.html#method.burn1231	pub fn burn_from(1232		collection: &NonfungibleHandle<T>,1233		spender: &T::CrossAccountId,1234		from: &T::CrossAccountId,1235		token: TokenId,1236		nesting_budget: &dyn Budget,1237	) -> DispatchResult {1238		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12391240		// =========12411242		Self::burn(collection, from, token)1243	}12441245	/// Check that `from` token could be nested in `under` token.1246	///1247	pub fn check_nesting(1248		handle: &NonfungibleHandle<T>,1249		sender: T::CrossAccountId,1250		from: (CollectionId, TokenId),1251		under: TokenId,1252		nesting_budget: &dyn Budget,1253	) -> DispatchResult {1254		let nesting = handle.permissions.nesting();12551256		#[cfg(not(feature = "runtime-benchmarks"))]1257		let permissive = false;1258		#[cfg(feature = "runtime-benchmarks")]1259		let permissive = nesting.permissive;12601261		if permissive {1262			// Pass1263		} else if nesting.token_owner1264			&& <PalletStructure<T>>::check_indirectly_owned(1265				sender.clone(),1266				handle.id,1267				under,1268				Some(from),1269				nesting_budget,1270			)? {1271			// Pass1272		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1273			// Pass1274		} else {1275			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1276		}12771278		if let Some(whitelist) = &nesting.restricted {1279			ensure!(1280				whitelist.contains(&from.0),1281				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1282			);1283		}1284		Ok(())1285	}12861287	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1288		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1289	}12901291	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1292		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1293	}12941295	fn collection_has_tokens(collection_id: CollectionId) -> bool {1296		<TokenData<T>>::iter_prefix((collection_id,))1297			.next()1298			.is_some()1299	}13001301	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1302		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1303			.next()1304			.is_some()1305	}13061307	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1308		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1309			.map(|((child_collection_id, child_id), _)| TokenChild {1310				collection: child_collection_id,1311				token: child_id,1312			})1313			.collect()1314	}13151316	/// Mint single NFT token.1317	///1318	/// Delegated to [`create_multiple_items`]1319	///1320	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1321	pub fn create_item(1322		collection: &NonfungibleHandle<T>,1323		sender: &T::CrossAccountId,1324		data: CreateItemData<T>,1325		nesting_budget: &dyn Budget,1326	) -> DispatchResult {1327		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1328	}1329}