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

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, collections::btree_set::BTreeSet};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			0282		}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		data: CreateCollectionData<T::AccountId>,409		is_external: bool,410	) -> Result<CollectionId, DispatchError> {411		<PalletCommon<T>>::init_collection(412			owner,413			data,414			CollectionFlags {415				external: is_external,416				..Default::default()417			},418		)419	}420421	/// Destroy NFT collection422	///423	/// `destroy_collection` will throw error if collection contains any tokens.424	/// Only owner can destroy collection.425	pub fn destroy_collection(426		collection: NonfungibleHandle<T>,427		sender: &T::CrossAccountId,428	) -> DispatchResult {429		let id = collection.id;430431		if Self::collection_has_tokens(id) {432			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());433		}434435		// =========436437		PalletCommon::destroy_collection(collection.0, sender)?;438439		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);440		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);441		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);442		<TokensMinted<T>>::remove(id);443		<TokensBurnt<T>>::remove(id);444		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);445		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);446		Ok(())447	}448449	/// Burn NFT token450	///451	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token452	/// if the token is nested.453	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.454	/// Also removes all corresponding properties and auxiliary properties.455	///456	/// - `token`: Token that should be burned457	/// - `collection`: Collection that contains the token458	pub fn burn(459		collection: &NonfungibleHandle<T>,460		sender: &T::CrossAccountId,461		token: TokenId,462	) -> DispatchResult {463		let token_data =464			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;465		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);466467		if collection.permissions.access() == AccessMode::AllowList {468			collection.check_allowlist(sender)?;469		}470471		if Self::token_has_children(collection.id, token) {472			return Err(<Error<T>>::CantBurnNftWithChildren.into());473		}474475		let burnt = <TokensBurnt<T>>::get(collection.id)476			.checked_add(1)477			.ok_or(ArithmeticError::Overflow)?;478479		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))480			.checked_sub(1)481			.ok_or(ArithmeticError::Overflow)?;482483		// =========484485		if balance == 0 {486			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));487		} else {488			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);489		}490491		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);492493		<Owned<T>>::remove((collection.id, &token_data.owner, token));494		<TokensBurnt<T>>::insert(collection.id, burnt);495		<TokenData<T>>::remove((collection.id, token));496		<TokenProperties<T>>::remove((collection.id, token));497		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);498		let old_spender = <Allowance<T>>::take((collection.id, token));499500		if let Some(old_spender) = old_spender {501			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(502				collection.id,503				token,504				token_data.owner.clone(),505				old_spender,506				0,507			));508		}509510		<PalletEvm<T>>::deposit_log(511			ERC721Events::Transfer {512				from: *token_data.owner.as_eth(),513				to: H160::default(),514				token_id: token.into(),515			}516			.to_log(collection_id_to_address(collection.id)),517		);518		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(519			collection.id,520			token,521			token_data.owner,522			1,523		));524		Ok(())525	}526527	/// Same as [`burn`] but burns all the tokens that are nested in the token first528	///529	/// - `self_budget`: Limit for searching children in depth.530	/// - `breadth_budget`: Limit of breadth of searching children.531	///532	/// [`burn`]: struct.Pallet.html#method.burn533	#[transactional]534	pub fn burn_recursively(535		collection: &NonfungibleHandle<T>,536		sender: &T::CrossAccountId,537		token: TokenId,538		self_budget: &dyn Budget,539		breadth_budget: &dyn Budget,540	) -> DispatchResultWithPostInfo {541		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);542543		let current_token_account =544			T::CrossTokenAddressMapping::token_to_address(collection.id, token);545546		let mut weight = 0 as Weight;547548		// This method is transactional, if user in fact doesn't have permissions to remove token -549		// tokens removed here will be restored after rejected transaction550		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {551			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);552			let PostDispatchInfo { actual_weight, .. } =553				<PalletStructure<T>>::burn_item_recursively(554					current_token_account.clone(),555					collection,556					token,557					self_budget,558					breadth_budget,559				)?;560			if let Some(actual_weight) = actual_weight {561				weight = weight.saturating_add(actual_weight);562			}563		}564565		Self::burn(collection, sender, token)?;566		DispatchResultWithPostInfo::Ok(PostDispatchInfo {567			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),568			pays_fee: Pays::Yes,569		})570	}571572	/// Batch operation to add, edit or remove properties for the token573	///574	/// All affected properties should have mutable permission and sender should have575	/// permission to edit those properties.576	///577	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.578	/// - `is_token_create`: Indicates that method is called during token initialization.579	///   Allows to bypass ownership check.580	#[transactional]581	fn modify_token_properties(582		collection: &NonfungibleHandle<T>,583		sender: &T::CrossAccountId,584		token_id: TokenId,585		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,586		is_token_create: bool,587		nesting_budget: &dyn Budget,588	) -> DispatchResult {589		let mut collection_admin_status = None;590		let mut token_owner_result = None;591592		let mut is_collection_admin =593			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));594595		let mut is_token_owner = || {596			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {597				let is_owned = <PalletStructure<T>>::check_indirectly_owned(598					sender.clone(),599					collection.id,600					token_id,601					None,602					nesting_budget,603				)?;604605				Ok(is_owned)606			})607		};608609		for (key, value) in properties {610			let permission = <PalletCommon<T>>::property_permissions(collection.id)611				.get(&key)612				.cloned()613				.unwrap_or_else(PropertyPermission::none);614615			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))616				.get(&key)617				.is_some();618619			match permission {620				PropertyPermission { mutable: false, .. } if is_property_exists => {621					return Err(<CommonError<T>>::NoPermission.into());622				}623624				PropertyPermission {625					collection_admin,626					token_owner,627					..628				} => {629					//TODO: investigate threats during public minting.630					if is_token_create && (collection_admin || token_owner) && value.is_some() {631						// Pass632					} else if collection_admin && is_collection_admin() {633						// Pass634					} else if token_owner && is_token_owner()? {635						// Pass636					} else {637						fail!(<CommonError<T>>::NoPermission);638					}639				}640			}641642			match value {643				Some(value) => {644					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {645						properties.try_set(key.clone(), value)646					})647					.map_err(<CommonError<T>>::from)?;648649					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(650						collection.id,651						token_id,652						key,653					));654				}655				None => {656					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {657						properties.remove(&key)658					})659					.map_err(<CommonError<T>>::from)?;660661					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(662						collection.id,663						token_id,664						key,665					));666				}667			}668		}669670		Ok(())671	}672673	/// Batch operation to add or edit properties for the token674	///675	/// Same as [`modify_token_properties`] but doesn't allow to remove properties676	///677	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties678	pub fn set_token_properties(679		collection: &NonfungibleHandle<T>,680		sender: &T::CrossAccountId,681		token_id: TokenId,682		properties: impl Iterator<Item = Property>,683		is_token_create: bool,684		nesting_budget: &dyn Budget,685	) -> DispatchResult {686		Self::modify_token_properties(687			collection,688			sender,689			token_id,690			properties.map(|p| (p.key, Some(p.value))),691			is_token_create,692			nesting_budget,693		)694	}695696	/// Add or edit single property for the token697	///698	/// Calls [`set_token_properties`] internally699	///700	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties701	pub fn set_token_property(702		collection: &NonfungibleHandle<T>,703		sender: &T::CrossAccountId,704		token_id: TokenId,705		property: Property,706		nesting_budget: &dyn Budget,707	) -> DispatchResult {708		let is_token_create = false;709710		Self::set_token_properties(711			collection,712			sender,713			token_id,714			[property].into_iter(),715			is_token_create,716			nesting_budget,717		)718	}719720	/// Batch operation to remove properties from the token721	///722	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties723	///724	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties725	pub fn delete_token_properties(726		collection: &NonfungibleHandle<T>,727		sender: &T::CrossAccountId,728		token_id: TokenId,729		property_keys: impl Iterator<Item = PropertyKey>,730		nesting_budget: &dyn Budget,731	) -> DispatchResult {732		let is_token_create = false;733734		Self::modify_token_properties(735			collection,736			sender,737			token_id,738			property_keys.into_iter().map(|key| (key, None)),739			is_token_create,740			nesting_budget,741		)742	}743744	/// Remove single property from the token745	///746	/// Calls [`delete_token_properties`] internally747	///748	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties749	pub fn delete_token_property(750		collection: &NonfungibleHandle<T>,751		sender: &T::CrossAccountId,752		token_id: TokenId,753		property_key: PropertyKey,754		nesting_budget: &dyn Budget,755	) -> DispatchResult {756		Self::delete_token_properties(757			collection,758			sender,759			token_id,760			[property_key].into_iter(),761			nesting_budget,762		)763	}764765	/// Add or edit properties for the collection766	pub fn set_collection_properties(767		collection: &NonfungibleHandle<T>,768		sender: &T::CrossAccountId,769		properties: Vec<Property>,770	) -> DispatchResult {771		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)772	}773774	/// Remove properties from the collection775	pub fn delete_collection_properties(776		collection: &CollectionHandle<T>,777		sender: &T::CrossAccountId,778		property_keys: Vec<PropertyKey>,779	) -> DispatchResult {780		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)781	}782783	/// Set property permissions for the token.784	///785	/// Sender should be the owner or admin of token's collection.786	pub fn set_token_property_permissions(787		collection: &CollectionHandle<T>,788		sender: &T::CrossAccountId,789		property_permissions: Vec<PropertyKeyPermission>,790	) -> DispatchResult {791		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)792	}793794	/// Set property permissions for the token with scope.795	///796	/// Sender should be the owner or admin of token's collection.797	pub fn set_scoped_token_property_permissions(798		collection: &CollectionHandle<T>,799		sender: &T::CrossAccountId,800		scope: PropertyScope,801		property_permissions: Vec<PropertyKeyPermission>,802	) -> DispatchResult {803		<PalletCommon<T>>::set_scoped_token_property_permissions(804			collection,805			sender,806			scope,807			property_permissions,808		)809	}810811	/// Set property permissions for the collection.812	///813	/// Sender should be the owner or admin of the collection.814	pub fn set_property_permission(815		collection: &CollectionHandle<T>,816		sender: &T::CrossAccountId,817		permission: PropertyKeyPermission,818	) -> DispatchResult {819		<PalletCommon<T>>::set_property_permission(collection, sender, permission)820	}821822	/// Transfer NFT token from one account to another.823	///824	/// `from` account stops being the owner and `to` account becomes the owner of the token.825	/// If `to` is token than `to` becomes owner of the token and the token become nested.826	/// Unnests token from previous parent if it was nested before.827	/// Removes allowance for the token if there was any.828	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.829	///830	/// - `nesting_budget`: Limit for token nesting depth831	pub fn transfer(832		collection: &NonfungibleHandle<T>,833		from: &T::CrossAccountId,834		to: &T::CrossAccountId,835		token: TokenId,836		nesting_budget: &dyn Budget,837	) -> DispatchResult {838		ensure!(839			collection.limits.transfers_enabled(),840			<CommonError<T>>::TransferNotAllowed841		);842843		let token_data =844			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;845		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);846847		if collection.permissions.access() == AccessMode::AllowList {848			collection.check_allowlist(from)?;849			collection.check_allowlist(to)?;850		}851		<PalletCommon<T>>::ensure_correct_receiver(to)?;852853		let balance_from = <AccountBalance<T>>::get((collection.id, from))854			.checked_sub(1)855			.ok_or(<CommonError<T>>::TokenValueTooLow)?;856		let balance_to = if from != to {857			let balance_to = <AccountBalance<T>>::get((collection.id, to))858				.checked_add(1)859				.ok_or(ArithmeticError::Overflow)?;860861			ensure!(862				balance_to < collection.limits.account_token_ownership_limit(),863				<CommonError<T>>::AccountTokenLimitExceeded,864			);865866			Some(balance_to)867		} else {868			None869		};870871		<PalletStructure<T>>::nest_if_sent_to_token(872			from.clone(),873			to,874			collection.id,875			token,876			nesting_budget,877		)?;878879		// =========880881		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);882883		<TokenData<T>>::insert(884			(collection.id, token),885			ItemData {886				owner: to.clone(),887				..token_data888			},889		);890891		if let Some(balance_to) = balance_to {892			// from != to893			if balance_from == 0 {894				<AccountBalance<T>>::remove((collection.id, from));895			} else {896				<AccountBalance<T>>::insert((collection.id, from), balance_from);897			}898			<AccountBalance<T>>::insert((collection.id, to), balance_to);899			<Owned<T>>::remove((collection.id, from, token));900			<Owned<T>>::insert((collection.id, to, token), true);901		}902		Self::set_allowance_unchecked(collection, from, token, None, true);903904		<PalletEvm<T>>::deposit_log(905			ERC721Events::Transfer {906				from: *from.as_eth(),907				to: *to.as_eth(),908				token_id: token.into(),909			}910			.to_log(collection_id_to_address(collection.id)),911		);912		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(913			collection.id,914			token,915			from.clone(),916			to.clone(),917			1,918		));919		Ok(())920	}921922	/// Batch operation to mint multiple NFT tokens.923	///924	/// The sender should be the owner/admin of the collection or collection should be configured925	/// to allow public minting.926	/// Throws if amount of tokens reached it's limit for the collection or if caller reached927	/// token ownership limit.928	///929	/// - `data`: Contains list of token properties and users who will become the owners of the930	///   corresponging tokens.931	/// - `nesting_budget`: Limit for token nesting depth932	pub fn create_multiple_items(933		collection: &NonfungibleHandle<T>,934		sender: &T::CrossAccountId,935		data: Vec<CreateItemData<T>>,936		nesting_budget: &dyn Budget,937	) -> DispatchResult {938		if !collection.is_owner_or_admin(sender) {939			ensure!(940				collection.permissions.mint_mode(),941				<CommonError<T>>::PublicMintingNotAllowed942			);943			collection.check_allowlist(sender)?;944945			for item in data.iter() {946				collection.check_allowlist(&item.owner)?;947			}948		}949950		for data in data.iter() {951			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;952		}953954		let first_token = <TokensMinted<T>>::get(collection.id);955		let tokens_minted = first_token956			.checked_add(data.len() as u32)957			.ok_or(ArithmeticError::Overflow)?;958		ensure!(959			tokens_minted <= collection.limits.token_limit(),960			<CommonError<T>>::CollectionTokenLimitExceeded961		);962963		let mut balances = BTreeMap::new();964		for data in &data {965			let balance = balances966				.entry(&data.owner)967				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));968			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;969970			ensure!(971				*balance <= collection.limits.account_token_ownership_limit(),972				<CommonError<T>>::AccountTokenLimitExceeded,973			);974		}975976		for (i, data) in data.iter().enumerate() {977			let token = TokenId(first_token + i as u32 + 1);978979			<PalletStructure<T>>::check_nesting(980				sender.clone(),981				&data.owner,982				collection.id,983				token,984				nesting_budget,985			)?;986		}987988		// =========989990		with_transaction(|| {991			for (i, data) in data.iter().enumerate() {992				let token = first_token + i as u32 + 1;993994				<TokenData<T>>::insert(995					(collection.id, token),996					ItemData {997						// const_data: data.const_data.clone(),998						owner: data.owner.clone(),999					},1000				);10011002				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1003					&data.owner,1004					collection.id,1005					TokenId(token),1006				);10071008				if let Err(e) = Self::set_token_properties(1009					collection,1010					sender,1011					TokenId(token),1012					data.properties.clone().into_iter(),1013					true,1014					nesting_budget,1015				) {1016					return TransactionOutcome::Rollback(Err(e));1017				}1018			}1019			TransactionOutcome::Commit(Ok(()))1020		})?;10211022		<TokensMinted<T>>::insert(collection.id, tokens_minted);1023		for (account, balance) in balances {1024			<AccountBalance<T>>::insert((collection.id, account), balance);1025		}1026		for (i, data) in data.into_iter().enumerate() {1027			let token = first_token + i as u32 + 1;1028			<Owned<T>>::insert((collection.id, &data.owner, token), true);10291030			<PalletEvm<T>>::deposit_log(1031				ERC721Events::Transfer {1032					from: H160::default(),1033					to: *data.owner.as_eth(),1034					token_id: token.into(),1035				}1036				.to_log(collection_id_to_address(collection.id)),1037			);1038			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1039				collection.id,1040				TokenId(token),1041				data.owner.clone(),1042				1,1043			));1044		}1045		Ok(())1046	}10471048	pub fn set_allowance_unchecked(1049		collection: &NonfungibleHandle<T>,1050		sender: &T::CrossAccountId,1051		token: TokenId,1052		spender: Option<&T::CrossAccountId>,1053		assume_implicit_eth: bool,1054	) {1055		if let Some(spender) = spender {1056			let old_spender = <Allowance<T>>::get((collection.id, token));1057			<Allowance<T>>::insert((collection.id, token), spender);1058			// In ERC721 there is only one possible approved user of token, so we set1059			// approved user to spender1060			<PalletEvm<T>>::deposit_log(1061				ERC721Events::Approval {1062					owner: *sender.as_eth(),1063					approved: *spender.as_eth(),1064					token_id: token.into(),1065				}1066				.to_log(collection_id_to_address(collection.id)),1067			);1068			// In Unique chain, any token can have any amount of approved users, so we need to1069			// set allowance of old owner to 0, and allowance of new owner to 11070			if old_spender.as_ref() != Some(spender) {1071				if let Some(old_owner) = old_spender {1072					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1073						collection.id,1074						token,1075						sender.clone(),1076						old_owner,1077						0,1078					));1079				}1080				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1081					collection.id,1082					token,1083					sender.clone(),1084					spender.clone(),1085					1,1086				));1087			}1088		} else {1089			let old_spender = <Allowance<T>>::take((collection.id, token));1090			if !assume_implicit_eth {1091				// In ERC721 there is only one possible approved user of token, so we set1092				// approved user to zero address1093				<PalletEvm<T>>::deposit_log(1094					ERC721Events::Approval {1095						owner: *sender.as_eth(),1096						approved: H160::default(),1097						token_id: token.into(),1098					}1099					.to_log(collection_id_to_address(collection.id)),1100				);1101			}1102			// In Unique chain, any token can have any amount of approved users, so we need to1103			// set allowance of old owner to 01104			if let Some(old_spender) = old_spender {1105				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1106					collection.id,1107					token,1108					sender.clone(),1109					old_spender,1110					0,1111				));1112			}1113		}1114	}11151116	/// Set allowance for the spender to `transfer` or `burn` sender's token.1117	///1118	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1119	pub fn set_allowance(1120		collection: &NonfungibleHandle<T>,1121		sender: &T::CrossAccountId,1122		token: TokenId,1123		spender: Option<&T::CrossAccountId>,1124	) -> DispatchResult {1125		if collection.permissions.access() == AccessMode::AllowList {1126			collection.check_allowlist(sender)?;1127			if let Some(spender) = spender {1128				collection.check_allowlist(spender)?;1129			}1130		}11311132		if let Some(spender) = spender {1133			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1134		}11351136		let token_data =1137			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1138		if &token_data.owner != sender {1139			ensure!(1140				collection.ignores_owned_amount(sender),1141				<CommonError<T>>::CantApproveMoreThanOwned1142			);1143		}11441145		// =========11461147		Self::set_allowance_unchecked(collection, sender, token, spender, false);1148		Ok(())1149	}11501151	/// Checks allowance for the spender to use the token.1152	fn check_allowed(1153		collection: &NonfungibleHandle<T>,1154		spender: &T::CrossAccountId,1155		from: &T::CrossAccountId,1156		token: TokenId,1157		nesting_budget: &dyn Budget,1158	) -> DispatchResult {1159		if spender.conv_eq(from) {1160			return Ok(());1161		}1162		if collection.permissions.access() == AccessMode::AllowList {1163			// `from`, `to` checked in [`transfer`]1164			collection.check_allowlist(spender)?;1165		}11661167		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1168			return Ok(());1169		}11701171		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1172			ensure!(1173				<PalletStructure<T>>::check_indirectly_owned(1174					spender.clone(),1175					source.0,1176					source.1,1177					None,1178					nesting_budget1179				)?,1180				<CommonError<T>>::ApprovedValueTooLow,1181			);1182			return Ok(());1183		}1184		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1185			return Ok(());1186		}1187		ensure!(1188			collection.ignores_allowance(spender),1189			<CommonError<T>>::ApprovedValueTooLow1190		);1191		Ok(())1192	}11931194	/// Transfer NFT token from one account to another.1195	///1196	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1197	/// The owner should set allowance for the spender to transfer token.1198	///1199	/// [`transfer`]: struct.Pallet.html#method.transfer1200	pub fn transfer_from(1201		collection: &NonfungibleHandle<T>,1202		spender: &T::CrossAccountId,1203		from: &T::CrossAccountId,1204		to: &T::CrossAccountId,1205		token: TokenId,1206		nesting_budget: &dyn Budget,1207	) -> DispatchResult {1208		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12091210		// =========12111212		// Allowance is reset in [`transfer`]1213		Self::transfer(collection, from, to, token, nesting_budget)1214	}12151216	/// Burn NFT token for `from` account.1217	///1218	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1219	/// set allowance for the spender to burn token.1220	///1221	/// [`burn`]: struct.Pallet.html#method.burn1222	pub fn burn_from(1223		collection: &NonfungibleHandle<T>,1224		spender: &T::CrossAccountId,1225		from: &T::CrossAccountId,1226		token: TokenId,1227		nesting_budget: &dyn Budget,1228	) -> DispatchResult {1229		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12301231		// =========12321233		Self::burn(collection, from, token)1234	}12351236	/// Check that `from` token could be nested in `under` token.1237	///1238	pub fn check_nesting(1239		handle: &NonfungibleHandle<T>,1240		sender: T::CrossAccountId,1241		from: (CollectionId, TokenId),1242		under: TokenId,1243		nesting_budget: &dyn Budget,1244	) -> DispatchResult {1245		let nesting = handle.permissions.nesting();12461247		#[cfg(not(feature = "runtime-benchmarks"))]1248		let permissive = false;1249		#[cfg(feature = "runtime-benchmarks")]1250		let permissive = nesting.permissive;12511252		if permissive {1253			// Pass1254		} else if nesting.token_owner1255			&& <PalletStructure<T>>::check_indirectly_owned(1256				sender.clone(),1257				handle.id,1258				under,1259				Some(from),1260				nesting_budget,1261			)? {1262			// Pass1263		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1264			// Pass1265		} else {1266			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1267		}12681269		if let Some(whitelist) = &nesting.restricted {1270			ensure!(1271				whitelist.contains(&from.0),1272				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1273			);1274		}1275		Ok(())1276	}12771278	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1279		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1280	}12811282	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1283		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1284	}12851286	fn collection_has_tokens(collection_id: CollectionId) -> bool {1287		<TokenData<T>>::iter_prefix((collection_id,))1288			.next()1289			.is_some()1290	}12911292	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1293		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1294			.next()1295			.is_some()1296	}12971298	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1299		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1300			.map(|((child_collection_id, child_id), _)| TokenChild {1301				collection: child_collection_id,1302				token: child_id,1303			})1304			.collect()1305	}13061307	/// Mint single NFT token.1308	///1309	/// Delegated to [`create_multiple_items`]1310	///1311	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1312	pub fn create_item(1313		collection: &NonfungibleHandle<T>,1314		sender: &T::CrossAccountId,1315		data: CreateItemData<T>,1316		nesting_budget: &dyn Budget,1317	) -> DispatchResult {1318		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1319	}1320}