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

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//!   Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//!   an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//!   it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//!   attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//!   with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//!   Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96	BoundedVec, ensure, fail, transactional,97	storage::with_transaction,98	pallet_prelude::DispatchResultWithPostInfo,99	pallet_prelude::Weight,100	dispatch::{PostDispatchInfo, Pays},101};102use up_data_structs::{103	AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,104	CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,105	PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,106	TokenChild, AuxPropertyValue, PropertiesPermissionMap,107};108use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};109use pallet_common::{110	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,111	eth::collection_id_to_address, erc::CollectionHelpersEvents,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::{H160, Get};116use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};117use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};118use core::ops::Deref;119use codec::{Encode, Decode, MaxEncodedLen};120use scale_info::TypeInfo;121122pub use pallet::*;123use weights::WeightInfo;124#[cfg(feature = "runtime-benchmarks")]125pub mod benchmarking;126pub mod common;127pub mod erc;128pub mod weights;129130pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::Config>::CrossAccountId>;131pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;132133/// Token data, stored independently from other data used to describe it134/// for the convenience of database access. Notably contains the owner account address.135#[struct_versioning::versioned(version = 2, upper)]136#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]137pub struct ItemData<CrossAccountId> {138	#[version(..2)]139	pub const_data: BoundedVec<u8, CustomDataLimit>,140141	#[version(..2)]142	pub variable_data: BoundedVec<u8, CustomDataLimit>,143144	pub owner: CrossAccountId,145}146147#[frame_support::pallet]148pub mod pallet {149	use super::*;150	use frame_support::{151		Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,152	};153	use frame_system::pallet_prelude::*;154	use up_data_structs::{CollectionId, TokenId};155	use super::weights::WeightInfo;156157	#[pallet::error]158	pub enum Error<T> {159		/// Not Nonfungible item data used to mint in Nonfungible collection.160		NotNonfungibleDataUsedToMintFungibleCollectionToken,161		/// Used amount > 1 with NFT162		NonfungibleItemsHaveNoAmount,163		/// Unable to burn NFT with children164		CantBurnNftWithChildren,165	}166167	#[pallet::config]168	pub trait Config:169		frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config170	{171		type WeightInfo: WeightInfo;172	}173174	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);175176	#[pallet::pallet]177	#[pallet::storage_version(STORAGE_VERSION)]178	#[pallet::generate_store(pub(super) trait Store)]179	pub struct Pallet<T>(_);180181	/// Total amount of minted tokens in a collection.182	#[pallet::storage]183	pub type TokensMinted<T: Config> =184		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;185186	/// Amount of burnt tokens in a collection.187	#[pallet::storage]188	pub type TokensBurnt<T: Config> =189		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;190191	/// Token data, used to partially describe a token.192	#[pallet::storage]193	pub type TokenData<T: Config> = StorageNMap<194		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),195		Value = ItemData<T::CrossAccountId>,196		QueryKind = OptionQuery,197	>;198199	/// Map of key-value pairs, describing the metadata of a token.200	#[pallet::storage]201	#[pallet::getter(fn token_properties)]202	pub type TokenProperties<T: Config> = StorageNMap<203		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),204		Value = Properties,205		QueryKind = ValueQuery,206		OnEmpty = up_data_structs::TokenProperties,207	>;208209	/// Custom data of a token that is serialized to bytes,210	/// primarily reserved for on-chain operations,211	/// normally obscured from the external users.212	///213	/// Auxiliary properties are slightly different from214	/// usual [`TokenProperties`] due to an unlimited number215	/// and separately stored and written-to key-value pairs.216	///217	/// Currently used to store RMRK data.218	#[pallet::storage]219	#[pallet::getter(fn token_aux_property)]220	pub type TokenAuxProperties<T: Config> = StorageNMap<221		Key = (222			Key<Twox64Concat, CollectionId>,223			Key<Twox64Concat, TokenId>,224			Key<Twox64Concat, PropertyScope>,225			Key<Twox64Concat, PropertyKey>,226		),227		Value = AuxPropertyValue,228		QueryKind = OptionQuery,229	>;230231	/// Used to enumerate tokens owned by account.232	#[pallet::storage]233	pub type Owned<T: Config> = StorageNMap<234		Key = (235			Key<Twox64Concat, CollectionId>,236			Key<Blake2_128Concat, T::CrossAccountId>,237			Key<Twox64Concat, TokenId>,238		),239		Value = bool,240		QueryKind = ValueQuery,241	>;242243	/// Used to enumerate token's children.244	#[pallet::storage]245	#[pallet::getter(fn token_children)]246	pub type TokenChildren<T: Config> = StorageNMap<247		Key = (248			Key<Twox64Concat, CollectionId>,249			Key<Twox64Concat, TokenId>,250			Key<Twox64Concat, (CollectionId, TokenId)>,251		),252		Value = bool,253		QueryKind = ValueQuery,254	>;255256	/// Amount of tokens owned by an account in a collection.257	#[pallet::storage]258	pub type AccountBalance<T: Config> = StorageNMap<259		Key = (260			Key<Twox64Concat, CollectionId>,261			Key<Blake2_128Concat, T::CrossAccountId>,262		),263		Value = u32,264		QueryKind = ValueQuery,265	>;266267	/// Allowance set by a token owner for another user to perform one of certain transactions on a token.268	#[pallet::storage]269	pub type Allowance<T: Config> = StorageNMap<270		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),271		Value = T::CrossAccountId,272		QueryKind = OptionQuery,273	>;274275	/// Operator set by a wallet owner that could perform certain transactions on all tokens in the wallet.276	#[pallet::storage]277	pub type CollectionAllowance<T: Config> = StorageNMap<278		Key = (279			Key<Twox64Concat, CollectionId>,280			Key<Blake2_128Concat, T::CrossAccountId>,281			Key<Blake2_128Concat, T::CrossAccountId>,282		),283		Value = bool,284		QueryKind = ValueQuery,285	>;286287	/// Upgrade from the old schema to properties.288	#[pallet::hooks]289	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {290		fn on_runtime_upgrade() -> Weight {291			StorageVersion::new(1).put::<Pallet<T>>();292293			Weight::zero()294		}295	}296}297298pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);299impl<T: Config> NonfungibleHandle<T> {300	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {301		Self(inner)302	}303	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {304		self.0305	}306	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {307		&mut self.0308	}309}310311impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {312	fn recorder(&self) -> &SubstrateRecorder<T> {313		self.0.recorder()314	}315	fn into_recorder(self) -> SubstrateRecorder<T> {316		self.0.into_recorder()317	}318}319impl<T: Config> Deref for NonfungibleHandle<T> {320	type Target = pallet_common::CollectionHandle<T>;321322	fn deref(&self) -> &Self::Target {323		&self.0324	}325}326327impl<T: Config> Pallet<T> {328	/// Get number of NFT tokens in collection.329	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {330		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)331	}332333	/// Check that NFT token exists.334	///335	/// - `token`: Token ID.336	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {337		<TokenData<T>>::contains_key((collection.id, token))338	}339340	/// Set the token property with the scope.341	///342	/// - `property`: Contains key-value pair.343	pub fn set_scoped_token_property(344		collection_id: CollectionId,345		token_id: TokenId,346		scope: PropertyScope,347		property: Property,348	) -> DispatchResult {349		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {350			properties.try_scoped_set(scope, property.key, property.value)351		})352		.map_err(<CommonError<T>>::from)?;353354		Ok(())355	}356357	/// Batch operation to set multiple properties with the same scope.358	pub fn set_scoped_token_properties(359		collection_id: CollectionId,360		token_id: TokenId,361		scope: PropertyScope,362		properties: impl Iterator<Item = Property>,363	) -> DispatchResult {364		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {365			stored_properties.try_scoped_set_from_iter(scope, properties)366		})367		.map_err(<CommonError<T>>::from)?;368369		Ok(())370	}371372	/// Add or edit auxiliary data for the property.373	///374	/// - `f`: function that adds or edits auxiliary data.375	pub fn try_mutate_token_aux_property<R, E>(376		collection_id: CollectionId,377		token_id: TokenId,378		scope: PropertyScope,379		key: PropertyKey,380		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,381	) -> Result<R, E> {382		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)383	}384385	/// Remove auxiliary data for the property.386	pub fn remove_token_aux_property(387		collection_id: CollectionId,388		token_id: TokenId,389		scope: PropertyScope,390		key: PropertyKey,391	) {392		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));393	}394395	/// Get all auxiliary data in a given scope.396	///397	/// Returns iterator over Property Key - Data pairs.398	pub fn iterate_token_aux_properties(399		collection_id: CollectionId,400		token_id: TokenId,401		scope: PropertyScope,402	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {403		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))404	}405406	/// Get ID of the last minted token407	pub fn current_token_id(collection_id: CollectionId) -> TokenId {408		TokenId(<TokensMinted<T>>::get(collection_id))409	}410}411412// unchecked calls skips any permission checks413impl<T: Config> Pallet<T> {414	/// Create NFT collection415	///416	/// `init_collection` will take non-refundable deposit for collection creation.417	///418	/// - `data`: Contains settings for collection limits and permissions.419	pub fn init_collection(420		owner: T::CrossAccountId,421		payer: T::CrossAccountId,422		data: CreateCollectionData<T::AccountId>,423		flags: CollectionFlags,424	) -> Result<CollectionId, DispatchError> {425		<PalletCommon<T>>::init_collection(owner, payer, data, flags)426	}427428	/// Destroy NFT collection429	///430	/// `destroy_collection` will throw error if collection contains any tokens.431	/// Only owner can destroy collection.432	pub fn destroy_collection(433		collection: NonfungibleHandle<T>,434		sender: &T::CrossAccountId,435	) -> DispatchResult {436		let id = collection.id;437438		if Self::collection_has_tokens(id) {439			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());440		}441442		// =========443444		PalletCommon::destroy_collection(collection.0, sender)?;445446		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);447		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);448		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);449		<TokensMinted<T>>::remove(id);450		<TokensBurnt<T>>::remove(id);451		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);452		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);453		let _ = <CollectionAllowance<T>>::clear_prefix((id,), u32::MAX, None);454		Ok(())455	}456457	/// Burn NFT token458	///459	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token460	/// if the token is nested.461	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.462	/// Also removes all corresponding properties and auxiliary properties.463	///464	/// - `token`: Token that should be burned465	/// - `collection`: Collection that contains the token466	pub fn burn(467		collection: &NonfungibleHandle<T>,468		sender: &T::CrossAccountId,469		token: TokenId,470	) -> DispatchResult {471		let token_data =472			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;473		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);474475		if collection.permissions.access() == AccessMode::AllowList {476			collection.check_allowlist(sender)?;477		}478479		if Self::token_has_children(collection.id, token) {480			return Err(<Error<T>>::CantBurnNftWithChildren.into());481		}482483		let burnt = <TokensBurnt<T>>::get(collection.id)484			.checked_add(1)485			.ok_or(ArithmeticError::Overflow)?;486487		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))488			.checked_sub(1)489			.ok_or(ArithmeticError::Overflow)?;490491		// =========492493		if balance == 0 {494			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));495		} else {496			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);497		}498499		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);500501		<Owned<T>>::remove((collection.id, &token_data.owner, token));502		<TokensBurnt<T>>::insert(collection.id, burnt);503		<TokenData<T>>::remove((collection.id, token));504		<TokenProperties<T>>::remove((collection.id, token));505		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);506		let old_spender = <Allowance<T>>::take((collection.id, token));507508		if let Some(old_spender) = old_spender {509			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(510				collection.id,511				token,512				token_data.owner.clone(),513				old_spender,514				0,515			));516		}517518		<PalletEvm<T>>::deposit_log(519			ERC721Events::Transfer {520				from: *token_data.owner.as_eth(),521				to: H160::default(),522				token_id: token.into(),523			}524			.to_log(collection_id_to_address(collection.id)),525		);526		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(527			collection.id,528			token,529			token_data.owner,530			1,531		));532		Ok(())533	}534535	/// Same as [`burn`] but burns all the tokens that are nested in the token first536	///537	/// - `self_budget`: Limit for searching children in depth.538	/// - `breadth_budget`: Limit of breadth of searching children.539	///540	/// [`burn`]: struct.Pallet.html#method.burn541	#[transactional]542	pub fn burn_recursively(543		collection: &NonfungibleHandle<T>,544		sender: &T::CrossAccountId,545		token: TokenId,546		self_budget: &dyn Budget,547		breadth_budget: &dyn Budget,548	) -> DispatchResultWithPostInfo {549		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);550551		let current_token_account =552			T::CrossTokenAddressMapping::token_to_address(collection.id, token);553554		let mut weight = Weight::zero();555556		// This method is transactional, if user in fact doesn't have permissions to remove token -557		// tokens removed here will be restored after rejected transaction558		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {559			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);560			let PostDispatchInfo { actual_weight, .. } =561				<PalletStructure<T>>::burn_item_recursively(562					current_token_account.clone(),563					collection,564					token,565					self_budget,566					breadth_budget,567				)?;568			if let Some(actual_weight) = actual_weight {569				weight = weight.saturating_add(actual_weight);570			}571		}572573		Self::burn(collection, sender, token)?;574		DispatchResultWithPostInfo::Ok(PostDispatchInfo {575			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),576			pays_fee: Pays::Yes,577		})578	}579580	/// Batch operation to add, edit or remove properties for the token581	///582	/// All affected properties should have mutable permission and sender should have583	/// permission to edit those properties.584	///585	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.586	/// - `is_token_create`: Indicates that method is called during token initialization.587	///   Allows to bypass ownership check.588	#[transactional]589	fn modify_token_properties(590		collection: &NonfungibleHandle<T>,591		sender: &T::CrossAccountId,592		token_id: TokenId,593		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,594		is_token_create: bool,595		nesting_budget: &dyn Budget,596	) -> DispatchResult {597		let mut collection_admin_status = None;598		let mut token_owner_result = None;599600		let mut is_collection_admin =601			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));602603		let mut is_token_owner = || {604			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {605				let is_owned = <PalletStructure<T>>::check_indirectly_owned(606					sender.clone(),607					collection.id,608					token_id,609					None,610					nesting_budget,611				)?;612613				Ok(is_owned)614			})615		};616617		for (key, value) in properties {618			let permission = <PalletCommon<T>>::property_permissions(collection.id)619				.get(&key)620				.cloned()621				.unwrap_or_else(PropertyPermission::none);622623			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))624				.get(&key)625				.is_some();626627			match permission {628				PropertyPermission { mutable: false, .. } if is_property_exists => {629					return Err(<CommonError<T>>::NoPermission.into());630				}631632				PropertyPermission {633					collection_admin,634					token_owner,635					..636				} => {637					//TODO: investigate threats during public minting.638					if is_token_create && (collection_admin || token_owner) && value.is_some() {639						// Pass640					} else if collection_admin && is_collection_admin() {641						// Pass642					} else if token_owner && is_token_owner()? {643						// Pass644					} else {645						fail!(<CommonError<T>>::NoPermission);646					}647				}648			}649650			match value {651				Some(value) => {652					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {653						properties.try_set(key.clone(), value)654					})655					.map_err(<CommonError<T>>::from)?;656657					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(658						collection.id,659						token_id,660						key,661					));662				}663				None => {664					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {665						properties.remove(&key)666					})667					.map_err(<CommonError<T>>::from)?;668669					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(670						collection.id,671						token_id,672						key,673					));674				}675			}676677			<PalletEvm<T>>::deposit_log(678				CollectionHelpersEvents::TokenChanged {679					collection_id: collection_id_to_address(collection.id),680					token_id: token_id.into(),681				}682				.to_log(T::ContractAddress::get()),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_permissions(831		collection: &CollectionHandle<T>,832		sender: &T::CrossAccountId,833		permission: Vec<PropertyKeyPermission>,834	) -> DispatchResult {835		<PalletCommon<T>>::set_token_property_permissions(collection, sender, permission)836	}837838	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {839		<PalletCommon<T>>::property_permissions(collection_id)840	}841842	pub fn check_token_immediate_ownership(843		collection: &NonfungibleHandle<T>,844		token: TokenId,845		possible_owner: &T::CrossAccountId,846	) -> DispatchResult {847		let token_data =848			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;849		ensure!(850			&token_data.owner == possible_owner,851			<CommonError<T>>::NoPermission852		);853		Ok(())854	}855856	/// Transfer NFT token from one account to another.857	///858	/// `from` account stops being the owner and `to` account becomes the owner of the token.859	/// If `to` is token than `to` becomes owner of the token and the token become nested.860	/// Unnests token from previous parent if it was nested before.861	/// Removes allowance for the token if there was any.862	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.863	///864	/// - `nesting_budget`: Limit for token nesting depth865	pub fn transfer(866		collection: &NonfungibleHandle<T>,867		from: &T::CrossAccountId,868		to: &T::CrossAccountId,869		token: TokenId,870		nesting_budget: &dyn Budget,871	) -> DispatchResult {872		ensure!(873			collection.limits.transfers_enabled(),874			<CommonError<T>>::TransferNotAllowed875		);876877		let token_data =878			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;879		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);880881		if collection.permissions.access() == AccessMode::AllowList {882			collection.check_allowlist(from)?;883			collection.check_allowlist(to)?;884		}885		<PalletCommon<T>>::ensure_correct_receiver(to)?;886887		let balance_from = <AccountBalance<T>>::get((collection.id, from))888			.checked_sub(1)889			.ok_or(<CommonError<T>>::TokenValueTooLow)?;890		let balance_to = if from != to {891			let balance_to = <AccountBalance<T>>::get((collection.id, to))892				.checked_add(1)893				.ok_or(ArithmeticError::Overflow)?;894895			ensure!(896				balance_to < collection.limits.account_token_ownership_limit(),897				<CommonError<T>>::AccountTokenLimitExceeded,898			);899900			Some(balance_to)901		} else {902			None903		};904905		<PalletStructure<T>>::nest_if_sent_to_token(906			from.clone(),907			to,908			collection.id,909			token,910			nesting_budget,911		)?;912913		// =========914915		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);916917		<TokenData<T>>::insert(918			(collection.id, token),919			ItemData {920				owner: to.clone(),921				..token_data922			},923		);924925		if let Some(balance_to) = balance_to {926			// from != to927			if balance_from == 0 {928				<AccountBalance<T>>::remove((collection.id, from));929			} else {930				<AccountBalance<T>>::insert((collection.id, from), balance_from);931			}932			<AccountBalance<T>>::insert((collection.id, to), balance_to);933			<Owned<T>>::remove((collection.id, from, token));934			<Owned<T>>::insert((collection.id, to, token), true);935		}936		Self::set_allowance_unchecked(collection, from, token, None, true);937938		<PalletEvm<T>>::deposit_log(939			ERC721Events::Transfer {940				from: *from.as_eth(),941				to: *to.as_eth(),942				token_id: token.into(),943			}944			.to_log(collection_id_to_address(collection.id)),945		);946		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(947			collection.id,948			token,949			from.clone(),950			to.clone(),951			1,952		));953		Ok(())954	}955956	/// Batch operation to mint multiple NFT tokens.957	///958	/// The sender should be the owner/admin of the collection or collection should be configured959	/// to allow public minting.960	/// Throws if amount of tokens reached it's limit for the collection or if caller reached961	/// token ownership limit.962	///963	/// - `data`: Contains list of token properties and users who will become the owners of the964	///   corresponging tokens.965	/// - `nesting_budget`: Limit for token nesting depth966	pub fn create_multiple_items(967		collection: &NonfungibleHandle<T>,968		sender: &T::CrossAccountId,969		data: Vec<CreateItemData<T>>,970		nesting_budget: &dyn Budget,971	) -> DispatchResult {972		if !collection.is_owner_or_admin(sender) {973			ensure!(974				collection.permissions.mint_mode(),975				<CommonError<T>>::PublicMintingNotAllowed976			);977			collection.check_allowlist(sender)?;978979			for item in data.iter() {980				collection.check_allowlist(&item.owner)?;981			}982		}983984		for data in data.iter() {985			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;986		}987988		let first_token = <TokensMinted<T>>::get(collection.id);989		let tokens_minted = first_token990			.checked_add(data.len() as u32)991			.ok_or(ArithmeticError::Overflow)?;992		ensure!(993			tokens_minted <= collection.limits.token_limit(),994			<CommonError<T>>::CollectionTokenLimitExceeded995		);996997		let mut balances = BTreeMap::new();998		for data in &data {999			let balance = balances1000				.entry(&data.owner)1001				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));1002			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;10031004			ensure!(1005				*balance <= collection.limits.account_token_ownership_limit(),1006				<CommonError<T>>::AccountTokenLimitExceeded,1007			);1008		}10091010		for (i, data) in data.iter().enumerate() {1011			let token = TokenId(first_token + i as u32 + 1);10121013			<PalletStructure<T>>::check_nesting(1014				sender.clone(),1015				&data.owner,1016				collection.id,1017				token,1018				nesting_budget,1019			)?;1020		}10211022		// =========10231024		with_transaction(|| {1025			for (i, data) in data.iter().enumerate() {1026				let token = first_token + i as u32 + 1;10271028				<TokenData<T>>::insert(1029					(collection.id, token),1030					ItemData {1031						// const_data: data.const_data.clone(),1032						owner: data.owner.clone(),1033					},1034				);10351036				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1037					&data.owner,1038					collection.id,1039					TokenId(token),1040				);10411042				if let Err(e) = Self::set_token_properties(1043					collection,1044					sender,1045					TokenId(token),1046					data.properties.clone().into_iter(),1047					true,1048					nesting_budget,1049				) {1050					return TransactionOutcome::Rollback(Err(e));1051				}1052			}1053			TransactionOutcome::Commit(Ok(()))1054		})?;10551056		<TokensMinted<T>>::insert(collection.id, tokens_minted);1057		for (account, balance) in balances {1058			<AccountBalance<T>>::insert((collection.id, account), balance);1059		}1060		for (i, data) in data.into_iter().enumerate() {1061			let token = first_token + i as u32 + 1;1062			<Owned<T>>::insert((collection.id, &data.owner, token), true);10631064			<PalletEvm<T>>::deposit_log(1065				ERC721Events::Transfer {1066					from: H160::default(),1067					to: *data.owner.as_eth(),1068					token_id: token.into(),1069				}1070				.to_log(collection_id_to_address(collection.id)),1071			);1072			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1073				collection.id,1074				TokenId(token),1075				data.owner.clone(),1076				1,1077			));1078		}1079		Ok(())1080	}10811082	pub fn set_allowance_unchecked(1083		collection: &NonfungibleHandle<T>,1084		sender: &T::CrossAccountId,1085		token: TokenId,1086		spender: Option<&T::CrossAccountId>,1087		assume_implicit_eth: bool,1088	) {1089		if let Some(spender) = spender {1090			let old_spender = <Allowance<T>>::get((collection.id, token));1091			<Allowance<T>>::insert((collection.id, token), spender);1092			// In ERC721 there is only one possible approved user of token, so we set1093			// approved user to spender1094			<PalletEvm<T>>::deposit_log(1095				ERC721Events::Approval {1096					owner: *sender.as_eth(),1097					approved: *spender.as_eth(),1098					token_id: token.into(),1099				}1100				.to_log(collection_id_to_address(collection.id)),1101			);1102			// In Unique chain, any token can have any amount of approved users, so we need to1103			// set allowance of old owner to 0, and allowance of new owner to 11104			if old_spender.as_ref() != Some(spender) {1105				if let Some(old_owner) = old_spender {1106					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1107						collection.id,1108						token,1109						sender.clone(),1110						old_owner,1111						0,1112					));1113				}1114				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1115					collection.id,1116					token,1117					sender.clone(),1118					spender.clone(),1119					1,1120				));1121			}1122		} else {1123			let old_spender = <Allowance<T>>::take((collection.id, token));1124			if !assume_implicit_eth {1125				// In ERC721 there is only one possible approved user of token, so we set1126				// approved user to zero address1127				<PalletEvm<T>>::deposit_log(1128					ERC721Events::Approval {1129						owner: *sender.as_eth(),1130						approved: H160::default(),1131						token_id: token.into(),1132					}1133					.to_log(collection_id_to_address(collection.id)),1134				);1135			}1136			// In Unique chain, any token can have any amount of approved users, so we need to1137			// set allowance of old owner to 01138			if let Some(old_spender) = old_spender {1139				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1140					collection.id,1141					token,1142					sender.clone(),1143					old_spender,1144					0,1145				));1146			}1147		}1148	}11491150	/// Set allowance for the spender to `transfer` or `burn` sender's token.1151	///1152	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1153	pub fn set_allowance(1154		collection: &NonfungibleHandle<T>,1155		sender: &T::CrossAccountId,1156		token: TokenId,1157		spender: Option<&T::CrossAccountId>,1158	) -> DispatchResult {1159		if collection.permissions.access() == AccessMode::AllowList {1160			collection.check_allowlist(sender)?;1161			if let Some(spender) = spender {1162				collection.check_allowlist(spender)?;1163			}1164		}11651166		if let Some(spender) = spender {1167			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1168		}11691170		let token_data =1171			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1172		if &token_data.owner != sender {1173			ensure!(1174				collection.ignores_owned_amount(sender),1175				<CommonError<T>>::CantApproveMoreThanOwned1176			);1177		}11781179		// =========11801181		Self::set_allowance_unchecked(collection, sender, token, spender, false);1182		Ok(())1183	}11841185	/// Checks allowance for the spender to use the token.1186	fn check_allowed(1187		collection: &NonfungibleHandle<T>,1188		spender: &T::CrossAccountId,1189		from: &T::CrossAccountId,1190		token: TokenId,1191		nesting_budget: &dyn Budget,1192	) -> DispatchResult {1193		if spender.conv_eq(from) {1194			return Ok(());1195		}1196		if collection.permissions.access() == AccessMode::AllowList {1197			// `from`, `to` checked in [`transfer`]1198			collection.check_allowlist(spender)?;1199		}12001201		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1202			return Ok(());1203		}12041205		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1206			ensure!(1207				<PalletStructure<T>>::check_indirectly_owned(1208					spender.clone(),1209					source.0,1210					source.1,1211					None,1212					nesting_budget1213				)?,1214				<CommonError<T>>::ApprovedValueTooLow,1215			);1216			return Ok(());1217		}1218		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1219			return Ok(());1220		}1221		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1222			return Ok(());1223		}1224		ensure!(1225			collection.ignores_allowance(spender),1226			<CommonError<T>>::ApprovedValueTooLow1227		);1228		Ok(())1229	}12301231	/// Transfer NFT token from one account to another.1232	///1233	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1234	/// The owner should set allowance for the spender to transfer token.1235	///1236	/// [`transfer`]: struct.Pallet.html#method.transfer1237	pub fn transfer_from(1238		collection: &NonfungibleHandle<T>,1239		spender: &T::CrossAccountId,1240		from: &T::CrossAccountId,1241		to: &T::CrossAccountId,1242		token: TokenId,1243		nesting_budget: &dyn Budget,1244	) -> DispatchResult {1245		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12461247		// =========12481249		// Allowance is reset in [`transfer`]1250		Self::transfer(collection, from, to, token, nesting_budget)1251	}12521253	/// Burn NFT token for `from` account.1254	///1255	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1256	/// set allowance for the spender to burn token.1257	///1258	/// [`burn`]: struct.Pallet.html#method.burn1259	pub fn burn_from(1260		collection: &NonfungibleHandle<T>,1261		spender: &T::CrossAccountId,1262		from: &T::CrossAccountId,1263		token: TokenId,1264		nesting_budget: &dyn Budget,1265	) -> DispatchResult {1266		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12671268		// =========12691270		Self::burn(collection, from, token)1271	}12721273	/// Check that `from` token could be nested in `under` token.1274	///1275	pub fn check_nesting(1276		handle: &NonfungibleHandle<T>,1277		sender: T::CrossAccountId,1278		from: (CollectionId, TokenId),1279		under: TokenId,1280		nesting_budget: &dyn Budget,1281	) -> DispatchResult {1282		let nesting = handle.permissions.nesting();12831284		#[cfg(not(feature = "runtime-benchmarks"))]1285		let permissive = false;1286		#[cfg(feature = "runtime-benchmarks")]1287		let permissive = nesting.permissive;12881289		if permissive {1290			// Pass1291		} else if nesting.token_owner1292			&& <PalletStructure<T>>::check_indirectly_owned(1293				sender.clone(),1294				handle.id,1295				under,1296				Some(from),1297				nesting_budget,1298			)? {1299			// Pass1300		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1301			// Pass1302		} else {1303			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1304		}13051306		if let Some(whitelist) = &nesting.restricted {1307			ensure!(1308				whitelist.contains(&from.0),1309				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1310			);1311		}1312		Ok(())1313	}13141315	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1316		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1317	}13181319	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1320		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1321	}13221323	fn collection_has_tokens(collection_id: CollectionId) -> bool {1324		<TokenData<T>>::iter_prefix((collection_id,))1325			.next()1326			.is_some()1327	}13281329	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1330		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1331			.next()1332			.is_some()1333	}13341335	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1336		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1337			.map(|((child_collection_id, child_id), _)| TokenChild {1338				collection: child_collection_id,1339				token: child_id,1340			})1341			.collect()1342	}13431344	/// Mint single NFT token.1345	///1346	/// Delegated to [`create_multiple_items`]1347	///1348	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1349	pub fn create_item(1350		collection: &NonfungibleHandle<T>,1351		sender: &T::CrossAccountId,1352		data: CreateItemData<T>,1353		nesting_budget: &dyn Budget,1354	) -> DispatchResult {1355		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1356	}13571358	/// Sets or unsets the approval of a given operator.1359	///1360	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1361	/// - `owner`: Token owner1362	/// - `operator`: Operator1363	/// - `approve`: Should operator status be granted or revoked?1364	pub fn set_allowance_for_all(1365		collection: &NonfungibleHandle<T>,1366		owner: &T::CrossAccountId,1367		operator: &T::CrossAccountId,1368		approve: bool,1369	) -> DispatchResult {1370		if collection.permissions.access() == AccessMode::AllowList {1371			collection.check_allowlist(owner)?;1372			collection.check_allowlist(operator)?;1373		}13741375		<PalletCommon<T>>::ensure_correct_receiver(operator)?;13761377		// =========13781379		<CollectionAllowance<T>>::insert((collection.id, owner, operator), approve);1380		<PalletEvm<T>>::deposit_log(1381			ERC721Events::ApprovalForAll {1382				owner: *owner.as_eth(),1383				operator: *operator.as_eth(),1384				approved: approve,1385			}1386			.to_log(collection_id_to_address(collection.id)),1387		);1388		<PalletCommon<T>>::deposit_event(CommonEvent::ApprovedForAll(1389			collection.id,1390			owner.clone(),1391			operator.clone(),1392			approve,1393		));1394		Ok(())1395	}13961397	/// Tells whether the given `owner` approves the `operator`.1398	pub fn allowance_for_all(1399		collection: &NonfungibleHandle<T>,1400		owner: &T::CrossAccountId,1401		operator: &T::CrossAccountId,1402	) -> bool {1403		<CollectionAllowance<T>>::get((collection.id, owner, operator))1404	}14051406	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1407		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1408			properties.recompute_consumed_space();1409		});14101411		Ok(())1412	}1413}