git.delta.rocks / unique-network / refs/commits / 3e10430eed1f

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> WithRecorder<T> for NonfungibleHandle<T> {301	fn recorder(&self) -> &SubstrateRecorder<T> {302		self.0.recorder()303	}304	fn into_recorder(self) -> SubstrateRecorder<T> {305		self.0.into_recorder()306	}307}308impl<T: Config> Deref for NonfungibleHandle<T> {309	type Target = pallet_common::CollectionHandle<T>;310311	fn deref(&self) -> &Self::Target {312		&self.0313	}314}315316impl<T: Config> Pallet<T> {317	/// Get number of NFT tokens in collection.318	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {319		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)320	}321322	/// Check that NFT token exists.323	///324	/// - `token`: Token ID.325	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {326		<TokenData<T>>::contains_key((collection.id, token))327	}328329	/// Set the token property with the scope.330	///331	/// - `property`: Contains key-value pair.332	pub fn set_scoped_token_property(333		collection_id: CollectionId,334		token_id: TokenId,335		scope: PropertyScope,336		property: Property,337	) -> DispatchResult {338		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {339			properties.try_scoped_set(scope, property.key, property.value)340		})341		.map_err(<CommonError<T>>::from)?;342343		Ok(())344	}345346	/// Batch operation to set multiple properties with the same scope.347	pub fn set_scoped_token_properties(348		collection_id: CollectionId,349		token_id: TokenId,350		scope: PropertyScope,351		properties: impl Iterator<Item = Property>,352	) -> DispatchResult {353		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {354			stored_properties.try_scoped_set_from_iter(scope, properties)355		})356		.map_err(<CommonError<T>>::from)?;357358		Ok(())359	}360361	/// Add or edit auxiliary data for the property.362	///363	/// - `f`: function that adds or edits auxiliary data.364	pub fn try_mutate_token_aux_property<R, E>(365		collection_id: CollectionId,366		token_id: TokenId,367		scope: PropertyScope,368		key: PropertyKey,369		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,370	) -> Result<R, E> {371		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)372	}373374	/// Remove auxiliary data for the property.375	pub fn remove_token_aux_property(376		collection_id: CollectionId,377		token_id: TokenId,378		scope: PropertyScope,379		key: PropertyKey,380	) {381		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));382	}383384	/// Get all auxiliary data in a given scope.385	///386	/// Returns iterator over Property Key - Data pairs.387	pub fn iterate_token_aux_properties(388		collection_id: CollectionId,389		token_id: TokenId,390		scope: PropertyScope,391	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {392		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))393	}394395	/// Get ID of the last minted token396	pub fn current_token_id(collection_id: CollectionId) -> TokenId {397		TokenId(<TokensMinted<T>>::get(collection_id))398	}399}400401// unchecked calls skips any permission checks402impl<T: Config> Pallet<T> {403	/// Create NFT collection404	///405	/// `init_collection` will take non-refundable deposit for collection creation.406	///407	/// - `data`: Contains settings for collection limits and permissions.408	pub fn init_collection(409		owner: T::CrossAccountId,410		payer: T::CrossAccountId,411		data: CreateCollectionData<T::AccountId>,412		is_external: bool,413	) -> Result<CollectionId, DispatchError> {414		<PalletCommon<T>>::init_collection(415			owner,416			payer,417			data,418			CollectionFlags {419				external: is_external,420				..Default::default()421			},422		)423	}424425	/// Destroy NFT collection426	///427	/// `destroy_collection` will throw error if collection contains any tokens.428	/// Only owner can destroy collection.429	pub fn destroy_collection(430		collection: NonfungibleHandle<T>,431		sender: &T::CrossAccountId,432	) -> DispatchResult {433		let id = collection.id;434435		if Self::collection_has_tokens(id) {436			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());437		}438439		// =========440441		PalletCommon::destroy_collection(collection.0, sender)?;442443		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);444		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);445		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);446		<TokensMinted<T>>::remove(id);447		<TokensBurnt<T>>::remove(id);448		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);449		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);450		Ok(())451	}452453	/// Burn NFT token454	///455	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token456	/// if the token is nested.457	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.458	/// Also removes all corresponding properties and auxiliary properties.459	///460	/// - `token`: Token that should be burned461	/// - `collection`: Collection that contains the token462	pub fn burn(463		collection: &NonfungibleHandle<T>,464		sender: &T::CrossAccountId,465		token: TokenId,466	) -> DispatchResult {467		let token_data =468			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;469		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);470471		if collection.permissions.access() == AccessMode::AllowList {472			collection.check_allowlist(sender)?;473		}474475		if Self::token_has_children(collection.id, token) {476			return Err(<Error<T>>::CantBurnNftWithChildren.into());477		}478479		let burnt = <TokensBurnt<T>>::get(collection.id)480			.checked_add(1)481			.ok_or(ArithmeticError::Overflow)?;482483		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))484			.checked_sub(1)485			.ok_or(ArithmeticError::Overflow)?;486487		// =========488489		if balance == 0 {490			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));491		} else {492			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);493		}494495		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);496497		<Owned<T>>::remove((collection.id, &token_data.owner, token));498		<TokensBurnt<T>>::insert(collection.id, burnt);499		<TokenData<T>>::remove((collection.id, token));500		<TokenProperties<T>>::remove((collection.id, token));501		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);502		let old_spender = <Allowance<T>>::take((collection.id, token));503504		if let Some(old_spender) = old_spender {505			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(506				collection.id,507				token,508				token_data.owner.clone(),509				old_spender,510				0,511			));512		}513514		<PalletEvm<T>>::deposit_log(515			ERC721Events::Transfer {516				from: *token_data.owner.as_eth(),517				to: H160::default(),518				token_id: token.into(),519			}520			.to_log(collection_id_to_address(collection.id)),521		);522		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(523			collection.id,524			token,525			token_data.owner,526			1,527		));528		Ok(())529	}530531	/// Same as [`burn`] but burns all the tokens that are nested in the token first532	///533	/// - `self_budget`: Limit for searching children in depth.534	/// - `breadth_budget`: Limit of breadth of searching children.535	///536	/// [`burn`]: struct.Pallet.html#method.burn537	#[transactional]538	pub fn burn_recursively(539		collection: &NonfungibleHandle<T>,540		sender: &T::CrossAccountId,541		token: TokenId,542		self_budget: &dyn Budget,543		breadth_budget: &dyn Budget,544	) -> DispatchResultWithPostInfo {545		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);546547		let current_token_account =548			T::CrossTokenAddressMapping::token_to_address(collection.id, token);549550		let mut weight = Weight::zero();551552		// This method is transactional, if user in fact doesn't have permissions to remove token -553		// tokens removed here will be restored after rejected transaction554		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {555			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);556			let PostDispatchInfo { actual_weight, .. } =557				<PalletStructure<T>>::burn_item_recursively(558					current_token_account.clone(),559					collection,560					token,561					self_budget,562					breadth_budget,563				)?;564			if let Some(actual_weight) = actual_weight {565				weight = weight.saturating_add(actual_weight);566			}567		}568569		Self::burn(collection, sender, token)?;570		DispatchResultWithPostInfo::Ok(PostDispatchInfo {571			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),572			pays_fee: Pays::Yes,573		})574	}575576	/// Batch operation to add, edit or remove properties for the token577	///578	/// All affected properties should have mutable permission and sender should have579	/// permission to edit those properties.580	///581	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.582	/// - `is_token_create`: Indicates that method is called during token initialization.583	///   Allows to bypass ownership check.584	#[transactional]585	fn modify_token_properties(586		collection: &NonfungibleHandle<T>,587		sender: &T::CrossAccountId,588		token_id: TokenId,589		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,590		is_token_create: bool,591		nesting_budget: &dyn Budget,592	) -> DispatchResult {593		let mut collection_admin_status = None;594		let mut token_owner_result = None;595596		let mut is_collection_admin =597			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));598599		let mut is_token_owner = || {600			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {601				let is_owned = <PalletStructure<T>>::check_indirectly_owned(602					sender.clone(),603					collection.id,604					token_id,605					None,606					nesting_budget,607				)?;608609				Ok(is_owned)610			})611		};612613		for (key, value) in properties {614			let permission = <PalletCommon<T>>::property_permissions(collection.id)615				.get(&key)616				.cloned()617				.unwrap_or_else(PropertyPermission::none);618619			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))620				.get(&key)621				.is_some();622623			match permission {624				PropertyPermission { mutable: false, .. } if is_property_exists => {625					return Err(<CommonError<T>>::NoPermission.into());626				}627628				PropertyPermission {629					collection_admin,630					token_owner,631					..632				} => {633					//TODO: investigate threats during public minting.634					if is_token_create && (collection_admin || token_owner) && value.is_some() {635						// Pass636					} else if collection_admin && is_collection_admin() {637						// Pass638					} else if token_owner && is_token_owner()? {639						// Pass640					} else {641						fail!(<CommonError<T>>::NoPermission);642					}643				}644			}645646			match value {647				Some(value) => {648					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {649						properties.try_set(key.clone(), value)650					})651					.map_err(<CommonError<T>>::from)?;652653					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(654						collection.id,655						token_id,656						key,657					));658				}659				None => {660					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {661						properties.remove(&key)662					})663					.map_err(<CommonError<T>>::from)?;664665					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(666						collection.id,667						token_id,668						key,669					));670				}671			}672		}673674		Ok(())675	}676677	/// Batch operation to add or edit properties for the token678	///679	/// Same as [`modify_token_properties`] but doesn't allow to remove properties680	///681	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties682	pub fn set_token_properties(683		collection: &NonfungibleHandle<T>,684		sender: &T::CrossAccountId,685		token_id: TokenId,686		properties: impl Iterator<Item = Property>,687		is_token_create: bool,688		nesting_budget: &dyn Budget,689	) -> DispatchResult {690		Self::modify_token_properties(691			collection,692			sender,693			token_id,694			properties.map(|p| (p.key, Some(p.value))),695			is_token_create,696			nesting_budget,697		)698	}699700	/// Add or edit single property for the token701	///702	/// Calls [`set_token_properties`] internally703	///704	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties705	pub fn set_token_property(706		collection: &NonfungibleHandle<T>,707		sender: &T::CrossAccountId,708		token_id: TokenId,709		property: Property,710		nesting_budget: &dyn Budget,711	) -> DispatchResult {712		let is_token_create = false;713714		Self::set_token_properties(715			collection,716			sender,717			token_id,718			[property].into_iter(),719			is_token_create,720			nesting_budget,721		)722	}723724	/// Batch operation to remove properties from the token725	///726	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties727	///728	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties729	pub fn delete_token_properties(730		collection: &NonfungibleHandle<T>,731		sender: &T::CrossAccountId,732		token_id: TokenId,733		property_keys: impl Iterator<Item = PropertyKey>,734		nesting_budget: &dyn Budget,735	) -> DispatchResult {736		let is_token_create = false;737738		Self::modify_token_properties(739			collection,740			sender,741			token_id,742			property_keys.into_iter().map(|key| (key, None)),743			is_token_create,744			nesting_budget,745		)746	}747748	/// Remove single property from the token749	///750	/// Calls [`delete_token_properties`] internally751	///752	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties753	pub fn delete_token_property(754		collection: &NonfungibleHandle<T>,755		sender: &T::CrossAccountId,756		token_id: TokenId,757		property_key: PropertyKey,758		nesting_budget: &dyn Budget,759	) -> DispatchResult {760		Self::delete_token_properties(761			collection,762			sender,763			token_id,764			[property_key].into_iter(),765			nesting_budget,766		)767	}768769	/// Add or edit properties for the collection770	pub fn set_collection_properties(771		collection: &NonfungibleHandle<T>,772		sender: &T::CrossAccountId,773		properties: Vec<Property>,774	) -> DispatchResult {775		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)776	}777778	/// Remove properties from the collection779	pub fn delete_collection_properties(780		collection: &CollectionHandle<T>,781		sender: &T::CrossAccountId,782		property_keys: Vec<PropertyKey>,783	) -> DispatchResult {784		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)785	}786787	/// Set property permissions for the token.788	///789	/// Sender should be the owner or admin of token's collection.790	pub fn set_token_property_permissions(791		collection: &CollectionHandle<T>,792		sender: &T::CrossAccountId,793		property_permissions: Vec<PropertyKeyPermission>,794	) -> DispatchResult {795		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)796	}797798	/// Set property permissions for the token with scope.799	///800	/// Sender should be the owner or admin of token's collection.801	pub fn set_scoped_token_property_permissions(802		collection: &CollectionHandle<T>,803		sender: &T::CrossAccountId,804		scope: PropertyScope,805		property_permissions: Vec<PropertyKeyPermission>,806	) -> DispatchResult {807		<PalletCommon<T>>::set_scoped_token_property_permissions(808			collection,809			sender,810			scope,811			property_permissions,812		)813	}814815	/// Set property permissions for the collection.816	///817	/// Sender should be the owner or admin of the collection.818	pub fn set_property_permission(819		collection: &CollectionHandle<T>,820		sender: &T::CrossAccountId,821		permission: PropertyKeyPermission,822	) -> DispatchResult {823		<PalletCommon<T>>::set_property_permission(collection, sender, permission)824	}825826	/// Transfer NFT token from one account to another.827	///828	/// `from` account stops being the owner and `to` account becomes the owner of the token.829	/// If `to` is token than `to` becomes owner of the token and the token become nested.830	/// Unnests token from previous parent if it was nested before.831	/// Removes allowance for the token if there was any.832	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.833	///834	/// - `nesting_budget`: Limit for token nesting depth835	pub fn transfer(836		collection: &NonfungibleHandle<T>,837		from: &T::CrossAccountId,838		to: &T::CrossAccountId,839		token: TokenId,840		nesting_budget: &dyn Budget,841	) -> DispatchResult {842		ensure!(843			collection.limits.transfers_enabled(),844			<CommonError<T>>::TransferNotAllowed845		);846847		let token_data =848			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;849		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);850851		if collection.permissions.access() == AccessMode::AllowList {852			collection.check_allowlist(from)?;853			collection.check_allowlist(to)?;854		}855		<PalletCommon<T>>::ensure_correct_receiver(to)?;856857		let balance_from = <AccountBalance<T>>::get((collection.id, from))858			.checked_sub(1)859			.ok_or(<CommonError<T>>::TokenValueTooLow)?;860		let balance_to = if from != to {861			let balance_to = <AccountBalance<T>>::get((collection.id, to))862				.checked_add(1)863				.ok_or(ArithmeticError::Overflow)?;864865			ensure!(866				balance_to < collection.limits.account_token_ownership_limit(),867				<CommonError<T>>::AccountTokenLimitExceeded,868			);869870			Some(balance_to)871		} else {872			None873		};874875		<PalletStructure<T>>::nest_if_sent_to_token(876			from.clone(),877			to,878			collection.id,879			token,880			nesting_budget,881		)?;882883		// =========884885		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);886887		<TokenData<T>>::insert(888			(collection.id, token),889			ItemData {890				owner: to.clone(),891				..token_data892			},893		);894895		if let Some(balance_to) = balance_to {896			// from != to897			if balance_from == 0 {898				<AccountBalance<T>>::remove((collection.id, from));899			} else {900				<AccountBalance<T>>::insert((collection.id, from), balance_from);901			}902			<AccountBalance<T>>::insert((collection.id, to), balance_to);903			<Owned<T>>::remove((collection.id, from, token));904			<Owned<T>>::insert((collection.id, to, token), true);905		}906		Self::set_allowance_unchecked(collection, from, token, None, true);907908		<PalletEvm<T>>::deposit_log(909			ERC721Events::Transfer {910				from: *from.as_eth(),911				to: *to.as_eth(),912				token_id: token.into(),913			}914			.to_log(collection_id_to_address(collection.id)),915		);916		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(917			collection.id,918			token,919			from.clone(),920			to.clone(),921			1,922		));923		Ok(())924	}925926	/// Batch operation to mint multiple NFT tokens.927	///928	/// The sender should be the owner/admin of the collection or collection should be configured929	/// to allow public minting.930	/// Throws if amount of tokens reached it's limit for the collection or if caller reached931	/// token ownership limit.932	///933	/// - `data`: Contains list of token properties and users who will become the owners of the934	///   corresponging tokens.935	/// - `nesting_budget`: Limit for token nesting depth936	pub fn create_multiple_items(937		collection: &NonfungibleHandle<T>,938		sender: &T::CrossAccountId,939		data: Vec<CreateItemData<T>>,940		nesting_budget: &dyn Budget,941	) -> DispatchResult {942		if !collection.is_owner_or_admin(sender) {943			ensure!(944				collection.permissions.mint_mode(),945				<CommonError<T>>::PublicMintingNotAllowed946			);947			collection.check_allowlist(sender)?;948949			for item in data.iter() {950				collection.check_allowlist(&item.owner)?;951			}952		}953954		for data in data.iter() {955			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;956		}957958		let first_token = <TokensMinted<T>>::get(collection.id);959		let tokens_minted = first_token960			.checked_add(data.len() as u32)961			.ok_or(ArithmeticError::Overflow)?;962		ensure!(963			tokens_minted <= collection.limits.token_limit(),964			<CommonError<T>>::CollectionTokenLimitExceeded965		);966967		let mut balances = BTreeMap::new();968		for data in &data {969			let balance = balances970				.entry(&data.owner)971				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));972			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;973974			ensure!(975				*balance <= collection.limits.account_token_ownership_limit(),976				<CommonError<T>>::AccountTokenLimitExceeded,977			);978		}979980		for (i, data) in data.iter().enumerate() {981			let token = TokenId(first_token + i as u32 + 1);982983			<PalletStructure<T>>::check_nesting(984				sender.clone(),985				&data.owner,986				collection.id,987				token,988				nesting_budget,989			)?;990		}991992		// =========993994		with_transaction(|| {995			for (i, data) in data.iter().enumerate() {996				let token = first_token + i as u32 + 1;997998				<TokenData<T>>::insert(999					(collection.id, token),1000					ItemData {1001						// const_data: data.const_data.clone(),1002						owner: data.owner.clone(),1003					},1004				);10051006				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1007					&data.owner,1008					collection.id,1009					TokenId(token),1010				);10111012				if let Err(e) = Self::set_token_properties(1013					collection,1014					sender,1015					TokenId(token),1016					data.properties.clone().into_iter(),1017					true,1018					nesting_budget,1019				) {1020					return TransactionOutcome::Rollback(Err(e));1021				}1022			}1023			TransactionOutcome::Commit(Ok(()))1024		})?;10251026		<TokensMinted<T>>::insert(collection.id, tokens_minted);1027		for (account, balance) in balances {1028			<AccountBalance<T>>::insert((collection.id, account), balance);1029		}1030		for (i, data) in data.into_iter().enumerate() {1031			let token = first_token + i as u32 + 1;1032			<Owned<T>>::insert((collection.id, &data.owner, token), true);10331034			<PalletEvm<T>>::deposit_log(1035				ERC721Events::Transfer {1036					from: H160::default(),1037					to: *data.owner.as_eth(),1038					token_id: token.into(),1039				}1040				.to_log(collection_id_to_address(collection.id)),1041			);1042			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1043				collection.id,1044				TokenId(token),1045				data.owner.clone(),1046				1,1047			));1048		}1049		Ok(())1050	}10511052	pub fn set_allowance_unchecked(1053		collection: &NonfungibleHandle<T>,1054		sender: &T::CrossAccountId,1055		token: TokenId,1056		spender: Option<&T::CrossAccountId>,1057		assume_implicit_eth: bool,1058	) {1059		if let Some(spender) = spender {1060			let old_spender = <Allowance<T>>::get((collection.id, token));1061			<Allowance<T>>::insert((collection.id, token), spender);1062			// In ERC721 there is only one possible approved user of token, so we set1063			// approved user to spender1064			<PalletEvm<T>>::deposit_log(1065				ERC721Events::Approval {1066					owner: *sender.as_eth(),1067					approved: *spender.as_eth(),1068					token_id: token.into(),1069				}1070				.to_log(collection_id_to_address(collection.id)),1071			);1072			// In Unique chain, any token can have any amount of approved users, so we need to1073			// set allowance of old owner to 0, and allowance of new owner to 11074			if old_spender.as_ref() != Some(spender) {1075				if let Some(old_owner) = old_spender {1076					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1077						collection.id,1078						token,1079						sender.clone(),1080						old_owner,1081						0,1082					));1083				}1084				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1085					collection.id,1086					token,1087					sender.clone(),1088					spender.clone(),1089					1,1090				));1091			}1092		} else {1093			let old_spender = <Allowance<T>>::take((collection.id, token));1094			if !assume_implicit_eth {1095				// In ERC721 there is only one possible approved user of token, so we set1096				// approved user to zero address1097				<PalletEvm<T>>::deposit_log(1098					ERC721Events::Approval {1099						owner: *sender.as_eth(),1100						approved: H160::default(),1101						token_id: token.into(),1102					}1103					.to_log(collection_id_to_address(collection.id)),1104				);1105			}1106			// In Unique chain, any token can have any amount of approved users, so we need to1107			// set allowance of old owner to 01108			if let Some(old_spender) = old_spender {1109				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1110					collection.id,1111					token,1112					sender.clone(),1113					old_spender,1114					0,1115				));1116			}1117		}1118	}11191120	/// Set allowance for the spender to `transfer` or `burn` sender's token.1121	///1122	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1123	pub fn set_allowance(1124		collection: &NonfungibleHandle<T>,1125		sender: &T::CrossAccountId,1126		token: TokenId,1127		spender: Option<&T::CrossAccountId>,1128	) -> DispatchResult {1129		if collection.permissions.access() == AccessMode::AllowList {1130			collection.check_allowlist(sender)?;1131			if let Some(spender) = spender {1132				collection.check_allowlist(spender)?;1133			}1134		}11351136		if let Some(spender) = spender {1137			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1138		}11391140		let token_data =1141			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1142		if &token_data.owner != sender {1143			ensure!(1144				collection.ignores_owned_amount(sender),1145				<CommonError<T>>::CantApproveMoreThanOwned1146			);1147		}11481149		// =========11501151		Self::set_allowance_unchecked(collection, sender, token, spender, false);1152		Ok(())1153	}11541155	/// Checks allowance for the spender to use the token.1156	fn check_allowed(1157		collection: &NonfungibleHandle<T>,1158		spender: &T::CrossAccountId,1159		from: &T::CrossAccountId,1160		token: TokenId,1161		nesting_budget: &dyn Budget,1162	) -> DispatchResult {1163		if spender.conv_eq(from) {1164			return Ok(());1165		}1166		if collection.permissions.access() == AccessMode::AllowList {1167			// `from`, `to` checked in [`transfer`]1168			collection.check_allowlist(spender)?;1169		}11701171		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1172			return Ok(());1173		}11741175		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1176			ensure!(1177				<PalletStructure<T>>::check_indirectly_owned(1178					spender.clone(),1179					source.0,1180					source.1,1181					None,1182					nesting_budget1183				)?,1184				<CommonError<T>>::ApprovedValueTooLow,1185			);1186			return Ok(());1187		}1188		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1189			return Ok(());1190		}1191		ensure!(1192			collection.ignores_allowance(spender),1193			<CommonError<T>>::ApprovedValueTooLow1194		);1195		Ok(())1196	}11971198	/// Transfer NFT token from one account to another.1199	///1200	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1201	/// The owner should set allowance for the spender to transfer token.1202	///1203	/// [`transfer`]: struct.Pallet.html#method.transfer1204	pub fn transfer_from(1205		collection: &NonfungibleHandle<T>,1206		spender: &T::CrossAccountId,1207		from: &T::CrossAccountId,1208		to: &T::CrossAccountId,1209		token: TokenId,1210		nesting_budget: &dyn Budget,1211	) -> DispatchResult {1212		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12131214		// =========12151216		// Allowance is reset in [`transfer`]1217		Self::transfer(collection, from, to, token, nesting_budget)1218	}12191220	/// Burn NFT token for `from` account.1221	///1222	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1223	/// set allowance for the spender to burn token.1224	///1225	/// [`burn`]: struct.Pallet.html#method.burn1226	pub fn burn_from(1227		collection: &NonfungibleHandle<T>,1228		spender: &T::CrossAccountId,1229		from: &T::CrossAccountId,1230		token: TokenId,1231		nesting_budget: &dyn Budget,1232	) -> DispatchResult {1233		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12341235		// =========12361237		Self::burn(collection, from, token)1238	}12391240	/// Check that `from` token could be nested in `under` token.1241	///1242	pub fn check_nesting(1243		handle: &NonfungibleHandle<T>,1244		sender: T::CrossAccountId,1245		from: (CollectionId, TokenId),1246		under: TokenId,1247		nesting_budget: &dyn Budget,1248	) -> DispatchResult {1249		let nesting = handle.permissions.nesting();12501251		#[cfg(not(feature = "runtime-benchmarks"))]1252		let permissive = false;1253		#[cfg(feature = "runtime-benchmarks")]1254		let permissive = nesting.permissive;12551256		if permissive {1257			// Pass1258		} else if nesting.token_owner1259			&& <PalletStructure<T>>::check_indirectly_owned(1260				sender.clone(),1261				handle.id,1262				under,1263				Some(from),1264				nesting_budget,1265			)? {1266			// Pass1267		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1268			// Pass1269		} else {1270			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1271		}12721273		if let Some(whitelist) = &nesting.restricted {1274			ensure!(1275				whitelist.contains(&from.0),1276				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1277			);1278		}1279		Ok(())1280	}12811282	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1283		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1284	}12851286	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1287		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1288	}12891290	fn collection_has_tokens(collection_id: CollectionId) -> bool {1291		<TokenData<T>>::iter_prefix((collection_id,))1292			.next()1293			.is_some()1294	}12951296	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1297		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1298			.next()1299			.is_some()1300	}13011302	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1303		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1304			.map(|((child_collection_id, child_id), _)| TokenChild {1305				collection: child_collection_id,1306				token: child_id,1307			})1308			.collect()1309	}13101311	/// Mint single NFT token.1312	///1313	/// Delegated to [`create_multiple_items`]1314	///1315	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1316	pub fn create_item(1317		collection: &NonfungibleHandle<T>,1318		sender: &T::CrossAccountId,1319		data: CreateItemData<T>,1320		nesting_budget: &dyn Budget,1321	) -> DispatchResult {1322		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1323	}1324}