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

1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617//! # Nonfungible Pallet18//!19//! The Nonfungible pallet provides functionality for handling nonfungible collections and tokens.20//!21//! - [`Config`]22//! - [`NonfungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Nonfungible pallet provides functions for:29//!30//! - NFT collection creation and removal31//! - Minting and burning of NFT tokens32//! - Retrieving account balances33//! - Transfering NFT tokens34//! - Setting and checking allowance for NFT tokens35//! - Setting properties and permissions for NFT collections and tokens36//! - Nesting and unnesting tokens37//!38//! ### Terminology39//!40//! - **NFT token:** Non fungible token.41//!42//! - **NFT Collection:** A collection of NFT tokens. All NFT tokens are part of a collection.43//!   Each collection can define it's own properties, properties for it's tokens and set of permissions.44//!45//! - **Balance:** Number of NFT tokens owned by an account46//!47//! - **Allowance:** NFT tokens owned by one account that another account is allowed to make operations on48//!49//! - **Burning:** The process of “deleting” a token from a collection and from50//!   an account balance of the owner.51//!52//! - **Nesting:** Setting up parent-child relationship between tokens. Nested tokens are inhereting53//!   owner from their parent. There could be multiple levels of nesting. Token couldn't be nested in54//!   it's child token i.e. parent-child relationship graph shouldn't have cycles.55//!56//! - **Properties:** Key-Values pairs. Token properties are attached to a token. Collection properties are57//!   attached to a collection. Set of permissions could be defined for each property.58//!59//! ### Implementations60//!61//! The Nonfungible pallet provides implementations for the following traits. If these traits provide62//! the functionality that you need, then you can avoid coupling with the Nonfungible pallet.63//!64//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight65//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing66//!   with collections67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create NFT collection. NFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising NFT collection. There should be no tokens in the collection.75//! - `burn` - Burn NFT token owned by account.76//! - `transfer` - Transfer NFT token. Transfers should be enabled for NFT collection.77//!   Nests the NFT token if it is sent to another token.78//! - `create_item` - Mint NFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account.80//! - `set_token_property` - Set token property value.81//! - `delete_token_property` - Remove property from the token.82//! - `set_collection_properties` - Set collection properties.83//! - `delete_collection_properties` - Remove properties from the collection.84//! - `set_property_permission` - Set collection property permission.85//! - `set_token_property_permissions` - Set token property permissions.86//!87//! ## Assumptions88//!89//! * To perform operations on tokens sender should be in collection's allow list if collection access mode is `AllowList`.9091#![cfg_attr(not(feature = "std"), no_std)]9293use erc::ERC721Events;94use evm_coder::ToLog;95use frame_support::{96	BoundedVec, ensure, fail, transactional,97	storage::with_transaction,98	pallet_prelude::DispatchResultWithPostInfo,99	pallet_prelude::Weight,100	dispatch::{PostDispatchInfo, Pays},101};102use up_data_structs::{103	AccessMode, CollectionId, CollectionFlags, CustomDataLimit, TokenId, CreateCollectionData,104	CreateNftExData, mapping::TokenAddressMapping, budget::Budget, Property, PropertyKey,105	PropertyValue, PropertyKeyPermission, Properties, PropertyScope, TrySetProperty, TokenChild,106	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,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::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 unused.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	/// A batch operation to add, edit or remove properties for a token.581	///582	/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.583	/// - `is_token_create`: Indicates that method is called during token initialization.584	///   Allows to bypass ownership check.585	///586	/// All affected properties should have `mutable` permission587	/// to be **deleted** or to be **set more than once**,588	/// and the sender should have permission to edit those properties.589	///590	/// This function fires an event for each property change.591	/// In case of an error, all the changes (including the events) will be reverted592	/// since the function is transactional.593	#[transactional]594	fn modify_token_properties(595		collection: &NonfungibleHandle<T>,596		sender: &T::CrossAccountId,597		token_id: TokenId,598		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,599		is_token_create: bool,600		nesting_budget: &dyn Budget,601	) -> DispatchResult {602		let is_token_owner = || {603			let is_owned = <PalletStructure<T>>::check_indirectly_owned(604				sender.clone(),605				collection.id,606				token_id,607				None,608				nesting_budget,609			)?;610611			Ok(is_owned)612		};613614		let stored_properties = <TokenProperties<T>>::get((collection.id, token_id));615616		<PalletCommon<T>>::modify_token_properties(617			collection,618			sender,619			token_id,620			properties_updates,621			is_token_create,622			stored_properties,623			is_token_owner,624			|properties| <TokenProperties<T>>::set((collection.id, token_id), properties),625		)626	}627628	/// Batch operation to add or edit properties for the token629	///630	/// Same as [`modify_token_properties`] but doesn't allow to remove properties631	///632	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties633	pub fn set_token_properties(634		collection: &NonfungibleHandle<T>,635		sender: &T::CrossAccountId,636		token_id: TokenId,637		properties: impl Iterator<Item = Property>,638		is_token_create: bool,639		nesting_budget: &dyn Budget,640	) -> DispatchResult {641		Self::modify_token_properties(642			collection,643			sender,644			token_id,645			properties.map(|p| (p.key, Some(p.value))),646			is_token_create,647			nesting_budget,648		)649	}650651	/// Add or edit single property for the token652	///653	/// Calls [`set_token_properties`] internally654	///655	/// [`set_token_properties`]: struct.Pallet.html#method.set_token_properties656	pub fn set_token_property(657		collection: &NonfungibleHandle<T>,658		sender: &T::CrossAccountId,659		token_id: TokenId,660		property: Property,661		nesting_budget: &dyn Budget,662	) -> DispatchResult {663		let is_token_create = false;664665		Self::set_token_properties(666			collection,667			sender,668			token_id,669			[property].into_iter(),670			is_token_create,671			nesting_budget,672		)673	}674675	/// Batch operation to remove properties from the token676	///677	/// Same as [`modify_token_properties`] but doesn't allow to add or edit properties678	///679	/// [`modify_token_properties`]: struct.Pallet.html#method.modify_token_properties680	pub fn delete_token_properties(681		collection: &NonfungibleHandle<T>,682		sender: &T::CrossAccountId,683		token_id: TokenId,684		property_keys: impl Iterator<Item = PropertyKey>,685		nesting_budget: &dyn Budget,686	) -> DispatchResult {687		let is_token_create = false;688689		Self::modify_token_properties(690			collection,691			sender,692			token_id,693			property_keys.into_iter().map(|key| (key, None)),694			is_token_create,695			nesting_budget,696		)697	}698699	/// Remove single property from the token700	///701	/// Calls [`delete_token_properties`] internally702	///703	/// [`delete_token_properties`]: struct.Pallet.html#method.delete_token_properties704	pub fn delete_token_property(705		collection: &NonfungibleHandle<T>,706		sender: &T::CrossAccountId,707		token_id: TokenId,708		property_key: PropertyKey,709		nesting_budget: &dyn Budget,710	) -> DispatchResult {711		Self::delete_token_properties(712			collection,713			sender,714			token_id,715			[property_key].into_iter(),716			nesting_budget,717		)718	}719720	/// Add or edit properties for the collection721	pub fn set_collection_properties(722		collection: &NonfungibleHandle<T>,723		sender: &T::CrossAccountId,724		properties: Vec<Property>,725	) -> DispatchResult {726		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())727	}728729	/// Remove properties from the collection730	pub fn delete_collection_properties(731		collection: &CollectionHandle<T>,732		sender: &T::CrossAccountId,733		property_keys: Vec<PropertyKey>,734	) -> DispatchResult {735		<PalletCommon<T>>::delete_collection_properties(736			collection,737			sender,738			property_keys.into_iter(),739		)740	}741742	/// Set property permissions for the token.743	///744	/// Sender should be the owner or admin of token's collection.745	pub fn set_token_property_permissions(746		collection: &CollectionHandle<T>,747		sender: &T::CrossAccountId,748		property_permissions: Vec<PropertyKeyPermission>,749	) -> DispatchResult {750		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)751	}752753	/// Set property permissions for the token with scope.754	///755	/// Sender should be the owner or admin of token's collection.756	pub fn set_scoped_token_property_permissions(757		collection: &CollectionHandle<T>,758		sender: &T::CrossAccountId,759		scope: PropertyScope,760		property_permissions: Vec<PropertyKeyPermission>,761	) -> DispatchResult {762		<PalletCommon<T>>::set_scoped_token_property_permissions(763			collection,764			sender,765			scope,766			property_permissions,767		)768	}769770	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {771		<PalletCommon<T>>::property_permissions(collection_id)772	}773774	pub fn check_token_immediate_ownership(775		collection: &NonfungibleHandle<T>,776		token: TokenId,777		possible_owner: &T::CrossAccountId,778	) -> DispatchResult {779		let token_data =780			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;781		ensure!(782			&token_data.owner == possible_owner,783			<CommonError<T>>::NoPermission784		);785		Ok(())786	}787788	/// Transfer NFT token from one account to another.789	///790	/// `from` account stops being the owner and `to` account becomes the owner of the token.791	/// If `to` is token than `to` becomes owner of the token and the token become nested.792	/// Unnests token from previous parent if it was nested before.793	/// Removes allowance for the token if there was any.794	/// Throws if transfers aren't allowed for collection or if receiver reached token ownership limit.795	///796	/// - `nesting_budget`: Limit for token nesting depth797	pub fn transfer(798		collection: &NonfungibleHandle<T>,799		from: &T::CrossAccountId,800		to: &T::CrossAccountId,801		token: TokenId,802		nesting_budget: &dyn Budget,803	) -> DispatchResult {804		ensure!(805			collection.limits.transfers_enabled(),806			<CommonError<T>>::TransferNotAllowed807		);808809		let token_data =810			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;811		ensure!(&token_data.owner == from, <CommonError<T>>::NoPermission);812813		if collection.permissions.access() == AccessMode::AllowList {814			collection.check_allowlist(from)?;815			collection.check_allowlist(to)?;816		}817		<PalletCommon<T>>::ensure_correct_receiver(to)?;818819		let balance_from = <AccountBalance<T>>::get((collection.id, from))820			.checked_sub(1)821			.ok_or(<CommonError<T>>::TokenValueTooLow)?;822		let balance_to = if from != to {823			let balance_to = <AccountBalance<T>>::get((collection.id, to))824				.checked_add(1)825				.ok_or(ArithmeticError::Overflow)?;826827			ensure!(828				balance_to < collection.limits.account_token_ownership_limit(),829				<CommonError<T>>::AccountTokenLimitExceeded,830			);831832			Some(balance_to)833		} else {834			None835		};836837		<PalletStructure<T>>::nest_if_sent_to_token(838			from.clone(),839			to,840			collection.id,841			token,842			nesting_budget,843		)?;844845		// =========846847		<PalletStructure<T>>::unnest_if_nested(&token_data.owner, collection.id, token);848849		<TokenData<T>>::insert(850			(collection.id, token),851			ItemData {852				owner: to.clone(),853				..token_data854			},855		);856857		if let Some(balance_to) = balance_to {858			// from != to859			if balance_from == 0 {860				<AccountBalance<T>>::remove((collection.id, from));861			} else {862				<AccountBalance<T>>::insert((collection.id, from), balance_from);863			}864			<AccountBalance<T>>::insert((collection.id, to), balance_to);865			<Owned<T>>::remove((collection.id, from, token));866			<Owned<T>>::insert((collection.id, to, token), true);867		}868		Self::set_allowance_unchecked(collection, from, token, None, true);869870		<PalletEvm<T>>::deposit_log(871			ERC721Events::Transfer {872				from: *from.as_eth(),873				to: *to.as_eth(),874				token_id: token.into(),875			}876			.to_log(collection_id_to_address(collection.id)),877		);878		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(879			collection.id,880			token,881			from.clone(),882			to.clone(),883			1,884		));885		Ok(())886	}887888	/// Batch operation to mint multiple NFT tokens.889	///890	/// The sender should be the owner/admin of the collection or collection should be configured891	/// to allow public minting.892	/// Throws if amount of tokens reached it's limit for the collection or if caller reached893	/// token ownership limit.894	///895	/// - `data`: Contains list of token properties and users who will become the owners of the896	///   corresponging tokens.897	/// - `nesting_budget`: Limit for token nesting depth898	pub fn create_multiple_items(899		collection: &NonfungibleHandle<T>,900		sender: &T::CrossAccountId,901		data: Vec<CreateItemData<T>>,902		nesting_budget: &dyn Budget,903	) -> DispatchResult {904		if !collection.is_owner_or_admin(sender) {905			ensure!(906				collection.permissions.mint_mode(),907				<CommonError<T>>::PublicMintingNotAllowed908			);909			collection.check_allowlist(sender)?;910911			for item in data.iter() {912				collection.check_allowlist(&item.owner)?;913			}914		}915916		for data in data.iter() {917			<PalletCommon<T>>::ensure_correct_receiver(&data.owner)?;918		}919920		let first_token = <TokensMinted<T>>::get(collection.id);921		let tokens_minted = first_token922			.checked_add(data.len() as u32)923			.ok_or(ArithmeticError::Overflow)?;924		ensure!(925			tokens_minted <= collection.limits.token_limit(),926			<CommonError<T>>::CollectionTokenLimitExceeded927		);928929		let mut balances = BTreeMap::new();930		for data in &data {931			let balance = balances932				.entry(&data.owner)933				.or_insert_with(|| <AccountBalance<T>>::get((collection.id, &data.owner)));934			*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;935936			ensure!(937				*balance <= collection.limits.account_token_ownership_limit(),938				<CommonError<T>>::AccountTokenLimitExceeded,939			);940		}941942		for (i, data) in data.iter().enumerate() {943			let token = TokenId(first_token + i as u32 + 1);944945			<PalletStructure<T>>::check_nesting(946				sender.clone(),947				&data.owner,948				collection.id,949				token,950				nesting_budget,951			)?;952		}953954		// =========955956		with_transaction(|| {957			for (i, data) in data.iter().enumerate() {958				let token = first_token + i as u32 + 1;959960				<TokenData<T>>::insert(961					(collection.id, token),962					ItemData {963						// const_data: data.const_data.clone(),964						owner: data.owner.clone(),965					},966				);967968				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(969					&data.owner,970					collection.id,971					TokenId(token),972				);973974				if let Err(e) = Self::set_token_properties(975					collection,976					sender,977					TokenId(token),978					data.properties.clone().into_iter(),979					true,980					nesting_budget,981				) {982					return TransactionOutcome::Rollback(Err(e));983				}984			}985			TransactionOutcome::Commit(Ok(()))986		})?;987988		<TokensMinted<T>>::insert(collection.id, tokens_minted);989		for (account, balance) in balances {990			<AccountBalance<T>>::insert((collection.id, account), balance);991		}992		for (i, data) in data.into_iter().enumerate() {993			let token = first_token + i as u32 + 1;994			<Owned<T>>::insert((collection.id, &data.owner, token), true);995996			<PalletEvm<T>>::deposit_log(997				ERC721Events::Transfer {998					from: H160::default(),999					to: *data.owner.as_eth(),1000					token_id: token.into(),1001				}1002				.to_log(collection_id_to_address(collection.id)),1003			);1004			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1005				collection.id,1006				TokenId(token),1007				data.owner.clone(),1008				1,1009			));1010		}1011		Ok(())1012	}10131014	pub fn set_allowance_unchecked(1015		collection: &NonfungibleHandle<T>,1016		sender: &T::CrossAccountId,1017		token: TokenId,1018		spender: Option<&T::CrossAccountId>,1019		assume_implicit_eth: bool,1020	) {1021		if let Some(spender) = spender {1022			let old_spender = <Allowance<T>>::get((collection.id, token));1023			<Allowance<T>>::insert((collection.id, token), spender);1024			// In ERC721 there is only one possible approved user of token, so we set1025			// approved user to spender1026			<PalletEvm<T>>::deposit_log(1027				ERC721Events::Approval {1028					owner: *sender.as_eth(),1029					approved: *spender.as_eth(),1030					token_id: token.into(),1031				}1032				.to_log(collection_id_to_address(collection.id)),1033			);1034			// In Unique chain, any token can have any amount of approved users, so we need to1035			// set allowance of old owner to 0, and allowance of new owner to 11036			if old_spender.as_ref() != Some(spender) {1037				if let Some(old_owner) = old_spender {1038					<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1039						collection.id,1040						token,1041						sender.clone(),1042						old_owner,1043						0,1044					));1045				}1046				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1047					collection.id,1048					token,1049					sender.clone(),1050					spender.clone(),1051					1,1052				));1053			}1054		} else {1055			let old_spender = <Allowance<T>>::take((collection.id, token));1056			if !assume_implicit_eth {1057				// In ERC721 there is only one possible approved user of token, so we set1058				// approved user to zero address1059				<PalletEvm<T>>::deposit_log(1060					ERC721Events::Approval {1061						owner: *sender.as_eth(),1062						approved: H160::default(),1063						token_id: token.into(),1064					}1065					.to_log(collection_id_to_address(collection.id)),1066				);1067			}1068			// In Unique chain, any token can have any amount of approved users, so we need to1069			// set allowance of old owner to 01070			if let Some(old_spender) = old_spender {1071				<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1072					collection.id,1073					token,1074					sender.clone(),1075					old_spender,1076					0,1077				));1078			}1079		}1080	}10811082	/// Set allowance for the spender to `transfer` or `burn` sender's token.1083	///1084	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1085	pub fn set_allowance(1086		collection: &NonfungibleHandle<T>,1087		sender: &T::CrossAccountId,1088		token: TokenId,1089		spender: Option<&T::CrossAccountId>,1090	) -> DispatchResult {1091		if collection.permissions.access() == AccessMode::AllowList {1092			collection.check_allowlist(sender)?;1093			if let Some(spender) = spender {1094				collection.check_allowlist(spender)?;1095			}1096		}10971098		if let Some(spender) = spender {1099			<PalletCommon<T>>::ensure_correct_receiver(spender)?;1100		}11011102		let token_data =1103			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1104		if &token_data.owner != sender {1105			ensure!(1106				collection.ignores_owned_amount(sender),1107				<CommonError<T>>::CantApproveMoreThanOwned1108			);1109		}11101111		// =========11121113		Self::set_allowance_unchecked(collection, sender, token, spender, false);1114		Ok(())1115	}11161117	/// Set allowance for the spender to `transfer` or `burn` sender's token from eth mirror.1118	///1119	/// - `from`: Address of sender's eth mirror.1120	/// - `to`: Adress of spender.1121	/// - `token`: Token the spender is allowed to `transfer` or `burn`.1122	pub fn set_allowance_from(1123		collection: &NonfungibleHandle<T>,1124		sender: &T::CrossAccountId,1125		from: &T::CrossAccountId,1126		token: TokenId,1127		to: Option<&T::CrossAccountId>,1128	) -> DispatchResult {1129		if collection.permissions.access() == AccessMode::AllowList {1130			collection.check_allowlist(sender)?;1131			collection.check_allowlist(from)?;1132			if let Some(to) = to {1133				collection.check_allowlist(to)?;1134			}1135		}11361137		if let Some(to) = to {1138			<PalletCommon<T>>::ensure_correct_receiver(to)?;1139		}11401141		ensure!(1142			sender.conv_eq(from),1143			<CommonError<T>>::AddressIsNotEthMirror1144		);11451146		let token_data =1147			<TokenData<T>>::get((collection.id, token)).ok_or(<CommonError<T>>::TokenNotFound)?;1148		if token_data.owner != *from {1149			ensure!(1150				collection.limits.owner_can_transfer()1151					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from)),1152				<CommonError<T>>::CantApproveMoreThanOwned1153			);1154		}11551156		// =========11571158		Self::set_allowance_unchecked(collection, from, token, to, false);1159		Ok(())1160	}11611162	/// Checks allowance for the spender to use the token.1163	fn check_allowed(1164		collection: &NonfungibleHandle<T>,1165		spender: &T::CrossAccountId,1166		from: &T::CrossAccountId,1167		token: TokenId,1168		nesting_budget: &dyn Budget,1169	) -> DispatchResult {1170		if spender.conv_eq(from) {1171			return Ok(());1172		}1173		if collection.permissions.access() == AccessMode::AllowList {1174			// `from`, `to` checked in [`transfer`]1175			collection.check_allowlist(spender)?;1176		}11771178		if collection.ignores_token_restrictions(spender) {1179			return Ok(());1180		}11811182		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1183			ensure!(1184				<PalletStructure<T>>::check_indirectly_owned(1185					spender.clone(),1186					source.0,1187					source.1,1188					None,1189					nesting_budget1190				)?,1191				<CommonError<T>>::ApprovedValueTooLow,1192			);1193			return Ok(());1194		}1195		if <Allowance<T>>::get((collection.id, token)).as_ref() == Some(spender) {1196			return Ok(());1197		}1198		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1199			return Ok(());1200		}12011202		Err(<CommonError<T>>::ApprovedValueTooLow.into())1203	}12041205	/// Transfer NFT token from one account to another.1206	///1207	/// Same as the [`transfer`] but spender doesn't needs to be the owner of the token.1208	/// The owner should set allowance for the spender to transfer token.1209	///1210	/// [`transfer`]: struct.Pallet.html#method.transfer1211	pub fn transfer_from(1212		collection: &NonfungibleHandle<T>,1213		spender: &T::CrossAccountId,1214		from: &T::CrossAccountId,1215		to: &T::CrossAccountId,1216		token: TokenId,1217		nesting_budget: &dyn Budget,1218	) -> DispatchResult {1219		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12201221		// =========12221223		// Allowance is reset in [`transfer`]1224		Self::transfer(collection, from, to, token, nesting_budget)1225	}12261227	/// Burn NFT token for `from` account.1228	///1229	/// Same as the [`burn`] but spender doesn't need to be an owner of the token. The owner should1230	/// set allowance for the spender to burn token.1231	///1232	/// [`burn`]: struct.Pallet.html#method.burn1233	pub fn burn_from(1234		collection: &NonfungibleHandle<T>,1235		spender: &T::CrossAccountId,1236		from: &T::CrossAccountId,1237		token: TokenId,1238		nesting_budget: &dyn Budget,1239	) -> DispatchResult {1240		Self::check_allowed(collection, spender, from, token, nesting_budget)?;12411242		// =========12431244		Self::burn(collection, from, token)1245	}12461247	/// Check that `from` token could be nested in `under` token.1248	///1249	pub fn check_nesting(1250		handle: &NonfungibleHandle<T>,1251		sender: T::CrossAccountId,1252		from: (CollectionId, TokenId),1253		under: TokenId,1254		nesting_budget: &dyn Budget,1255	) -> DispatchResult {1256		let nesting = handle.permissions.nesting();12571258		#[cfg(not(feature = "runtime-benchmarks"))]1259		let permissive = false;1260		#[cfg(feature = "runtime-benchmarks")]1261		let permissive = nesting.permissive;12621263		if permissive {1264			ensure!(1265				<TokenData<T>>::contains_key((handle.id, under)),1266				<CommonError<T>>::TokenNotFound1267			);1268		} else if nesting.token_owner1269			&& <PalletStructure<T>>::check_indirectly_owned(1270				sender.clone(),1271				handle.id,1272				under,1273				Some(from),1274				nesting_budget,1275			)? {1276			// Pass, token existence and ouroboros checks are done in `check_indirectly_owned`1277		} else if nesting.collection_admin && handle.is_owner_or_admin(&sender) {1278			// token existence and ouroboros checks are done in `get_checked_topmost_owner`1279			let _ = <PalletStructure<T>>::get_checked_topmost_owner(1280				handle.id,1281				under,1282				Some(from),1283				nesting_budget,1284			)?1285			.ok_or(<CommonError<T>>::TokenNotFound)?;1286		} else {1287			fail!(<CommonError<T>>::UserIsNotAllowedToNest);1288		}12891290		if let Some(whitelist) = &nesting.restricted {1291			ensure!(1292				whitelist.contains(&from.0),1293				<CommonError<T>>::SourceCollectionIsNotAllowedToNest1294			);1295		}1296		Ok(())1297	}12981299	fn nest(under: (CollectionId, TokenId), to_nest: (CollectionId, TokenId)) {1300		<TokenChildren<T>>::insert((under.0, under.1, (to_nest.0, to_nest.1)), true);1301	}13021303	fn unnest(under: (CollectionId, TokenId), to_unnest: (CollectionId, TokenId)) {1304		<TokenChildren<T>>::remove((under.0, under.1, to_unnest));1305	}13061307	fn collection_has_tokens(collection_id: CollectionId) -> bool {1308		<TokenData<T>>::iter_prefix((collection_id,))1309			.next()1310			.is_some()1311	}13121313	fn token_has_children(collection_id: CollectionId, token_id: TokenId) -> bool {1314		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1315			.next()1316			.is_some()1317	}13181319	pub fn token_children_ids(collection_id: CollectionId, token_id: TokenId) -> Vec<TokenChild> {1320		<TokenChildren<T>>::iter_prefix((collection_id, token_id))1321			.map(|((child_collection_id, child_id), _)| TokenChild {1322				collection: child_collection_id,1323				token: child_id,1324			})1325			.collect()1326	}13271328	/// Mint single NFT token.1329	///1330	/// Delegated to [`create_multiple_items`]1331	///1332	/// [`create_multiple_items`]: struct.Pallet.html#method.create_multiple_items1333	pub fn create_item(1334		collection: &NonfungibleHandle<T>,1335		sender: &T::CrossAccountId,1336		data: CreateItemData<T>,1337		nesting_budget: &dyn Budget,1338	) -> DispatchResult {1339		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1340	}13411342	/// Sets or unsets the approval of a given operator.1343	///1344	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1345	/// - `owner`: Token owner1346	/// - `operator`: Operator1347	/// - `approve`: Should operator status be granted or revoked?1348	pub fn set_allowance_for_all(1349		collection: &NonfungibleHandle<T>,1350		owner: &T::CrossAccountId,1351		operator: &T::CrossAccountId,1352		approve: bool,1353	) -> DispatchResult {1354		<PalletCommon<T>>::set_allowance_for_all(1355			collection,1356			owner,1357			operator,1358			approve,1359			|| <CollectionAllowance<T>>::insert((collection.id, owner, operator), approve),1360			ERC721Events::ApprovalForAll {1361				owner: *owner.as_eth(),1362				operator: *operator.as_eth(),1363				approved: approve,1364			}1365			.to_log(collection_id_to_address(collection.id)),1366		)1367	}13681369	/// Tells whether the given `owner` approves the `operator`.1370	pub fn allowance_for_all(1371		collection: &NonfungibleHandle<T>,1372		owner: &T::CrossAccountId,1373		operator: &T::CrossAccountId,1374	) -> bool {1375		<CollectionAllowance<T>>::get((collection.id, owner, operator))1376	}13771378	pub fn repair_item(collection: &NonfungibleHandle<T>, token: TokenId) -> DispatchResult {1379		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1380			properties.recompute_consumed_space();1381		});13821383		Ok(())1384	}1385}