git.delta.rocks / unique-network / refs/commits / 4e01cb3cfaf7

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, CustomDataLimit, TokenId, CreateCollectionData, CreateNftExData,104	mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission, PropertyKey,105	PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,106	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, collections::btree_set::BTreeSet};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::account::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			0282		}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}298impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {299	fn recorder(&self) -> &SubstrateRecorder<T> {300		self.0.recorder()301	}302	fn into_recorder(self) -> SubstrateRecorder<T> {303		self.0.into_recorder()304	}305}306impl<T: Config> Deref for NonfungibleHandle<T> {307	type Target = pallet_common::CollectionHandle<T>;308309	fn deref(&self) -> &Self::Target {310		&self.0311	}312}313314impl<T: Config> Pallet<T> {315	/// Get number of NFT tokens in collection.316	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {317		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)318	}319320	/// Check that NFT token exists.321	///322	/// - `token`: Token ID.323	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {324		<TokenData<T>>::contains_key((collection.id, token))325	}326327	/// Set the token property with the scope.328	///329	/// - `property`: Contains key-value pair.330	pub fn set_scoped_token_property(331		collection_id: CollectionId,332		token_id: TokenId,333		scope: PropertyScope,334		property: Property,335	) -> DispatchResult {336		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {337			properties.try_scoped_set(scope, property.key, property.value)338		})339		.map_err(<CommonError<T>>::from)?;340341		Ok(())342	}343344	/// Batch operation to set multiple properties with the same scope.345	pub fn set_scoped_token_properties(346		collection_id: CollectionId,347		token_id: TokenId,348		scope: PropertyScope,349		properties: impl Iterator<Item = Property>,350	) -> DispatchResult {351		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {352			stored_properties.try_scoped_set_from_iter(scope, properties)353		})354		.map_err(<CommonError<T>>::from)?;355356		Ok(())357	}358359	/// Add or edit auxiliary data for the property.360	///361	/// - `f`: function that adds or edits auxiliary data.362	pub fn try_mutate_token_aux_property<R, E>(363		collection_id: CollectionId,364		token_id: TokenId,365		scope: PropertyScope,366		key: PropertyKey,367		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,368	) -> Result<R, E> {369		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)370	}371372	/// Remove auxiliary data for the property.373	pub fn remove_token_aux_property(374		collection_id: CollectionId,375		token_id: TokenId,376		scope: PropertyScope,377		key: PropertyKey,378	) {379		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));380	}381382	/// Get all auxiliary data in a given scope.383	///384	/// Returns iterator over Property Key - Data pairs.385	pub fn iterate_token_aux_properties(386		collection_id: CollectionId,387		token_id: TokenId,388		scope: PropertyScope,389	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {390		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))391	}392393	/// Get ID of the last minted token394	pub fn current_token_id(collection_id: CollectionId) -> TokenId {395		TokenId(<TokensMinted<T>>::get(collection_id))396	}397}398399// unchecked calls skips any permission checks400impl<T: Config> Pallet<T> {401	/// Create NFT collection402	///403	/// `init_collection` will take non-refundable deposit for collection creation.404	///405	/// - `data`: Contains settings for collection limits and permissions.406	pub fn init_collection(407		owner: T::CrossAccountId,408		data: CreateCollectionData<T::AccountId>,409		is_external: bool,410	) -> Result<CollectionId, DispatchError> {411		<PalletCommon<T>>::init_collection(owner, data, is_external)412	}413414	/// Destroy NFT collection415	///416	/// `destroy_collection` will throw error if collection contains any tokens.417	/// Only owner can destroy collection.418	pub fn destroy_collection(419		collection: NonfungibleHandle<T>,420		sender: &T::CrossAccountId,421	) -> DispatchResult {422		let id = collection.id;423424		if Self::collection_has_tokens(id) {425			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());426		}427428		// =========429430		PalletCommon::destroy_collection(collection.0, sender)?;431432		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);433		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);434		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);435		<TokensMinted<T>>::remove(id);436		<TokensBurnt<T>>::remove(id);437		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);438		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);439		Ok(())440	}441442	/// Burn NFT token443	///444	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token445	/// if the token is nested.446	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.447	/// Also removes all corresponding properties and auxiliary properties.448	///449	/// - `token`: Token that should be burned450	/// - `collection`: Collection that contains the token451	pub fn burn(452		collection: &NonfungibleHandle<T>,453		sender: &T::CrossAccountId,454		token: TokenId,455	) -> DispatchResult {456		let token_data =457			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;458		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);459460		if collection.permissions.access() == AccessMode::AllowList {461			collection.check_allowlist(sender)?;462		}463464		if Self::token_has_children(collection.id, token) {465			return Err(<Error<T>>::CantBurnNftWithChildren.into());466		}467468		let burnt = <TokensBurnt<T>>::get(collection.id)469			.checked_add(1)470			.ok_or(ArithmeticError::Overflow)?;471472		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))473			.checked_sub(1)474			.ok_or(ArithmeticError::Overflow)?;475476		// =========477478		if balance == 0 {479			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));480		} else {481			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);482		}483484		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);485486		<Owned<T>>::remove((collection.id, &token_data.owner, token));487		<TokensBurnt<T>>::insert(collection.id, burnt);488		<TokenData<T>>::remove((collection.id, token));489		<TokenProperties<T>>::remove((collection.id, token));490		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);491		let old_spender = <Allowance<T>>::take((collection.id, token));492493		if let Some(old_spender) = old_spender {494			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(495				collection.id,496				token,497				token_data.owner.clone(),498				old_spender,499				0,500			));501		}502503		<PalletEvm<T>>::deposit_log(504			ERC721Events::Transfer {505				from: *token_data.owner.as_eth(),506				to: H160::default(),507				token_id: token.into(),508			}509			.to_log(collection_id_to_address(collection.id)),510		);511		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(512			collection.id,513			token,514			token_data.owner,515			1,516		));517		Ok(())518	}519520	/// Same as [`burn`] but burns all the tokens that are nested in the token first521	///522	/// - `self_budget`: Limit for searching children in depth.523	/// - `breadth_budget`: Limit of breadth of searching children.524	///525	/// [`burn`]: struct.Pallet.html#method.burn526	#[transactional]527	pub fn burn_recursively(528		collection: &NonfungibleHandle<T>,529		sender: &T::CrossAccountId,530		token: TokenId,531		self_budget: &dyn Budget,532		breadth_budget: &dyn Budget,533	) -> DispatchResultWithPostInfo {534		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);535536		let current_token_account =537			T::CrossTokenAddressMapping::token_to_address(collection.id, token);538539		let mut weight = 0 as Weight;540541		// This method is transactional, if user in fact doesn't have permissions to remove token -542		// tokens removed here will be restored after rejected transaction543		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {544			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);545			let PostDispatchInfo { actual_weight, .. } =546				<PalletStructure<T>>::burn_item_recursively(547					current_token_account.clone(),548					collection,549					token,550					self_budget,551					breadth_budget,552				)?;553			if let Some(actual_weight) = actual_weight {554				weight = weight.saturating_add(actual_weight);555			}556		}557558		Self::burn(collection, sender, token)?;559		DispatchResultWithPostInfo::Ok(PostDispatchInfo {560			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),561			pays_fee: Pays::Yes,562		})563	}564565	/// Batch operation to add, edit or remove properties for the token566	///567	/// All affected properties should have mutable permission and sender should have568	/// permission to edit those properties.569	///570	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.571	/// - `is_token_create`: Indicates that method is called during token initialization.572	///   Allows to bypass ownership check.573	#[transactional]574	fn modify_token_properties(575		collection: &NonfungibleHandle<T>,576		sender: &T::CrossAccountId,577		token_id: TokenId,578		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,579		is_token_create: bool,580		nesting_budget: &dyn Budget,581	) -> DispatchResult {582		let mut collection_admin_status = None;583		let mut token_owner_result = None;584585		let mut is_collection_admin =586			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));587588		let mut is_token_owner = || {589			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {590				let is_owned = <PalletStructure<T>>::check_indirectly_owned(591					sender.clone(),592					collection.id,593					token_id,594					None,595					nesting_budget,596				)?;597598				Ok(is_owned)599			})600		};601602		for (key, value) in properties {603			let permission = <PalletCommon<T>>::property_permissions(collection.id)604				.get(&key)605				.cloned()606				.unwrap_or_else(PropertyPermission::none);607608			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))609				.get(&key)610				.is_some();611612			match permission {613				PropertyPermission { mutable: false, .. } if is_property_exists => {614					return Err(<CommonError<T>>::NoPermission.into());615				}616617				PropertyPermission {618					collection_admin,619					token_owner,620					..621				} => {622					//TODO: investigate threats during public minting.623					if is_token_create && (collection_admin || token_owner) && value.is_some() {624						// Pass625					} else if collection_admin && is_collection_admin() {626						// Pass627					} else if token_owner && is_token_owner()? {628						// Pass629					} else {630						fail!(<CommonError<T>>::NoPermission);631					}632				}633			}634635			match value {636				Some(value) => {637					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {638						properties.try_set(key.clone(), value)639					})640					.map_err(<CommonError<T>>::from)?;641642					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(643						collection.id,644						token_id,645						key,646					));647				}648				None => {649					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {650						properties.remove(&key)651					})652					.map_err(<CommonError<T>>::from)?;653654					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(655						collection.id,656						token_id,657						key,658					));659				}660			}661		}662663		Ok(())664	}665666	/// Batch operation to add or edit properties for the token667	///668	/// Same as [`modify_token_properties`] but doesn't allow to remove properties669	///670	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties671	pub fn set_token_properties(672		collection: &NonfungibleHandle<T>,673		sender: &T::CrossAccountId,674		token_id: TokenId,675		properties: impl Iterator<Item = Property>,676		is_token_create: bool,677		nesting_budget: &dyn Budget,678	) -> DispatchResult {679		Self::modify_token_properties(680			collection,681			sender,682			token_id,683			properties.map(|p| (p.key, Some(p.value))),684			is_token_create,685			nesting_budget,686		)687	}688689	/// Add or edit single property for the token690	///691	/// Calls [`set_token_properties`] internally692	///693	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties694	pub fn set_token_property(695		collection: &NonfungibleHandle<T>,696		sender: &T::CrossAccountId,697		token_id: TokenId,698		property: Property,699		nesting_budget: &dyn Budget,700	) -> DispatchResult {701		let is_token_create = false;702703		Self::set_token_properties(704			collection,705			sender,706			token_id,707			[property].into_iter(),708			is_token_create,709			nesting_budget,710		)711	}712713	/// Batch operation to remove properties from the token714	///715	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties716	///717	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties718	pub fn delete_token_properties(719		collection: &NonfungibleHandle<T>,720		sender: &T::CrossAccountId,721		token_id: TokenId,722		property_keys: impl Iterator<Item = PropertyKey>,723		nesting_budget: &dyn Budget,724	) -> DispatchResult {725		let is_token_create = false;726727		Self::modify_token_properties(728			collection,729			sender,730			token_id,731			property_keys.into_iter().map(|key| (key, None)),732			is_token_create,733			nesting_budget,734		)735	}736737	/// Remove single property from the token738	///739	/// Calls [`delete_token_properties`] internally740	///741	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties742	pub fn delete_token_property(743		collection: &NonfungibleHandle<T>,744		sender: &T::CrossAccountId,745		token_id: TokenId,746		property_key: PropertyKey,747		nesting_budget: &dyn Budget,748	) -> DispatchResult {749		Self::delete_token_properties(750			collection,751			sender,752			token_id,753			[property_key].into_iter(),754			nesting_budget,755		)756	}757758	/// Add or edit properties for the collection759	pub fn set_collection_properties(760		collection: &NonfungibleHandle<T>,761		sender: &T::CrossAccountId,762		properties: Vec<Property>,763	) -> DispatchResult {764		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)765	}766767	/// Remove properties from the collection768	pub fn delete_collection_properties(769		collection: &CollectionHandle<T>,770		sender: &T::CrossAccountId,771		property_keys: Vec<PropertyKey>,772	) -> DispatchResult {773		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)774	}775776	/// Set property permissions for the token.777	///778	/// Sender should be the owner or admin of token's collection.779	pub fn set_token_property_permissions(780		collection: &CollectionHandle<T>,781		sender: &T::CrossAccountId,782		property_permissions: Vec<PropertyKeyPermission>,783	) -> DispatchResult {784		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)785	}786787	/// Set property permissions for the token with scope.788	///789	/// Sender should be the owner or admin of token's collection.790	pub fn set_scoped_token_property_permissions(791		collection: &CollectionHandle<T>,792		sender: &T::CrossAccountId,793		scope: PropertyScope,794		property_permissions: Vec<PropertyKeyPermission>,795	) -> DispatchResult {796		<PalletCommon<T>>::set_scoped_token_property_permissions(797			collection,798			sender,799			scope,800			property_permissions,801		)802	}803804	/// Set property permissions for the collection.805	///806	/// Sender should be the owner or admin of the collection.807	pub fn set_property_permission(808		collection: &CollectionHandle<T>,809		sender: &T::CrossAccountId,810		permission: PropertyKeyPermission,811	) -> DispatchResult {812		<PalletCommon<T>>::set_property_permission(collection, sender, permission)813	}814815	/// Transfer NFT token from one account to another.816	///817	/// `from` account stops being the owner and `to` account becomes the owner of the token.818	/// If `to` is token than `to` becomes owner of the token and the token become nested.819	/// Unnests token from previous parent if it was nested before.820	/// Removes allowance for the token if there was any.821	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.822	///823	/// - `nesting_budget`: Limit for token nesting depth824	pub fn transfer(825		collection: &NonfungibleHandle<T>,826		from: &T::CrossAccountId,827		to: &T::CrossAccountId,828		token: TokenId,829		nesting_budget: &dyn Budget,830	) -> DispatchResult {831		ensure!(832			collection.limits.transfers_enabled(),833			<CommonError<T>>::TransferNotAllowed834		);835836		let token_data =837			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;838		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);839840		if collection.permissions.access() == AccessMode::AllowList {841			collection.check_allowlist(from)?;842			collection.check_allowlist(to)?;843		}844		<PalletCommon<T>>::ensure_correct_receiver(to)?;845846		let balance_from = <AccountBalance<T>>::get((collection.id, from))847			.checked_sub(1)848			.ok_or(<CommonError<T>>::TokenValueTooLow)?;849		let balance_to = if from != to {850			let balance_to = <AccountBalance<T>>::get((collection.id, to))851				.checked_add(1)852				.ok_or(ArithmeticError::Overflow)?;853854			ensure!(855				balance_to < collection.limits.account_token_ownership_limit(),856				<CommonError<T>>::AccountTokenLimitExceeded,857			);858859			Some(balance_to)860		} else {861			None862		};863864		<PalletStructure<T>>::nest_if_sent_to_token(865			from.clone(),866			to,867			collection.id,868			token,869			nesting_budget,870		)?;871872		// =========873874		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);875876		<TokenData<T>>::insert(877			(collection.id, token),878			ItemData {879				owner: to.clone(),880				..token_data881			},882		);883884		if let Some(balance_to) = balance_to {885			// from != to886			if balance_from == 0 {887				<AccountBalance<T>>::remove((collection.id, from));888			} else {889				<AccountBalance<T>>::insert((collection.id, from), balance_from);890			}891			<AccountBalance<T>>::insert((collection.id, to), balance_to);892			<Owned<T>>::remove((collection.id, from, token));893			<Owned<T>>::insert((collection.id, to, token), true);894		}895		Self::set_allowance_unchecked(collection, from, token, None, true);896897		<PalletEvm<T>>::deposit_log(898			ERC721Events::Transfer {899				from: *from.as_eth(),900				to: *to.as_eth(),901				token_id: token.into(),902			}903			.to_log(collection_id_to_address(collection.id)),904		);905		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(906			collection.id,907			token,908			from.clone(),909			to.clone(),910			1,911		));912		Ok(())913	}914915	/// Batch operation to mint multiple NFT tokens.916	///917	/// The sender should be the owner/admin of the collection or collection should be configured918	/// to allow public minting.919	/// Throws if amount of tokens reached it's limit for the collection or if caller reached920	/// token ownership limit.921	///922	/// - `data`: Contains list of token properties and users who will become the owners of the923	///   corresponging tokens.924	/// - `nesting_budget`: Limit for token nesting depth925	pub fn create_multiple_items(926		collection: &NonfungibleHandle<T>,927		sender: &T::CrossAccountId,928		data: Vec<CreateItemData<T>>,929		nesting_budget: &dyn Budget,930	) -> DispatchResult {931		if !collection.is_owner_or_admin(sender) {932			ensure!(933				collection.permissions.mint_mode(),934				<CommonError<T>>::PublicMintingNotAllowed935			);936			collection.check_allowlist(sender)?;937938			for item in data.iter() {939				collection.check_allowlist(&item.owner)?;940			}941		}942943		for data in data.iter() {944			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;945		}946947		let first_token = <TokensMinted<T>>::get(collection.id);948		let tokens_minted = first_token949			.checked_add(data.len() as u32)950			.ok_or(ArithmeticError::Overflow)?;951		ensure!(952			tokens_minted <= collection.limits.token_limit(),953			<CommonError<T>>::CollectionTokenLimitExceeded954		);955956		let mut balances = BTreeMap::new();957		for data in &data {958			let balance = balances959				.entry(&data.owner)960				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));961			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;962963			ensure!(964				*balance <= collection.limits.account_token_ownership_limit(),965				<CommonError<T>>::AccountTokenLimitExceeded,966			);967		}968969		for (i, data) in data.iter().enumerate() {970			let token = TokenId(first_token + i as u32 + 1);971972			<PalletStructure<T>>::check_nesting(973				sender.clone(),974				&data.owner,975				collection.id,976				token,977				nesting_budget,978			)?;979		}980981		// =========982983		with_transaction(|| {984			for (i, data) in data.iter().enumerate() {985				let token = first_token + i as u32 + 1;986987				<TokenData<T>>::insert(988					(collection.id, token),989					ItemData {990						// const_data: data.const_data.clone(),991						owner: data.owner.clone(),992					},993				);994995				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(996					&data.owner,997					collection.id,998					TokenId(token),999				);10001001				if let Err(e) = Self::set_token_properties(1002					collection,1003					sender,1004					TokenId(token),1005					data.properties.clone().into_iter(),1006					true,1007					nesting_budget,1008				) {1009					return TransactionOutcome::Rollback(Err(e));1010				}1011			}1012			TransactionOutcome::Commit(Ok(()))1013		})?;10141015		<TokensMinted<T>>::insert(collection.id, tokens_minted);1016		for (account, balance) in balances {1017			<AccountBalance<T>>::insert((collection.id, account), balance);1018		}1019		for (i, data) in data.into_iter().enumerate() {1020			let token = first_token + i as u32 + 1;1021			<Owned<T>>::insert((collection.id, &data.owner, token), true);10221023			<PalletEvm<T>>::deposit_log(1024				ERC721Events::Transfer {1025					from: H160::default(),1026					to: *data.owner.as_eth(),1027					token_id: token.into(),1028				}1029				.to_log(collection_id_to_address(collection.id)),1030			);1031			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1032				collection.id,1033				TokenId(token),1034				data.owner.clone(),1035				1,1036			));1037		}1038		Ok(())1039	}10401041	pub fn set_allowance_unchecked(1042		collection: &NonfungibleHandle<T>,1043		sender: &T::CrossAccountId,1044		token: TokenId,1045		spender: Option<&T::CrossAccountId>,1046		assume_implicit_eth: bool,1047	) {1048		if let Some(spender) = spender {1049			let old_spender = <Allowance<T>>::get((collection.id, token));1050			<Allowance<T>>::insert((collection.id, token), spender);1051			// In ERC721 there is only one possible approved user of token, so we set1052			// approved user to spender1053			<PalletEvm<T>>::deposit_log(1054				ERC721Events::Approval {1055					owner: *sender.as_eth(),1056					approved: *spender.as_eth(),1057					token_id: token.into(),1058				}1059				.to_log(collection_id_to_address(collection.id)),1060			);1061			// In Unique chain, any token can have any amount of approved users, so we need to1062			// set allowance of old owner to 0, and allowance of new owner to 11063			if old_spender.as_ref() != Some(spender) {1064				if let Some(old_owner) = old_spender {1065					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1066						collection.id,1067						token,1068						sender.clone(),1069						old_owner,1070						0,1071					));1072				}1073				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1074					collection.id,1075					token,1076					sender.clone(),1077					spender.clone(),1078					1,1079				));1080			}1081		} else {1082			let old_spender = <Allowance<T>>::take((collection.id, token));1083			if !assume_implicit_eth {1084				// In ERC721 there is only one possible approved user of token, so we set1085				// approved user to zero address1086				<PalletEvm<T>>::deposit_log(1087					ERC721Events::Approval {1088						owner: *sender.as_eth(),1089						approved: H160::default(),1090						token_id: token.into(),1091					}1092					.to_log(collection_id_to_address(collection.id)),1093				);1094			}1095			// In Unique chain, any token can have any amount of approved users, so we need to1096			// set allowance of old owner to 01097			if let Some(old_spender) = old_spender {1098				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1099					collection.id,1100					token,1101					sender.clone(),1102					old_spender,1103					0,1104				));1105			}1106		}1107	}11081109	/// Set allowance for the spender to `transfer` or `burn` sender's token.1110	///1111	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1112	pub fn set_allowance(1113		collection: &NonfungibleHandle<T>,1114		sender: &T::CrossAccountId,1115		token: TokenId,1116		spender: Option<&T::CrossAccountId>,1117	) -> DispatchResult {1118		if collection.permissions.access() == AccessMode::AllowList {1119			collection.check_allowlist(sender)?;1120			if let Some(spender) = spender {1121				collection.check_allowlist(spender)?;1122			}1123		}11241125		if let Some(spender) = spender {1126			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1127		}11281129		let token_data =1130			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1131		if &token_data.owner != sender {1132			ensure!(1133				collection.ignores_owned_amount(sender),1134				<CommonError<T>>::CantApproveMoreThanOwned1135			);1136		}11371138		// =========11391140		Self::set_allowance_unchecked(collection, sender, token, spender, false);1141		Ok(())1142	}11431144	/// Checks allowance for the spender to use the token.1145	fn check_allowed(1146		collection: &NonfungibleHandle<T>,1147		spender: &T::CrossAccountId,1148		from: &T::CrossAccountId,1149		token: TokenId,1150		nesting_budget: &dyn Budget,1151	) -> DispatchResult {1152		if spender.conv_eq(from) {1153			return Ok(());1154		}1155		if collection.permissions.access() == AccessMode::AllowList {1156			// `from`, `to` checked in [`transfer`]1157			collection.check_allowlist(spender)?;1158		}11591160		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1161			return Ok(());1162		}11631164		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1165			ensure!(1166				<PalletStructure<T>>::check_indirectly_owned(1167					spender.clone(),1168					source.0,1169					source.1,1170					None,1171					nesting_budget1172				)?,1173				<CommonError<T>>::ApprovedValueTooLow,1174			);1175			return Ok(());1176		}1177		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1178			return Ok(());1179		}1180		ensure!(1181			collection.ignores_allowance(spender),1182			<CommonError<T>>::ApprovedValueTooLow1183		);1184		Ok(())1185	}11861187	/// Transfer NFT token from one account to another.1188	///1189	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1190	/// The owner should set allowance for the spender to transfer token.1191	///1192	/// [`transfer`]: struct.Pallet.html#method.transfer1193	pub fn transfer_from(1194		collection: &NonfungibleHandle<T>,1195		spender: &T::CrossAccountId,1196		from: &T::CrossAccountId,1197		to: &T::CrossAccountId,1198		token: TokenId,1199		nesting_budget: &dyn Budget,1200	) -> DispatchResult {1201		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12021203		// =========12041205		// Allowance is reset in [`transfer`]1206		Self::transfer(collection, from, to, token, nesting_budget)1207	}12081209	/// Burn NFT token for `from` account.1210	///1211	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1212	/// set allowance for the spender to burn token.1213	///1214	/// [`burn`]: struct.Pallet.html#method.burn1215	pub fn burn_from(1216		collection: &NonfungibleHandle<T>,1217		spender: &T::CrossAccountId,1218		from: &T::CrossAccountId,1219		token: TokenId,1220		nesting_budget: &dyn Budget,1221	) -> DispatchResult {1222		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12231224		// =========12251226		Self::burn(collection, from, token)1227	}12281229	/// Check that `from` token could be nested in `under` token.1230	///1231	pub fn check_nesting(1232		handle: &NonfungibleHandle<T>,1233		sender: T::CrossAccountId,1234		from: (CollectionId, TokenId),1235		under: TokenId,1236		nesting_budget: &dyn Budget,1237	) -> DispatchResult {1238		let nesting = handle.permissions.nesting();12391240		#[cfg(not(feature = "runtime-benchmarks"))]1241		let permissive = false;1242		#[cfg(feature = "runtime-benchmarks")]1243		let permissive = nesting.permissive;12441245		if permissive {1246			// Pass1247		} else if nesting.token_owner1248			&& <PalletStructure<T>>::check_indirectly_owned(1249				sender.clone(),1250				handle.id,1251				under,1252				Some(from),1253				nesting_budget,1254			)? {1255			// Pass1256		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1257			// Pass1258		} else {1259			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1260		}12611262		if let Some(whitelist) = &nesting.restricted {1263			ensure!(1264				whitelist.contains(&from.0),1265				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1266			);1267		}1268		Ok(())1269	}12701271	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1272		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1273	}12741275	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1276		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1277	}12781279	fn collection_has_tokens(collection_id: CollectionId) -> bool {1280		<TokenData<T>>::iter_prefix((collection_id,))1281			.next()1282			.is_some()1283	}12841285	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1286		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1287			.next()1288			.is_some()1289	}12901291	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1292		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1293			.map(|((child_collection_id, child_id), _)| TokenChild {1294				collection: child_collection_id,1295				token: child_id,1296			})1297			.collect()1298	}12991300	/// Mint single NFT token.1301	///1302	/// Delegated to [`create_multiple_items`]1303	///1304	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1305	pub fn create_item(1306		collection: &NonfungibleHandle<T>,1307		sender: &T::CrossAccountId,1308		data: CreateItemData<T>,1309		nesting_budget: &dyn Budget,1310	) -> DispatchResult {1311		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1312	}1313}