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

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}298299impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {300	fn recorder(&self) -> &SubstrateRecorder<T> {301		self.0.recorder()302	}303	fn into_recorder(self) -> SubstrateRecorder<T> {304		self.0.into_recorder()305	}306}307impl<T: Config> Deref for NonfungibleHandle<T> {308	type Target = pallet_common::CollectionHandle<T>;309310	fn deref(&self) -> &Self::Target {311		&self.0312	}313}314315impl<T: Config> Pallet<T> {316	/// Get number of NFT tokens in collection.317	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {318		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)319	}320321	/// Check that NFT token exists.322	///323	/// - `token`: Token ID.324	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {325		<TokenData<T>>::contains_key((collection.id, token))326	}327328	/// Set the token property with the scope.329	///330	/// - `property`: Contains key-value pair.331	pub fn set_scoped_token_property(332		collection_id: CollectionId,333		token_id: TokenId,334		scope: PropertyScope,335		property: Property,336	) -> DispatchResult {337		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {338			properties.try_scoped_set(scope, property.key, property.value)339		})340		.map_err(<CommonError<T>>::from)?;341342		Ok(())343	}344345	/// Batch operation to set multiple properties with the same scope.346	pub fn set_scoped_token_properties(347		collection_id: CollectionId,348		token_id: TokenId,349		scope: PropertyScope,350		properties: impl Iterator<Item = Property>,351	) -> DispatchResult {352		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {353			stored_properties.try_scoped_set_from_iter(scope, properties)354		})355		.map_err(<CommonError<T>>::from)?;356357		Ok(())358	}359360	/// Add or edit auxiliary data for the property.361	///362	/// - `f`: function that adds or edits auxiliary data.363	pub fn try_mutate_token_aux_property<R, E>(364		collection_id: CollectionId,365		token_id: TokenId,366		scope: PropertyScope,367		key: PropertyKey,368		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,369	) -> Result<R, E> {370		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)371	}372373	/// Remove auxiliary data for the property.374	pub fn remove_token_aux_property(375		collection_id: CollectionId,376		token_id: TokenId,377		scope: PropertyScope,378		key: PropertyKey,379	) {380		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));381	}382383	/// Get all auxiliary data in a given scope.384	///385	/// Returns iterator over Property Key - Data pairs.386	pub fn iterate_token_aux_properties(387		collection_id: CollectionId,388		token_id: TokenId,389		scope: PropertyScope,390	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {391		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))392	}393394	/// Get ID of the last minted token395	pub fn current_token_id(collection_id: CollectionId) -> TokenId {396		TokenId(<TokensMinted<T>>::get(collection_id))397	}398}399400// unchecked calls skips any permission checks401impl<T: Config> Pallet<T> {402	/// Create NFT collection403	///404	/// `init_collection` will take non-refundable deposit for collection creation.405	///406	/// - `data`: Contains settings for collection limits and permissions.407	pub fn init_collection(408		owner: T::CrossAccountId,409		payer: T::CrossAccountId,410		data: CreateCollectionData<T::AccountId>,411		is_external: bool,412	) -> Result<CollectionId, DispatchError> {413		<PalletCommon<T>>::init_collection(414			owner,415			payer,416			data,417			CollectionFlags {418				external: is_external,419				..Default::default()420			},421		)422	}423424	/// Destroy NFT collection425	///426	/// `destroy_collection` will throw error if collection contains any tokens.427	/// Only owner can destroy collection.428	pub fn destroy_collection(429		collection: NonfungibleHandle<T>,430		sender: &T::CrossAccountId,431	) -> DispatchResult {432		let id = collection.id;433434		if Self::collection_has_tokens(id) {435			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());436		}437438		// =========439440		PalletCommon::destroy_collection(collection.0, sender)?;441442		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);443		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);444		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);445		<TokensMinted<T>>::remove(id);446		<TokensBurnt<T>>::remove(id);447		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);448		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);449		Ok(())450	}451452	/// Burn NFT token453	///454	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token455	/// if the token is nested.456	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.457	/// Also removes all corresponding properties and auxiliary properties.458	///459	/// - `token`: Token that should be burned460	/// - `collection`: Collection that contains the token461	pub fn burn(462		collection: &NonfungibleHandle<T>,463		sender: &T::CrossAccountId,464		token: TokenId,465	) -> DispatchResult {466		let token_data =467			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;468		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);469470		if collection.permissions.access() == AccessMode::AllowList {471			collection.check_allowlist(sender)?;472		}473474		if Self::token_has_children(collection.id, token) {475			return Err(<Error<T>>::CantBurnNftWithChildren.into());476		}477478		let burnt = <TokensBurnt<T>>::get(collection.id)479			.checked_add(1)480			.ok_or(ArithmeticError::Overflow)?;481482		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))483			.checked_sub(1)484			.ok_or(ArithmeticError::Overflow)?;485486		// =========487488		if balance == 0 {489			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));490		} else {491			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);492		}493494		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);495496		<Owned<T>>::remove((collection.id, &token_data.owner, token));497		<TokensBurnt<T>>::insert(collection.id, burnt);498		<TokenData<T>>::remove((collection.id, token));499		<TokenProperties<T>>::remove((collection.id, token));500		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);501		let old_spender = <Allowance<T>>::take((collection.id, token));502503		if let Some(old_spender) = old_spender {504			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(505				collection.id,506				token,507				token_data.owner.clone(),508				old_spender,509				0,510			));511		}512513		<PalletEvm<T>>::deposit_log(514			ERC721Events::Transfer {515				from: *token_data.owner.as_eth(),516				to: H160::default(),517				token_id: token.into(),518			}519			.to_log(collection_id_to_address(collection.id)),520		);521		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(522			collection.id,523			token,524			token_data.owner,525			1,526		));527		Ok(())528	}529530	/// Same as [`burn`] but burns all the tokens that are nested in the token first531	///532	/// - `self_budget`: Limit for searching children in depth.533	/// - `breadth_budget`: Limit of breadth of searching children.534	///535	/// [`burn`]: struct.Pallet.html#method.burn536	#[transactional]537	pub fn burn_recursively(538		collection: &NonfungibleHandle<T>,539		sender: &T::CrossAccountId,540		token: TokenId,541		self_budget: &dyn Budget,542		breadth_budget: &dyn Budget,543	) -> DispatchResultWithPostInfo {544		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);545546		let current_token_account =547			T::CrossTokenAddressMapping::token_to_address(collection.id, token);548549		let mut weight = Weight::zero();550551		// This method is transactional, if user in fact doesn't have permissions to remove token -552		// tokens removed here will be restored after rejected transaction553		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {554			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);555			let PostDispatchInfo { actual_weight, .. } =556				<PalletStructure<T>>::burn_item_recursively(557					current_token_account.clone(),558					collection,559					token,560					self_budget,561					breadth_budget,562				)?;563			if let Some(actual_weight) = actual_weight {564				weight = weight.saturating_add(actual_weight);565			}566		}567568		Self::burn(collection, sender, token)?;569		DispatchResultWithPostInfo::Ok(PostDispatchInfo {570			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),571			pays_fee: Pays::Yes,572		})573	}574575	/// Batch operation to add, edit or remove properties for the token576	///577	/// All affected properties should have mutable permission and sender should have578	/// permission to edit those properties.579	///580	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.581	/// - `is_token_create`: Indicates that method is called during token initialization.582	///   Allows to bypass ownership check.583	#[transactional]584	fn modify_token_properties(585		collection: &NonfungibleHandle<T>,586		sender: &T::CrossAccountId,587		token_id: TokenId,588		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,589		is_token_create: bool,590		nesting_budget: &dyn Budget,591	) -> DispatchResult {592		let mut collection_admin_status = None;593		let mut token_owner_result = None;594595		let mut is_collection_admin =596			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));597598		let mut is_token_owner = || {599			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {600				let is_owned = <PalletStructure<T>>::check_indirectly_owned(601					sender.clone(),602					collection.id,603					token_id,604					None,605					nesting_budget,606				)?;607608				Ok(is_owned)609			})610		};611612		for (key, value) in properties {613			let permission = <PalletCommon<T>>::property_permissions(collection.id)614				.get(&key)615				.cloned()616				.unwrap_or_else(PropertyPermission::none);617618			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))619				.get(&key)620				.is_some();621622			match permission {623				PropertyPermission { mutable: false, .. } if is_property_exists => {624					return Err(<CommonError<T>>::NoPermission.into());625				}626627				PropertyPermission {628					collection_admin,629					token_owner,630					..631				} => {632					//TODO: investigate threats during public minting.633					if is_token_create && (collection_admin || token_owner) && value.is_some() {634						// Pass635					} else if collection_admin && is_collection_admin() {636						// Pass637					} else if token_owner && is_token_owner()? {638						// Pass639					} else {640						fail!(<CommonError<T>>::NoPermission);641					}642				}643			}644645			match value {646				Some(value) => {647					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {648						properties.try_set(key.clone(), value)649					})650					.map_err(<CommonError<T>>::from)?;651652					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(653						collection.id,654						token_id,655						key,656					));657				}658				None => {659					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {660						properties.remove(&key)661					})662					.map_err(<CommonError<T>>::from)?;663664					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(665						collection.id,666						token_id,667						key,668					));669				}670			}671		}672673		Ok(())674	}675676	/// Batch operation to add or edit properties for the token677	///678	/// Same as [`modify_token_properties`] but doesn't allow to remove properties679	///680	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties681	pub fn set_token_properties(682		collection: &NonfungibleHandle<T>,683		sender: &T::CrossAccountId,684		token_id: TokenId,685		properties: impl Iterator<Item = Property>,686		is_token_create: bool,687		nesting_budget: &dyn Budget,688	) -> DispatchResult {689		Self::modify_token_properties(690			collection,691			sender,692			token_id,693			properties.map(|p| (p.key, Some(p.value))),694			is_token_create,695			nesting_budget,696		)697	}698699	/// Add or edit single property for the token700	///701	/// Calls [`set_token_properties`] internally702	///703	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties704	pub fn set_token_property(705		collection: &NonfungibleHandle<T>,706		sender: &T::CrossAccountId,707		token_id: TokenId,708		property: Property,709		nesting_budget: &dyn Budget,710	) -> DispatchResult {711		let is_token_create = false;712713		Self::set_token_properties(714			collection,715			sender,716			token_id,717			[property].into_iter(),718			is_token_create,719			nesting_budget,720		)721	}722723	/// Batch operation to remove properties from the token724	///725	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties726	///727	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties728	pub fn delete_token_properties(729		collection: &NonfungibleHandle<T>,730		sender: &T::CrossAccountId,731		token_id: TokenId,732		property_keys: impl Iterator<Item = PropertyKey>,733		nesting_budget: &dyn Budget,734	) -> DispatchResult {735		let is_token_create = false;736737		Self::modify_token_properties(738			collection,739			sender,740			token_id,741			property_keys.into_iter().map(|key| (key, None)),742			is_token_create,743			nesting_budget,744		)745	}746747	/// Remove single property from the token748	///749	/// Calls [`delete_token_properties`] internally750	///751	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties752	pub fn delete_token_property(753		collection: &NonfungibleHandle<T>,754		sender: &T::CrossAccountId,755		token_id: TokenId,756		property_key: PropertyKey,757		nesting_budget: &dyn Budget,758	) -> DispatchResult {759		Self::delete_token_properties(760			collection,761			sender,762			token_id,763			[property_key].into_iter(),764			nesting_budget,765		)766	}767768	/// Add or edit properties for the collection769	pub fn set_collection_properties(770		collection: &NonfungibleHandle<T>,771		sender: &T::CrossAccountId,772		properties: Vec<Property>,773	) -> DispatchResult {774		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)775	}776777	/// Remove properties from the collection778	pub fn delete_collection_properties(779		collection: &CollectionHandle<T>,780		sender: &T::CrossAccountId,781		property_keys: Vec<PropertyKey>,782	) -> DispatchResult {783		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)784	}785786	/// Set property permissions for the token.787	///788	/// Sender should be the owner or admin of token's collection.789	pub fn set_token_property_permissions(790		collection: &CollectionHandle<T>,791		sender: &T::CrossAccountId,792		property_permissions: Vec<PropertyKeyPermission>,793	) -> DispatchResult {794		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)795	}796797	/// Set property permissions for the token with scope.798	///799	/// Sender should be the owner or admin of token's collection.800	pub fn set_scoped_token_property_permissions(801		collection: &CollectionHandle<T>,802		sender: &T::CrossAccountId,803		scope: PropertyScope,804		property_permissions: Vec<PropertyKeyPermission>,805	) -> DispatchResult {806		<PalletCommon<T>>::set_scoped_token_property_permissions(807			collection,808			sender,809			scope,810			property_permissions,811		)812	}813814	/// Set property permissions for the collection.815	///816	/// Sender should be the owner or admin of the collection.817	pub fn set_property_permission(818		collection: &CollectionHandle<T>,819		sender: &T::CrossAccountId,820		permission: PropertyKeyPermission,821	) -> DispatchResult {822		<PalletCommon<T>>::set_property_permission(collection, sender, permission)823	}824825	/// Transfer NFT token from one account to another.826	///827	/// `from` account stops being the owner and `to` account becomes the owner of the token.828	/// If `to` is token than `to` becomes owner of the token and the token become nested.829	/// Unnests token from previous parent if it was nested before.830	/// Removes allowance for the token if there was any.831	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.832	///833	/// - `nesting_budget`: Limit for token nesting depth834	pub fn transfer(835		collection: &NonfungibleHandle<T>,836		from: &T::CrossAccountId,837		to: &T::CrossAccountId,838		token: TokenId,839		nesting_budget: &dyn Budget,840	) -> DispatchResult {841		ensure!(842			collection.limits.transfers_enabled(),843			<CommonError<T>>::TransferNotAllowed844		);845846		let token_data =847			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;848		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);849850		if collection.permissions.access() == AccessMode::AllowList {851			collection.check_allowlist(from)?;852			collection.check_allowlist(to)?;853		}854		<PalletCommon<T>>::ensure_correct_receiver(to)?;855856		let balance_from = <AccountBalance<T>>::get((collection.id, from))857			.checked_sub(1)858			.ok_or(<CommonError<T>>::TokenValueTooLow)?;859		let balance_to = if from != to {860			let balance_to = <AccountBalance<T>>::get((collection.id, to))861				.checked_add(1)862				.ok_or(ArithmeticError::Overflow)?;863864			ensure!(865				balance_to < collection.limits.account_token_ownership_limit(),866				<CommonError<T>>::AccountTokenLimitExceeded,867			);868869			Some(balance_to)870		} else {871			None872		};873874		<PalletStructure<T>>::nest_if_sent_to_token(875			from.clone(),876			to,877			collection.id,878			token,879			nesting_budget,880		)?;881882		// =========883884		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);885886		<TokenData<T>>::insert(887			(collection.id, token),888			ItemData {889				owner: to.clone(),890				..token_data891			},892		);893894		if let Some(balance_to) = balance_to {895			// from != to896			if balance_from == 0 {897				<AccountBalance<T>>::remove((collection.id, from));898			} else {899				<AccountBalance<T>>::insert((collection.id, from), balance_from);900			}901			<AccountBalance<T>>::insert((collection.id, to), balance_to);902			<Owned<T>>::remove((collection.id, from, token));903			<Owned<T>>::insert((collection.id, to, token), true);904		}905		Self::set_allowance_unchecked(collection, from, token, None, true);906907		<PalletEvm<T>>::deposit_log(908			ERC721Events::Transfer {909				from: *from.as_eth(),910				to: *to.as_eth(),911				token_id: token.into(),912			}913			.to_log(collection_id_to_address(collection.id)),914		);915		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(916			collection.id,917			token,918			from.clone(),919			to.clone(),920			1,921		));922		Ok(())923	}924925	/// Batch operation to mint multiple NFT tokens.926	///927	/// The sender should be the owner/admin of the collection or collection should be configured928	/// to allow public minting.929	/// Throws if amount of tokens reached it's limit for the collection or if caller reached930	/// token ownership limit.931	///932	/// - `data`: Contains list of token properties and users who will become the owners of the933	///   corresponging tokens.934	/// - `nesting_budget`: Limit for token nesting depth935	pub fn create_multiple_items(936		collection: &NonfungibleHandle<T>,937		sender: &T::CrossAccountId,938		data: Vec<CreateItemData<T>>,939		nesting_budget: &dyn Budget,940	) -> DispatchResult {941		if !collection.is_owner_or_admin(sender) {942			ensure!(943				collection.permissions.mint_mode(),944				<CommonError<T>>::PublicMintingNotAllowed945			);946			collection.check_allowlist(sender)?;947948			for item in data.iter() {949				collection.check_allowlist(&item.owner)?;950			}951		}952953		for data in data.iter() {954			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;955		}956957		let first_token = <TokensMinted<T>>::get(collection.id);958		let tokens_minted = first_token959			.checked_add(data.len() as u32)960			.ok_or(ArithmeticError::Overflow)?;961		ensure!(962			tokens_minted <= collection.limits.token_limit(),963			<CommonError<T>>::CollectionTokenLimitExceeded964		);965966		let mut balances = BTreeMap::new();967		for data in &data {968			let balance = balances969				.entry(&data.owner)970				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));971			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;972973			ensure!(974				*balance <= collection.limits.account_token_ownership_limit(),975				<CommonError<T>>::AccountTokenLimitExceeded,976			);977		}978979		for (i, data) in data.iter().enumerate() {980			let token = TokenId(first_token + i as u32 + 1);981982			<PalletStructure<T>>::check_nesting(983				sender.clone(),984				&data.owner,985				collection.id,986				token,987				nesting_budget,988			)?;989		}990991		// =========992993		with_transaction(|| {994			for (i, data) in data.iter().enumerate() {995				let token = first_token + i as u32 + 1;996997				<TokenData<T>>::insert(998					(collection.id, token),999					ItemData {1000						// const_data: data.const_data.clone(),1001						owner: data.owner.clone(),1002					},1003				);10041005				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1006					&data.owner,1007					collection.id,1008					TokenId(token),1009				);10101011				if let Err(e) = Self::set_token_properties(1012					collection,1013					sender,1014					TokenId(token),1015					data.properties.clone().into_iter(),1016					true,1017					nesting_budget,1018				) {1019					return TransactionOutcome::Rollback(Err(e));1020				}1021			}1022			TransactionOutcome::Commit(Ok(()))1023		})?;10241025		<TokensMinted<T>>::insert(collection.id, tokens_minted);1026		for (account, balance) in balances {1027			<AccountBalance<T>>::insert((collection.id, account), balance);1028		}1029		for (i, data) in data.into_iter().enumerate() {1030			let token = first_token + i as u32 + 1;1031			<Owned<T>>::insert((collection.id, &data.owner, token), true);10321033			<PalletEvm<T>>::deposit_log(1034				ERC721Events::Transfer {1035					from: H160::default(),1036					to: *data.owner.as_eth(),1037					token_id: token.into(),1038				}1039				.to_log(collection_id_to_address(collection.id)),1040			);1041			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1042				collection.id,1043				TokenId(token),1044				data.owner.clone(),1045				1,1046			));1047		}1048		Ok(())1049	}10501051	pub fn set_allowance_unchecked(1052		collection: &NonfungibleHandle<T>,1053		sender: &T::CrossAccountId,1054		token: TokenId,1055		spender: Option<&T::CrossAccountId>,1056		assume_implicit_eth: bool,1057	) {1058		if let Some(spender) = spender {1059			let old_spender = <Allowance<T>>::get((collection.id, token));1060			<Allowance<T>>::insert((collection.id, token), spender);1061			// In ERC721 there is only one possible approved user of token, so we set1062			// approved user to spender1063			<PalletEvm<T>>::deposit_log(1064				ERC721Events::Approval {1065					owner: *sender.as_eth(),1066					approved: *spender.as_eth(),1067					token_id: token.into(),1068				}1069				.to_log(collection_id_to_address(collection.id)),1070			);1071			// In Unique chain, any token can have any amount of approved users, so we need to1072			// set allowance of old owner to 0, and allowance of new owner to 11073			if old_spender.as_ref() != Some(spender) {1074				if let Some(old_owner) = old_spender {1075					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1076						collection.id,1077						token,1078						sender.clone(),1079						old_owner,1080						0,1081					));1082				}1083				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1084					collection.id,1085					token,1086					sender.clone(),1087					spender.clone(),1088					1,1089				));1090			}1091		} else {1092			let old_spender = <Allowance<T>>::take((collection.id, token));1093			if !assume_implicit_eth {1094				// In ERC721 there is only one possible approved user of token, so we set1095				// approved user to zero address1096				<PalletEvm<T>>::deposit_log(1097					ERC721Events::Approval {1098						owner: *sender.as_eth(),1099						approved: H160::default(),1100						token_id: token.into(),1101					}1102					.to_log(collection_id_to_address(collection.id)),1103				);1104			}1105			// In Unique chain, any token can have any amount of approved users, so we need to1106			// set allowance of old owner to 01107			if let Some(old_spender) = old_spender {1108				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1109					collection.id,1110					token,1111					sender.clone(),1112					old_spender,1113					0,1114				));1115			}1116		}1117	}11181119	/// Set allowance for the spender to `transfer` or `burn` sender's token.1120	///1121	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1122	pub fn set_allowance(1123		collection: &NonfungibleHandle<T>,1124		sender: &T::CrossAccountId,1125		token: TokenId,1126		spender: Option<&T::CrossAccountId>,1127	) -> DispatchResult {1128		if collection.permissions.access() == AccessMode::AllowList {1129			collection.check_allowlist(sender)?;1130			if let Some(spender) = spender {1131				collection.check_allowlist(spender)?;1132			}1133		}11341135		if let Some(spender) = spender {1136			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1137		}11381139		let token_data =1140			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1141		if &token_data.owner != sender {1142			ensure!(1143				collection.ignores_owned_amount(sender),1144				<CommonError<T>>::CantApproveMoreThanOwned1145			);1146		}11471148		// =========11491150		Self::set_allowance_unchecked(collection, sender, token, spender, false);1151		Ok(())1152	}11531154	/// Checks allowance for the spender to use the token.1155	fn check_allowed(1156		collection: &NonfungibleHandle<T>,1157		spender: &T::CrossAccountId,1158		from: &T::CrossAccountId,1159		token: TokenId,1160		nesting_budget: &dyn Budget,1161	) -> DispatchResult {1162		if spender.conv_eq(from) {1163			return Ok(());1164		}1165		if collection.permissions.access() == AccessMode::AllowList {1166			// `from`, `to` checked in [`transfer`]1167			collection.check_allowlist(spender)?;1168		}11691170		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1171			return Ok(());1172		}11731174		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1175			ensure!(1176				<PalletStructure<T>>::check_indirectly_owned(1177					spender.clone(),1178					source.0,1179					source.1,1180					None,1181					nesting_budget1182				)?,1183				<CommonError<T>>::ApprovedValueTooLow,1184			);1185			return Ok(());1186		}1187		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1188			return Ok(());1189		}1190		ensure!(1191			collection.ignores_allowance(spender),1192			<CommonError<T>>::ApprovedValueTooLow1193		);1194		Ok(())1195	}11961197	/// Transfer NFT token from one account to another.1198	///1199	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1200	/// The owner should set allowance for the spender to transfer token.1201	///1202	/// [`transfer`]: struct.Pallet.html#method.transfer1203	pub fn transfer_from(1204		collection: &NonfungibleHandle<T>,1205		spender: &T::CrossAccountId,1206		from: &T::CrossAccountId,1207		to: &T::CrossAccountId,1208		token: TokenId,1209		nesting_budget: &dyn Budget,1210	) -> DispatchResult {1211		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12121213		// =========12141215		// Allowance is reset in [`transfer`]1216		Self::transfer(collection, from, to, token, nesting_budget)1217	}12181219	/// Burn NFT token for `from` account.1220	///1221	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1222	/// set allowance for the spender to burn token.1223	///1224	/// [`burn`]: struct.Pallet.html#method.burn1225	pub fn burn_from(1226		collection: &NonfungibleHandle<T>,1227		spender: &T::CrossAccountId,1228		from: &T::CrossAccountId,1229		token: TokenId,1230		nesting_budget: &dyn Budget,1231	) -> DispatchResult {1232		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12331234		// =========12351236		Self::burn(collection, from, token)1237	}12381239	/// Check that `from` token could be nested in `under` token.1240	///1241	pub fn check_nesting(1242		handle: &NonfungibleHandle<T>,1243		sender: T::CrossAccountId,1244		from: (CollectionId, TokenId),1245		under: TokenId,1246		nesting_budget: &dyn Budget,1247	) -> DispatchResult {1248		let nesting = handle.permissions.nesting();12491250		#[cfg(not(feature = "runtime-benchmarks"))]1251		let permissive = false;1252		#[cfg(feature = "runtime-benchmarks")]1253		let permissive = nesting.permissive;12541255		if permissive {1256			// Pass1257		} else if nesting.token_owner1258			&& <PalletStructure<T>>::check_indirectly_owned(1259				sender.clone(),1260				handle.id,1261				under,1262				Some(from),1263				nesting_budget,1264			)? {1265			// Pass1266		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1267			// Pass1268		} else {1269			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1270		}12711272		if let Some(whitelist) = &nesting.restricted {1273			ensure!(1274				whitelist.contains(&from.0),1275				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1276			);1277		}1278		Ok(())1279	}12801281	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1282		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1283	}12841285	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1286		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1287	}12881289	fn collection_has_tokens(collection_id: CollectionId) -> bool {1290		<TokenData<T>>::iter_prefix((collection_id,))1291			.next()1292			.is_some()1293	}12941295	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1296		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1297			.next()1298			.is_some()1299	}13001301	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1302		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1303			.map(|((child_collection_id, child_id), _)| TokenChild {1304				collection: child_collection_id,1305				token: child_id,1306			})1307			.collect()1308	}13091310	/// Mint single NFT token.1311	///1312	/// Delegated to [`create_multiple_items`]1313	///1314	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1315	pub fn create_item(1316		collection: &NonfungibleHandle<T>,1317		sender: &T::CrossAccountId,1318		data: CreateItemData<T>,1319		nesting_budget: &dyn Budget,1320	) -> DispatchResult {1321		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1322	}1323}