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

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	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {828		<PalletCommon<T>>::property_permissions(collection_id)829	}830831	pub fn check_token_immediate_ownership(832		collection: &NonfungibleHandle<T>,833		token: TokenId,834		possible_owner: &T::CrossAccountId,835	) -> DispatchResult {836		let token_data =837			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;838		ensure!(839			&token_data.owner == possible_owner,840			<CommonError<T>>::NoPermission841		);842		Ok(())843	}844845	/// Transfer NFT token from one account to another.846	///847	/// `from` account stops being the owner and `to` account becomes the owner of the token.848	/// If `to` is token than `to` becomes owner of the token and the token become nested.849	/// Unnests token from previous parent if it was nested before.850	/// Removes allowance for the token if there was any.851	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.852	///853	/// - `nesting_budget`: Limit for token nesting depth854	pub fn transfer(855		collection: &NonfungibleHandle<T>,856		from: &T::CrossAccountId,857		to: &T::CrossAccountId,858		token: TokenId,859		nesting_budget: &dyn Budget,860	) -> DispatchResult {861		ensure!(862			collection.limits.transfers_enabled(),863			<CommonError<T>>::TransferNotAllowed864		);865866		let token_data =867			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;868		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);869870		if collection.permissions.access() == AccessMode::AllowList {871			collection.check_allowlist(from)?;872			collection.check_allowlist(to)?;873		}874		<PalletCommon<T>>::ensure_correct_receiver(to)?;875876		let balance_from = <AccountBalance<T>>::get((collection.id, from))877			.checked_sub(1)878			.ok_or(<CommonError<T>>::TokenValueTooLow)?;879		let balance_to = if from != to {880			let balance_to = <AccountBalance<T>>::get((collection.id, to))881				.checked_add(1)882				.ok_or(ArithmeticError::Overflow)?;883884			ensure!(885				balance_to < collection.limits.account_token_ownership_limit(),886				<CommonError<T>>::AccountTokenLimitExceeded,887			);888889			Some(balance_to)890		} else {891			None892		};893894		<PalletStructure<T>>::nest_if_sent_to_token(895			from.clone(),896			to,897			collection.id,898			token,899			nesting_budget,900		)?;901902		// =========903904		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);905906		<TokenData<T>>::insert(907			(collection.id, token),908			ItemData {909				owner: to.clone(),910				..token_data911			},912		);913914		if let Some(balance_to) = balance_to {915			// from != to916			if balance_from == 0 {917				<AccountBalance<T>>::remove((collection.id, from));918			} else {919				<AccountBalance<T>>::insert((collection.id, from), balance_from);920			}921			<AccountBalance<T>>::insert((collection.id, to), balance_to);922			<Owned<T>>::remove((collection.id, from, token));923			<Owned<T>>::insert((collection.id, to, token), true);924		}925		Self::set_allowance_unchecked(collection, from, token, None, true);926927		<PalletEvm<T>>::deposit_log(928			ERC721Events::Transfer {929				from: *from.as_eth(),930				to: *to.as_eth(),931				token_id: token.into(),932			}933			.to_log(collection_id_to_address(collection.id)),934		);935		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(936			collection.id,937			token,938			from.clone(),939			to.clone(),940			1,941		));942		Ok(())943	}944945	/// Batch operation to mint multiple NFT tokens.946	///947	/// The sender should be the owner/admin of the collection or collection should be configured948	/// to allow public minting.949	/// Throws if amount of tokens reached it's limit for the collection or if caller reached950	/// token ownership limit.951	///952	/// - `data`: Contains list of token properties and users who will become the owners of the953	///   corresponging tokens.954	/// - `nesting_budget`: Limit for token nesting depth955	pub fn create_multiple_items(956		collection: &NonfungibleHandle<T>,957		sender: &T::CrossAccountId,958		data: Vec<CreateItemData<T>>,959		nesting_budget: &dyn Budget,960	) -> DispatchResult {961		if !collection.is_owner_or_admin(sender) {962			ensure!(963				collection.permissions.mint_mode(),964				<CommonError<T>>::PublicMintingNotAllowed965			);966			collection.check_allowlist(sender)?;967968			for item in data.iter() {969				collection.check_allowlist(&item.owner)?;970			}971		}972973		for data in data.iter() {974			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;975		}976977		let first_token = <TokensMinted<T>>::get(collection.id);978		let tokens_minted = first_token979			.checked_add(data.len() as u32)980			.ok_or(ArithmeticError::Overflow)?;981		ensure!(982			tokens_minted <= collection.limits.token_limit(),983			<CommonError<T>>::CollectionTokenLimitExceeded984		);985986		let mut balances = BTreeMap::new();987		for data in &data {988			let balance = balances989				.entry(&data.owner)990				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));991			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;992993			ensure!(994				*balance <= collection.limits.account_token_ownership_limit(),995				<CommonError<T>>::AccountTokenLimitExceeded,996			);997		}998999		for (i, data) in data.iter().enumerate() {1000			let token = TokenId(first_token + i as u32 + 1);10011002			<PalletStructure<T>>::check_nesting(1003				sender.clone(),1004				&data.owner,1005				collection.id,1006				token,1007				nesting_budget,1008			)?;1009		}10101011		// =========10121013		with_transaction(|| {1014			for (i, data) in data.iter().enumerate() {1015				let token = first_token + i as u32 + 1;10161017				<TokenData<T>>::insert(1018					(collection.id, token),1019					ItemData {1020						// const_data: data.const_data.clone(),1021						owner: data.owner.clone(),1022					},1023				);10241025				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1026					&data.owner,1027					collection.id,1028					TokenId(token),1029				);10301031				if let Err(e) = Self::set_token_properties(1032					collection,1033					sender,1034					TokenId(token),1035					data.properties.clone().into_iter(),1036					true,1037					nesting_budget,1038				) {1039					return TransactionOutcome::Rollback(Err(e));1040				}1041			}1042			TransactionOutcome::Commit(Ok(()))1043		})?;10441045		<TokensMinted<T>>::insert(collection.id, tokens_minted);1046		for (account, balance) in balances {1047			<AccountBalance<T>>::insert((collection.id, account), balance);1048		}1049		for (i, data) in data.into_iter().enumerate() {1050			let token = first_token + i as u32 + 1;1051			<Owned<T>>::insert((collection.id, &data.owner, token), true);10521053			<PalletEvm<T>>::deposit_log(1054				ERC721Events::Transfer {1055					from: H160::default(),1056					to: *data.owner.as_eth(),1057					token_id: token.into(),1058				}1059				.to_log(collection_id_to_address(collection.id)),1060			);1061			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1062				collection.id,1063				TokenId(token),1064				data.owner.clone(),1065				1,1066			));1067		}1068		Ok(())1069	}10701071	pub fn set_allowance_unchecked(1072		collection: &NonfungibleHandle<T>,1073		sender: &T::CrossAccountId,1074		token: TokenId,1075		spender: Option<&T::CrossAccountId>,1076		assume_implicit_eth: bool,1077	) {1078		if let Some(spender) = spender {1079			let old_spender = <Allowance<T>>::get((collection.id, token));1080			<Allowance<T>>::insert((collection.id, token), spender);1081			// In ERC721 there is only one possible approved user of token, so we set1082			// approved user to spender1083			<PalletEvm<T>>::deposit_log(1084				ERC721Events::Approval {1085					owner: *sender.as_eth(),1086					approved: *spender.as_eth(),1087					token_id: token.into(),1088				}1089				.to_log(collection_id_to_address(collection.id)),1090			);1091			// In Unique chain, any token can have any amount of approved users, so we need to1092			// set allowance of old owner to 0, and allowance of new owner to 11093			if old_spender.as_ref() != Some(spender) {1094				if let Some(old_owner) = old_spender {1095					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1096						collection.id,1097						token,1098						sender.clone(),1099						old_owner,1100						0,1101					));1102				}1103				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1104					collection.id,1105					token,1106					sender.clone(),1107					spender.clone(),1108					1,1109				));1110			}1111		} else {1112			let old_spender = <Allowance<T>>::take((collection.id, token));1113			if !assume_implicit_eth {1114				// In ERC721 there is only one possible approved user of token, so we set1115				// approved user to zero address1116				<PalletEvm<T>>::deposit_log(1117					ERC721Events::Approval {1118						owner: *sender.as_eth(),1119						approved: H160::default(),1120						token_id: token.into(),1121					}1122					.to_log(collection_id_to_address(collection.id)),1123				);1124			}1125			// In Unique chain, any token can have any amount of approved users, so we need to1126			// set allowance of old owner to 01127			if let Some(old_spender) = old_spender {1128				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1129					collection.id,1130					token,1131					sender.clone(),1132					old_spender,1133					0,1134				));1135			}1136		}1137	}11381139	/// Set allowance for the spender to `transfer` or `burn` sender's token.1140	///1141	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1142	pub fn set_allowance(1143		collection: &NonfungibleHandle<T>,1144		sender: &T::CrossAccountId,1145		token: TokenId,1146		spender: Option<&T::CrossAccountId>,1147	) -> DispatchResult {1148		if collection.permissions.access() == AccessMode::AllowList {1149			collection.check_allowlist(sender)?;1150			if let Some(spender) = spender {1151				collection.check_allowlist(spender)?;1152			}1153		}11541155		if let Some(spender) = spender {1156			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1157		}11581159		let token_data =1160			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1161		if &token_data.owner != sender {1162			ensure!(1163				collection.ignores_owned_amount(sender),1164				<CommonError<T>>::CantApproveMoreThanOwned1165			);1166		}11671168		// =========11691170		Self::set_allowance_unchecked(collection, sender, token, spender, false);1171		Ok(())1172	}11731174	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1175	///1176	/// - `from`: Address of sender's eth mirror.1177	/// - `to`: Adress of spender.1178	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1179	pub fn set_allowance_from(1180		collection: &NonfungibleHandle<T>,1181		sender: &T::CrossAccountId,1182		from: &T::CrossAccountId,1183		token: TokenId,1184		to: Option<&T::CrossAccountId>,1185	) -> DispatchResult {1186		if collection.permissions.access() == AccessMode::AllowList {1187			collection.check_allowlist(sender)?;1188			collection.check_allowlist(from)?;1189			if let Some(to) = to {1190				collection.check_allowlist(to)?;1191			}1192		}11931194		if let Some(to) = to {1195			<PalletCommon<T>>::ensure_correct_receiver(to)?;1196		}11971198		ensure!(1199			sender.conv_eq(from),1200			<CommonError<T>>::AddressIsNotEthMirror1201		);12021203		let token_data =1204			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1205		if token_data.owner != *from {1206			ensure!(1207				collection.limits.owner_can_transfer()1208					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1209				<CommonError<T>>::CantApproveMoreThanOwned1210			);1211		}12121213		// =========12141215		Self::set_allowance_unchecked(collection, from, token, to, false);1216		Ok(())1217	}12181219	/// Checks allowance for the spender to use the token.1220	fn check_allowed(1221		collection: &NonfungibleHandle<T>,1222		spender: &T::CrossAccountId,1223		from: &T::CrossAccountId,1224		token: TokenId,1225		nesting_budget: &dyn Budget,1226	) -> DispatchResult {1227		if spender.conv_eq(from) {1228			return Ok(());1229		}1230		if collection.permissions.access() == AccessMode::AllowList {1231			// `from`, `to` checked in [`transfer`]1232			collection.check_allowlist(spender)?;1233		}12341235		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1236			return Ok(());1237		}12381239		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1240			ensure!(1241				<PalletStructure<T>>::check_indirectly_owned(1242					spender.clone(),1243					source.0,1244					source.1,1245					None,1246					nesting_budget1247				)?,1248				<CommonError<T>>::ApprovedValueTooLow,1249			);1250			return Ok(());1251		}1252		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1253			return Ok(());1254		}1255		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1256			return Ok(());1257		}1258		ensure!(1259			collection.ignores_allowance(spender),1260			<CommonError<T>>::ApprovedValueTooLow1261		);1262		Ok(())1263	}12641265	/// Transfer NFT token from one account to another.1266	///1267	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1268	/// The owner should set allowance for the spender to transfer token.1269	///1270	/// [`transfer`]: struct.Pallet.html#method.transfer1271	pub fn transfer_from(1272		collection: &NonfungibleHandle<T>,1273		spender: &T::CrossAccountId,1274		from: &T::CrossAccountId,1275		to: &T::CrossAccountId,1276		token: TokenId,1277		nesting_budget: &dyn Budget,1278	) -> DispatchResult {1279		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12801281		// =========12821283		// Allowance is reset in [`transfer`]1284		Self::transfer(collection, from, to, token, nesting_budget)1285	}12861287	/// Burn NFT token for `from` account.1288	///1289	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1290	/// set allowance for the spender to burn token.1291	///1292	/// [`burn`]: struct.Pallet.html#method.burn1293	pub fn burn_from(1294		collection: &NonfungibleHandle<T>,1295		spender: &T::CrossAccountId,1296		from: &T::CrossAccountId,1297		token: TokenId,1298		nesting_budget: &dyn Budget,1299	) -> DispatchResult {1300		Self::check_allowed(collection, spender, from, token, nesting_budget)?;13011302		// =========13031304		Self::burn(collection, from, token)1305	}13061307	/// Check that `from` token could be nested in `under` token.1308	///1309	pub fn check_nesting(1310		handle: &NonfungibleHandle<T>,1311		sender: T::CrossAccountId,1312		from: (CollectionId, TokenId),1313		under: TokenId,1314		nesting_budget: &dyn Budget,1315	) -> DispatchResult {1316		let nesting = handle.permissions.nesting();13171318		#[cfg(not(feature = "runtime-benchmarks"))]1319		let permissive = false;1320		#[cfg(feature = "runtime-benchmarks")]1321		let permissive = nesting.permissive;13221323		if permissive {1324			// Pass1325		} else if nesting.token_owner1326			&& <PalletStructure<T>>::check_indirectly_owned(1327				sender.clone(),1328				handle.id,1329				under,1330				Some(from),1331				nesting_budget,1332			)? {1333			// Pass1334		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1335			// Pass1336		} else {1337			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1338		}13391340		if let Some(whitelist) = &nesting.restricted {1341			ensure!(1342				whitelist.contains(&from.0),1343				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1344			);1345		}1346		Ok(())1347	}13481349	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1350		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1351	}13521353	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1354		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1355	}13561357	fn collection_has_tokens(collection_id: CollectionId) -> bool {1358		<TokenData<T>>::iter_prefix((collection_id,))1359			.next()1360			.is_some()1361	}13621363	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1364		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1365			.next()1366			.is_some()1367	}13681369	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1370		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1371			.map(|((child_collection_id, child_id), _)| TokenChild {1372				collection: child_collection_id,1373				token: child_id,1374			})1375			.collect()1376	}13771378	/// Mint single NFT token.1379	///1380	/// Delegated to [`create_multiple_items`]1381	///1382	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1383	pub fn create_item(1384		collection: &NonfungibleHandle<T>,1385		sender: &T::CrossAccountId,1386		data: CreateItemData<T>,1387		nesting_budget: &dyn Budget,1388	) -> DispatchResult {1389		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1390	}13911392	/// Sets or unsets the approval of a given operator.1393	///1394	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1395	/// - `owner`: Token owner1396	/// - `operator`: Operator1397	/// - `approve`: Should operator status be granted or revoked?1398	pub fn set_allowance_for_all(1399		collection: &NonfungibleHandle<T>,1400		owner: &T::CrossAccountId,1401		operator: &T::CrossAccountId,1402		approve: bool,1403	) -> DispatchResult {1404		if collection.permissions.access() == AccessMode::AllowList {1405			collection.check_allowlist(owner)?;1406			collection.check_allowlist(operator)?;1407		}14081409		<PalletCommon<T>>::ensure_correct_receiver(operator)?;14101411		// =========14121413		<CollectionAllowance<T>>::insert((collection.id, owner, operator), approve);1414		<PalletEvm<T>>::deposit_log(1415			ERC721Events::ApprovalForAll {1416				owner: *owner.as_eth(),1417				operator: *operator.as_eth(),1418				approved: approve,1419			}1420			.to_log(collection_id_to_address(collection.id)),1421		);1422		<PalletCommon<T>>::deposit_event(CommonEvent::ApprovedForAll(1423			collection.id,1424			owner.clone(),1425			operator.clone(),1426			approve,1427		));1428		Ok(())1429	}14301431	/// Tells whether the given `owner` approves the `operator`.1432	pub fn allowance_for_all(1433		collection: &NonfungibleHandle<T>,1434		owner: &T::CrossAccountId,1435		operator: &T::CrossAccountId,1436	) -> bool {1437		<CollectionAllowance<T>>::get((collection.id, owner, operator))1438	}14391440	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1441		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1442			properties.recompute_consumed_space();1443		});14441445		Ok(())1446	}1447}