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

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//!   Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//!   an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//!   it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//!   attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//!   with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//!   Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96	BoundedVec, ensure, fail, transactional,97	storage::with_transaction,98	pallet_prelude::DispatchResultWithPostInfo,99	pallet_prelude::Weight,100	dispatch::{PostDispatchInfo, Pays},101};102use up_data_structs::{103	AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,104	CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyPermission,105	PropertyKey, PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty,106	TokenChild, AuxPropertyValue, PropertiesPermissionMap,107};108use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};109use pallet_common::{110	Error as CommonError, Pallet as PalletCommon, Event as CommonEvent, CollectionHandle,111	eth::collection_id_to_address, erc::CollectionHelpersEvents,112};113use pallet_structure::{Pallet as PalletStructure, Error as StructureError};114use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder};115use sp_core::{H160, Get};116use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};117use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};118use core::ops::Deref;119use codec::{Encode, Decode, MaxEncodedLen};120use scale_info::TypeInfo;121122pub use pallet::*;123use weights::WeightInfo;124#[cfg(feature = "runtime-benchmarks")]125pub mod benchmarking;126pub mod common;127pub mod erc;128pub mod weights;129130pub type CreateItemData<T> = CreateNftExData<<T as pallet_evm::Config>::CrossAccountId>;131pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;132133/// Token data, stored independently from other data used to describe it134/// for the convenience of database access. Notably contains the owner account address.135#[struct_versioning::versioned(version = 2, upper)]136#[derive(Encode, Decode, TypeInfo, MaxEncodedLen)]137pub struct ItemData<CrossAccountId> {138	#[version(..2)]139	pub const_data: BoundedVec<u8, CustomDataLimit>,140141	#[version(..2)]142	pub variable_data: BoundedVec<u8, CustomDataLimit>,143144	pub owner: CrossAccountId,145}146147#[frame_support::pallet]148pub mod pallet {149	use super::*;150	use frame_support::{151		Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key, traits::StorageVersion,152	};153	use frame_system::pallet_prelude::*;154	use up_data_structs::{CollectionId, TokenId};155	use super::weights::WeightInfo;156157	#[pallet::error]158	pub enum Error<T> {159		/// Not Nonfungible item data used to mint in Nonfungible collection.160		NotNonfungibleDataUsedToMintFungibleCollectionToken,161		/// Used amount > 1 with NFT162		NonfungibleItemsHaveNoAmount,163		/// Unable to burn NFT with children164		CantBurnNftWithChildren,165	}166167	#[pallet::config]168	pub trait Config:169		frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config170	{171		type WeightInfo: WeightInfo;172	}173174	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);175176	#[pallet::pallet]177	#[pallet::storage_version(STORAGE_VERSION)]178	#[pallet::generate_store(pub(super) trait Store)]179	pub struct Pallet<T>(_);180181	/// Total amount of minted tokens in a collection.182	#[pallet::storage]183	pub type TokensMinted<T: Config> =184		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;185186	/// Amount of burnt tokens in a collection.187	#[pallet::storage]188	pub type TokensBurnt<T: Config> =189		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;190191	/// Token data, used to partially describe a token.192	#[pallet::storage]193	pub type TokenData<T: Config> = StorageNMap<194		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),195		Value = ItemData<T::CrossAccountId>,196		QueryKind = OptionQuery,197	>;198199	/// Map of key-value pairs, describing the metadata of a token.200	#[pallet::storage]201	#[pallet::getter(fn token_properties)]202	pub type TokenProperties<T: Config> = StorageNMap<203		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),204		Value = Properties,205		QueryKind = ValueQuery,206		OnEmpty = up_data_structs::TokenProperties,207	>;208209	/// Custom data of a token that is serialized to bytes,210	/// primarily reserved for on-chain operations,211	/// normally obscured from the external users.212	///213	/// Auxiliary properties are slightly different from214	/// usual [`TokenProperties`] due to an unlimited number215	/// and separately stored and written-to key-value pairs.216	///217	/// Currently 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	/// Operator set by a wallet owner that could perform certain transactions on all tokens in the wallet.276	#[pallet::storage]277	pub type CollectionAllowance<T: Config> = StorageNMap<278		Key = (279			Key<Twox64Concat, CollectionId>,280			Key<Blake2_128Concat, T::CrossAccountId>,281			Key<Blake2_128Concat, T::CrossAccountId>,282		),283		Value = bool,284		QueryKind = ValueQuery,285	>;286287	/// Upgrade from the old schema to properties.288	#[pallet::hooks]289	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {290		fn on_runtime_upgrade() -> Weight {291			StorageVersion::new(1).put::<Pallet<T>>();292293			Weight::zero()294		}295	}296}297298pub struct NonfungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);299impl<T: Config> NonfungibleHandle<T> {300	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {301		Self(inner)302	}303	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {304		self.0305	}306	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {307		&mut self.0308	}309}310311impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {312	fn recorder(&self) -> &SubstrateRecorder<T> {313		self.0.recorder()314	}315	fn into_recorder(self) -> SubstrateRecorder<T> {316		self.0.into_recorder()317	}318}319impl<T: Config> Deref for NonfungibleHandle<T> {320	type Target = pallet_common::CollectionHandle<T>;321322	fn deref(&self) -> &Self::Target {323		&self.0324	}325}326327impl<T: Config> Pallet<T> {328	/// Get number of NFT tokens in collection.329	pub fn total_supply(collection: &NonfungibleHandle<T>) -> u32 {330		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)331	}332333	/// Check that NFT token exists.334	///335	/// - `token`: Token ID.336	pub fn token_exists(collection: &NonfungibleHandle<T>, token: TokenId) -> bool {337		<TokenData<T>>::contains_key((collection.id, token))338	}339340	/// Set the token property with the scope.341	///342	/// - `property`: Contains key-value pair.343	pub fn set_scoped_token_property(344		collection_id: CollectionId,345		token_id: TokenId,346		scope: PropertyScope,347		property: Property,348	) -> DispatchResult {349		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {350			properties.try_scoped_set(scope, property.key, property.value)351		})352		.map_err(<CommonError<T>>::from)?;353354		Ok(())355	}356357	/// Batch operation to set multiple properties with the same scope.358	pub fn set_scoped_token_properties(359		collection_id: CollectionId,360		token_id: TokenId,361		scope: PropertyScope,362		properties: impl Iterator<Item = Property>,363	) -> DispatchResult {364		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {365			stored_properties.try_scoped_set_from_iter(scope, properties)366		})367		.map_err(<CommonError<T>>::from)?;368369		Ok(())370	}371372	/// Add or edit auxiliary data for the property.373	///374	/// - `f`: function that adds or edits auxiliary data.375	pub fn try_mutate_token_aux_property<R, E>(376		collection_id: CollectionId,377		token_id: TokenId,378		scope: PropertyScope,379		key: PropertyKey,380		f: impl FnOnce(&mut Option<AuxPropertyValue>) -> Result<R, E>,381	) -> Result<R, E> {382		<TokenAuxProperties<T>>::try_mutate((collection_id, token_id, scope, key), f)383	}384385	/// Remove auxiliary data for the property.386	pub fn remove_token_aux_property(387		collection_id: CollectionId,388		token_id: TokenId,389		scope: PropertyScope,390		key: PropertyKey,391	) {392		<TokenAuxProperties<T>>::remove((collection_id, token_id, scope, key));393	}394395	/// Get all auxiliary data in a given scope.396	///397	/// Returns iterator over Property Key - Data pairs.398	pub fn iterate_token_aux_properties(399		collection_id: CollectionId,400		token_id: TokenId,401		scope: PropertyScope,402	) -> impl Iterator<Item = (PropertyKey, AuxPropertyValue)> {403		<TokenAuxProperties<T>>::iter_prefix((collection_id, token_id, scope))404	}405406	/// Get ID of the last minted token407	pub fn current_token_id(collection_id: CollectionId) -> TokenId {408		TokenId(<TokensMinted<T>>::get(collection_id))409	}410}411412// unchecked calls skips any permission checks413impl<T: Config> Pallet<T> {414	/// Create NFT collection415	///416	/// `init_collection` will take non-refundable deposit for collection creation.417	///418	/// - `data`: Contains settings for collection limits and permissions.419	pub fn init_collection(420		owner: T::CrossAccountId,421		payer: T::CrossAccountId,422		data: CreateCollectionData<T::AccountId>,423		flags: CollectionFlags,424	) -> Result<CollectionId, DispatchError> {425		<PalletCommon<T>>::init_collection(owner, payer, data, flags)426	}427428	/// Destroy NFT collection429	///430	/// `destroy_collection` will throw error if collection contains any tokens.431	/// Only owner can destroy collection.432	pub fn destroy_collection(433		collection: NonfungibleHandle<T>,434		sender: &T::CrossAccountId,435	) -> DispatchResult {436		let id = collection.id;437438		if Self::collection_has_tokens(id) {439			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());440		}441442		// =========443444		PalletCommon::destroy_collection(collection.0, sender)?;445446		let _ = <TokenData<T>>::clear_prefix((id,), u32::MAX, None);447		let _ = <TokenChildren<T>>::clear_prefix((id,), u32::MAX, None);448		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);449		<TokensMinted<T>>::remove(id);450		<TokensBurnt<T>>::remove(id);451		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);452		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);453		let _ = <CollectionAllowance<T>>::clear_prefix((id,), u32::MAX, None);454		Ok(())455	}456457	/// Burn NFT token458	///459	/// `burn` removes `token` from the `collection`, from it's owner and from the parent token460	/// if the token is nested.461	/// Only the owner can `burn` the token. The `token` shouldn't have any nested tokens.462	/// Also removes all corresponding properties and auxiliary properties.463	///464	/// - `token`: Token that should be burned465	/// - `collection`: Collection that contains the token466	pub fn burn(467		collection: &NonfungibleHandle<T>,468		sender: &T::CrossAccountId,469		token: TokenId,470	) -> DispatchResult {471		let token_data =472			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;473		ensure!(&token_data.owner == sender, <CommonError<T>>::NoPermission);474475		if collection.permissions.access() == AccessMode::AllowList {476			collection.check_allowlist(sender)?;477		}478479		if Self::token_has_children(collection.id, token) {480			return Err(<Error<T>>::CantBurnNftWithChildren.into());481		}482483		let burnt = <TokensBurnt<T>>::get(collection.id)484			.checked_add(1)485			.ok_or(ArithmeticError::Overflow)?;486487		let balance = <AccountBalance<T>>::get((collection.id, token_data.owner.clone()))488			.checked_sub(1)489			.ok_or(ArithmeticError::Overflow)?;490491		// =========492493		if balance == 0 {494			<AccountBalance<T>>::remove((collection.id, token_data.owner.clone()));495		} else {496			<AccountBalance<T>>::insert((collection.id, token_data.owner.clone()), balance);497		}498499		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);500501		<Owned<T>>::remove((collection.id, &token_data.owner, token));502		<TokensBurnt<T>>::insert(collection.id, burnt);503		<TokenData<T>>::remove((collection.id, token));504		<TokenProperties<T>>::remove((collection.id, token));505		let _ = <TokenAuxProperties<T>>::clear_prefix((collection.id, token), u32::MAX, None);506		let old_spender = <Allowance<T>>::take((collection.id, token));507508		if let Some(old_spender) = old_spender {509			<PalletCommon<T>>::deposit_event(CommonEvent::Approved(510				collection.id,511				token,512				token_data.owner.clone(),513				old_spender,514				0,515			));516		}517518		<PalletEvm<T>>::deposit_log(519			ERC721Events::Transfer {520				from: *token_data.owner.as_eth(),521				to: H160::default(),522				token_id: token.into(),523			}524			.to_log(collection_id_to_address(collection.id)),525		);526		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(527			collection.id,528			token,529			token_data.owner,530			1,531		));532		Ok(())533	}534535	/// Same as [`burn`] but burns all the tokens that are nested in the token first536	///537	/// - `self_budget`: Limit for searching children in depth.538	/// - `breadth_budget`: Limit of breadth of searching children.539	///540	/// [`burn`]: struct.Pallet.html#method.burn541	#[transactional]542	pub fn burn_recursively(543		collection: &NonfungibleHandle<T>,544		sender: &T::CrossAccountId,545		token: TokenId,546		self_budget: &dyn Budget,547		breadth_budget: &dyn Budget,548	) -> DispatchResultWithPostInfo {549		ensure!(self_budget.consume(), <StructureError<T>>::DepthLimit,);550551		let current_token_account =552			T::CrossTokenAddressMapping::token_to_address(collection.id, token);553554		let mut weight = Weight::zero();555556		// This method is transactional, if user in fact doesn't have permissions to remove token -557		// tokens removed here will be restored after rejected transaction558		for ((collection, token), _) in <TokenChildren<T>>::iter_prefix((collection.id, token)) {559			ensure!(breadth_budget.consume(), <StructureError<T>>::BreadthLimit,);560			let PostDispatchInfo { actual_weight, .. } =561				<PalletStructure<T>>::burn_item_recursively(562					current_token_account.clone(),563					collection,564					token,565					self_budget,566					breadth_budget,567				)?;568			if let Some(actual_weight) = actual_weight {569				weight = weight.saturating_add(actual_weight);570			}571		}572573		Self::burn(collection, sender, token)?;574		DispatchResultWithPostInfo::Ok(PostDispatchInfo {575			actual_weight: Some(weight + <SelfWeightOf<T>>::burn_item()),576			pays_fee: Pays::Yes,577		})578	}579580	/// Batch operation to add, edit or remove properties for the token581	///582	/// All affected properties should have mutable permission and sender should have583	/// permission to edit those properties.584	///585	/// - `nesting_budget`: Limit for searching parents in depth to check ownership.586	/// - `is_token_create`: Indicates that method is called during token initialization.587	///   Allows to bypass ownership check.588	#[transactional]589	fn modify_token_properties(590		collection: &NonfungibleHandle<T>,591		sender: &T::CrossAccountId,592		token_id: TokenId,593		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,594		is_token_create: bool,595		nesting_budget: &dyn Budget,596	) -> DispatchResult {597		let mut collection_admin_status = None;598		let mut token_owner_result = None;599600		let mut is_collection_admin =601			|| *collection_admin_status.get_or_insert_with(|| collection.is_owner_or_admin(sender));602603		let mut is_token_owner = || {604			*token_owner_result.get_or_insert_with(|| -> Result<bool, DispatchError> {605				let is_owned = <PalletStructure<T>>::check_indirectly_owned(606					sender.clone(),607					collection.id,608					token_id,609					None,610					nesting_budget,611				)?;612613				Ok(is_owned)614			})615		};616617		let mut stored_properties = <TokenProperties<T>>::get((collection.id, token_id));618		let permissions = <PalletCommon<T>>::property_permissions(collection.id);619620		for (key, value) in properties_updates {621			let permission = permissions622				.get(&key)623				.cloned()624				.unwrap_or_else(PropertyPermission::none);625626			let is_property_exists = stored_properties.get(&key).is_some();627628			match permission {629				PropertyPermission { mutable: false, .. } if is_property_exists => {630					return Err(<CommonError<T>>::NoPermission.into());631				}632633				PropertyPermission {634					collection_admin,635					token_owner,636					..637				} => {638					//TODO: investigate threats during public minting.639					if is_token_create && (collection_admin || token_owner) && value.is_some() {640						// Pass641					} else if collection_admin && is_collection_admin() {642						// Pass643					} else if token_owner && is_token_owner()? {644						// Pass645					} else {646						fail!(<CommonError<T>>::NoPermission);647					}648				}649			}650651			match value {652				Some(value) => {653					stored_properties654						.try_set(key.clone(), value)655						.map_err(<CommonError<T>>::from)?;656657					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(658						collection.id,659						token_id,660						key,661					));662				}663				None => {664					stored_properties665						.remove(&key)666						.map_err(<CommonError<T>>::from)?;667668					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(669						collection.id,670						token_id,671						key,672					));673				}674			}675676			<PalletEvm<T>>::deposit_log(677				CollectionHelpersEvents::TokenChanged {678					collection_id: collection_id_to_address(collection.id),679					token_id: token_id.into(),680				}681				.to_log(T::ContractAddress::get()),682			);683		}684685		<TokenProperties<T>>::set((collection.id, token_id), stored_properties);686687		Ok(())688	}689690	/// Batch operation to add or edit properties for the token691	///692	/// Same as [`modify_token_properties`] but doesn't allow to remove properties693	///694	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties695	pub fn set_token_properties(696		collection: &NonfungibleHandle<T>,697		sender: &T::CrossAccountId,698		token_id: TokenId,699		properties: impl Iterator<Item = Property>,700		is_token_create: bool,701		nesting_budget: &dyn Budget,702	) -> DispatchResult {703		Self::modify_token_properties(704			collection,705			sender,706			token_id,707			properties.map(|p| (p.key, Some(p.value))),708			is_token_create,709			nesting_budget,710		)711	}712713	/// Add or edit single property for the token714	///715	/// Calls [`set_token_properties`] internally716	///717	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties718	pub fn set_token_property(719		collection: &NonfungibleHandle<T>,720		sender: &T::CrossAccountId,721		token_id: TokenId,722		property: Property,723		nesting_budget: &dyn Budget,724	) -> DispatchResult {725		let is_token_create = false;726727		Self::set_token_properties(728			collection,729			sender,730			token_id,731			[property].into_iter(),732			is_token_create,733			nesting_budget,734		)735	}736737	/// Batch operation to remove properties from the token738	///739	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties740	///741	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties742	pub fn delete_token_properties(743		collection: &NonfungibleHandle<T>,744		sender: &T::CrossAccountId,745		token_id: TokenId,746		property_keys: impl Iterator<Item = PropertyKey>,747		nesting_budget: &dyn Budget,748	) -> DispatchResult {749		let is_token_create = false;750751		Self::modify_token_properties(752			collection,753			sender,754			token_id,755			property_keys.into_iter().map(|key| (key, None)),756			is_token_create,757			nesting_budget,758		)759	}760761	/// Remove single property from the token762	///763	/// Calls [`delete_token_properties`] internally764	///765	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties766	pub fn delete_token_property(767		collection: &NonfungibleHandle<T>,768		sender: &T::CrossAccountId,769		token_id: TokenId,770		property_key: PropertyKey,771		nesting_budget: &dyn Budget,772	) -> DispatchResult {773		Self::delete_token_properties(774			collection,775			sender,776			token_id,777			[property_key].into_iter(),778			nesting_budget,779		)780	}781782	/// Add or edit properties for the collection783	pub fn set_collection_properties(784		collection: &NonfungibleHandle<T>,785		sender: &T::CrossAccountId,786		properties: Vec<Property>,787	) -> DispatchResult {788		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())789	}790791	/// Remove properties from the collection792	pub fn delete_collection_properties(793		collection: &CollectionHandle<T>,794		sender: &T::CrossAccountId,795		property_keys: Vec<PropertyKey>,796	) -> DispatchResult {797		<PalletCommon<T>>::delete_collection_properties(798			collection,799			sender,800			property_keys.into_iter(),801		)802	}803804	/// Set property permissions for the token.805	///806	/// Sender should be the owner or admin of token's collection.807	pub fn set_token_property_permissions(808		collection: &CollectionHandle<T>,809		sender: &T::CrossAccountId,810		property_permissions: Vec<PropertyKeyPermission>,811	) -> DispatchResult {812		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)813	}814815	/// Set property permissions for the token with scope.816	///817	/// Sender should be the owner or admin of token's collection.818	pub fn set_scoped_token_property_permissions(819		collection: &CollectionHandle<T>,820		sender: &T::CrossAccountId,821		scope: PropertyScope,822		property_permissions: Vec<PropertyKeyPermission>,823	) -> DispatchResult {824		<PalletCommon<T>>::set_scoped_token_property_permissions(825			collection,826			sender,827			scope,828			property_permissions,829		)830	}831832	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {833		<PalletCommon<T>>::property_permissions(collection_id)834	}835836	pub fn check_token_immediate_ownership(837		collection: &NonfungibleHandle<T>,838		token: TokenId,839		possible_owner: &T::CrossAccountId,840	) -> DispatchResult {841		let token_data =842			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;843		ensure!(844			&token_data.owner == possible_owner,845			<CommonError<T>>::NoPermission846		);847		Ok(())848	}849850	/// Transfer NFT token from one account to another.851	///852	/// `from` account stops being the owner and `to` account becomes the owner of the token.853	/// If `to` is token than `to` becomes owner of the token and the token become nested.854	/// Unnests token from previous parent if it was nested before.855	/// Removes allowance for the token if there was any.856	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.857	///858	/// - `nesting_budget`: Limit for token nesting depth859	pub fn transfer(860		collection: &NonfungibleHandle<T>,861		from: &T::CrossAccountId,862		to: &T::CrossAccountId,863		token: TokenId,864		nesting_budget: &dyn Budget,865	) -> DispatchResult {866		ensure!(867			collection.limits.transfers_enabled(),868			<CommonError<T>>::TransferNotAllowed869		);870871		let token_data =872			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;873		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);874875		if collection.permissions.access() == AccessMode::AllowList {876			collection.check_allowlist(from)?;877			collection.check_allowlist(to)?;878		}879		<PalletCommon<T>>::ensure_correct_receiver(to)?;880881		let balance_from = <AccountBalance<T>>::get((collection.id, from))882			.checked_sub(1)883			.ok_or(<CommonError<T>>::TokenValueTooLow)?;884		let balance_to = if from != to {885			let balance_to = <AccountBalance<T>>::get((collection.id, to))886				.checked_add(1)887				.ok_or(ArithmeticError::Overflow)?;888889			ensure!(890				balance_to < collection.limits.account_token_ownership_limit(),891				<CommonError<T>>::AccountTokenLimitExceeded,892			);893894			Some(balance_to)895		} else {896			None897		};898899		<PalletStructure<T>>::nest_if_sent_to_token(900			from.clone(),901			to,902			collection.id,903			token,904			nesting_budget,905		)?;906907		// =========908909		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);910911		<TokenData<T>>::insert(912			(collection.id, token),913			ItemData {914				owner: to.clone(),915				..token_data916			},917		);918919		if let Some(balance_to) = balance_to {920			// from != to921			if balance_from == 0 {922				<AccountBalance<T>>::remove((collection.id, from));923			} else {924				<AccountBalance<T>>::insert((collection.id, from), balance_from);925			}926			<AccountBalance<T>>::insert((collection.id, to), balance_to);927			<Owned<T>>::remove((collection.id, from, token));928			<Owned<T>>::insert((collection.id, to, token), true);929		}930		Self::set_allowance_unchecked(collection, from, token, None, true);931932		<PalletEvm<T>>::deposit_log(933			ERC721Events::Transfer {934				from: *from.as_eth(),935				to: *to.as_eth(),936				token_id: token.into(),937			}938			.to_log(collection_id_to_address(collection.id)),939		);940		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(941			collection.id,942			token,943			from.clone(),944			to.clone(),945			1,946		));947		Ok(())948	}949950	/// Batch operation to mint multiple NFT tokens.951	///952	/// The sender should be the owner/admin of the collection or collection should be configured953	/// to allow public minting.954	/// Throws if amount of tokens reached it's limit for the collection or if caller reached955	/// token ownership limit.956	///957	/// - `data`: Contains list of token properties and users who will become the owners of the958	///   corresponging tokens.959	/// - `nesting_budget`: Limit for token nesting depth960	pub fn create_multiple_items(961		collection: &NonfungibleHandle<T>,962		sender: &T::CrossAccountId,963		data: Vec<CreateItemData<T>>,964		nesting_budget: &dyn Budget,965	) -> DispatchResult {966		if !collection.is_owner_or_admin(sender) {967			ensure!(968				collection.permissions.mint_mode(),969				<CommonError<T>>::PublicMintingNotAllowed970			);971			collection.check_allowlist(sender)?;972973			for item in data.iter() {974				collection.check_allowlist(&item.owner)?;975			}976		}977978		for data in data.iter() {979			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;980		}981982		let first_token = <TokensMinted<T>>::get(collection.id);983		let tokens_minted = first_token984			.checked_add(data.len() as u32)985			.ok_or(ArithmeticError::Overflow)?;986		ensure!(987			tokens_minted <= collection.limits.token_limit(),988			<CommonError<T>>::CollectionTokenLimitExceeded989		);990991		let mut balances = BTreeMap::new();992		for data in &data {993			let balance = balances994				.entry(&data.owner)995				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));996			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;997998			ensure!(999				*balance <= collection.limits.account_token_ownership_limit(),1000				<CommonError<T>>::AccountTokenLimitExceeded,1001			);1002		}10031004		for (i, data) in data.iter().enumerate() {1005			let token = TokenId(first_token + i as u32 + 1);10061007			<PalletStructure<T>>::check_nesting(1008				sender.clone(),1009				&data.owner,1010				collection.id,1011				token,1012				nesting_budget,1013			)?;1014		}10151016		// =========10171018		with_transaction(|| {1019			for (i, data) in data.iter().enumerate() {1020				let token = first_token + i as u32 + 1;10211022				<TokenData<T>>::insert(1023					(collection.id, token),1024					ItemData {1025						// const_data: data.const_data.clone(),1026						owner: data.owner.clone(),1027					},1028				);10291030				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1031					&data.owner,1032					collection.id,1033					TokenId(token),1034				);10351036				if let Err(e) = Self::set_token_properties(1037					collection,1038					sender,1039					TokenId(token),1040					data.properties.clone().into_iter(),1041					true,1042					nesting_budget,1043				) {1044					return TransactionOutcome::Rollback(Err(e));1045				}1046			}1047			TransactionOutcome::Commit(Ok(()))1048		})?;10491050		<TokensMinted<T>>::insert(collection.id, tokens_minted);1051		for (account, balance) in balances {1052			<AccountBalance<T>>::insert((collection.id, account), balance);1053		}1054		for (i, data) in data.into_iter().enumerate() {1055			let token = first_token + i as u32 + 1;1056			<Owned<T>>::insert((collection.id, &data.owner, token), true);10571058			<PalletEvm<T>>::deposit_log(1059				ERC721Events::Transfer {1060					from: H160::default(),1061					to: *data.owner.as_eth(),1062					token_id: token.into(),1063				}1064				.to_log(collection_id_to_address(collection.id)),1065			);1066			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1067				collection.id,1068				TokenId(token),1069				data.owner.clone(),1070				1,1071			));1072		}1073		Ok(())1074	}10751076	pub fn set_allowance_unchecked(1077		collection: &NonfungibleHandle<T>,1078		sender: &T::CrossAccountId,1079		token: TokenId,1080		spender: Option<&T::CrossAccountId>,1081		assume_implicit_eth: bool,1082	) {1083		if let Some(spender) = spender {1084			let old_spender = <Allowance<T>>::get((collection.id, token));1085			<Allowance<T>>::insert((collection.id, token), spender);1086			// In ERC721 there is only one possible approved user of token, so we set1087			// approved user to spender1088			<PalletEvm<T>>::deposit_log(1089				ERC721Events::Approval {1090					owner: *sender.as_eth(),1091					approved: *spender.as_eth(),1092					token_id: token.into(),1093				}1094				.to_log(collection_id_to_address(collection.id)),1095			);1096			// In Unique chain, any token can have any amount of approved users, so we need to1097			// set allowance of old owner to 0, and allowance of new owner to 11098			if old_spender.as_ref() != Some(spender) {1099				if let Some(old_owner) = old_spender {1100					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1101						collection.id,1102						token,1103						sender.clone(),1104						old_owner,1105						0,1106					));1107				}1108				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1109					collection.id,1110					token,1111					sender.clone(),1112					spender.clone(),1113					1,1114				));1115			}1116		} else {1117			let old_spender = <Allowance<T>>::take((collection.id, token));1118			if !assume_implicit_eth {1119				// In ERC721 there is only one possible approved user of token, so we set1120				// approved user to zero address1121				<PalletEvm<T>>::deposit_log(1122					ERC721Events::Approval {1123						owner: *sender.as_eth(),1124						approved: H160::default(),1125						token_id: token.into(),1126					}1127					.to_log(collection_id_to_address(collection.id)),1128				);1129			}1130			// In Unique chain, any token can have any amount of approved users, so we need to1131			// set allowance of old owner to 01132			if let Some(old_spender) = old_spender {1133				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1134					collection.id,1135					token,1136					sender.clone(),1137					old_spender,1138					0,1139				));1140			}1141		}1142	}11431144	/// Set allowance for the spender to `transfer` or `burn` sender's token.1145	///1146	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1147	pub fn set_allowance(1148		collection: &NonfungibleHandle<T>,1149		sender: &T::CrossAccountId,1150		token: TokenId,1151		spender: Option<&T::CrossAccountId>,1152	) -> DispatchResult {1153		if collection.permissions.access() == AccessMode::AllowList {1154			collection.check_allowlist(sender)?;1155			if let Some(spender) = spender {1156				collection.check_allowlist(spender)?;1157			}1158		}11591160		if let Some(spender) = spender {1161			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1162		}11631164		let token_data =1165			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1166		if &token_data.owner != sender {1167			ensure!(1168				collection.ignores_owned_amount(sender),1169				<CommonError<T>>::CantApproveMoreThanOwned1170			);1171		}11721173		// =========11741175		Self::set_allowance_unchecked(collection, sender, token, spender, false);1176		Ok(())1177	}11781179	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1180	///1181	/// - `from`: Address of sender's eth mirror.1182	/// - `to`: Adress of spender.1183	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1184	pub fn set_allowance_from(1185		collection: &NonfungibleHandle<T>,1186		sender: &T::CrossAccountId,1187		from: &T::CrossAccountId,1188		token: TokenId,1189		to: Option<&T::CrossAccountId>,1190	) -> DispatchResult {1191		if collection.permissions.access() == AccessMode::AllowList {1192			collection.check_allowlist(sender)?;1193			collection.check_allowlist(from)?;1194			if let Some(to) = to {1195				collection.check_allowlist(to)?;1196			}1197		}11981199		if let Some(to) = to {1200			<PalletCommon<T>>::ensure_correct_receiver(to)?;1201		}12021203		ensure!(1204			sender.conv_eq(from),1205			<CommonError<T>>::AddressIsNotEthMirror1206		);12071208		let token_data =1209			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1210		if token_data.owner != *from {1211			ensure!(1212				collection.limits.owner_can_transfer()1213					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1214				<CommonError<T>>::CantApproveMoreThanOwned1215			);1216		}12171218		// =========12191220		Self::set_allowance_unchecked(collection, from, token, to, false);1221		Ok(())1222	}12231224	/// Checks allowance for the spender to use the token.1225	fn check_allowed(1226		collection: &NonfungibleHandle<T>,1227		spender: &T::CrossAccountId,1228		from: &T::CrossAccountId,1229		token: TokenId,1230		nesting_budget: &dyn Budget,1231	) -> DispatchResult {1232		if spender.conv_eq(from) {1233			return Ok(());1234		}1235		if collection.permissions.access() == AccessMode::AllowList {1236			// `from`, `to` checked in [`transfer`]1237			collection.check_allowlist(spender)?;1238		}12391240		if collection.limits.owner_can_transfer() && collection.is_owner_or_admin(spender) {1241			return Ok(());1242		}12431244		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1245			ensure!(1246				<PalletStructure<T>>::check_indirectly_owned(1247					spender.clone(),1248					source.0,1249					source.1,1250					None,1251					nesting_budget1252				)?,1253				<CommonError<T>>::ApprovedValueTooLow,1254			);1255			return Ok(());1256		}1257		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1258			return Ok(());1259		}1260		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1261			return Ok(());1262		}1263		ensure!(1264			collection.ignores_allowance(spender),1265			<CommonError<T>>::ApprovedValueTooLow1266		);1267		Ok(())1268	}12691270	/// Transfer NFT token from one account to another.1271	///1272	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1273	/// The owner should set allowance for the spender to transfer token.1274	///1275	/// [`transfer`]: struct.Pallet.html#method.transfer1276	pub fn transfer_from(1277		collection: &NonfungibleHandle<T>,1278		spender: &T::CrossAccountId,1279		from: &T::CrossAccountId,1280		to: &T::CrossAccountId,1281		token: TokenId,1282		nesting_budget: &dyn Budget,1283	) -> DispatchResult {1284		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12851286		// =========12871288		// Allowance is reset in [`transfer`]1289		Self::transfer(collection, from, to, token, nesting_budget)1290	}12911292	/// Burn NFT token for `from` account.1293	///1294	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1295	/// set allowance for the spender to burn token.1296	///1297	/// [`burn`]: struct.Pallet.html#method.burn1298	pub fn burn_from(1299		collection: &NonfungibleHandle<T>,1300		spender: &T::CrossAccountId,1301		from: &T::CrossAccountId,1302		token: TokenId,1303		nesting_budget: &dyn Budget,1304	) -> DispatchResult {1305		Self::check_allowed(collection, spender, from, token, nesting_budget)?;13061307		// =========13081309		Self::burn(collection, from, token)1310	}13111312	/// Check that `from` token could be nested in `under` token.1313	///1314	pub fn check_nesting(1315		handle: &NonfungibleHandle<T>,1316		sender: T::CrossAccountId,1317		from: (CollectionId, TokenId),1318		under: TokenId,1319		nesting_budget: &dyn Budget,1320	) -> DispatchResult {1321		let nesting = handle.permissions.nesting();13221323		#[cfg(not(feature = "runtime-benchmarks"))]1324		let permissive = false;1325		#[cfg(feature = "runtime-benchmarks")]1326		let permissive = nesting.permissive;13271328		if permissive {1329			// Pass1330		} else if nesting.token_owner1331			&& <PalletStructure<T>>::check_indirectly_owned(1332				sender.clone(),1333				handle.id,1334				under,1335				Some(from),1336				nesting_budget,1337			)? {1338			// Pass1339		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1340			// Pass1341		} else {1342			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1343		}13441345		if let Some(whitelist) = &nesting.restricted {1346			ensure!(1347				whitelist.contains(&from.0),1348				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1349			);1350		}1351		Ok(())1352	}13531354	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1355		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1356	}13571358	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1359		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1360	}13611362	fn collection_has_tokens(collection_id: CollectionId) -> bool {1363		<TokenData<T>>::iter_prefix((collection_id,))1364			.next()1365			.is_some()1366	}13671368	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1369		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1370			.next()1371			.is_some()1372	}13731374	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1375		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1376			.map(|((child_collection_id, child_id), _)| TokenChild {1377				collection: child_collection_id,1378				token: child_id,1379			})1380			.collect()1381	}13821383	/// Mint single NFT token.1384	///1385	/// Delegated to [`create_multiple_items`]1386	///1387	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1388	pub fn create_item(1389		collection: &NonfungibleHandle<T>,1390		sender: &T::CrossAccountId,1391		data: CreateItemData<T>,1392		nesting_budget: &dyn Budget,1393	) -> DispatchResult {1394		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1395	}13961397	/// Sets or unsets the approval of a given operator.1398	///1399	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1400	/// - `owner`: Token owner1401	/// - `operator`: Operator1402	/// - `approve`: Should operator status be granted or revoked?1403	pub fn set_allowance_for_all(1404		collection: &NonfungibleHandle<T>,1405		owner: &T::CrossAccountId,1406		operator: &T::CrossAccountId,1407		approve: bool,1408	) -> DispatchResult {1409		if collection.permissions.access() == AccessMode::AllowList {1410			collection.check_allowlist(owner)?;1411			collection.check_allowlist(operator)?;1412		}14131414		<PalletCommon<T>>::ensure_correct_receiver(operator)?;14151416		// =========14171418		<CollectionAllowance<T>>::insert((collection.id, owner, operator), approve);1419		<PalletEvm<T>>::deposit_log(1420			ERC721Events::ApprovalForAll {1421				owner: *owner.as_eth(),1422				operator: *operator.as_eth(),1423				approved: approve,1424			}1425			.to_log(collection_id_to_address(collection.id)),1426		);1427		<PalletCommon<T>>::deposit_event(CommonEvent::ApprovedForAll(1428			collection.id,1429			owner.clone(),1430			operator.clone(),1431			approve,1432		));1433		Ok(())1434	}14351436	/// Tells whether the given `owner` approves the `operator`.1437	pub fn allowance_for_all(1438		collection: &NonfungibleHandle<T>,1439		owner: &T::CrossAccountId,1440		operator: &T::CrossAccountId,1441	) -> bool {1442		<CollectionAllowance<T>>::get((collection.id, owner, operator))1443	}14441445	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1446		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1447			properties.recompute_consumed_space();1448		});14491450		Ok(())1451	}1452}