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

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	weights::{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	erc::static_property::{key, value},112	eth::collection_id_to_address,113};114use pallet_structure::{Pallet as PalletStructure, Error as StructureError};115use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};116use sp_core::H160;117use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};118use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};119use core::ops::Deref;120use codec::{Encode, Decode, MaxEncodedLen};121use scale_info::TypeInfo;122123pub use pallet::*;124use weights::WeightInfo;125#[cfg(feature = "runtime-benchmarks")]126pub mod benchmarking;127pub mod common;128pub mod erc;129pub mod weights;130131pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::account::Config>::CrossAccountId>;132pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;133134/// Token data, stored independently from other data used to describe it135/// for the convenience of database access. Notably contains the owner account address.136#[struct_versioning::versioned(version = 2, upper)]137#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]138pub struct ItemData<CrossAccountId> {139	#[version(..2)]140	pub const_data: BoundedVec<u8, CustomDataLimit>,141142	#[version(..2)]143	pub variable_data: BoundedVec<u8, CustomDataLimit>,144145	pub owner: CrossAccountId,146}147148#[frame_support::pallet]149pub mod pallet {150	use super::*;151	use frame_support::{152		Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,153	};154	use frame_system::pallet_prelude::*;155	use up_data_structs::{CollectionId, TokenId};156	use super::weights::WeightInfo;157158	#[pallet::error]159	pub enum Error<T> {160		/// Not Nonfungible item data used to mint in Nonfungible collection.161		NotNonfungibleDataUsedToMintFungibleCollectionToken,162		/// Used amount > 1 with NFT163		NonfungibleItemsHaveNoAmount,164		/// Unable to burn NFT with children165		CantBurnNftWithChildren,166	}167168	#[pallet::config]169	pub trait Config:170		frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config171	{172		type WeightInfo: WeightInfo;173	}174175	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);176177	#[pallet::pallet]178	#[pallet::storage_version(STORAGE_VERSION)]179	#[pallet::generate_store(pub(super) trait Store)]180	pub struct Pallet<T>(_);181182	/// Total amount of minted tokens in a collection.183	#[pallet::storage]184	pub type TokensMinted<T: Config> =185		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;186187	/// Amount of burnt tokens in a collection.188	#[pallet::storage]189	pub type TokensBurnt<T: Config> =190		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;191192	/// Token data, used to partially describe a token.193	#[pallet::storage]194	pub type TokenData<T: Config> = StorageNMap<195		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),196		Value = ItemData<T::CrossAccountId>,197		QueryKind = OptionQuery,198	>;199200	/// Map of key-value pairs, describing the metadata of a token.201	#[pallet::storage]202	#[pallet::getter(fn token_properties)]203	pub type TokenProperties<T: Config> = StorageNMap<204		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),205		Value = Properties,206		QueryKind = ValueQuery,207		OnEmpty = up_data_structs::TokenProperties,208	>;209210	/// Custom data of a token that is serialized to bytes,211	/// primarily reserved for on-chain operations,212	/// normally obscured from the external users.213	///214	/// Auxiliary properties are slightly different from215	/// usual [`TokenProperties`] due to an unlimited number216	/// and separately stored and written-to key-value pairs.217	///218	/// Currently used to store RMRK data.219	#[pallet::storage]220	#[pallet::getter(fn token_aux_property)]221	pub type TokenAuxProperties<T: Config> = StorageNMap<222		Key = (223			Key<Twox64Concat, CollectionId>,224			Key<Twox64Concat, TokenId>,225			Key<Twox64Concat, PropertyScope>,226			Key<Twox64Concat, PropertyKey>,227		),228		Value = AuxPropertyValue,229		QueryKind = OptionQuery,230	>;231232	/// Used to enumerate tokens owned by account.233	#[pallet::storage]234	pub type Owned<T: Config> = StorageNMap<235		Key = (236			Key<Twox64Concat, CollectionId>,237			Key<Blake2_128Concat, T::CrossAccountId>,238			Key<Twox64Concat, TokenId>,239		),240		Value = bool,241		QueryKind = ValueQuery,242	>;243244	/// Used to enumerate token's children.245	#[pallet::storage]246	#[pallet::getter(fn token_children)]247	pub type TokenChildren<T: Config> = StorageNMap<248		Key = (249			Key<Twox64Concat, CollectionId>,250			Key<Twox64Concat, TokenId>,251			Key<Twox64Concat, (CollectionId, TokenId)>,252		),253		Value = bool,254		QueryKind = ValueQuery,255	>;256257	/// Amount of tokens owned by an account in a collection.258	#[pallet::storage]259	pub type AccountBalance<T: Config> = StorageNMap<260		Key = (261			Key<Twox64Concat, CollectionId>,262			Key<Blake2_128Concat, T::CrossAccountId>,263		),264		Value = u32,265		QueryKind = ValueQuery,266	>;267268	/// Allowance set by a token owner for another user to perform one of certain transactions on a token.269	#[pallet::storage]270	pub type Allowance<T: Config> = StorageNMap<271		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),272		Value = T::CrossAccountId,273		QueryKind = OptionQuery,274	>;275276	/// Upgrade from the old schema to properties.277	#[pallet::hooks]278	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {279		fn on_runtime_upgrade() -> Weight {280			StorageVersion::new(1).put::<Pallet<T>>();281282			Weight::zero()283		}284	}285}286287pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);288impl<T: Config> NonfungibleHandle<T> {289	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {290		Self(inner)291	}292	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {293		self.0294	}295	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {296		&mut self.0297	}298}299300impl<T: Config> NonfungibleHandle<T> {301	pub fn supports_metadata(&self) -> bool {302		if let Some(erc721_metadata) =303			pallet_common::Pallet::<T>::get_collection_property(self.id, &key::erc721_metadata())304		{305			*erc721_metadata.into_inner() == *value::ERC721_METADATA_SUPPORTED306		} else {307			false308		}309	}310}311312impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {313	fn recorder(&self) -> &SubstrateRecorder<T> {314		self.0.recorder()315	}316	fn into_recorder(self) -> SubstrateRecorder<T> {317		self.0.into_recorder()318	}319}320impl<T: Config> Deref for NonfungibleHandle<T> {321	type Target = pallet_common::CollectionHandle<T>;322323	fn deref(&self) -> &Self::Target {324		&self.0325	}326}327328impl<T: Config> Pallet<T> {329	/// Get number of NFT tokens in collection.330	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {331		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)332	}333334	/// Check that NFT token exists.335	///336	/// - `token`: Token ID.337	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {338		<TokenData<T>>::contains_key((collection.id, token))339	}340341	/// Set the token property with the scope.342	///343	/// - `property`: Contains key-value pair.344	pub fn set_scoped_token_property(345		collection_id: CollectionId,346		token_id: TokenId,347		scope: PropertyScope,348		property: Property,349	) -> DispatchResult {350		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {351			properties.try_scoped_set(scope, property.key, property.value)352		})353		.map_err(<CommonError<T>>::from)?;354355		Ok(())356	}357358	/// Batch operation to set multiple properties with the same scope.359	pub fn set_scoped_token_properties(360		collection_id: CollectionId,361		token_id: TokenId,362		scope: PropertyScope,363		properties: impl Iterator<Item = Property>,364	) -> DispatchResult {365		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {366			stored_properties.try_scoped_set_from_iter(scope, properties)367		})368		.map_err(<CommonError<T>>::from)?;369370		Ok(())371	}372373	/// Add or edit auxiliary data for the property.374	///375	/// - `f`: function that adds or edits auxiliary data.376	pub fn try_mutate_token_aux_property<R, E>(377		collection_id: CollectionId,378		token_id: TokenId,379		scope: PropertyScope,380		key: PropertyKey,381		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,382	) -> Result<R, E> {383		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)384	}385386	/// Remove auxiliary data for the property.387	pub fn remove_token_aux_property(388		collection_id: CollectionId,389		token_id: TokenId,390		scope: PropertyScope,391		key: PropertyKey,392	) {393		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));394	}395396	/// Get all auxiliary data in a given scope.397	///398	/// Returns iterator over Property Key - Data pairs.399	pub fn iterate_token_aux_properties(400		collection_id: CollectionId,401		token_id: TokenId,402		scope: PropertyScope,403	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {404		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))405	}406407	/// Get ID of the last minted token408	pub fn current_token_id(collection_id: CollectionId) -> TokenId {409		TokenId(<TokensMinted<T>>::get(collection_id))410	}411}412413// unchecked calls skips any permission checks414impl<T: Config> Pallet<T> {415	/// Create NFT collection416	///417	/// `init_collection` will take non-refundable deposit for collection creation.418	///419	/// - `data`: Contains settings for collection limits and permissions.420	pub fn init_collection(421		owner: T::CrossAccountId,422		payer: T::CrossAccountId,423		data: CreateCollectionData<T::AccountId>,424		is_external: bool,425	) -> Result<CollectionId, DispatchError> {426		<PalletCommon<T>>::init_collection(427			owner,428			payer,429			data,430			CollectionFlags {431				external: is_external,432				..Default::default()433			},434		)435	}436437	/// Destroy NFT collection438	///439	/// `destroy_collection` will throw error if collection contains any tokens.440	/// Only owner can destroy collection.441	pub fn destroy_collection(442		collection: NonfungibleHandle<T>,443		sender: &T::CrossAccountId,444	) -> DispatchResult {445		let id = collection.id;446447		if Self::collection_has_tokens(id) {448			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());449		}450451		// =========452453		PalletCommon::destroy_collection(collection.0, sender)?;454455		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);456		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);457		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);458		<TokensMinted<T>>::remove(id);459		<TokensBurnt<T>>::remove(id);460		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);461		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);462		Ok(())463	}464465	/// Burn NFT token466	///467	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token468	/// if the token is nested.469	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.470	/// Also removes all corresponding properties and auxiliary properties.471	///472	/// - `token`: Token that should be burned473	/// - `collection`: Collection that contains the token474	pub fn burn(475		collection: &NonfungibleHandle<T>,476		sender: &T::CrossAccountId,477		token: TokenId,478	) -> DispatchResult {479		let token_data =480			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;481		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);482483		if collection.permissions.access() == AccessMode::AllowList {484			collection.check_allowlist(sender)?;485		}486487		if Self::token_has_children(collection.id, token) {488			return Err(<Error<T>>::CantBurnNftWithChildren.into());489		}490491		let burnt = <TokensBurnt<T>>::get(collection.id)492			.checked_add(1)493			.ok_or(ArithmeticError::Overflow)?;494495		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))496			.checked_sub(1)497			.ok_or(ArithmeticError::Overflow)?;498499		// =========500501		if balance == 0 {502			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));503		} else {504			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);505		}506507		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);508509		<Owned<T>>::remove((collection.id, &token_data.owner, token));510		<TokensBurnt<T>>::insert(collection.id, burnt);511		<TokenData<T>>::remove((collection.id, token));512		<TokenProperties<T>>::remove((collection.id, token));513		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);514		let old_spender = <Allowance<T>>::take((collection.id, token));515516		if let Some(old_spender) = old_spender {517			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(518				collection.id,519				token,520				token_data.owner.clone(),521				old_spender,522				0,523			));524		}525526		<PalletEvm<T>>::deposit_log(527			ERC721Events::Transfer {528				from: *token_data.owner.as_eth(),529				to: H160::default(),530				token_id: token.into(),531			}532			.to_log(collection_id_to_address(collection.id)),533		);534		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(535			collection.id,536			token,537			token_data.owner,538			1,539		));540		Ok(())541	}542543	/// Same as [`burn`] but burns all the tokens that are nested in the token first544	///545	/// - `self_budget`: Limit for searching children in depth.546	/// - `breadth_budget`: Limit of breadth of searching children.547	///548	/// [`burn`]: struct.Pallet.html#method.burn549	#[transactional]550	pub fn burn_recursively(551		collection: &NonfungibleHandle<T>,552		sender: &T::CrossAccountId,553		token: TokenId,554		self_budget: &dyn Budget,555		breadth_budget: &dyn Budget,556	) -> DispatchResultWithPostInfo {557		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);558559		let current_token_account =560			T::CrossTokenAddressMapping::token_to_address(collection.id, token);561562		let mut weight = Weight::zero();563564		// This method is transactional, if user in fact doesn't have permissions to remove token -565		// tokens removed here will be restored after rejected transaction566		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {567			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);568			let PostDispatchInfo { actual_weight, .. } =569				<PalletStructure<T>>::burn_item_recursively(570					current_token_account.clone(),571					collection,572					token,573					self_budget,574					breadth_budget,575				)?;576			if let Some(actual_weight) = actual_weight {577				weight = weight.saturating_add(actual_weight);578			}579		}580581		Self::burn(collection, sender, token)?;582		DispatchResultWithPostInfo::Ok(PostDispatchInfo {583			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),584			pays_fee: Pays::Yes,585		})586	}587588	/// Batch operation to add, edit or remove properties for the token589	///590	/// All affected properties should have mutable permission and sender should have591	/// permission to edit those properties.592	///593	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.594	/// - `is_token_create`: Indicates that method is called during token initialization.595	///   Allows to bypass ownership check.596	#[transactional]597	fn modify_token_properties(598		collection: &NonfungibleHandle<T>,599		sender: &T::CrossAccountId,600		token_id: TokenId,601		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,602		is_token_create: bool,603		nesting_budget: &dyn Budget,604	) -> DispatchResult {605		let mut collection_admin_status = None;606		let mut token_owner_result = None;607608		let mut is_collection_admin =609			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));610611		let mut is_token_owner = || {612			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {613				let is_owned = <PalletStructure<T>>::check_indirectly_owned(614					sender.clone(),615					collection.id,616					token_id,617					None,618					nesting_budget,619				)?;620621				Ok(is_owned)622			})623		};624625		for (key, value) in properties {626			let permission = <PalletCommon<T>>::property_permissions(collection.id)627				.get(&key)628				.cloned()629				.unwrap_or_else(PropertyPermission::none);630631			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))632				.get(&key)633				.is_some();634635			match permission {636				PropertyPermission { mutable: false, .. } if is_property_exists => {637					return Err(<CommonError<T>>::NoPermission.into());638				}639640				PropertyPermission {641					collection_admin,642					token_owner,643					..644				} => {645					//TODO: investigate threats during public minting.646					if is_token_create && (collection_admin || token_owner) && value.is_some() {647						// Pass648					} else if collection_admin && is_collection_admin() {649						// Pass650					} else if token_owner && is_token_owner()? {651						// Pass652					} else {653						fail!(<CommonError<T>>::NoPermission);654					}655				}656			}657658			match value {659				Some(value) => {660					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {661						properties.try_set(key.clone(), value)662					})663					.map_err(<CommonError<T>>::from)?;664665					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(666						collection.id,667						token_id,668						key,669					));670				}671				None => {672					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {673						properties.remove(&key)674					})675					.map_err(<CommonError<T>>::from)?;676677					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(678						collection.id,679						token_id,680						key,681					));682				}683			}684		}685686		Ok(())687	}688689	/// Batch operation to add or edit properties for the token690	///691	/// Same as [`modify_token_properties`] but doesn't allow to remove properties692	///693	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties694	pub fn set_token_properties(695		collection: &NonfungibleHandle<T>,696		sender: &T::CrossAccountId,697		token_id: TokenId,698		properties: impl Iterator<Item = Property>,699		is_token_create: bool,700		nesting_budget: &dyn Budget,701	) -> DispatchResult {702		Self::modify_token_properties(703			collection,704			sender,705			token_id,706			properties.map(|p| (p.key, Some(p.value))),707			is_token_create,708			nesting_budget,709		)710	}711712	/// Add or edit single property for the token713	///714	/// Calls [`set_token_properties`] internally715	///716	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties717	pub fn set_token_property(718		collection: &NonfungibleHandle<T>,719		sender: &T::CrossAccountId,720		token_id: TokenId,721		property: Property,722		nesting_budget: &dyn Budget,723	) -> DispatchResult {724		let is_token_create = false;725726		Self::set_token_properties(727			collection,728			sender,729			token_id,730			[property].into_iter(),731			is_token_create,732			nesting_budget,733		)734	}735736	/// Batch operation to remove properties from the token737	///738	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties739	///740	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties741	pub fn delete_token_properties(742		collection: &NonfungibleHandle<T>,743		sender: &T::CrossAccountId,744		token_id: TokenId,745		property_keys: impl Iterator<Item = PropertyKey>,746		nesting_budget: &dyn Budget,747	) -> DispatchResult {748		let is_token_create = false;749750		Self::modify_token_properties(751			collection,752			sender,753			token_id,754			property_keys.into_iter().map(|key| (key, None)),755			is_token_create,756			nesting_budget,757		)758	}759760	/// Remove single property from the token761	///762	/// Calls [`delete_token_properties`] internally763	///764	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties765	pub fn delete_token_property(766		collection: &NonfungibleHandle<T>,767		sender: &T::CrossAccountId,768		token_id: TokenId,769		property_key: PropertyKey,770		nesting_budget: &dyn Budget,771	) -> DispatchResult {772		Self::delete_token_properties(773			collection,774			sender,775			token_id,776			[property_key].into_iter(),777			nesting_budget,778		)779	}780781	/// Add or edit properties for the collection782	pub fn set_collection_properties(783		collection: &NonfungibleHandle<T>,784		sender: &T::CrossAccountId,785		properties: Vec<Property>,786	) -> DispatchResult {787		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)788	}789790	/// Remove properties from the collection791	pub fn delete_collection_properties(792		collection: &CollectionHandle<T>,793		sender: &T::CrossAccountId,794		property_keys: Vec<PropertyKey>,795	) -> DispatchResult {796		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)797	}798799	/// Set property permissions for the token.800	///801	/// Sender should be the owner or admin of token's collection.802	pub fn set_token_property_permissions(803		collection: &CollectionHandle<T>,804		sender: &T::CrossAccountId,805		property_permissions: Vec<PropertyKeyPermission>,806	) -> DispatchResult {807		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)808	}809810	/// Set property permissions for the token with scope.811	///812	/// Sender should be the owner or admin of token's collection.813	pub fn set_scoped_token_property_permissions(814		collection: &CollectionHandle<T>,815		sender: &T::CrossAccountId,816		scope: PropertyScope,817		property_permissions: Vec<PropertyKeyPermission>,818	) -> DispatchResult {819		<PalletCommon<T>>::set_scoped_token_property_permissions(820			collection,821			sender,822			scope,823			property_permissions,824		)825	}826827	/// Set property permissions for the collection.828	///829	/// Sender should be the owner or admin of the collection.830	pub fn set_property_permission(831		collection: &CollectionHandle<T>,832		sender: &T::CrossAccountId,833		permission: PropertyKeyPermission,834	) -> DispatchResult {835		<PalletCommon<T>>::set_property_permission(collection, sender, permission)836	}837838	/// Transfer NFT token from one account to another.839	///840	/// `from` account stops being the owner and `to` account becomes the owner of the token.841	/// If `to` is token than `to` becomes owner of the token and the token become nested.842	/// Unnests token from previous parent if it was nested before.843	/// Removes allowance for the token if there was any.844	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.845	///846	/// - `nesting_budget`: Limit for token nesting depth847	pub fn transfer(848		collection: &NonfungibleHandle<T>,849		from: &T::CrossAccountId,850		to: &T::CrossAccountId,851		token: TokenId,852		nesting_budget: &dyn Budget,853	) -> DispatchResult {854		ensure!(855			collection.limits.transfers_enabled(),856			<CommonError<T>>::TransferNotAllowed857		);858859		let token_data =860			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;861		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);862863		if collection.permissions.access() == AccessMode::AllowList {864			collection.check_allowlist(from)?;865			collection.check_allowlist(to)?;866		}867		<PalletCommon<T>>::ensure_correct_receiver(to)?;868869		let balance_from = <AccountBalance<T>>::get((collection.id, from))870			.checked_sub(1)871			.ok_or(<CommonError<T>>::TokenValueTooLow)?;872		let balance_to = if from != to {873			let balance_to = <AccountBalance<T>>::get((collection.id, to))874				.checked_add(1)875				.ok_or(ArithmeticError::Overflow)?;876877			ensure!(878				balance_to < collection.limits.account_token_ownership_limit(),879				<CommonError<T>>::AccountTokenLimitExceeded,880			);881882			Some(balance_to)883		} else {884			None885		};886887		<PalletStructure<T>>::nest_if_sent_to_token(888			from.clone(),889			to,890			collection.id,891			token,892			nesting_budget,893		)?;894895		// =========896897		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);898899		<TokenData<T>>::insert(900			(collection.id, token),901			ItemData {902				owner: to.clone(),903				..token_data904			},905		);906907		if let Some(balance_to) = balance_to {908			// from != to909			if balance_from == 0 {910				<AccountBalance<T>>::remove((collection.id, from));911			} else {912				<AccountBalance<T>>::insert((collection.id, from), balance_from);913			}914			<AccountBalance<T>>::insert((collection.id, to), balance_to);915			<Owned<T>>::remove((collection.id, from, token));916			<Owned<T>>::insert((collection.id, to, token), true);917		}918		Self::set_allowance_unchecked(collection, from, token, None, true);919920		<PalletEvm<T>>::deposit_log(921			ERC721Events::Transfer {922				from: *from.as_eth(),923				to: *to.as_eth(),924				token_id: token.into(),925			}926			.to_log(collection_id_to_address(collection.id)),927		);928		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(929			collection.id,930			token,931			from.clone(),932			to.clone(),933			1,934		));935		Ok(())936	}937938	/// Batch operation to mint multiple NFT tokens.939	///940	/// The sender should be the owner/admin of the collection or collection should be configured941	/// to allow public minting.942	/// Throws if amount of tokens reached it's limit for the collection or if caller reached943	/// token ownership limit.944	///945	/// - `data`: Contains list of token properties and users who will become the owners of the946	///   corresponging tokens.947	/// - `nesting_budget`: Limit for token nesting depth948	pub fn create_multiple_items(949		collection: &NonfungibleHandle<T>,950		sender: &T::CrossAccountId,951		data: Vec<CreateItemData<T>>,952		nesting_budget: &dyn Budget,953	) -> DispatchResult {954		if !collection.is_owner_or_admin(sender) {955			ensure!(956				collection.permissions.mint_mode(),957				<CommonError<T>>::PublicMintingNotAllowed958			);959			collection.check_allowlist(sender)?;960961			for item in data.iter() {962				collection.check_allowlist(&item.owner)?;963			}964		}965966		for data in data.iter() {967			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;968		}969970		let first_token = <TokensMinted<T>>::get(collection.id);971		let tokens_minted = first_token972			.checked_add(data.len() as u32)973			.ok_or(ArithmeticError::Overflow)?;974		ensure!(975			tokens_minted <= collection.limits.token_limit(),976			<CommonError<T>>::CollectionTokenLimitExceeded977		);978979		let mut balances = BTreeMap::new();980		for data in &data {981			let balance = balances982				.entry(&data.owner)983				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));984			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;985986			ensure!(987				*balance <= collection.limits.account_token_ownership_limit(),988				<CommonError<T>>::AccountTokenLimitExceeded,989			);990		}991992		for (i, data) in data.iter().enumerate() {993			let token = TokenId(first_token + i as u32 + 1);994995			<PalletStructure<T>>::check_nesting(996				sender.clone(),997				&data.owner,998				collection.id,999				token,1000				nesting_budget,1001			)?;1002		}10031004		// =========10051006		with_transaction(|| {1007			for (i, data) in data.iter().enumerate() {1008				let token = first_token + i as u32 + 1;10091010				<TokenData<T>>::insert(1011					(collection.id, token),1012					ItemData {1013						// const_data: data.const_data.clone(),1014						owner: data.owner.clone(),1015					},1016				);10171018				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1019					&data.owner,1020					collection.id,1021					TokenId(token),1022				);10231024				if let Err(e) = Self::set_token_properties(1025					collection,1026					sender,1027					TokenId(token),1028					data.properties.clone().into_iter(),1029					true,1030					nesting_budget,1031				) {1032					return TransactionOutcome::Rollback(Err(e));1033				}1034			}1035			TransactionOutcome::Commit(Ok(()))1036		})?;10371038		<TokensMinted<T>>::insert(collection.id, tokens_minted);1039		for (account, balance) in balances {1040			<AccountBalance<T>>::insert((collection.id, account), balance);1041		}1042		for (i, data) in data.into_iter().enumerate() {1043			let token = first_token + i as u32 + 1;1044			<Owned<T>>::insert((collection.id, &data.owner, token), true);10451046			<PalletEvm<T>>::deposit_log(1047				ERC721Events::Transfer {1048					from: H160::default(),1049					to: *data.owner.as_eth(),1050					token_id: token.into(),1051				}1052				.to_log(collection_id_to_address(collection.id)),1053			);1054			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1055				collection.id,1056				TokenId(token),1057				data.owner.clone(),1058				1,1059			));1060		}1061		Ok(())1062	}10631064	pub fn set_allowance_unchecked(1065		collection: &NonfungibleHandle<T>,1066		sender: &T::CrossAccountId,1067		token: TokenId,1068		spender: Option<&T::CrossAccountId>,1069		assume_implicit_eth: bool,1070	) {1071		if let Some(spender) = spender {1072			let old_spender = <Allowance<T>>::get((collection.id, token));1073			<Allowance<T>>::insert((collection.id, token), spender);1074			// In ERC721 there is only one possible approved user of token, so we set1075			// approved user to spender1076			<PalletEvm<T>>::deposit_log(1077				ERC721Events::Approval {1078					owner: *sender.as_eth(),1079					approved: *spender.as_eth(),1080					token_id: token.into(),1081				}1082				.to_log(collection_id_to_address(collection.id)),1083			);1084			// In Unique chain, any token can have any amount of approved users, so we need to1085			// set allowance of old owner to 0, and allowance of new owner to 11086			if old_spender.as_ref() != Some(spender) {1087				if let Some(old_owner) = old_spender {1088					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1089						collection.id,1090						token,1091						sender.clone(),1092						old_owner,1093						0,1094					));1095				}1096				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1097					collection.id,1098					token,1099					sender.clone(),1100					spender.clone(),1101					1,1102				));1103			}1104		} else {1105			let old_spender = <Allowance<T>>::take((collection.id, token));1106			if !assume_implicit_eth {1107				// In ERC721 there is only one possible approved user of token, so we set1108				// approved user to zero address1109				<PalletEvm<T>>::deposit_log(1110					ERC721Events::Approval {1111						owner: *sender.as_eth(),1112						approved: H160::default(),1113						token_id: token.into(),1114					}1115					.to_log(collection_id_to_address(collection.id)),1116				);1117			}1118			// In Unique chain, any token can have any amount of approved users, so we need to1119			// set allowance of old owner to 01120			if let Some(old_spender) = old_spender {1121				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1122					collection.id,1123					token,1124					sender.clone(),1125					old_spender,1126					0,1127				));1128			}1129		}1130	}11311132	/// Set allowance for the spender to `transfer` or `burn` sender's token.1133	///1134	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1135	pub fn set_allowance(1136		collection: &NonfungibleHandle<T>,1137		sender: &T::CrossAccountId,1138		token: TokenId,1139		spender: Option<&T::CrossAccountId>,1140	) -> DispatchResult {1141		if collection.permissions.access() == AccessMode::AllowList {1142			collection.check_allowlist(sender)?;1143			if let Some(spender) = spender {1144				collection.check_allowlist(spender)?;1145			}1146		}11471148		if let Some(spender) = spender {1149			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1150		}11511152		let token_data =1153			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1154		if &token_data.owner != sender {1155			ensure!(1156				collection.ignores_owned_amount(sender),1157				<CommonError<T>>::CantApproveMoreThanOwned1158			);1159		}11601161		// =========11621163		Self::set_allowance_unchecked(collection, sender, token, spender, false);1164		Ok(())1165	}11661167	/// Checks allowance for the spender to use the token.1168	fn check_allowed(1169		collection: &NonfungibleHandle<T>,1170		spender: &T::CrossAccountId,1171		from: &T::CrossAccountId,1172		token: TokenId,1173		nesting_budget: &dyn Budget,1174	) -> DispatchResult {1175		if spender.conv_eq(from) {1176			return Ok(());1177		}1178		if collection.permissions.access() == AccessMode::AllowList {1179			// `from`, `to` checked in [`transfer`]1180			collection.check_allowlist(spender)?;1181		}11821183		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1184			return Ok(());1185		}11861187		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1188			ensure!(1189				<PalletStructure<T>>::check_indirectly_owned(1190					spender.clone(),1191					source.0,1192					source.1,1193					None,1194					nesting_budget1195				)?,1196				<CommonError<T>>::ApprovedValueTooLow,1197			);1198			return Ok(());1199		}1200		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1201			return Ok(());1202		}1203		ensure!(1204			collection.ignores_allowance(spender),1205			<CommonError<T>>::ApprovedValueTooLow1206		);1207		Ok(())1208	}12091210	/// Transfer NFT token from one account to another.1211	///1212	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1213	/// The owner should set allowance for the spender to transfer token.1214	///1215	/// [`transfer`]: struct.Pallet.html#method.transfer1216	pub fn transfer_from(1217		collection: &NonfungibleHandle<T>,1218		spender: &T::CrossAccountId,1219		from: &T::CrossAccountId,1220		to: &T::CrossAccountId,1221		token: TokenId,1222		nesting_budget: &dyn Budget,1223	) -> DispatchResult {1224		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12251226		// =========12271228		// Allowance is reset in [`transfer`]1229		Self::transfer(collection, from, to, token, nesting_budget)1230	}12311232	/// Burn NFT token for `from` account.1233	///1234	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1235	/// set allowance for the spender to burn token.1236	///1237	/// [`burn`]: struct.Pallet.html#method.burn1238	pub fn burn_from(1239		collection: &NonfungibleHandle<T>,1240		spender: &T::CrossAccountId,1241		from: &T::CrossAccountId,1242		token: TokenId,1243		nesting_budget: &dyn Budget,1244	) -> DispatchResult {1245		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12461247		// =========12481249		Self::burn(collection, from, token)1250	}12511252	/// Check that `from` token could be nested in `under` token.1253	///1254	pub fn check_nesting(1255		handle: &NonfungibleHandle<T>,1256		sender: T::CrossAccountId,1257		from: (CollectionId, TokenId),1258		under: TokenId,1259		nesting_budget: &dyn Budget,1260	) -> DispatchResult {1261		let nesting = handle.permissions.nesting();12621263		#[cfg(not(feature = "runtime-benchmarks"))]1264		let permissive = false;1265		#[cfg(feature = "runtime-benchmarks")]1266		let permissive = nesting.permissive;12671268		if permissive {1269			// Pass1270		} else if nesting.token_owner1271			&& <PalletStructure<T>>::check_indirectly_owned(1272				sender.clone(),1273				handle.id,1274				under,1275				Some(from),1276				nesting_budget,1277			)? {1278			// Pass1279		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1280			// Pass1281		} else {1282			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1283		}12841285		if let Some(whitelist) = &nesting.restricted {1286			ensure!(1287				whitelist.contains(&from.0),1288				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1289			);1290		}1291		Ok(())1292	}12931294	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1295		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1296	}12971298	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1299		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1300	}13011302	fn collection_has_tokens(collection_id: CollectionId) -> bool {1303		<TokenData<T>>::iter_prefix((collection_id,))1304			.next()1305			.is_some()1306	}13071308	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1309		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1310			.next()1311			.is_some()1312	}13131314	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1315		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1316			.map(|((child_collection_id, child_id), _)| TokenChild {1317				collection: child_collection_id,1318				token: child_id,1319			})1320			.collect()1321	}13221323	/// Mint single NFT token.1324	///1325	/// Delegated to [`create_multiple_items`]1326	///1327	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1328	pub fn create_item(1329		collection: &NonfungibleHandle<T>,1330		sender: &T::CrossAccountId,1331		data: CreateItemData<T>,1332		nesting_budget: &dyn Budget,1333	) -> DispatchResult {1334		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1335	}1336}