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

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, PropertyScope, TrySetProperty, TokenChild,106	AuxPropertyValue, PropertiesPermissionMap, TokenProperties as TokenPropertiesT,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 = TokenPropertiesT,205		QueryKind = ValueQuery,206	>;207208	/// Custom data of a token that is serialized to bytes,209	/// primarily reserved for on-chain operations,210	/// normally obscured from the external users.211	///212	/// Auxiliary properties are slightly different from213	/// usual [`TokenProperties`] due to an unlimited number214	/// and separately stored and written-to key-value pairs.215	///216	/// Currently unused.217	#[pallet::storage]218	#[pallet::getter(fn token_aux_property)]219	pub type TokenAuxProperties<T: Config> = StorageNMap<220		Key = (221			Key<Twox64Concat, CollectionId>,222			Key<Twox64Concat, TokenId>,223			Key<Twox64Concat, PropertyScope>,224			Key<Twox64Concat, PropertyKey>,225		),226		Value = AuxPropertyValue,227		QueryKind = OptionQuery,228	>;229230	/// Used to enumerate tokens owned by account.231	#[pallet::storage]232	pub type Owned<T: Config> = StorageNMap<233		Key = (234			Key<Twox64Concat, CollectionId>,235			Key<Blake2_128Concat, T::CrossAccountId>,236			Key<Twox64Concat, TokenId>,237		),238		Value = bool,239		QueryKind = ValueQuery,240	>;241242	/// Used to enumerate token's children.243	#[pallet::storage]244	#[pallet::getter(fn token_children)]245	pub type TokenChildren<T: Config> = StorageNMap<246		Key = (247			Key<Twox64Concat, CollectionId>,248			Key<Twox64Concat, TokenId>,249			Key<Twox64Concat, (CollectionId, TokenId)>,250		),251		Value = bool,252		QueryKind = ValueQuery,253	>;254255	/// Amount of tokens owned by an account in a collection.256	#[pallet::storage]257	pub type AccountBalance<T: Config> = StorageNMap<258		Key = (259			Key<Twox64Concat, CollectionId>,260			Key<Blake2_128Concat, T::CrossAccountId>,261		),262		Value = u32,263		QueryKind = ValueQuery,264	>;265266	/// Allowance set by a token owner for another user to perform one of certain transactions on a token.267	#[pallet::storage]268	pub type Allowance<T: Config> = StorageNMap<269		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),270		Value = T::CrossAccountId,271		QueryKind = OptionQuery,272	>;273274	/// Operator set by a wallet owner that could perform certain transactions on all tokens in the wallet.275	#[pallet::storage]276	pub type CollectionAllowance<T: Config> = StorageNMap<277		Key = (278			Key<Twox64Concat, CollectionId>,279			Key<Blake2_128Concat, T::CrossAccountId>,280			Key<Blake2_128Concat, T::CrossAccountId>,281		),282		Value = bool,283		QueryKind = ValueQuery,284	>;285286	/// Upgrade from the old schema to properties.287	#[pallet::hooks]288	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {289		fn on_runtime_upgrade() -> Weight {290			StorageVersion::new(1).put::<Pallet<T>>();291292			Weight::zero()293		}294	}295}296297pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);298impl<T: Config> NonfungibleHandle<T> {299	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {300		Self(inner)301	}302	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {303		self.0304	}305	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {306		&mut self.0307	}308}309310impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {311	fn recorder(&self) -> &SubstrateRecorder<T> {312		self.0.recorder()313	}314	fn into_recorder(self) -> SubstrateRecorder<T> {315		self.0.into_recorder()316	}317}318impl<T: Config> Deref for NonfungibleHandle<T> {319	type Target = pallet_common::CollectionHandle<T>;320321	fn deref(&self) -> &Self::Target {322		&self.0323	}324}325326impl<T: Config> Pallet<T> {327	/// Get number of NFT tokens in collection.328	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {329		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)330	}331332	/// Check that NFT token exists.333	///334	/// - `token`: Token ID.335	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {336		<TokenData<T>>::contains_key((collection.id, token))337	}338339	/// Set the token property with the scope.340	///341	/// - `property`: Contains key-value pair.342	pub fn set_scoped_token_property(343		collection_id: CollectionId,344		token_id: TokenId,345		scope: PropertyScope,346		property: Property,347	) -> DispatchResult {348		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {349			properties.try_scoped_set(scope, property.key, property.value)350		})351		.map_err(<CommonError<T>>::from)?;352353		Ok(())354	}355356	/// Batch operation to set multiple properties with the same scope.357	pub fn set_scoped_token_properties(358		collection_id: CollectionId,359		token_id: TokenId,360		scope: PropertyScope,361		properties: impl Iterator<Item = Property>,362	) -> DispatchResult {363		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {364			stored_properties.try_scoped_set_from_iter(scope, properties)365		})366		.map_err(<CommonError<T>>::from)?;367368		Ok(())369	}370371	/// Add or edit auxiliary data for the property.372	///373	/// - `f`: function that adds or edits auxiliary data.374	pub fn try_mutate_token_aux_property<R, E>(375		collection_id: CollectionId,376		token_id: TokenId,377		scope: PropertyScope,378		key: PropertyKey,379		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,380	) -> Result<R, E> {381		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)382	}383384	/// Remove auxiliary data for the property.385	pub fn remove_token_aux_property(386		collection_id: CollectionId,387		token_id: TokenId,388		scope: PropertyScope,389		key: PropertyKey,390	) {391		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));392	}393394	/// Get all auxiliary data in a given scope.395	///396	/// Returns iterator over Property Key - Data pairs.397	pub fn iterate_token_aux_properties(398		collection_id: CollectionId,399		token_id: TokenId,400		scope: PropertyScope,401	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {402		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))403	}404405	/// Get ID of the last minted token406	pub fn current_token_id(collection_id: CollectionId) -> TokenId {407		TokenId(<TokensMinted<T>>::get(collection_id))408	}409}410411// unchecked calls skips any permission checks412impl<T: Config> Pallet<T> {413	/// Create NFT collection414	///415	/// `init_collection` will take non-refundable deposit for collection creation.416	///417	/// - `data`: Contains settings for collection limits and permissions.418	pub fn init_collection(419		owner: T::CrossAccountId,420		payer: T::CrossAccountId,421		data: CreateCollectionData<T::AccountId>,422		flags: CollectionFlags,423	) -> Result<CollectionId, DispatchError> {424		<PalletCommon<T>>::init_collection(owner, payer, data, flags)425	}426427	/// Destroy NFT collection428	///429	/// `destroy_collection` will throw error if collection contains any tokens.430	/// Only owner can destroy collection.431	pub fn destroy_collection(432		collection: NonfungibleHandle<T>,433		sender: &T::CrossAccountId,434	) -> DispatchResult {435		let id = collection.id;436437		if Self::collection_has_tokens(id) {438			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());439		}440441		// =========442443		PalletCommon::destroy_collection(collection.0, sender)?;444445		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);446		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);447		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);448		<TokensMinted<T>>::remove(id);449		<TokensBurnt<T>>::remove(id);450		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);451		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);452		let _ = <CollectionAllowance<T>>::clear_prefix((id,), u32::MAX, None);453		Ok(())454	}455456	/// Burn NFT token457	///458	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token459	/// if the token is nested.460	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.461	/// Also removes all corresponding properties and auxiliary properties.462	///463	/// - `token`: Token that should be burned464	/// - `collection`: Collection that contains the token465	pub fn burn(466		collection: &NonfungibleHandle<T>,467		sender: &T::CrossAccountId,468		token: TokenId,469	) -> DispatchResult {470		let token_data =471			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;472		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);473474		if collection.permissions.access() == AccessMode::AllowList {475			collection.check_allowlist(sender)?;476		}477478		if Self::token_has_children(collection.id, token) {479			return Err(<Error<T>>::CantBurnNftWithChildren.into());480		}481482		let burnt = <TokensBurnt<T>>::get(collection.id)483			.checked_add(1)484			.ok_or(ArithmeticError::Overflow)?;485486		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))487			.checked_sub(1)488			.ok_or(ArithmeticError::Overflow)?;489490		// =========491492		if balance == 0 {493			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));494		} else {495			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);496		}497498		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);499500		<Owned<T>>::remove((collection.id, &token_data.owner, token));501		<TokensBurnt<T>>::insert(collection.id, burnt);502		<TokenData<T>>::remove((collection.id, token));503		<TokenProperties<T>>::remove((collection.id, token));504		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);505		let old_spender = <Allowance<T>>::take((collection.id, token));506507		if let Some(old_spender) = old_spender {508			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(509				collection.id,510				token,511				token_data.owner.clone(),512				old_spender,513				0,514			));515		}516517		<PalletEvm<T>>::deposit_log(518			ERC721Events::Transfer {519				from: *token_data.owner.as_eth(),520				to: H160::default(),521				token_id: token.into(),522			}523			.to_log(collection_id_to_address(collection.id)),524		);525		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(526			collection.id,527			token,528			token_data.owner,529			1,530		));531		Ok(())532	}533534	/// Same as [`burn`] but burns all the tokens that are nested in the token first535	///536	/// - `self_budget`: Limit for searching children in depth.537	/// - `breadth_budget`: Limit of breadth of searching children.538	///539	/// [`burn`]: struct.Pallet.html#method.burn540	#[transactional]541	pub fn burn_recursively(542		collection: &NonfungibleHandle<T>,543		sender: &T::CrossAccountId,544		token: TokenId,545		self_budget: &dyn Budget,546		breadth_budget: &dyn Budget,547	) -> DispatchResultWithPostInfo {548		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);549550		let current_token_account =551			T::CrossTokenAddressMapping::token_to_address(collection.id, token);552553		let mut weight = Weight::zero();554555		// This method is transactional, if user in fact doesn't have permissions to remove token -556		// tokens removed here will be restored after rejected transaction557		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {558			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);559			let PostDispatchInfo { actual_weight, .. } =560				<PalletStructure<T>>::burn_item_recursively(561					current_token_account.clone(),562					collection,563					token,564					self_budget,565					breadth_budget,566				)?;567			if let Some(actual_weight) = actual_weight {568				weight = weight.saturating_add(actual_weight);569			}570		}571572		Self::burn(collection, sender, token)?;573		DispatchResultWithPostInfo::Ok(PostDispatchInfo {574			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),575			pays_fee: Pays::Yes,576		})577	}578579	/// A batch operation to add, edit or remove properties for a token.580	///581	/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.582	/// - `is_token_create`: Indicates that method is called during token initialization.583	///   Allows to bypass ownership check.584	///585	/// All affected properties should have `mutable` permission586	/// to be **deleted** or to be **set more than once**,587	/// and the sender should have permission to edit those properties.588	///589	/// This function fires an event for each property change.590	/// In case of an error, all the changes (including the events) will be reverted591	/// since the function is transactional.592	#[transactional]593	fn modify_token_properties(594		collection: &NonfungibleHandle<T>,595		sender: &T::CrossAccountId,596		token_id: TokenId,597		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,598		is_token_create: bool,599		nesting_budget: &dyn Budget,600	) -> DispatchResult {601		let is_token_owner = || {602			let is_owned = <PalletStructure<T>>::check_indirectly_owned(603				sender.clone(),604				collection.id,605				token_id,606				None,607				nesting_budget,608			)?;609610			Ok(is_owned)611		};612613		let stored_properties = <TokenProperties<T>>::get((collection.id, token_id));614615		<PalletCommon<T>>::modify_token_properties(616			collection,617			sender,618			token_id,619			properties_updates,620			is_token_create,621			stored_properties,622			is_token_owner,623			|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),624			erc::ERC721TokenEvent::TokenChanged {625				token_id: token_id.into(),626			}627			.to_log(T::ContractAddress::get()),628		)629	}630631	/// Batch operation to add or edit properties for the token632	///633	/// Same as [`modify_token_properties`] but doesn't allow to remove properties634	///635	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties636	pub fn set_token_properties(637		collection: &NonfungibleHandle<T>,638		sender: &T::CrossAccountId,639		token_id: TokenId,640		properties: impl Iterator<Item = Property>,641		is_token_create: bool,642		nesting_budget: &dyn Budget,643	) -> DispatchResult {644		Self::modify_token_properties(645			collection,646			sender,647			token_id,648			properties.map(|p| (p.key, Some(p.value))),649			is_token_create,650			nesting_budget,651		)652	}653654	/// Add or edit single property for the token655	///656	/// Calls [`set_token_properties`] internally657	///658	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties659	pub fn set_token_property(660		collection: &NonfungibleHandle<T>,661		sender: &T::CrossAccountId,662		token_id: TokenId,663		property: Property,664		nesting_budget: &dyn Budget,665	) -> DispatchResult {666		let is_token_create = false;667668		Self::set_token_properties(669			collection,670			sender,671			token_id,672			[property].into_iter(),673			is_token_create,674			nesting_budget,675		)676	}677678	/// Batch operation to remove properties from the token679	///680	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties681	///682	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties683	pub fn delete_token_properties(684		collection: &NonfungibleHandle<T>,685		sender: &T::CrossAccountId,686		token_id: TokenId,687		property_keys: impl Iterator<Item = PropertyKey>,688		nesting_budget: &dyn Budget,689	) -> DispatchResult {690		let is_token_create = false;691692		Self::modify_token_properties(693			collection,694			sender,695			token_id,696			property_keys.into_iter().map(|key| (key, None)),697			is_token_create,698			nesting_budget,699		)700	}701702	/// Remove single property from the token703	///704	/// Calls [`delete_token_properties`] internally705	///706	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties707	pub fn delete_token_property(708		collection: &NonfungibleHandle<T>,709		sender: &T::CrossAccountId,710		token_id: TokenId,711		property_key: PropertyKey,712		nesting_budget: &dyn Budget,713	) -> DispatchResult {714		Self::delete_token_properties(715			collection,716			sender,717			token_id,718			[property_key].into_iter(),719			nesting_budget,720		)721	}722723	/// Add or edit properties for the collection724	pub fn set_collection_properties(725		collection: &NonfungibleHandle<T>,726		sender: &T::CrossAccountId,727		properties: Vec<Property>,728	) -> DispatchResult {729		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())730	}731732	/// Remove properties from the collection733	pub fn delete_collection_properties(734		collection: &CollectionHandle<T>,735		sender: &T::CrossAccountId,736		property_keys: Vec<PropertyKey>,737	) -> DispatchResult {738		<PalletCommon<T>>::delete_collection_properties(739			collection,740			sender,741			property_keys.into_iter(),742		)743	}744745	/// Set property permissions for the token.746	///747	/// Sender should be the owner or admin of token's collection.748	pub fn set_token_property_permissions(749		collection: &CollectionHandle<T>,750		sender: &T::CrossAccountId,751		property_permissions: Vec<PropertyKeyPermission>,752	) -> DispatchResult {753		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)754	}755756	/// Set property permissions for the token with scope.757	///758	/// Sender should be the owner or admin of token's collection.759	pub fn set_scoped_token_property_permissions(760		collection: &CollectionHandle<T>,761		sender: &T::CrossAccountId,762		scope: PropertyScope,763		property_permissions: Vec<PropertyKeyPermission>,764	) -> DispatchResult {765		<PalletCommon<T>>::set_scoped_token_property_permissions(766			collection,767			sender,768			scope,769			property_permissions,770		)771	}772773	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {774		<PalletCommon<T>>::property_permissions(collection_id)775	}776777	pub fn check_token_immediate_ownership(778		collection: &NonfungibleHandle<T>,779		token: TokenId,780		possible_owner: &T::CrossAccountId,781	) -> DispatchResult {782		let token_data =783			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;784		ensure!(785			&token_data.owner == possible_owner,786			<CommonError<T>>::NoPermission787		);788		Ok(())789	}790791	/// Transfer NFT token from one account to another.792	///793	/// `from` account stops being the owner and `to` account becomes the owner of the token.794	/// If `to` is token than `to` becomes owner of the token and the token become nested.795	/// Unnests token from previous parent if it was nested before.796	/// Removes allowance for the token if there was any.797	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.798	///799	/// - `nesting_budget`: Limit for token nesting depth800	pub fn transfer(801		collection: &NonfungibleHandle<T>,802		from: &T::CrossAccountId,803		to: &T::CrossAccountId,804		token: TokenId,805		nesting_budget: &dyn Budget,806	) -> DispatchResult {807		ensure!(808			collection.limits.transfers_enabled(),809			<CommonError<T>>::TransferNotAllowed810		);811812		let token_data =813			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;814		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);815816		if collection.permissions.access() == AccessMode::AllowList {817			collection.check_allowlist(from)?;818			collection.check_allowlist(to)?;819		}820		<PalletCommon<T>>::ensure_correct_receiver(to)?;821822		let balance_from = <AccountBalance<T>>::get((collection.id, from))823			.checked_sub(1)824			.ok_or(<CommonError<T>>::TokenValueTooLow)?;825		let balance_to = if from != to {826			let balance_to = <AccountBalance<T>>::get((collection.id, to))827				.checked_add(1)828				.ok_or(ArithmeticError::Overflow)?;829830			ensure!(831				balance_to < collection.limits.account_token_ownership_limit(),832				<CommonError<T>>::AccountTokenLimitExceeded,833			);834835			Some(balance_to)836		} else {837			None838		};839840		<PalletStructure<T>>::nest_if_sent_to_token(841			from.clone(),842			to,843			collection.id,844			token,845			nesting_budget,846		)?;847848		// =========849850		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);851852		<TokenData<T>>::insert(853			(collection.id, token),854			ItemData {855				owner: to.clone(),856				..token_data857			},858		);859860		if let Some(balance_to) = balance_to {861			// from != to862			if balance_from == 0 {863				<AccountBalance<T>>::remove((collection.id, from));864			} else {865				<AccountBalance<T>>::insert((collection.id, from), balance_from);866			}867			<AccountBalance<T>>::insert((collection.id, to), balance_to);868			<Owned<T>>::remove((collection.id, from, token));869			<Owned<T>>::insert((collection.id, to, token), true);870		}871		Self::set_allowance_unchecked(collection, from, token, None, true);872873		<PalletEvm<T>>::deposit_log(874			ERC721Events::Transfer {875				from: *from.as_eth(),876				to: *to.as_eth(),877				token_id: token.into(),878			}879			.to_log(collection_id_to_address(collection.id)),880		);881		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(882			collection.id,883			token,884			from.clone(),885			to.clone(),886			1,887		));888		Ok(())889	}890891	/// Batch operation to mint multiple NFT tokens.892	///893	/// The sender should be the owner/admin of the collection or collection should be configured894	/// to allow public minting.895	/// Throws if amount of tokens reached it's limit for the collection or if caller reached896	/// token ownership limit.897	///898	/// - `data`: Contains list of token properties and users who will become the owners of the899	///   corresponging tokens.900	/// - `nesting_budget`: Limit for token nesting depth901	pub fn create_multiple_items(902		collection: &NonfungibleHandle<T>,903		sender: &T::CrossAccountId,904		data: Vec<CreateItemData<T>>,905		nesting_budget: &dyn Budget,906	) -> DispatchResult {907		if !collection.is_owner_or_admin(sender) {908			ensure!(909				collection.permissions.mint_mode(),910				<CommonError<T>>::PublicMintingNotAllowed911			);912			collection.check_allowlist(sender)?;913914			for item in data.iter() {915				collection.check_allowlist(&item.owner)?;916			}917		}918919		for data in data.iter() {920			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;921		}922923		let first_token = <TokensMinted<T>>::get(collection.id);924		let tokens_minted = first_token925			.checked_add(data.len() as u32)926			.ok_or(ArithmeticError::Overflow)?;927		ensure!(928			tokens_minted <= collection.limits.token_limit(),929			<CommonError<T>>::CollectionTokenLimitExceeded930		);931932		let mut balances = BTreeMap::new();933		for data in &data {934			let balance = balances935				.entry(&data.owner)936				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));937			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;938939			ensure!(940				*balance <= collection.limits.account_token_ownership_limit(),941				<CommonError<T>>::AccountTokenLimitExceeded,942			);943		}944945		for (i, data) in data.iter().enumerate() {946			let token = TokenId(first_token + i as u32 + 1);947948			<PalletStructure<T>>::check_nesting(949				sender.clone(),950				&data.owner,951				collection.id,952				token,953				nesting_budget,954			)?;955		}956957		// =========958959		with_transaction(|| {960			for (i, data) in data.iter().enumerate() {961				let token = first_token + i as u32 + 1;962963				<TokenData<T>>::insert(964					(collection.id, token),965					ItemData {966						// const_data: data.const_data.clone(),967						owner: data.owner.clone(),968					},969				);970971				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(972					&data.owner,973					collection.id,974					TokenId(token),975				);976977				if let Err(e) = Self::set_token_properties(978					collection,979					sender,980					TokenId(token),981					data.properties.clone().into_iter(),982					true,983					nesting_budget,984				) {985					return TransactionOutcome::Rollback(Err(e));986				}987			}988			TransactionOutcome::Commit(Ok(()))989		})?;990991		<TokensMinted<T>>::insert(collection.id, tokens_minted);992		for (account, balance) in balances {993			<AccountBalance<T>>::insert((collection.id, account), balance);994		}995		for (i, data) in data.into_iter().enumerate() {996			let token = first_token + i as u32 + 1;997			<Owned<T>>::insert((collection.id, &data.owner, token), true);998999			<PalletEvm<T>>::deposit_log(1000				ERC721Events::Transfer {1001					from: H160::default(),1002					to: *data.owner.as_eth(),1003					token_id: token.into(),1004				}1005				.to_log(collection_id_to_address(collection.id)),1006			);1007			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1008				collection.id,1009				TokenId(token),1010				data.owner.clone(),1011				1,1012			));1013		}1014		Ok(())1015	}10161017	pub fn set_allowance_unchecked(1018		collection: &NonfungibleHandle<T>,1019		sender: &T::CrossAccountId,1020		token: TokenId,1021		spender: Option<&T::CrossAccountId>,1022		assume_implicit_eth: bool,1023	) {1024		if let Some(spender) = spender {1025			let old_spender = <Allowance<T>>::get((collection.id, token));1026			<Allowance<T>>::insert((collection.id, token), spender);1027			// In ERC721 there is only one possible approved user of token, so we set1028			// approved user to spender1029			<PalletEvm<T>>::deposit_log(1030				ERC721Events::Approval {1031					owner: *sender.as_eth(),1032					approved: *spender.as_eth(),1033					token_id: token.into(),1034				}1035				.to_log(collection_id_to_address(collection.id)),1036			);1037			// In Unique chain, any token can have any amount of approved users, so we need to1038			// set allowance of old owner to 0, and allowance of new owner to 11039			if old_spender.as_ref() != Some(spender) {1040				if let Some(old_owner) = old_spender {1041					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1042						collection.id,1043						token,1044						sender.clone(),1045						old_owner,1046						0,1047					));1048				}1049				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1050					collection.id,1051					token,1052					sender.clone(),1053					spender.clone(),1054					1,1055				));1056			}1057		} else {1058			let old_spender = <Allowance<T>>::take((collection.id, token));1059			if !assume_implicit_eth {1060				// In ERC721 there is only one possible approved user of token, so we set1061				// approved user to zero address1062				<PalletEvm<T>>::deposit_log(1063					ERC721Events::Approval {1064						owner: *sender.as_eth(),1065						approved: H160::default(),1066						token_id: token.into(),1067					}1068					.to_log(collection_id_to_address(collection.id)),1069				);1070			}1071			// In Unique chain, any token can have any amount of approved users, so we need to1072			// set allowance of old owner to 01073			if let Some(old_spender) = old_spender {1074				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1075					collection.id,1076					token,1077					sender.clone(),1078					old_spender,1079					0,1080				));1081			}1082		}1083	}10841085	pub fn get_allowance(1086		collection: &NonfungibleHandle<T>,1087		token_id: TokenId,1088	) -> Result<Option<T::CrossAccountId>, DispatchError> {1089		ensure!(1090			<TokenData<T>>::get((collection.id, token_id)).is_some(),1091			<CommonError<T>>::TokenNotFound1092		);1093		Ok(<Allowance<T>>::get((collection.id, token_id)))1094	}10951096	/// Set allowance for the spender to `transfer` or `burn` sender's token.1097	///1098	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1099	pub fn set_allowance(1100		collection: &NonfungibleHandle<T>,1101		sender: &T::CrossAccountId,1102		token: TokenId,1103		spender: Option<&T::CrossAccountId>,1104	) -> DispatchResult {1105		if collection.permissions.access() == AccessMode::AllowList {1106			collection.check_allowlist(sender)?;1107			if let Some(spender) = spender {1108				collection.check_allowlist(spender)?;1109			}1110		}11111112		if let Some(spender) = spender {1113			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1114		}11151116		let token_data =1117			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1118		if &token_data.owner != sender {1119			ensure!(1120				collection.ignores_owned_amount(sender),1121				<CommonError<T>>::CantApproveMoreThanOwned1122			);1123		}11241125		// =========11261127		Self::set_allowance_unchecked(collection, sender, token, spender, false);1128		Ok(())1129	}11301131	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1132	///1133	/// - `from`: Address of sender's eth mirror.1134	/// - `to`: Adress of spender.1135	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1136	pub fn set_allowance_from(1137		collection: &NonfungibleHandle<T>,1138		sender: &T::CrossAccountId,1139		from: &T::CrossAccountId,1140		token: TokenId,1141		to: Option<&T::CrossAccountId>,1142	) -> DispatchResult {1143		if collection.permissions.access() == AccessMode::AllowList {1144			collection.check_allowlist(sender)?;1145			collection.check_allowlist(from)?;1146			if let Some(to) = to {1147				collection.check_allowlist(to)?;1148			}1149		}11501151		if let Some(to) = to {1152			<PalletCommon<T>>::ensure_correct_receiver(to)?;1153		}11541155		ensure!(1156			sender.conv_eq(from),1157			<CommonError<T>>::AddressIsNotEthMirror1158		);11591160		let token_data =1161			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1162		if token_data.owner != *from {1163			ensure!(1164				collection.limits.owner_can_transfer()1165					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1166				<CommonError<T>>::CantApproveMoreThanOwned1167			);1168		}11691170		// =========11711172		Self::set_allowance_unchecked(collection, from, token, to, false);1173		Ok(())1174	}11751176	/// Checks allowance for the spender to use the token.1177	fn check_allowed(1178		collection: &NonfungibleHandle<T>,1179		spender: &T::CrossAccountId,1180		from: &T::CrossAccountId,1181		token: TokenId,1182		nesting_budget: &dyn Budget,1183	) -> DispatchResult {1184		if spender.conv_eq(from) {1185			return Ok(());1186		}1187		if collection.permissions.access() == AccessMode::AllowList {1188			// `from`, `to` checked in [`transfer`]1189			collection.check_allowlist(spender)?;1190		}11911192		if collection.ignores_token_restrictions(spender) {1193			return Ok(());1194		}11951196		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1197			ensure!(1198				<PalletStructure<T>>::check_indirectly_owned(1199					spender.clone(),1200					source.0,1201					source.1,1202					None,1203					nesting_budget1204				)?,1205				<CommonError<T>>::ApprovedValueTooLow,1206			);1207			return Ok(());1208		}1209		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1210			return Ok(());1211		}1212		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1213			return Ok(());1214		}12151216		Err(<CommonError<T>>::ApprovedValueTooLow.into())1217	}12181219	/// Transfer NFT token from one account to another.1220	///1221	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1222	/// The owner should set allowance for the spender to transfer token.1223	///1224	/// [`transfer`]: struct.Pallet.html#method.transfer1225	pub fn transfer_from(1226		collection: &NonfungibleHandle<T>,1227		spender: &T::CrossAccountId,1228		from: &T::CrossAccountId,1229		to: &T::CrossAccountId,1230		token: TokenId,1231		nesting_budget: &dyn Budget,1232	) -> DispatchResult {1233		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12341235		// =========12361237		// Allowance is reset in [`transfer`]1238		Self::transfer(collection, from, to, token, nesting_budget)1239	}12401241	/// Burn NFT token for `from` account.1242	///1243	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1244	/// set allowance for the spender to burn token.1245	///1246	/// [`burn`]: struct.Pallet.html#method.burn1247	pub fn burn_from(1248		collection: &NonfungibleHandle<T>,1249		spender: &T::CrossAccountId,1250		from: &T::CrossAccountId,1251		token: TokenId,1252		nesting_budget: &dyn Budget,1253	) -> DispatchResult {1254		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12551256		// =========12571258		Self::burn(collection, from, token)1259	}12601261	/// Check that `from` token could be nested in `under` token.1262	///1263	pub fn check_nesting(1264		handle: &NonfungibleHandle<T>,1265		sender: T::CrossAccountId,1266		from: (CollectionId, TokenId),1267		under: TokenId,1268		nesting_budget: &dyn Budget,1269	) -> DispatchResult {1270		let nesting = handle.permissions.nesting();12711272		#[cfg(not(feature = "runtime-benchmarks"))]1273		let permissive = false;1274		#[cfg(feature = "runtime-benchmarks")]1275		let permissive = nesting.permissive;12761277		if permissive {1278			ensure!(1279				<TokenData<T>>::contains_key((handle.id, under)),1280				<CommonError<T>>::TokenNotFound1281			);1282		} else if nesting.token_owner1283			&& <PalletStructure<T>>::check_indirectly_owned(1284				sender.clone(),1285				handle.id,1286				under,1287				Some(from),1288				nesting_budget,1289			)? {1290			// Pass, token existence and ouroboros checks are done in `check_indirectly_owned`1291		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1292			// token existence and ouroboros checks are done in `get_checked_topmost_owner`1293			let _ = <PalletStructure<T>>::get_checked_topmost_owner(1294				handle.id,1295				under,1296				Some(from),1297				nesting_budget,1298			)?1299			.ok_or(<CommonError<T>>::TokenNotFound)?;1300		} else {1301			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1302		}13031304		if let Some(whitelist) = &nesting.restricted {1305			ensure!(1306				whitelist.contains(&from.0),1307				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1308			);1309		}1310		Ok(())1311	}13121313	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1314		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1315	}13161317	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1318		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1319	}13201321	fn collection_has_tokens(collection_id: CollectionId) -> bool {1322		<TokenData<T>>::iter_prefix((collection_id,))1323			.next()1324			.is_some()1325	}13261327	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1328		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1329			.next()1330			.is_some()1331	}13321333	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1334		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1335			.map(|((child_collection_id, child_id), _)| TokenChild {1336				collection: child_collection_id,1337				token: child_id,1338			})1339			.collect()1340	}13411342	/// Mint single NFT token.1343	///1344	/// Delegated to [`create_multiple_items`]1345	///1346	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1347	pub fn create_item(1348		collection: &NonfungibleHandle<T>,1349		sender: &T::CrossAccountId,1350		data: CreateItemData<T>,1351		nesting_budget: &dyn Budget,1352	) -> DispatchResult {1353		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1354	}13551356	/// Sets or unsets the approval of a given operator.1357	///1358	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1359	/// - `owner`: Token owner1360	/// - `operator`: Operator1361	/// - `approve`: Should operator status be granted or revoked?1362	pub fn set_allowance_for_all(1363		collection: &NonfungibleHandle<T>,1364		owner: &T::CrossAccountId,1365		operator: &T::CrossAccountId,1366		approve: bool,1367	) -> DispatchResult {1368		<PalletCommon<T>>::set_allowance_for_all(1369			collection,1370			owner,1371			operator,1372			approve,1373			|| <CollectionAllowance<T>>::insert((collection.id, owner, operator), approve),1374			ERC721Events::ApprovalForAll {1375				owner: *owner.as_eth(),1376				operator: *operator.as_eth(),1377				approved: approve,1378			}1379			.to_log(collection_id_to_address(collection.id)),1380		)1381	}13821383	/// Tells whether the given `owner` approves the `operator`.1384	pub fn allowance_for_all(1385		collection: &NonfungibleHandle<T>,1386		owner: &T::CrossAccountId,1387		operator: &T::CrossAccountId,1388	) -> bool {1389		<CollectionAllowance<T>>::get((collection.id, owner, operator))1390	}13911392	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1393		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1394			properties.recompute_consumed_space();1395		});13961397		Ok(())1398	}1399}