git.delta.rocks / unique-network / refs/commits / 2e3c4de7682f

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//!   Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//!   an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//!   it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//!   attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//!   with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//!   Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96	BoundedVec, ensure, fail, transactional,97	storage::with_transaction,98	pallet_prelude::DispatchResultWithPostInfo,99	pallet_prelude::Weight,100	weights::{PostDispatchInfo, Pays},101};102use up_data_structs::{103	AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,104	CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,105	PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,106	TokenChild, AuxPropertyValue,107};108use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};109use pallet_common::{110	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,111	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::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::account::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	/// Upgrade from the old schema to properties.276	#[pallet::hooks]277	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {278		fn on_runtime_upgrade() -> Weight {279			StorageVersion::new(1).put::<Pallet<T>>();280281			Weight::zero()282		}283	}284}285286pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);287impl<T: Config> NonfungibleHandle<T> {288	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {289		Self(inner)290	}291	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {292		self.0293	}294	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {295		&mut self.0296	}297}298impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {299	fn recorder(&self) -> &SubstrateRecorder<T> {300		self.0.recorder()301	}302	fn into_recorder(self) -> SubstrateRecorder<T> {303		self.0.into_recorder()304	}305}306impl<T: Config> Deref for NonfungibleHandle<T> {307	type Target = pallet_common::CollectionHandle<T>;308309	fn deref(&self) -> &Self::Target {310		&self.0311	}312}313314impl<T: Config> Pallet<T> {315	/// Get number of NFT tokens in collection.316	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {317		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)318	}319320	/// Check that NFT token exists.321	///322	/// - `token`: Token ID.323	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {324		<TokenData<T>>::contains_key((collection.id, token))325	}326327	/// Set the token property with the scope.328	///329	/// - `property`: Contains key-value pair.330	pub fn set_scoped_token_property(331		collection_id: CollectionId,332		token_id: TokenId,333		scope: PropertyScope,334		property: Property,335	) -> DispatchResult {336		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {337			properties.try_scoped_set(scope, property.key, property.value)338		})339		.map_err(<CommonError<T>>::from)?;340341		Ok(())342	}343344	/// Batch operation to set multiple properties with the same scope.345	pub fn set_scoped_token_properties(346		collection_id: CollectionId,347		token_id: TokenId,348		scope: PropertyScope,349		properties: impl Iterator<Item = Property>,350	) -> DispatchResult {351		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {352			stored_properties.try_scoped_set_from_iter(scope, properties)353		})354		.map_err(<CommonError<T>>::from)?;355356		Ok(())357	}358359	/// Add or edit auxiliary data for the property.360	///361	/// - `f`: function that adds or edits auxiliary data.362	pub fn try_mutate_token_aux_property<R, E>(363		collection_id: CollectionId,364		token_id: TokenId,365		scope: PropertyScope,366		key: PropertyKey,367		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,368	) -> Result<R, E> {369		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)370	}371372	/// Remove auxiliary data for the property.373	pub fn remove_token_aux_property(374		collection_id: CollectionId,375		token_id: TokenId,376		scope: PropertyScope,377		key: PropertyKey,378	) {379		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));380	}381382	/// Get all auxiliary data in a given scope.383	///384	/// Returns iterator over Property Key - Data pairs.385	pub fn iterate_token_aux_properties(386		collection_id: CollectionId,387		token_id: TokenId,388		scope: PropertyScope,389	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {390		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))391	}392393	/// Get ID of the last minted token394	pub fn current_token_id(collection_id: CollectionId) -> TokenId {395		TokenId(<TokensMinted<T>>::get(collection_id))396	}397}398399// unchecked calls skips any permission checks400impl<T: Config> Pallet<T> {401	/// Create NFT collection402	///403	/// `init_collection` will take non-refundable deposit for collection creation.404	///405	/// - `data`: Contains settings for collection limits and permissions.406	pub fn init_collection(407		owner: T::CrossAccountId,408		payer: T::CrossAccountId,409		data: CreateCollectionData<T::AccountId>,410		is_external: bool,411	) -> Result<CollectionId, DispatchError> {412		<PalletCommon<T>>::init_collection(413			owner,414			payer,415			data,416			CollectionFlags {417				external: is_external,418				..Default::default()419			},420		)421	}422423	/// Destroy NFT collection424	///425	/// `destroy_collection` will throw error if collection contains any tokens.426	/// Only owner can destroy collection.427	pub fn destroy_collection(428		collection: NonfungibleHandle<T>,429		sender: &T::CrossAccountId,430	) -> DispatchResult {431		let id = collection.id;432433		if Self::collection_has_tokens(id) {434			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());435		}436437		// =========438439		PalletCommon::destroy_collection(collection.0, sender)?;440441		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);442		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);443		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);444		<TokensMinted<T>>::remove(id);445		<TokensBurnt<T>>::remove(id);446		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);447		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);448		Ok(())449	}450451	/// Burn NFT token452	///453	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token454	/// if the token is nested.455	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.456	/// Also removes all corresponding properties and auxiliary properties.457	///458	/// - `token`: Token that should be burned459	/// - `collection`: Collection that contains the token460	pub fn burn(461		collection: &NonfungibleHandle<T>,462		sender: &T::CrossAccountId,463		token: TokenId,464	) -> DispatchResult {465		let token_data =466			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;467		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);468469		if collection.permissions.access() == AccessMode::AllowList {470			collection.check_allowlist(sender)?;471		}472473		if Self::token_has_children(collection.id, token) {474			return Err(<Error<T>>::CantBurnNftWithChildren.into());475		}476477		let burnt = <TokensBurnt<T>>::get(collection.id)478			.checked_add(1)479			.ok_or(ArithmeticError::Overflow)?;480481		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))482			.checked_sub(1)483			.ok_or(ArithmeticError::Overflow)?;484485		// =========486487		if balance == 0 {488			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));489		} else {490			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);491		}492493		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);494495		<Owned<T>>::remove((collection.id, &token_data.owner, token));496		<TokensBurnt<T>>::insert(collection.id, burnt);497		<TokenData<T>>::remove((collection.id, token));498		<TokenProperties<T>>::remove((collection.id, token));499		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);500		let old_spender = <Allowance<T>>::take((collection.id, token));501502		if let Some(old_spender) = old_spender {503			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(504				collection.id,505				token,506				token_data.owner.clone(),507				old_spender,508				0,509			));510		}511512		<PalletEvm<T>>::deposit_log(513			ERC721Events::Transfer {514				from: *token_data.owner.as_eth(),515				to: H160::default(),516				token_id: token.into(),517			}518			.to_log(collection_id_to_address(collection.id)),519		);520		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(521			collection.id,522			token,523			token_data.owner,524			1,525		));526		Ok(())527	}528529	/// Same as [`burn`] but burns all the tokens that are nested in the token first530	///531	/// - `self_budget`: Limit for searching children in depth.532	/// - `breadth_budget`: Limit of breadth of searching children.533	///534	/// [`burn`]: struct.Pallet.html#method.burn535	#[transactional]536	pub fn burn_recursively(537		collection: &NonfungibleHandle<T>,538		sender: &T::CrossAccountId,539		token: TokenId,540		self_budget: &dyn Budget,541		breadth_budget: &dyn Budget,542	) -> DispatchResultWithPostInfo {543		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);544545		let current_token_account =546			T::CrossTokenAddressMapping::token_to_address(collection.id, token);547548		let mut weight = Weight::zero();549550		// This method is transactional, if user in fact doesn't have permissions to remove token -551		// tokens removed here will be restored after rejected transaction552		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {553			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);554			let PostDispatchInfo { actual_weight, .. } =555				<PalletStructure<T>>::burn_item_recursively(556					current_token_account.clone(),557					collection,558					token,559					self_budget,560					breadth_budget,561				)?;562			if let Some(actual_weight) = actual_weight {563				weight = weight.saturating_add(actual_weight);564			}565		}566567		Self::burn(collection, sender, token)?;568		DispatchResultWithPostInfo::Ok(PostDispatchInfo {569			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),570			pays_fee: Pays::Yes,571		})572	}573574	/// Batch operation to add, edit or remove properties for the token575	///576	/// All affected properties should have mutable permission and sender should have577	/// permission to edit those properties.578	///579	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.580	/// - `is_token_create`: Indicates that method is called during token initialization.581	///   Allows to bypass ownership check.582	#[transactional]583	fn modify_token_properties(584		collection: &NonfungibleHandle<T>,585		sender: &T::CrossAccountId,586		token_id: TokenId,587		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,588		is_token_create: bool,589		nesting_budget: &dyn Budget,590	) -> DispatchResult {591		let mut collection_admin_status = None;592		let mut token_owner_result = None;593594		let mut is_collection_admin =595			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));596597		let mut is_token_owner = || {598			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {599				let is_owned = <PalletStructure<T>>::check_indirectly_owned(600					sender.clone(),601					collection.id,602					token_id,603					None,604					nesting_budget,605				)?;606607				Ok(is_owned)608			})609		};610611		for (key, value) in properties {612			let permission = <PalletCommon<T>>::property_permissions(collection.id)613				.get(&key)614				.cloned()615				.unwrap_or_else(PropertyPermission::none);616617			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))618				.get(&key)619				.is_some();620621			match permission {622				PropertyPermission { mutable: false, .. } if is_property_exists => {623					return Err(<CommonError<T>>::NoPermission.into());624				}625626				PropertyPermission {627					collection_admin,628					token_owner,629					..630				} => {631					//TODO: investigate threats during public minting.632					if is_token_create && (collection_admin || token_owner) && value.is_some() {633						// Pass634					} else if collection_admin && is_collection_admin() {635						// Pass636					} else if token_owner && is_token_owner()? {637						// Pass638					} else {639						fail!(<CommonError<T>>::NoPermission);640					}641				}642			}643644			match value {645				Some(value) => {646					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {647						properties.try_set(key.clone(), value)648					})649					.map_err(<CommonError<T>>::from)?;650651					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(652						collection.id,653						token_id,654						key,655					));656				}657				None => {658					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {659						properties.remove(&key)660					})661					.map_err(<CommonError<T>>::from)?;662663					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(664						collection.id,665						token_id,666						key,667					));668				}669			}670		}671672		Ok(())673	}674675	/// Batch operation to add or edit properties for the token676	///677	/// Same as [`modify_token_properties`] but doesn't allow to remove properties678	///679	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties680	pub fn set_token_properties(681		collection: &NonfungibleHandle<T>,682		sender: &T::CrossAccountId,683		token_id: TokenId,684		properties: impl Iterator<Item = Property>,685		is_token_create: bool,686		nesting_budget: &dyn Budget,687	) -> DispatchResult {688		Self::modify_token_properties(689			collection,690			sender,691			token_id,692			properties.map(|p| (p.key, Some(p.value))),693			is_token_create,694			nesting_budget,695		)696	}697698	/// Add or edit single property for the token699	///700	/// Calls [`set_token_properties`] internally701	///702	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties703	pub fn set_token_property(704		collection: &NonfungibleHandle<T>,705		sender: &T::CrossAccountId,706		token_id: TokenId,707		property: Property,708		nesting_budget: &dyn Budget,709	) -> DispatchResult {710		let is_token_create = false;711712		Self::set_token_properties(713			collection,714			sender,715			token_id,716			[property].into_iter(),717			is_token_create,718			nesting_budget,719		)720	}721722	/// Batch operation to remove properties from the token723	///724	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties725	///726	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties727	pub fn delete_token_properties(728		collection: &NonfungibleHandle<T>,729		sender: &T::CrossAccountId,730		token_id: TokenId,731		property_keys: impl Iterator<Item = PropertyKey>,732		nesting_budget: &dyn Budget,733	) -> DispatchResult {734		let is_token_create = false;735736		Self::modify_token_properties(737			collection,738			sender,739			token_id,740			property_keys.into_iter().map(|key| (key, None)),741			is_token_create,742			nesting_budget,743		)744	}745746	/// Remove single property from the token747	///748	/// Calls [`delete_token_properties`] internally749	///750	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties751	pub fn delete_token_property(752		collection: &NonfungibleHandle<T>,753		sender: &T::CrossAccountId,754		token_id: TokenId,755		property_key: PropertyKey,756		nesting_budget: &dyn Budget,757	) -> DispatchResult {758		Self::delete_token_properties(759			collection,760			sender,761			token_id,762			[property_key].into_iter(),763			nesting_budget,764		)765	}766767	/// Add or edit properties for the collection768	pub fn set_collection_properties(769		collection: &NonfungibleHandle<T>,770		sender: &T::CrossAccountId,771		properties: Vec<Property>,772	) -> DispatchResult {773		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)774	}775776	/// Remove properties from the collection777	pub fn delete_collection_properties(778		collection: &CollectionHandle<T>,779		sender: &T::CrossAccountId,780		property_keys: Vec<PropertyKey>,781	) -> DispatchResult {782		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)783	}784785	/// Set property permissions for the token.786	///787	/// Sender should be the owner or admin of token's collection.788	pub fn set_token_property_permissions(789		collection: &CollectionHandle<T>,790		sender: &T::CrossAccountId,791		property_permissions: Vec<PropertyKeyPermission>,792	) -> DispatchResult {793		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)794	}795796	/// Set property permissions for the token with scope.797	///798	/// Sender should be the owner or admin of token's collection.799	pub fn set_scoped_token_property_permissions(800		collection: &CollectionHandle<T>,801		sender: &T::CrossAccountId,802		scope: PropertyScope,803		property_permissions: Vec<PropertyKeyPermission>,804	) -> DispatchResult {805		<PalletCommon<T>>::set_scoped_token_property_permissions(806			collection,807			sender,808			scope,809			property_permissions,810		)811	}812813	/// Set property permissions for the collection.814	///815	/// Sender should be the owner or admin of the collection.816	pub fn set_property_permission(817		collection: &CollectionHandle<T>,818		sender: &T::CrossAccountId,819		permission: PropertyKeyPermission,820	) -> DispatchResult {821		<PalletCommon<T>>::set_property_permission(collection, sender, permission)822	}823824	/// Transfer NFT token from one account to another.825	///826	/// `from` account stops being the owner and `to` account becomes the owner of the token.827	/// If `to` is token than `to` becomes owner of the token and the token become nested.828	/// Unnests token from previous parent if it was nested before.829	/// Removes allowance for the token if there was any.830	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.831	///832	/// - `nesting_budget`: Limit for token nesting depth833	pub fn transfer(834		collection: &NonfungibleHandle<T>,835		from: &T::CrossAccountId,836		to: &T::CrossAccountId,837		token: TokenId,838		nesting_budget: &dyn Budget,839	) -> DispatchResult {840		ensure!(841			collection.limits.transfers_enabled(),842			<CommonError<T>>::TransferNotAllowed843		);844845		let token_data =846			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;847		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);848849		if collection.permissions.access() == AccessMode::AllowList {850			collection.check_allowlist(from)?;851			collection.check_allowlist(to)?;852		}853		<PalletCommon<T>>::ensure_correct_receiver(to)?;854855		let balance_from = <AccountBalance<T>>::get((collection.id, from))856			.checked_sub(1)857			.ok_or(<CommonError<T>>::TokenValueTooLow)?;858		let balance_to = if from != to {859			let balance_to = <AccountBalance<T>>::get((collection.id, to))860				.checked_add(1)861				.ok_or(ArithmeticError::Overflow)?;862863			ensure!(864				balance_to < collection.limits.account_token_ownership_limit(),865				<CommonError<T>>::AccountTokenLimitExceeded,866			);867868			Some(balance_to)869		} else {870			None871		};872873		<PalletStructure<T>>::nest_if_sent_to_token(874			from.clone(),875			to,876			collection.id,877			token,878			nesting_budget,879		)?;880881		// =========882883		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);884885		<TokenData<T>>::insert(886			(collection.id, token),887			ItemData {888				owner: to.clone(),889				..token_data890			},891		);892893		if let Some(balance_to) = balance_to {894			// from != to895			if balance_from == 0 {896				<AccountBalance<T>>::remove((collection.id, from));897			} else {898				<AccountBalance<T>>::insert((collection.id, from), balance_from);899			}900			<AccountBalance<T>>::insert((collection.id, to), balance_to);901			<Owned<T>>::remove((collection.id, from, token));902			<Owned<T>>::insert((collection.id, to, token), true);903		}904		Self::set_allowance_unchecked(collection, from, token, None, true);905906		<PalletEvm<T>>::deposit_log(907			ERC721Events::Transfer {908				from: *from.as_eth(),909				to: *to.as_eth(),910				token_id: token.into(),911			}912			.to_log(collection_id_to_address(collection.id)),913		);914		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(915			collection.id,916			token,917			from.clone(),918			to.clone(),919			1,920		));921		Ok(())922	}923924	/// Batch operation to mint multiple NFT tokens.925	///926	/// The sender should be the owner/admin of the collection or collection should be configured927	/// to allow public minting.928	/// Throws if amount of tokens reached it's limit for the collection or if caller reached929	/// token ownership limit.930	///931	/// - `data`: Contains list of token properties and users who will become the owners of the932	///   corresponging tokens.933	/// - `nesting_budget`: Limit for token nesting depth934	pub fn create_multiple_items(935		collection: &NonfungibleHandle<T>,936		sender: &T::CrossAccountId,937		data: Vec<CreateItemData<T>>,938		nesting_budget: &dyn Budget,939	) -> DispatchResult {940		if !collection.is_owner_or_admin(sender) {941			ensure!(942				collection.permissions.mint_mode(),943				<CommonError<T>>::PublicMintingNotAllowed944			);945			collection.check_allowlist(sender)?;946947			for item in data.iter() {948				collection.check_allowlist(&item.owner)?;949			}950		}951952		for data in data.iter() {953			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;954		}955956		let first_token = <TokensMinted<T>>::get(collection.id);957		let tokens_minted = first_token958			.checked_add(data.len() as u32)959			.ok_or(ArithmeticError::Overflow)?;960		ensure!(961			tokens_minted <= collection.limits.token_limit(),962			<CommonError<T>>::CollectionTokenLimitExceeded963		);964965		let mut balances = BTreeMap::new();966		for data in &data {967			let balance = balances968				.entry(&data.owner)969				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));970			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;971972			ensure!(973				*balance <= collection.limits.account_token_ownership_limit(),974				<CommonError<T>>::AccountTokenLimitExceeded,975			);976		}977978		for (i, data) in data.iter().enumerate() {979			let token = TokenId(first_token + i as u32 + 1);980981			<PalletStructure<T>>::check_nesting(982				sender.clone(),983				&data.owner,984				collection.id,985				token,986				nesting_budget,987			)?;988		}989990		// =========991992		with_transaction(|| {993			for (i, data) in data.iter().enumerate() {994				let token = first_token + i as u32 + 1;995996				<TokenData<T>>::insert(997					(collection.id, token),998					ItemData {999						// const_data: data.const_data.clone(),1000						owner: data.owner.clone(),1001					},1002				);10031004				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1005					&data.owner,1006					collection.id,1007					TokenId(token),1008				);10091010				if let Err(e) = Self::set_token_properties(1011					collection,1012					sender,1013					TokenId(token),1014					data.properties.clone().into_iter(),1015					true,1016					nesting_budget,1017				) {1018					return TransactionOutcome::Rollback(Err(e));1019				}1020			}1021			TransactionOutcome::Commit(Ok(()))1022		})?;10231024		<TokensMinted<T>>::insert(collection.id, tokens_minted);1025		for (account, balance) in balances {1026			<AccountBalance<T>>::insert((collection.id, account), balance);1027		}1028		for (i, data) in data.into_iter().enumerate() {1029			let token = first_token + i as u32 + 1;1030			<Owned<T>>::insert((collection.id, &data.owner, token), true);10311032			<PalletEvm<T>>::deposit_log(1033				ERC721Events::Transfer {1034					from: H160::default(),1035					to: *data.owner.as_eth(),1036					token_id: token.into(),1037				}1038				.to_log(collection_id_to_address(collection.id)),1039			);1040			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1041				collection.id,1042				TokenId(token),1043				data.owner.clone(),1044				1,1045			));1046		}1047		Ok(())1048	}10491050	pub fn set_allowance_unchecked(1051		collection: &NonfungibleHandle<T>,1052		sender: &T::CrossAccountId,1053		token: TokenId,1054		spender: Option<&T::CrossAccountId>,1055		assume_implicit_eth: bool,1056	) {1057		if let Some(spender) = spender {1058			let old_spender = <Allowance<T>>::get((collection.id, token));1059			<Allowance<T>>::insert((collection.id, token), spender);1060			// In ERC721 there is only one possible approved user of token, so we set1061			// approved user to spender1062			<PalletEvm<T>>::deposit_log(1063				ERC721Events::Approval {1064					owner: *sender.as_eth(),1065					approved: *spender.as_eth(),1066					token_id: token.into(),1067				}1068				.to_log(collection_id_to_address(collection.id)),1069			);1070			// In Unique chain, any token can have any amount of approved users, so we need to1071			// set allowance of old owner to 0, and allowance of new owner to 11072			if old_spender.as_ref() != Some(spender) {1073				if let Some(old_owner) = old_spender {1074					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1075						collection.id,1076						token,1077						sender.clone(),1078						old_owner,1079						0,1080					));1081				}1082				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1083					collection.id,1084					token,1085					sender.clone(),1086					spender.clone(),1087					1,1088				));1089			}1090		} else {1091			let old_spender = <Allowance<T>>::take((collection.id, token));1092			if !assume_implicit_eth {1093				// In ERC721 there is only one possible approved user of token, so we set1094				// approved user to zero address1095				<PalletEvm<T>>::deposit_log(1096					ERC721Events::Approval {1097						owner: *sender.as_eth(),1098						approved: H160::default(),1099						token_id: token.into(),1100					}1101					.to_log(collection_id_to_address(collection.id)),1102				);1103			}1104			// In Unique chain, any token can have any amount of approved users, so we need to1105			// set allowance of old owner to 01106			if let Some(old_spender) = old_spender {1107				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1108					collection.id,1109					token,1110					sender.clone(),1111					old_spender,1112					0,1113				));1114			}1115		}1116	}11171118	/// Set allowance for the spender to `transfer` or `burn` sender's token.1119	///1120	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1121	pub fn set_allowance(1122		collection: &NonfungibleHandle<T>,1123		sender: &T::CrossAccountId,1124		token: TokenId,1125		spender: Option<&T::CrossAccountId>,1126	) -> DispatchResult {1127		if collection.permissions.access() == AccessMode::AllowList {1128			collection.check_allowlist(sender)?;1129			if let Some(spender) = spender {1130				collection.check_allowlist(spender)?;1131			}1132		}11331134		if let Some(spender) = spender {1135			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1136		}11371138		let token_data =1139			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1140		if &token_data.owner != sender {1141			ensure!(1142				collection.ignores_owned_amount(sender),1143				<CommonError<T>>::CantApproveMoreThanOwned1144			);1145		}11461147		// =========11481149		Self::set_allowance_unchecked(collection, sender, token, spender, false);1150		Ok(())1151	}11521153	/// Checks allowance for the spender to use the token.1154	fn check_allowed(1155		collection: &NonfungibleHandle<T>,1156		spender: &T::CrossAccountId,1157		from: &T::CrossAccountId,1158		token: TokenId,1159		nesting_budget: &dyn Budget,1160	) -> DispatchResult {1161		if spender.conv_eq(from) {1162			return Ok(());1163		}1164		if collection.permissions.access() == AccessMode::AllowList {1165			// `from`, `to` checked in [`transfer`]1166			collection.check_allowlist(spender)?;1167		}11681169		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1170			return Ok(());1171		}11721173		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1174			ensure!(1175				<PalletStructure<T>>::check_indirectly_owned(1176					spender.clone(),1177					source.0,1178					source.1,1179					None,1180					nesting_budget1181				)?,1182				<CommonError<T>>::ApprovedValueTooLow,1183			);1184			return Ok(());1185		}1186		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1187			return Ok(());1188		}1189		ensure!(1190			collection.ignores_allowance(spender),1191			<CommonError<T>>::ApprovedValueTooLow1192		);1193		Ok(())1194	}11951196	/// Transfer NFT token from one account to another.1197	///1198	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1199	/// The owner should set allowance for the spender to transfer token.1200	///1201	/// [`transfer`]: struct.Pallet.html#method.transfer1202	pub fn transfer_from(1203		collection: &NonfungibleHandle<T>,1204		spender: &T::CrossAccountId,1205		from: &T::CrossAccountId,1206		to: &T::CrossAccountId,1207		token: TokenId,1208		nesting_budget: &dyn Budget,1209	) -> DispatchResult {1210		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12111212		// =========12131214		// Allowance is reset in [`transfer`]1215		Self::transfer(collection, from, to, token, nesting_budget)1216	}12171218	/// Burn NFT token for `from` account.1219	///1220	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1221	/// set allowance for the spender to burn token.1222	///1223	/// [`burn`]: struct.Pallet.html#method.burn1224	pub fn burn_from(1225		collection: &NonfungibleHandle<T>,1226		spender: &T::CrossAccountId,1227		from: &T::CrossAccountId,1228		token: TokenId,1229		nesting_budget: &dyn Budget,1230	) -> DispatchResult {1231		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12321233		// =========12341235		Self::burn(collection, from, token)1236	}12371238	/// Check that `from` token could be nested in `under` token.1239	///1240	pub fn check_nesting(1241		handle: &NonfungibleHandle<T>,1242		sender: T::CrossAccountId,1243		from: (CollectionId, TokenId),1244		under: TokenId,1245		nesting_budget: &dyn Budget,1246	) -> DispatchResult {1247		let nesting = handle.permissions.nesting();12481249		#[cfg(not(feature = "runtime-benchmarks"))]1250		let permissive = false;1251		#[cfg(feature = "runtime-benchmarks")]1252		let permissive = nesting.permissive;12531254		if permissive {1255			// Pass1256		} else if nesting.token_owner1257			&& <PalletStructure<T>>::check_indirectly_owned(1258				sender.clone(),1259				handle.id,1260				under,1261				Some(from),1262				nesting_budget,1263			)? {1264			// Pass1265		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1266			// Pass1267		} else {1268			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1269		}12701271		if let Some(whitelist) = &nesting.restricted {1272			ensure!(1273				whitelist.contains(&from.0),1274				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1275			);1276		}1277		Ok(())1278	}12791280	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1281		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1282	}12831284	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1285		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1286	}12871288	fn collection_has_tokens(collection_id: CollectionId) -> bool {1289		<TokenData<T>>::iter_prefix((collection_id,))1290			.next()1291			.is_some()1292	}12931294	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1295		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1296			.next()1297			.is_some()1298	}12991300	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1301		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1302			.map(|((child_collection_id, child_id), _)| TokenChild {1303				collection: child_collection_id,1304				token: child_id,1305			})1306			.collect()1307	}13081309	/// Mint single NFT token.1310	///1311	/// Delegated to [`create_multiple_items`]1312	///1313	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1314	pub fn create_item(1315		collection: &NonfungibleHandle<T>,1316		sender: &T::CrossAccountId,1317		data: CreateItemData<T>,1318		nesting_budget: &dyn Budget,1319	) -> DispatchResult {1320		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1321	}1322}