git.delta.rocks / unique-network / refs/commits / 6cb52a2e4f02

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, PropertyKey,105	PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,106	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,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::{Get, H160};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 unused.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	/// A batch operation to add, edit or remove properties for a token.581	///582	/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.583	/// - `is_token_create`: Indicates that method is called during token initialization.584	///   Allows to bypass ownership check.585	///586	/// All affected properties should have `mutable` permission587	/// to be **deleted** or to be **set more than once**,588	/// and the sender should have permission to edit those properties.589	///590	/// This function fires an event for each property change.591	/// In case of an error, all the changes (including the events) will be reverted592	/// since the function is transactional.593	#[transactional]594	fn modify_token_properties(595		collection: &NonfungibleHandle<T>,596		sender: &T::CrossAccountId,597		token_id: TokenId,598		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,599		is_token_create: bool,600		nesting_budget: &dyn Budget,601	) -> DispatchResult {602		let is_token_owner = || {603			let is_owned = <PalletStructure<T>>::check_indirectly_owned(604				sender.clone(),605				collection.id,606				token_id,607				None,608				nesting_budget,609			)?;610611			Ok(is_owned)612		};613614		let stored_properties = <TokenProperties<T>>::get((collection.id, token_id));615616		<PalletCommon<T>>::modify_token_properties(617			collection,618			sender,619			token_id,620			properties_updates,621			is_token_create,622			stored_properties,623			is_token_owner,624			|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),625			erc::ERC721TokenEvent::TokenChanged {626				collection_id: collection_id_to_address(collection.id),627				token_id: token_id.into(),628			}629			.to_log(T::ContractAddress::get()),630		)631	}632633	/// Batch operation to add or edit properties for the token634	///635	/// Same as [`modify_token_properties`] but doesn't allow to remove properties636	///637	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties638	pub fn set_token_properties(639		collection: &NonfungibleHandle<T>,640		sender: &T::CrossAccountId,641		token_id: TokenId,642		properties: impl Iterator<Item = Property>,643		is_token_create: bool,644		nesting_budget: &dyn Budget,645	) -> DispatchResult {646		Self::modify_token_properties(647			collection,648			sender,649			token_id,650			properties.map(|p| (p.key, Some(p.value))),651			is_token_create,652			nesting_budget,653		)654	}655656	/// Add or edit single property for the token657	///658	/// Calls [`set_token_properties`] internally659	///660	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties661	pub fn set_token_property(662		collection: &NonfungibleHandle<T>,663		sender: &T::CrossAccountId,664		token_id: TokenId,665		property: Property,666		nesting_budget: &dyn Budget,667	) -> DispatchResult {668		let is_token_create = false;669670		Self::set_token_properties(671			collection,672			sender,673			token_id,674			[property].into_iter(),675			is_token_create,676			nesting_budget,677		)678	}679680	/// Batch operation to remove properties from the token681	///682	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties683	///684	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties685	pub fn delete_token_properties(686		collection: &NonfungibleHandle<T>,687		sender: &T::CrossAccountId,688		token_id: TokenId,689		property_keys: impl Iterator<Item = PropertyKey>,690		nesting_budget: &dyn Budget,691	) -> DispatchResult {692		let is_token_create = false;693694		Self::modify_token_properties(695			collection,696			sender,697			token_id,698			property_keys.into_iter().map(|key| (key, None)),699			is_token_create,700			nesting_budget,701		)702	}703704	/// Remove single property from the token705	///706	/// Calls [`delete_token_properties`] internally707	///708	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties709	pub fn delete_token_property(710		collection: &NonfungibleHandle<T>,711		sender: &T::CrossAccountId,712		token_id: TokenId,713		property_key: PropertyKey,714		nesting_budget: &dyn Budget,715	) -> DispatchResult {716		Self::delete_token_properties(717			collection,718			sender,719			token_id,720			[property_key].into_iter(),721			nesting_budget,722		)723	}724725	/// Add or edit properties for the collection726	pub fn set_collection_properties(727		collection: &NonfungibleHandle<T>,728		sender: &T::CrossAccountId,729		properties: Vec<Property>,730	) -> DispatchResult {731		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())732	}733734	/// Remove properties from the collection735	pub fn delete_collection_properties(736		collection: &CollectionHandle<T>,737		sender: &T::CrossAccountId,738		property_keys: Vec<PropertyKey>,739	) -> DispatchResult {740		<PalletCommon<T>>::delete_collection_properties(741			collection,742			sender,743			property_keys.into_iter(),744		)745	}746747	/// Set property permissions for the token.748	///749	/// Sender should be the owner or admin of token's collection.750	pub fn set_token_property_permissions(751		collection: &CollectionHandle<T>,752		sender: &T::CrossAccountId,753		property_permissions: Vec<PropertyKeyPermission>,754	) -> DispatchResult {755		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)756	}757758	/// Set property permissions for the token with scope.759	///760	/// Sender should be the owner or admin of token's collection.761	pub fn set_scoped_token_property_permissions(762		collection: &CollectionHandle<T>,763		sender: &T::CrossAccountId,764		scope: PropertyScope,765		property_permissions: Vec<PropertyKeyPermission>,766	) -> DispatchResult {767		<PalletCommon<T>>::set_scoped_token_property_permissions(768			collection,769			sender,770			scope,771			property_permissions,772		)773	}774775	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {776		<PalletCommon<T>>::property_permissions(collection_id)777	}778779	pub fn check_token_immediate_ownership(780		collection: &NonfungibleHandle<T>,781		token: TokenId,782		possible_owner: &T::CrossAccountId,783	) -> DispatchResult {784		let token_data =785			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;786		ensure!(787			&token_data.owner == possible_owner,788			<CommonError<T>>::NoPermission789		);790		Ok(())791	}792793	/// Transfer NFT token from one account to another.794	///795	/// `from` account stops being the owner and `to` account becomes the owner of the token.796	/// If `to` is token than `to` becomes owner of the token and the token become nested.797	/// Unnests token from previous parent if it was nested before.798	/// Removes allowance for the token if there was any.799	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.800	///801	/// - `nesting_budget`: Limit for token nesting depth802	pub fn transfer(803		collection: &NonfungibleHandle<T>,804		from: &T::CrossAccountId,805		to: &T::CrossAccountId,806		token: TokenId,807		nesting_budget: &dyn Budget,808	) -> DispatchResult {809		ensure!(810			collection.limits.transfers_enabled(),811			<CommonError<T>>::TransferNotAllowed812		);813814		let token_data =815			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;816		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);817818		if collection.permissions.access() == AccessMode::AllowList {819			collection.check_allowlist(from)?;820			collection.check_allowlist(to)?;821		}822		<PalletCommon<T>>::ensure_correct_receiver(to)?;823824		let balance_from = <AccountBalance<T>>::get((collection.id, from))825			.checked_sub(1)826			.ok_or(<CommonError<T>>::TokenValueTooLow)?;827		let balance_to = if from != to {828			let balance_to = <AccountBalance<T>>::get((collection.id, to))829				.checked_add(1)830				.ok_or(ArithmeticError::Overflow)?;831832			ensure!(833				balance_to < collection.limits.account_token_ownership_limit(),834				<CommonError<T>>::AccountTokenLimitExceeded,835			);836837			Some(balance_to)838		} else {839			None840		};841842		<PalletStructure<T>>::nest_if_sent_to_token(843			from.clone(),844			to,845			collection.id,846			token,847			nesting_budget,848		)?;849850		// =========851852		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);853854		<TokenData<T>>::insert(855			(collection.id, token),856			ItemData {857				owner: to.clone(),858				..token_data859			},860		);861862		if let Some(balance_to) = balance_to {863			// from != to864			if balance_from == 0 {865				<AccountBalance<T>>::remove((collection.id, from));866			} else {867				<AccountBalance<T>>::insert((collection.id, from), balance_from);868			}869			<AccountBalance<T>>::insert((collection.id, to), balance_to);870			<Owned<T>>::remove((collection.id, from, token));871			<Owned<T>>::insert((collection.id, to, token), true);872		}873		Self::set_allowance_unchecked(collection, from, token, None, true);874875		<PalletEvm<T>>::deposit_log(876			ERC721Events::Transfer {877				from: *from.as_eth(),878				to: *to.as_eth(),879				token_id: token.into(),880			}881			.to_log(collection_id_to_address(collection.id)),882		);883		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(884			collection.id,885			token,886			from.clone(),887			to.clone(),888			1,889		));890		Ok(())891	}892893	/// Batch operation to mint multiple NFT tokens.894	///895	/// The sender should be the owner/admin of the collection or collection should be configured896	/// to allow public minting.897	/// Throws if amount of tokens reached it's limit for the collection or if caller reached898	/// token ownership limit.899	///900	/// - `data`: Contains list of token properties and users who will become the owners of the901	///   corresponging tokens.902	/// - `nesting_budget`: Limit for token nesting depth903	pub fn create_multiple_items(904		collection: &NonfungibleHandle<T>,905		sender: &T::CrossAccountId,906		data: Vec<CreateItemData<T>>,907		nesting_budget: &dyn Budget,908	) -> DispatchResult {909		if !collection.is_owner_or_admin(sender) {910			ensure!(911				collection.permissions.mint_mode(),912				<CommonError<T>>::PublicMintingNotAllowed913			);914			collection.check_allowlist(sender)?;915916			for item in data.iter() {917				collection.check_allowlist(&item.owner)?;918			}919		}920921		for data in data.iter() {922			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;923		}924925		let first_token = <TokensMinted<T>>::get(collection.id);926		let tokens_minted = first_token927			.checked_add(data.len() as u32)928			.ok_or(ArithmeticError::Overflow)?;929		ensure!(930			tokens_minted <= collection.limits.token_limit(),931			<CommonError<T>>::CollectionTokenLimitExceeded932		);933934		let mut balances = BTreeMap::new();935		for data in &data {936			let balance = balances937				.entry(&data.owner)938				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));939			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;940941			ensure!(942				*balance <= collection.limits.account_token_ownership_limit(),943				<CommonError<T>>::AccountTokenLimitExceeded,944			);945		}946947		for (i, data) in data.iter().enumerate() {948			let token = TokenId(first_token + i as u32 + 1);949950			<PalletStructure<T>>::check_nesting(951				sender.clone(),952				&data.owner,953				collection.id,954				token,955				nesting_budget,956			)?;957		}958959		// =========960961		with_transaction(|| {962			for (i, data) in data.iter().enumerate() {963				let token = first_token + i as u32 + 1;964965				<TokenData<T>>::insert(966					(collection.id, token),967					ItemData {968						// const_data: data.const_data.clone(),969						owner: data.owner.clone(),970					},971				);972973				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(974					&data.owner,975					collection.id,976					TokenId(token),977				);978979				if let Err(e) = Self::set_token_properties(980					collection,981					sender,982					TokenId(token),983					data.properties.clone().into_iter(),984					true,985					nesting_budget,986				) {987					return TransactionOutcome::Rollback(Err(e));988				}989			}990			TransactionOutcome::Commit(Ok(()))991		})?;992993		<TokensMinted<T>>::insert(collection.id, tokens_minted);994		for (account, balance) in balances {995			<AccountBalance<T>>::insert((collection.id, account), balance);996		}997		for (i, data) in data.into_iter().enumerate() {998			let token = first_token + i as u32 + 1;999			<Owned<T>>::insert((collection.id, &data.owner, token), true);10001001			<PalletEvm<T>>::deposit_log(1002				ERC721Events::Transfer {1003					from: H160::default(),1004					to: *data.owner.as_eth(),1005					token_id: token.into(),1006				}1007				.to_log(collection_id_to_address(collection.id)),1008			);1009			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1010				collection.id,1011				TokenId(token),1012				data.owner.clone(),1013				1,1014			));1015		}1016		Ok(())1017	}10181019	pub fn set_allowance_unchecked(1020		collection: &NonfungibleHandle<T>,1021		sender: &T::CrossAccountId,1022		token: TokenId,1023		spender: Option<&T::CrossAccountId>,1024		assume_implicit_eth: bool,1025	) {1026		if let Some(spender) = spender {1027			let old_spender = <Allowance<T>>::get((collection.id, token));1028			<Allowance<T>>::insert((collection.id, token), spender);1029			// In ERC721 there is only one possible approved user of token, so we set1030			// approved user to spender1031			<PalletEvm<T>>::deposit_log(1032				ERC721Events::Approval {1033					owner: *sender.as_eth(),1034					approved: *spender.as_eth(),1035					token_id: token.into(),1036				}1037				.to_log(collection_id_to_address(collection.id)),1038			);1039			// In Unique chain, any token can have any amount of approved users, so we need to1040			// set allowance of old owner to 0, and allowance of new owner to 11041			if old_spender.as_ref() != Some(spender) {1042				if let Some(old_owner) = old_spender {1043					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1044						collection.id,1045						token,1046						sender.clone(),1047						old_owner,1048						0,1049					));1050				}1051				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1052					collection.id,1053					token,1054					sender.clone(),1055					spender.clone(),1056					1,1057				));1058			}1059		} else {1060			let old_spender = <Allowance<T>>::take((collection.id, token));1061			if !assume_implicit_eth {1062				// In ERC721 there is only one possible approved user of token, so we set1063				// approved user to zero address1064				<PalletEvm<T>>::deposit_log(1065					ERC721Events::Approval {1066						owner: *sender.as_eth(),1067						approved: H160::default(),1068						token_id: token.into(),1069					}1070					.to_log(collection_id_to_address(collection.id)),1071				);1072			}1073			// In Unique chain, any token can have any amount of approved users, so we need to1074			// set allowance of old owner to 01075			if let Some(old_spender) = old_spender {1076				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1077					collection.id,1078					token,1079					sender.clone(),1080					old_spender,1081					0,1082				));1083			}1084		}1085	}10861087	/// Set allowance for the spender to `transfer` or `burn` sender's token.1088	///1089	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1090	pub fn set_allowance(1091		collection: &NonfungibleHandle<T>,1092		sender: &T::CrossAccountId,1093		token: TokenId,1094		spender: Option<&T::CrossAccountId>,1095	) -> DispatchResult {1096		if collection.permissions.access() == AccessMode::AllowList {1097			collection.check_allowlist(sender)?;1098			if let Some(spender) = spender {1099				collection.check_allowlist(spender)?;1100			}1101		}11021103		if let Some(spender) = spender {1104			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1105		}11061107		let token_data =1108			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1109		if &token_data.owner != sender {1110			ensure!(1111				collection.ignores_owned_amount(sender),1112				<CommonError<T>>::CantApproveMoreThanOwned1113			);1114		}11151116		// =========11171118		Self::set_allowance_unchecked(collection, sender, token, spender, false);1119		Ok(())1120	}11211122	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1123	///1124	/// - `from`: Address of sender's eth mirror.1125	/// - `to`: Adress of spender.1126	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1127	pub fn set_allowance_from(1128		collection: &NonfungibleHandle<T>,1129		sender: &T::CrossAccountId,1130		from: &T::CrossAccountId,1131		token: TokenId,1132		to: Option<&T::CrossAccountId>,1133	) -> DispatchResult {1134		if collection.permissions.access() == AccessMode::AllowList {1135			collection.check_allowlist(sender)?;1136			collection.check_allowlist(from)?;1137			if let Some(to) = to {1138				collection.check_allowlist(to)?;1139			}1140		}11411142		if let Some(to) = to {1143			<PalletCommon<T>>::ensure_correct_receiver(to)?;1144		}11451146		ensure!(1147			sender.conv_eq(from),1148			<CommonError<T>>::AddressIsNotEthMirror1149		);11501151		let token_data =1152			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1153		if token_data.owner != *from {1154			ensure!(1155				collection.limits.owner_can_transfer()1156					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1157				<CommonError<T>>::CantApproveMoreThanOwned1158			);1159		}11601161		// =========11621163		Self::set_allowance_unchecked(collection, from, token, to, false);1164		Ok(())1165	}11661167	/// Checks allowance for the spender to use the token.1168	fn check_allowed(1169		collection: &NonfungibleHandle<T>,1170		spender: &T::CrossAccountId,1171		from: &T::CrossAccountId,1172		token: TokenId,1173		nesting_budget: &dyn Budget,1174	) -> DispatchResult {1175		if spender.conv_eq(from) {1176			return Ok(());1177		}1178		if collection.permissions.access() == AccessMode::AllowList {1179			// `from`, `to` checked in [`transfer`]1180			collection.check_allowlist(spender)?;1181		}11821183		if collection.ignores_token_restrictions(spender) {1184			return Ok(());1185		}11861187		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1188			ensure!(1189				<PalletStructure<T>>::check_indirectly_owned(1190					spender.clone(),1191					source.0,1192					source.1,1193					None,1194					nesting_budget1195				)?,1196				<CommonError<T>>::ApprovedValueTooLow,1197			);1198			return Ok(());1199		}1200		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1201			return Ok(());1202		}1203		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1204			return Ok(());1205		}12061207		Err(<CommonError<T>>::ApprovedValueTooLow.into())1208	}12091210	/// Transfer NFT token from one account to another.1211	///1212	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1213	/// The owner should set allowance for the spender to transfer token.1214	///1215	/// [`transfer`]: struct.Pallet.html#method.transfer1216	pub fn transfer_from(1217		collection: &NonfungibleHandle<T>,1218		spender: &T::CrossAccountId,1219		from: &T::CrossAccountId,1220		to: &T::CrossAccountId,1221		token: TokenId,1222		nesting_budget: &dyn Budget,1223	) -> DispatchResult {1224		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12251226		// =========12271228		// Allowance is reset in [`transfer`]1229		Self::transfer(collection, from, to, token, nesting_budget)1230	}12311232	/// Burn NFT token for `from` account.1233	///1234	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1235	/// set allowance for the spender to burn token.1236	///1237	/// [`burn`]: struct.Pallet.html#method.burn1238	pub fn burn_from(1239		collection: &NonfungibleHandle<T>,1240		spender: &T::CrossAccountId,1241		from: &T::CrossAccountId,1242		token: TokenId,1243		nesting_budget: &dyn Budget,1244	) -> DispatchResult {1245		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12461247		// =========12481249		Self::burn(collection, from, token)1250	}12511252	/// Check that `from` token could be nested in `under` token.1253	///1254	pub fn check_nesting(1255		handle: &NonfungibleHandle<T>,1256		sender: T::CrossAccountId,1257		from: (CollectionId, TokenId),1258		under: TokenId,1259		nesting_budget: &dyn Budget,1260	) -> DispatchResult {1261		let nesting = handle.permissions.nesting();12621263		#[cfg(not(feature = "runtime-benchmarks"))]1264		let permissive = false;1265		#[cfg(feature = "runtime-benchmarks")]1266		let permissive = nesting.permissive;12671268		if permissive {1269			ensure!(1270				<TokenData<T>>::contains_key((handle.id, under)),1271				<CommonError<T>>::TokenNotFound1272			);1273		} else if nesting.token_owner1274			&& <PalletStructure<T>>::check_indirectly_owned(1275				sender.clone(),1276				handle.id,1277				under,1278				Some(from),1279				nesting_budget,1280			)? {1281			// Pass, token existence and ouroboros checks are done in `check_indirectly_owned`1282		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1283			// token existence and ouroboros checks are done in `get_checked_topmost_owner`1284			let _ = <PalletStructure<T>>::get_checked_topmost_owner(1285				handle.id,1286				under,1287				Some(from),1288				nesting_budget,1289			)?1290			.ok_or(<CommonError<T>>::TokenNotFound)?;1291		} else {1292			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1293		}12941295		if let Some(whitelist) = &nesting.restricted {1296			ensure!(1297				whitelist.contains(&from.0),1298				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1299			);1300		}1301		Ok(())1302	}13031304	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1305		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1306	}13071308	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1309		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1310	}13111312	fn collection_has_tokens(collection_id: CollectionId) -> bool {1313		<TokenData<T>>::iter_prefix((collection_id,))1314			.next()1315			.is_some()1316	}13171318	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1319		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1320			.next()1321			.is_some()1322	}13231324	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1325		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1326			.map(|((child_collection_id, child_id), _)| TokenChild {1327				collection: child_collection_id,1328				token: child_id,1329			})1330			.collect()1331	}13321333	/// Mint single NFT token.1334	///1335	/// Delegated to [`create_multiple_items`]1336	///1337	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1338	pub fn create_item(1339		collection: &NonfungibleHandle<T>,1340		sender: &T::CrossAccountId,1341		data: CreateItemData<T>,1342		nesting_budget: &dyn Budget,1343	) -> DispatchResult {1344		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1345	}13461347	/// Sets or unsets the approval of a given operator.1348	///1349	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1350	/// - `owner`: Token owner1351	/// - `operator`: Operator1352	/// - `approve`: Should operator status be granted or revoked?1353	pub fn set_allowance_for_all(1354		collection: &NonfungibleHandle<T>,1355		owner: &T::CrossAccountId,1356		operator: &T::CrossAccountId,1357		approve: bool,1358	) -> DispatchResult {1359		<PalletCommon<T>>::set_allowance_for_all(1360			collection,1361			owner,1362			operator,1363			approve,1364			|| <CollectionAllowance<T>>::insert((collection.id, owner, operator), approve),1365			ERC721Events::ApprovalForAll {1366				owner: *owner.as_eth(),1367				operator: *operator.as_eth(),1368				approved: approve,1369			}1370			.to_log(collection_id_to_address(collection.id)),1371		)1372	}13731374	/// Tells whether the given `owner` approves the `operator`.1375	pub fn allowance_for_all(1376		collection: &NonfungibleHandle<T>,1377		owner: &T::CrossAccountId,1378		operator: &T::CrossAccountId,1379	) -> bool {1380		<CollectionAllowance<T>>::get((collection.id, owner, operator))1381	}13821383	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1384		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1385			properties.recompute_consumed_space();1386		});13871388		Ok(())1389	}1390}