git.delta.rocks / unique-network / refs/commits / 7680e6689f4d

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//! # Refungible Pallet18//!19//! The Refungible pallet provides functionality for handling refungible collections and tokens.20//!21//! - [`Config`]22//! - [`RefungibleHandle`]23//! - [`Pallet`]24//! - [`CommonWeights`](common::CommonWeights)25//!26//! ## Overview27//!28//! The Refungible pallet provides functions for:29//!30//! - RFT collection creation and removal31//! - Minting and burning of RFT tokens32//! - Partition and repartition of RFT tokens33//! - Retrieving number of pieces of RFT token34//! - Retrieving account balances35//! - Transfering RFT token pieces36//! - Burning RFT token pieces37//! - Setting and checking allowance for RFT tokens38//!39//! ### Terminology40//!41//! - **RFT token:** Non fungible token that was partitioned to pieces. If an account owns all42//!   of the RFT token pieces than it owns the RFT token and can repartition it.43//!44//! - **RFT Collection:** A collection of RFT tokens. All RFT tokens are part of a collection.45//!   Each collection has its own settings and set of permissions.46//!47//! - **RFT token piece:** A fungible part of an RFT token.48//!49//! - **Balance:** RFT token pieces owned by an account50//!51//! - **Allowance:** Maximum number of RFT token pieces that one account is allowed to52//!   transfer from the balance of another account53//!54//! - **Burning:** The process of “deleting” a token from a collection or removing token pieces from55//!   an account balance.56//!57//! ### Implementations58//!59//! The Refungible pallet provides implementations for the following traits. If these traits provide60//! the functionality that you need, then you can avoid coupling with the Refungible pallet.61//!62//! - [`CommonWeightInfo`](pallet_common::CommonWeightInfo): Functions for retrieval of transaction weight63//! - [`CommonCollectionOperations`](pallet_common::CommonCollectionOperations): Functions for dealing64//!   with collections65//! - [`RefungibleExtensions`](pallet_common::RefungibleExtensions): Functions specific for refungible66//!   collection67//!68//! ## Interface69//!70//! ### Dispatchable Functions71//!72//! - `init_collection` - Create RFT collection. RFT collection can be configured to allow or deny access for73//!   some accounts.74//! - `destroy_collection` - Destroy exising RFT collection. There should be no tokens in the collection.75//! - `burn` - Burn some amount of RFT token pieces owned by account. Burns the RFT token if no pieces left.76//! - `transfer` - Transfer some amount of RFT token pieces. Transfers should be enabled for RFT collection.77//!   Nests the RFT token if RFT token pieces are sent to another token.78//! - `create_item` - Mint RFT token in collection. Sender should have permission to mint tokens.79//! - `set_allowance` - Set allowance for another account to transfer balance from sender's account.80//! - `repartition` - Repartition token to selected number of pieces. Sender should own all existing pieces.81//!82//! ## Assumptions83//!84//! * Total number of pieces for one token shouldn't exceed `up_data_structs::MAX_REFUNGIBLE_PIECES`.85//! * Total number of tokens of all types shouldn't be greater than `up_data_structs::MAX_TOKEN_PREFIX_LENGTH`.86//! * Sender should be in collection's allow list to perform operations on tokens.8788#![cfg_attr(not(feature = "std"), no_std)]8990use crate::erc_token::ERC20Events;91use crate::erc::ERC721Events;9293use codec::{Encode, Decode, MaxEncodedLen};94use core::ops::Deref;95use derivative::Derivative;96use evm_coder::ToLog;97use frame_support::{98	BoundedBTreeMap, BoundedVec, ensure, fail, storage::with_transaction, transactional,99	pallet_prelude::ConstU32,100};101use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};102use pallet_evm_coder_substrate::WithRecorder;103use pallet_common::{104	CommonCollectionOperations, Error as CommonError, eth::collection_id_to_address,105	Event as CommonEvent, Pallet as PalletCommon,106};107use pallet_structure::Pallet as PalletStructure;108use scale_info::TypeInfo;109use sp_core::H160;110use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};111use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};112use up_data_structs::{113	AccessMode, budget::Budget, CollectionId, CollectionFlags, CollectionPropertiesVec,114	CreateCollectionData, CustomDataLimit, mapping::TokenAddressMapping, MAX_ITEMS_PER_BATCH,115	MAX_REFUNGIBLE_PIECES, Property, PropertyKey, PropertyKeyPermission, PropertyPermission,116	PropertyScope, PropertyValue, TokenId, TrySetProperty,117};118119pub use pallet::*;120#[cfg(feature = "runtime-benchmarks")]121pub mod benchmarking;122pub mod common;123pub mod erc;124pub mod erc_token;125pub mod weights;126127#[derive(Derivative, Clone)]128pub struct CreateItemData<CrossAccountId> {129	#[derivative(Debug(format_with = "bounded::map_debug"))]130	pub users: BoundedBTreeMap<CrossAccountId, u128, ConstU32<MAX_ITEMS_PER_BATCH>>,131	#[derivative(Debug(format_with = "bounded::vec_debug"))]132	pub properties: CollectionPropertiesVec,133}134pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;135136/// Token data, stored independently from other data used to describe it137/// for the convenience of database access. Notably contains the token metadata.138#[struct_versioning::versioned(version = 2, upper)]139#[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]140pub struct ItemData {141	pub const_data: BoundedVec<u8, CustomDataLimit>,142143	#[version(..2)]144	pub variable_data: BoundedVec<u8, CustomDataLimit>,145}146147#[frame_support::pallet]148pub mod pallet {149	use super::*;150	use frame_support::{151		Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key,152		traits::StorageVersion,153	};154	use frame_system::pallet_prelude::*;155	use up_data_structs::{CollectionId, TokenId};156	use super::weights::WeightInfo;157158	#[pallet::error]159	pub enum Error<T> {160		/// Not Refungible item data used to mint in Refungible collection.161		NotRefungibleDataUsedToMintFungibleCollectionToken,162		/// Maximum refungibility exceeded.163		WrongRefungiblePieces,164		/// Refungible token can't be repartitioned by user who isn't owns all pieces.165		RepartitionWhileNotOwningAllPieces,166		/// Refungible token can't nest other tokens.167		RefungibleDisallowsNesting,168		/// Setting item properties is not allowed.169		SettingPropertiesNotAllowed,170	}171172	#[pallet::config]173	pub trait Config:174		frame_system::Config + pallet_common::Config + pallet_structure::Config175	{176		type WeightInfo: WeightInfo;177	}178179	const STORAGE_VERSION: StorageVersion = StorageVersion::new(2);180181	#[pallet::pallet]182	#[pallet::storage_version(STORAGE_VERSION)]183	#[pallet::generate_store(pub(super) trait Store)]184	pub struct Pallet<T>(_);185186	/// Total amount of minted tokens in a collection.187	#[pallet::storage]188	pub type TokensMinted<T: Config> =189		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;190191	/// Amount of tokens burnt in a collection.192	#[pallet::storage]193	pub type TokensBurnt<T: Config> =194		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;195196	/// Token data, used to partially describe a token.197	// TODO: remove198	#[pallet::storage]199	#[deprecated(since = "0.2.0", note = "ItemData is no more contains usefull data")]200	pub type TokenData<T: Config> = StorageNMap<201		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),202		Value = ItemData,203		QueryKind = ValueQuery,204	>;205206	/// Amount of pieces a refungible token is split into.207	#[pallet::storage]208	#[pallet::getter(fn token_properties)]209	pub type TokenProperties<T: Config> = StorageNMap<210		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),211		Value = up_data_structs::Properties,212		QueryKind = ValueQuery,213		OnEmpty = up_data_structs::TokenProperties,214	>;215216	/// Total amount of pieces for token217	#[pallet::storage]218	pub type TotalSupply<T: Config> = StorageNMap<219		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),220		Value = u128,221		QueryKind = ValueQuery,222	>;223224	/// Used to enumerate tokens owned by account.225	#[pallet::storage]226	pub type Owned<T: Config> = StorageNMap<227		Key = (228			Key<Twox64Concat, CollectionId>,229			Key<Blake2_128Concat, T::CrossAccountId>,230			Key<Twox64Concat, TokenId>,231		),232		Value = bool,233		QueryKind = ValueQuery,234	>;235236	/// Amount of tokens (not pieces) partially owned by an account within a collection.237	#[pallet::storage]238	pub type AccountBalance<T: Config> = StorageNMap<239		Key = (240			Key<Twox64Concat, CollectionId>,241			// Owner242			Key<Blake2_128Concat, T::CrossAccountId>,243		),244		Value = u32,245		QueryKind = ValueQuery,246	>;247248	/// Amount of token pieces owned by account.249	#[pallet::storage]250	pub type Balance<T: Config> = StorageNMap<251		Key = (252			Key<Twox64Concat, CollectionId>,253			Key<Twox64Concat, TokenId>,254			// Owner255			Key<Blake2_128Concat, T::CrossAccountId>,256		),257		Value = u128,258		QueryKind = ValueQuery,259	>;260261	/// Allowance set by a token owner for another user to perform one of certain transactions on a number of pieces of a token.262	#[pallet::storage]263	pub type Allowance<T: Config> = StorageNMap<264		Key = (265			Key<Twox64Concat, CollectionId>,266			Key<Twox64Concat, TokenId>,267			// Owner268			Key<Blake2_128, T::CrossAccountId>,269			// Spender270			Key<Blake2_128Concat, T::CrossAccountId>,271		),272		Value = u128,273		QueryKind = ValueQuery,274	>;275276	/// Operator set by a wallet owner that could perform certain transactions on all tokens in the wallet.277	#[pallet::storage]278	pub type CollectionAllowance<T: Config> = StorageNMap<279		Key = (280			Key<Twox64Concat, CollectionId>,281			Key<Blake2_128Concat, T::CrossAccountId>,282			Key<Blake2_128Concat, T::CrossAccountId>,283		),284		Value = bool,285		QueryKind = ValueQuery,286	>;287288	#[pallet::hooks]289	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {290		fn on_runtime_upgrade() -> Weight {291			let storage_version = StorageVersion::get::<Pallet<T>>();292			if storage_version < StorageVersion::new(2) {293				#[allow(deprecated)]294				let _ = <TokenData<T>>::clear(u32::MAX, None);295			}296			StorageVersion::new(2).put::<Pallet<T>>();297298			Weight::zero()299		}300	}301}302303pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);304impl<T: Config> RefungibleHandle<T> {305	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {306		Self(inner)307	}308	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {309		self.0310	}311	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {312		&mut self.0313	}314}315316impl<T: Config> Deref for RefungibleHandle<T> {317	type Target = pallet_common::CollectionHandle<T>;318319	fn deref(&self) -> &Self::Target {320		&self.0321	}322}323324impl<T: Config> WithRecorder<T> for RefungibleHandle<T> {325	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {326		self.0.recorder()327	}328	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {329		self.0.into_recorder()330	}331}332333impl<T: Config> Pallet<T> {334	/// Get number of RFT tokens in collection335	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {336		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)337	}338339	/// Check that RFT token exists340	///341	/// - `token`: Token ID.342	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {343		<TotalSupply<T>>::contains_key((collection.id, token))344	}345346	pub fn set_scoped_token_property(347		collection_id: CollectionId,348		token_id: TokenId,349		scope: PropertyScope,350		property: Property,351	) -> DispatchResult {352		TokenProperties::<T>::try_mutate((collection_id, token_id), |properties| {353			properties.try_scoped_set(scope, property.key, property.value)354		})355		.map_err(<CommonError<T>>::from)?;356357		Ok(())358	}359360	pub fn set_scoped_token_properties(361		collection_id: CollectionId,362		token_id: TokenId,363		scope: PropertyScope,364		properties: impl Iterator<Item = Property>,365	) -> DispatchResult {366		TokenProperties::<T>::try_mutate((collection_id, token_id), |stored_properties| {367			stored_properties.try_scoped_set_from_iter(scope, properties)368		})369		.map_err(<CommonError<T>>::from)?;370371		Ok(())372	}373}374375// unchecked calls skips any permission checks376impl<T: Config> Pallet<T> {377	/// Create RFT collection378	///379	/// `init_collection` will take non-refundable deposit for collection creation.380	///381	/// - `data`: Contains settings for collection limits and permissions.382	pub fn init_collection(383		owner: T::CrossAccountId,384		payer: T::CrossAccountId,385		data: CreateCollectionData<T::AccountId>,386		flags: CollectionFlags,387	) -> Result<CollectionId, DispatchError> {388		<PalletCommon<T>>::init_collection(owner, payer, data, flags)389	}390391	/// Destroy RFT collection392	///393	/// `destroy_collection` will throw error if collection contains any tokens.394	/// Only owner can destroy collection.395	pub fn destroy_collection(396		collection: RefungibleHandle<T>,397		sender: &T::CrossAccountId,398	) -> DispatchResult {399		let id = collection.id;400401		if Self::collection_has_tokens(id) {402			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());403		}404405		// =========406407		PalletCommon::destroy_collection(collection.0, sender)?;408409		<TokensMinted<T>>::remove(id);410		<TokensBurnt<T>>::remove(id);411		let _ = <TotalSupply<T>>::clear_prefix((id,), u32::MAX, None);412		let _ = <Balance<T>>::clear_prefix((id,), u32::MAX, None);413		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);414		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);415		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);416		Ok(())417	}418419	fn collection_has_tokens(collection_id: CollectionId) -> bool {420		<TotalSupply<T>>::iter_prefix((collection_id,))421			.next()422			.is_some()423	}424425	pub fn burn_token_unchecked(426		collection: &RefungibleHandle<T>,427		owner: &T::CrossAccountId,428		token_id: TokenId,429	) -> DispatchResult {430		let burnt = <TokensBurnt<T>>::get(collection.id)431			.checked_add(1)432			.ok_or(ArithmeticError::Overflow)?;433434		<TokensBurnt<T>>::insert(collection.id, burnt);435		<TokenProperties<T>>::remove((collection.id, token_id));436		<TotalSupply<T>>::remove((collection.id, token_id));437		let _ = <Balance<T>>::clear_prefix((collection.id, token_id), u32::MAX, None);438		let _ = <Allowance<T>>::clear_prefix((collection.id, token_id), u32::MAX, None);439		<PalletEvm<T>>::deposit_log(440			ERC721Events::Transfer {441				from: *owner.as_eth(),442				to: H160::default(),443				token_id: token_id.into(),444			}445			.to_log(collection_id_to_address(collection.id)),446		);447		Ok(())448	}449450	/// Burn RFT token pieces451	///452	/// `burn` will decrease total amount of token pieces and amount owned by sender.453	/// `burn` can be called even if there are multiple owners of the RFT token.454	/// If sender wouldn't have any pieces left after `burn` than she will stop being455	/// one of the owners of the token. If there is no account that owns any pieces of456	/// the token than token will be burned too.457	///458	/// - `amount`: Amount of token pieces to burn.459	/// - `token`: Token who's pieces should be burned460	/// - `collection`: Collection that contains the token461	pub fn burn(462		collection: &RefungibleHandle<T>,463		owner: &T::CrossAccountId,464		token: TokenId,465		amount: u128,466	) -> DispatchResult {467		if <Balance<T>>::get((collection.id, token, owner)) == 0 {468			return Err(<CommonError<T>>::TokenValueTooLow.into());469		}470471		let total_supply = <TotalSupply<T>>::get((collection.id, token))472			.checked_sub(amount)473			.ok_or(<CommonError<T>>::TokenValueTooLow)?;474475		// This was probally last owner of this token?476		if total_supply == 0 {477			// Ensure user actually owns this amount478			ensure!(479				<Balance<T>>::get((collection.id, token, owner)) == amount,480				<CommonError<T>>::TokenValueTooLow481			);482			let account_balance = <AccountBalance<T>>::get((collection.id, owner))483				.checked_sub(1)484				// Should not occur485				.ok_or(ArithmeticError::Underflow)?;486487			// =========488489			<Owned<T>>::remove((collection.id, owner, token));490			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);491			<AccountBalance<T>>::insert((collection.id, owner), account_balance);492			Self::burn_token_unchecked(collection, owner, token)?;493			<PalletEvm<T>>::deposit_log(494				ERC20Events::Transfer {495					from: *owner.as_eth(),496					to: H160::default(),497					value: amount.into(),498				}499				.to_log(collection_id_to_address(collection.id)),500			);501			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(502				collection.id,503				token,504				owner.clone(),505				amount,506			));507			return Ok(());508		}509510		let balance = <Balance<T>>::get((collection.id, token, owner))511			.checked_sub(amount)512			.ok_or(<CommonError<T>>::TokenValueTooLow)?;513		let account_balance = if balance == 0 {514			<AccountBalance<T>>::get((collection.id, owner))515				.checked_sub(1)516				// Should not occur517				.ok_or(ArithmeticError::Underflow)?518		} else {519			0520		};521522		// =========523524		if balance == 0 {525			<Owned<T>>::remove((collection.id, owner, token));526			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);527			<Balance<T>>::remove((collection.id, token, owner));528			<AccountBalance<T>>::insert((collection.id, owner), account_balance);529530			if let Some(user) = Self::token_owner(collection.id, token) {531				<PalletEvm<T>>::deposit_log(532					ERC721Events::Transfer {533						from: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,534						to: *user.as_eth(),535						token_id: token.into(),536					}537					.to_log(collection_id_to_address(collection.id)),538				);539			}540		} else {541			<Balance<T>>::insert((collection.id, token, owner), balance);542		}543		<TotalSupply<T>>::insert((collection.id, token), total_supply);544545		<PalletEvm<T>>::deposit_log(546			ERC20Events::Transfer {547				from: *owner.as_eth(),548				to: H160::default(),549				value: amount.into(),550			}551			.to_log(T::EvmTokenAddressMapping::token_to_address(552				collection.id,553				token,554			)),555		);556		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(557			collection.id,558			token,559			owner.clone(),560			amount,561		));562		Ok(())563	}564565	#[transactional]566	fn modify_token_properties(567		collection: &RefungibleHandle<T>,568		sender: &T::CrossAccountId,569		token_id: TokenId,570		properties: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,571		is_token_create: bool,572		nesting_budget: &dyn Budget,573	) -> DispatchResult {574		let is_collection_admin = || collection.is_owner_or_admin(sender);575		let is_token_owner = || -> Result<bool, DispatchError> {576			let balance = collection.balance(sender.clone(), token_id);577			let total_pieces: u128 =578				Self::total_pieces(collection.id, token_id).unwrap_or(u128::MAX);579			if balance != total_pieces {580				return Ok(false);581			}582583			let is_bundle_owner = <PalletStructure<T>>::check_indirectly_owned(584				sender.clone(),585				collection.id,586				token_id,587				None,588				nesting_budget,589			)?;590591			Ok(is_bundle_owner)592		};593594		for (key, value) in properties {595			let permission = <PalletCommon<T>>::property_permissions(collection.id)596				.get(&key)597				.cloned()598				.unwrap_or_else(PropertyPermission::none);599600			let is_property_exists = TokenProperties::<T>::get((collection.id, token_id))601				.get(&key)602				.is_some();603604			match permission {605				PropertyPermission { mutable: false, .. } if is_property_exists => {606					return Err(<CommonError<T>>::NoPermission.into());607				}608609				PropertyPermission {610					collection_admin,611					token_owner,612					..613				} => {614					//TODO: investigate threats during public minting.615					let is_token_create =616						is_token_create && (collection_admin || token_owner) && value.is_some();617					if !(is_token_create618						|| (collection_admin && is_collection_admin())619						|| (token_owner && is_token_owner()?))620					{621						fail!(<CommonError<T>>::NoPermission);622					}623				}624			}625626			match value {627				Some(value) => {628					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {629						properties.try_set(key.clone(), value)630					})631					.map_err(<CommonError<T>>::from)?;632633					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertySet(634						collection.id,635						token_id,636						key,637					));638				}639				None => {640					<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {641						properties.remove(&key)642					})643					.map_err(<CommonError<T>>::from)?;644645					<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(646						collection.id,647						token_id,648						key,649					));650				}651			}652		}653654		Ok(())655	}656657	pub fn set_token_properties(658		collection: &RefungibleHandle<T>,659		sender: &T::CrossAccountId,660		token_id: TokenId,661		properties: impl Iterator<Item = Property>,662		is_token_create: bool,663		nesting_budget: &dyn Budget,664	) -> DispatchResult {665		Self::modify_token_properties(666			collection,667			sender,668			token_id,669			properties.map(|p| (p.key, Some(p.value))),670			is_token_create,671			nesting_budget,672		)673	}674675	pub fn set_token_property(676		collection: &RefungibleHandle<T>,677		sender: &T::CrossAccountId,678		token_id: TokenId,679		property: Property,680		nesting_budget: &dyn Budget,681	) -> DispatchResult {682		let is_token_create = false;683684		Self::set_token_properties(685			collection,686			sender,687			token_id,688			[property].into_iter(),689			is_token_create,690			nesting_budget,691		)692	}693694	pub fn delete_token_properties(695		collection: &RefungibleHandle<T>,696		sender: &T::CrossAccountId,697		token_id: TokenId,698		property_keys: impl Iterator<Item = PropertyKey>,699		nesting_budget: &dyn Budget,700	) -> DispatchResult {701		let is_token_create = false;702703		Self::modify_token_properties(704			collection,705			sender,706			token_id,707			property_keys.into_iter().map(|key| (key, None)),708			is_token_create,709			nesting_budget,710		)711	}712713	pub fn delete_token_property(714		collection: &RefungibleHandle<T>,715		sender: &T::CrossAccountId,716		token_id: TokenId,717		property_key: PropertyKey,718		nesting_budget: &dyn Budget,719	) -> DispatchResult {720		Self::delete_token_properties(721			collection,722			sender,723			token_id,724			[property_key].into_iter(),725			nesting_budget,726		)727	}728729	/// Transfer RFT token pieces from one account to another.730	///731	/// If the sender is no longer owns any pieces after the `transfer` than she stops being an owner of the token.732	///733	/// - `from`: Owner of token pieces to transfer.734	/// - `to`: Recepient of transfered token pieces.735	/// - `amount`: Amount of token pieces to transfer.736	/// - `token`: Token whos pieces should be transfered737	/// - `collection`: Collection that contains the token738	pub fn transfer(739		collection: &RefungibleHandle<T>,740		from: &T::CrossAccountId,741		to: &T::CrossAccountId,742		token: TokenId,743		amount: u128,744		nesting_budget: &dyn Budget,745	) -> DispatchResult {746		ensure!(747			collection.limits.transfers_enabled(),748			<CommonError<T>>::TransferNotAllowed749		);750751		if collection.permissions.access() == AccessMode::AllowList {752			collection.check_allowlist(from)?;753			collection.check_allowlist(to)?;754		}755		<PalletCommon<T>>::ensure_correct_receiver(to)?;756757		let initial_balance_from = <Balance<T>>::get((collection.id, token, from));758759		if initial_balance_from == 0 {760			return Err(<CommonError<T>>::TokenValueTooLow.into());761		}762763		let updated_balance_from = initial_balance_from764			.checked_sub(amount)765			.ok_or(<CommonError<T>>::TokenValueTooLow)?;766		let mut create_target = false;767		let from_to_differ = from != to;768		let updated_balance_to = if from != to && amount != 0 {769			let old_balance = <Balance<T>>::get((collection.id, token, to));770			if old_balance == 0 {771				create_target = true;772			}773			Some(774				old_balance775					.checked_add(amount)776					.ok_or(ArithmeticError::Overflow)?,777			)778		} else {779			None780		};781782		let account_balance_from = if updated_balance_from == 0 {783			Some(784				<AccountBalance<T>>::get((collection.id, from))785					.checked_sub(1)786					// Should not occur787					.ok_or(ArithmeticError::Underflow)?,788			)789		} else {790			None791		};792		// Account data is created in token, AccountBalance should be increased793		// But only if from != to as we shouldn't check overflow in this case794		let account_balance_to = if create_target && from_to_differ {795			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))796				.checked_add(1)797				.ok_or(ArithmeticError::Overflow)?;798			ensure!(799				account_balance_to < collection.limits.account_token_ownership_limit(),800				<CommonError<T>>::AccountTokenLimitExceeded,801			);802803			Some(account_balance_to)804		} else {805			None806		};807808		// =========809810		if let Some(updated_balance_to) = updated_balance_to {811			// from != to && amount != 0812813			<PalletStructure<T>>::nest_if_sent_to_token(814				from.clone(),815				to,816				collection.id,817				token,818				nesting_budget,819			)?;820821			if updated_balance_from == 0 {822				<Balance<T>>::remove((collection.id, token, from));823				<PalletStructure<T>>::unnest_if_nested(from, collection.id, token);824			} else {825				<Balance<T>>::insert((collection.id, token, from), updated_balance_from);826			}827			<Balance<T>>::insert((collection.id, token, to), updated_balance_to);828			if let Some(account_balance_from) = account_balance_from {829				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);830				<Owned<T>>::remove((collection.id, from, token));831			}832			if let Some(account_balance_to) = account_balance_to {833				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);834				<Owned<T>>::insert((collection.id, to, token), true);835			}836		}837838		<PalletEvm<T>>::deposit_log(839			ERC20Events::Transfer {840				from: *from.as_eth(),841				to: *to.as_eth(),842				value: amount.into(),843			}844			.to_log(T::EvmTokenAddressMapping::token_to_address(845				collection.id,846				token,847			)),848		);849850		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(851			collection.id,852			token,853			from.clone(),854			to.clone(),855			amount,856		));857858		let total_supply = <TotalSupply<T>>::get((collection.id, token));859860		if amount == total_supply {861			// if token was fully owned by `from` and will be fully owned by `to` after transfer862			<PalletEvm<T>>::deposit_log(863				ERC721Events::Transfer {864					from: *from.as_eth(),865					to: *to.as_eth(),866					token_id: token.into(),867				}868				.to_log(collection_id_to_address(collection.id)),869			);870		} else if let Some(updated_balance_to) = updated_balance_to {871			// if `from` not equals `to`. This condition is needed to avoid sending event872			// when `from` fully owns token and sends part of token pieces to itself.873			if initial_balance_from == total_supply {874				// if token was fully owned by `from` and will be only partially owned by `to`875				// and `from` after transfer876				<PalletEvm<T>>::deposit_log(877					ERC721Events::Transfer {878						from: *from.as_eth(),879						to: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,880						token_id: token.into(),881					}882					.to_log(collection_id_to_address(collection.id)),883				);884			} else if updated_balance_to == total_supply {885				// if token was partially owned by `from` and will be fully owned by `to` after transfer886				<PalletEvm<T>>::deposit_log(887					ERC721Events::Transfer {888						from: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,889						to: *to.as_eth(),890						token_id: token.into(),891					}892					.to_log(collection_id_to_address(collection.id)),893				);894			}895		}896897		Ok(())898	}899900	/// Batched operation to create multiple RFT tokens.901	///902	/// Same as `create_item` but creates multiple tokens.903	///904	/// - `data`: Same as 'data` in `create_item` but contains data for multiple tokens.905	pub fn create_multiple_items(906		collection: &RefungibleHandle<T>,907		sender: &T::CrossAccountId,908		data: Vec<CreateItemData<T::CrossAccountId>>,909		nesting_budget: &dyn Budget,910	) -> DispatchResult {911		if !collection.is_owner_or_admin(sender) {912			ensure!(913				collection.permissions.mint_mode(),914				<CommonError<T>>::PublicMintingNotAllowed915			);916			collection.check_allowlist(sender)?;917918			for item in data.iter() {919				for user in item.users.keys() {920					collection.check_allowlist(user)?;921				}922			}923		}924925		for item in data.iter() {926			for (owner, _) in item.users.iter() {927				<PalletCommon<T>>::ensure_correct_receiver(owner)?;928			}929		}930931		// Total pieces per tokens932		let totals = data933			.iter()934			.map(|data| {935				Ok(data936					.users937					.iter()938					.map(|u| u.1)939					.try_fold(0u128, |acc, v| acc.checked_add(*v))940					.ok_or(ArithmeticError::Overflow)?)941			})942			.collect::<Result<Vec<_>, DispatchError>>()?;943		for total in &totals {944			ensure!(945				*total <= MAX_REFUNGIBLE_PIECES,946				<Error<T>>::WrongRefungiblePieces947			);948		}949950		let first_token_id = <TokensMinted<T>>::get(collection.id);951		let tokens_minted = first_token_id952			.checked_add(data.len() as u32)953			.ok_or(ArithmeticError::Overflow)?;954		ensure!(955			tokens_minted < collection.limits.token_limit(),956			<CommonError<T>>::CollectionTokenLimitExceeded957		);958959		let mut balances = BTreeMap::new();960		for data in &data {961			for owner in data.users.keys() {962				let balance = balances963					.entry(owner)964					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));965				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;966967				ensure!(968					*balance <= collection.limits.account_token_ownership_limit(),969					<CommonError<T>>::AccountTokenLimitExceeded,970				);971			}972		}973974		for (i, token) in data.iter().enumerate() {975			let token_id = TokenId(first_token_id + i as u32 + 1);976			for (to, _) in token.users.iter() {977				<PalletStructure<T>>::check_nesting(978					sender.clone(),979					to,980					collection.id,981					token_id,982					nesting_budget,983				)?;984			}985		}986987		// =========988989		with_transaction(|| {990			for (i, data) in data.iter().enumerate() {991				let token_id = first_token_id + i as u32 + 1;992				<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);993994				for (user, amount) in data.users.iter() {995					if *amount == 0 {996						continue;997					}998					<Balance<T>>::insert((collection.id, token_id, &user), amount);999					<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);1000					<PalletStructure<T>>::nest_if_sent_to_token_unchecked(1001						user,1002						collection.id,1003						TokenId(token_id),1004					);1005				}10061007				if let Err(e) = Self::set_token_properties(1008					collection,1009					sender,1010					TokenId(token_id),1011					data.properties.clone().into_iter(),1012					true,1013					nesting_budget,1014				) {1015					return TransactionOutcome::Rollback(Err(e));1016				}1017			}1018			TransactionOutcome::Commit(Ok(()))1019		})?;10201021		<TokensMinted<T>>::insert(collection.id, tokens_minted);10221023		for (account, balance) in balances {1024			<AccountBalance<T>>::insert((collection.id, account), balance);1025		}10261027		for (i, token) in data.into_iter().enumerate() {1028			let token_id = first_token_id + i as u32 + 1;10291030			let receivers = token1031				.users1032				.into_iter()1033				.filter(|(_, amount)| *amount > 0)1034				.collect::<Vec<_>>();10351036			if let [(user, _)] = receivers.as_slice() {1037				// if there is exactly one receiver1038				<PalletEvm<T>>::deposit_log(1039					ERC721Events::Transfer {1040						from: H160::default(),1041						to: *user.as_eth(),1042						token_id: token_id.into(),1043					}1044					.to_log(collection_id_to_address(collection.id)),1045				);1046			} else if let [_, ..] = receivers.as_slice() {1047				// if there is more than one receiver1048				<PalletEvm<T>>::deposit_log(1049					ERC721Events::Transfer {1050						from: H160::default(),1051						to: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,1052						token_id: token_id.into(),1053					}1054					.to_log(collection_id_to_address(collection.id)),1055				);1056			}10571058			for (user, amount) in receivers.into_iter() {1059				<PalletEvm<T>>::deposit_log(1060					ERC20Events::Transfer {1061						from: H160::default(),1062						to: *user.as_eth(),1063						value: amount.into(),1064					}1065					.to_log(T::EvmTokenAddressMapping::token_to_address(1066						collection.id,1067						TokenId(token_id),1068					)),1069				);1070				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1071					collection.id,1072					TokenId(token_id),1073					user,1074					amount,1075				));1076			}1077		}1078		Ok(())1079	}10801081	pub fn set_allowance_unchecked(1082		collection: &RefungibleHandle<T>,1083		sender: &T::CrossAccountId,1084		spender: &T::CrossAccountId,1085		token: TokenId,1086		amount: u128,1087	) {1088		if amount == 0 {1089			<Allowance<T>>::remove((collection.id, token, sender, spender));1090		} else {1091			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);1092		}10931094		<PalletEvm<T>>::deposit_log(1095			ERC20Events::Approval {1096				owner: *sender.as_eth(),1097				spender: *spender.as_eth(),1098				value: amount.into(),1099			}1100			.to_log(T::EvmTokenAddressMapping::token_to_address(1101				collection.id,1102				token,1103			)),1104		);1105		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(1106			collection.id,1107			token,1108			sender.clone(),1109			spender.clone(),1110			amount,1111		))1112	}11131114	/// Set allowance for the spender to `transfer` or `burn` sender's token pieces.1115	///1116	/// - `amount`: Amount of token pieces the spender is allowed to `transfer` or `burn.1117	pub fn set_allowance(1118		collection: &RefungibleHandle<T>,1119		sender: &T::CrossAccountId,1120		spender: &T::CrossAccountId,1121		token: TokenId,1122		amount: u128,1123	) -> DispatchResult {1124		if collection.permissions.access() == AccessMode::AllowList {1125			collection.check_allowlist(sender)?;1126			collection.check_allowlist(spender)?;1127		}11281129		<PalletCommon<T>>::ensure_correct_receiver(spender)?;11301131		if <Balance<T>>::get((collection.id, token, sender)) < amount {1132			ensure!(1133				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),1134				<CommonError<T>>::CantApproveMoreThanOwned1135			);1136		}11371138		// =========11391140		Self::set_allowance_unchecked(collection, sender, spender, token, amount);1141		Ok(())1142	}11431144	/// Returns allowance, which should be set after transaction1145	fn check_allowed(1146		collection: &RefungibleHandle<T>,1147		spender: &T::CrossAccountId,1148		from: &T::CrossAccountId,1149		token: TokenId,1150		amount: u128,1151		nesting_budget: &dyn Budget,1152	) -> Result<Option<u128>, DispatchError> {1153		if spender.conv_eq(from) {1154			return Ok(None);1155		}1156		if collection.permissions.access() == AccessMode::AllowList {1157			// `from`, `to` checked in [`transfer`]1158			collection.check_allowlist(spender)?;1159		}1160		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1161			// TODO: should collection owner be allowed to perform this transfer?1162			ensure!(1163				<PalletStructure<T>>::check_indirectly_owned(1164					spender.clone(),1165					source.0,1166					source.1,1167					None,1168					nesting_budget1169				)?,1170				<CommonError<T>>::ApprovedValueTooLow,1171			);1172			return Ok(None);1173		}1174		let allowance =1175			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);11761177		// Allowance (if any) would be reduced if spender is also wallet operator1178		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1179			return Ok(allowance);1180		}11811182		if allowance.is_none() {1183			ensure!(1184				collection.ignores_allowance(spender),1185				<CommonError<T>>::ApprovedValueTooLow1186			);1187		}1188		Ok(allowance)1189	}11901191	/// Transfer RFT token pieces from one account to another.1192	///1193	/// Same as the [`transfer`] but spender doesn't needs to be an owner of the token pieces.1194	/// The owner should set allowance for the spender to transfer pieces.1195	///1196	/// [`transfer`]: struct.Pallet.html#method.transfer1197	pub fn transfer_from(1198		collection: &RefungibleHandle<T>,1199		spender: &T::CrossAccountId,1200		from: &T::CrossAccountId,1201		to: &T::CrossAccountId,1202		token: TokenId,1203		amount: u128,1204		nesting_budget: &dyn Budget,1205	) -> DispatchResult {1206		let allowance =1207			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;12081209		// =========12101211		Self::transfer(collection, from, to, token, amount, nesting_budget)?;1212		if let Some(allowance) = allowance {1213			Self::set_allowance_unchecked(collection, from, spender, token, allowance);1214		}1215		Ok(())1216	}12171218	/// Burn RFT token pieces from the account.1219	///1220	/// Same as the [`burn`] but spender doesn't need to be an owner of the token pieces. The owner should1221	/// set allowance for the spender to burn pieces1222	///1223	/// [`burn`]: struct.Pallet.html#method.burn1224	pub fn burn_from(1225		collection: &RefungibleHandle<T>,1226		spender: &T::CrossAccountId,1227		from: &T::CrossAccountId,1228		token: TokenId,1229		amount: u128,1230		nesting_budget: &dyn Budget,1231	) -> DispatchResult {1232		let allowance =1233			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;12341235		// =========12361237		Self::burn(collection, from, token, amount)?;1238		if let Some(allowance) = allowance {1239			Self::set_allowance_unchecked(collection, from, spender, token, allowance);1240		}1241		Ok(())1242	}12431244	/// Create RFT token.1245	///1246	/// The sender should be the owner/admin of the collection or collection should be configured1247	/// to allow public minting.1248	///1249	/// - `data`: Contains list of users who will become the owners of the token pieces and amount1250	///   of token pieces they will receive.1251	pub fn create_item(1252		collection: &RefungibleHandle<T>,1253		sender: &T::CrossAccountId,1254		data: CreateItemData<T::CrossAccountId>,1255		nesting_budget: &dyn Budget,1256	) -> DispatchResult {1257		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1258	}12591260	/// Repartition RFT token.1261	///1262	/// `repartition` will set token balance of the sender and total amount of token pieces.1263	/// Sender should own all of the token pieces. `repartition' could be done even if some1264	/// token pieces were burned before.1265	///1266	/// - `amount`: Total amount of token pieces that the token will have after `repartition`.1267	pub fn repartition(1268		collection: &RefungibleHandle<T>,1269		owner: &T::CrossAccountId,1270		token: TokenId,1271		amount: u128,1272	) -> DispatchResult {1273		ensure!(1274			amount <= MAX_REFUNGIBLE_PIECES,1275			<Error<T>>::WrongRefungiblePieces1276		);1277		ensure!(amount > 0, <CommonError<T>>::TokenValueTooLow);1278		// Ensure user owns all pieces1279		let total_pieces = Self::total_pieces(collection.id, token).unwrap_or(u128::MAX);1280		let balance = <Balance<T>>::get((collection.id, token, owner));1281		ensure!(1282			total_pieces == balance,1283			<Error<T>>::RepartitionWhileNotOwningAllPieces1284		);12851286		<Balance<T>>::insert((collection.id, token, owner), amount);1287		<TotalSupply<T>>::insert((collection.id, token), amount);12881289		if amount > total_pieces {1290			let mint_amount = amount - total_pieces;1291			<PalletEvm<T>>::deposit_log(1292				ERC20Events::Transfer {1293					from: H160::default(),1294					to: *owner.as_eth(),1295					value: mint_amount.into(),1296				}1297				.to_log(T::EvmTokenAddressMapping::token_to_address(1298					collection.id,1299					token,1300				)),1301			);1302			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1303				collection.id,1304				token,1305				owner.clone(),1306				mint_amount,1307			));1308		} else if total_pieces > amount {1309			let burn_amount = total_pieces - amount;1310			<PalletEvm<T>>::deposit_log(1311				ERC20Events::Transfer {1312					from: *owner.as_eth(),1313					to: H160::default(),1314					value: burn_amount.into(),1315				}1316				.to_log(T::EvmTokenAddressMapping::token_to_address(1317					collection.id,1318					token,1319				)),1320			);1321			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(1322				collection.id,1323				token,1324				owner.clone(),1325				burn_amount,1326			));1327		}13281329		Ok(())1330	}13311332	fn token_owner(collection_id: CollectionId, token_id: TokenId) -> Option<T::CrossAccountId> {1333		let mut owner = None;1334		let mut count = 0;1335		for key in Balance::<T>::iter_key_prefix((collection_id, token_id)) {1336			count += 1;1337			if count > 1 {1338				return None;1339			}1340			owner = Some(key);1341		}1342		owner1343	}13441345	fn total_pieces(collection_id: CollectionId, token_id: TokenId) -> Option<u128> {1346		<TotalSupply<T>>::try_get((collection_id, token_id)).ok()1347	}13481349	pub fn set_collection_properties(1350		collection: &RefungibleHandle<T>,1351		sender: &T::CrossAccountId,1352		properties: Vec<Property>,1353	) -> DispatchResult {1354		<PalletCommon<T>>::set_collection_properties(collection, sender, properties)1355	}13561357	pub fn delete_collection_properties(1358		collection: &RefungibleHandle<T>,1359		sender: &T::CrossAccountId,1360		property_keys: Vec<PropertyKey>,1361	) -> DispatchResult {1362		<PalletCommon<T>>::delete_collection_properties(collection, sender, property_keys)1363	}13641365	pub fn set_token_property_permissions(1366		collection: &RefungibleHandle<T>,1367		sender: &T::CrossAccountId,1368		property_permissions: Vec<PropertyKeyPermission>,1369	) -> DispatchResult {1370		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)1371	}13721373	pub fn set_scoped_token_property_permissions(1374		collection: &RefungibleHandle<T>,1375		sender: &T::CrossAccountId,1376		scope: PropertyScope,1377		property_permissions: Vec<PropertyKeyPermission>,1378	) -> DispatchResult {1379		<PalletCommon<T>>::set_scoped_token_property_permissions(1380			collection,1381			sender,1382			scope,1383			property_permissions,1384		)1385	}13861387	/// Returns 10 token in no particular order.1388	///1389	/// There is no direct way to get token holders in ascending order,1390	/// since `iter_prefix` returns values in no particular order.1391	/// Therefore, getting the 10 largest holders with a large value of holders1392	/// can lead to impact memory allocation + sorting with  `n * log (n)`.1393	pub fn token_owners(1394		collection_id: CollectionId,1395		token: TokenId,1396	) -> Option<Vec<T::CrossAccountId>> {1397		let res: Vec<T::CrossAccountId> = <Balance<T>>::iter_prefix((collection_id, token))1398			.map(|(owner, _amount)| owner)1399			.take(10)1400			.collect();14011402		if res.is_empty() {1403			None1404		} else {1405			Some(res)1406		}1407	}14081409	/// Sets or unsets the approval of a given operator.1410	///1411	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1412	/// - `owner`: Token owner1413	/// - `operator`: Operator1414	/// - `approve`: Should operator status be granted or revoked?1415	pub fn set_allowance_for_all(1416		collection: &RefungibleHandle<T>,1417		owner: &T::CrossAccountId,1418		operator: &T::CrossAccountId,1419		approve: bool,1420	) -> DispatchResult {1421		if collection.permissions.access() == AccessMode::AllowList {1422			collection.check_allowlist(owner)?;1423			collection.check_allowlist(operator)?;1424		}14251426		<PalletCommon<T>>::ensure_correct_receiver(operator)?;14271428		// =========14291430		<CollectionAllowance<T>>::insert((collection.id, owner, operator), approve);1431		<PalletEvm<T>>::deposit_log(1432			ERC721Events::ApprovalForAll {1433				owner: *owner.as_eth(),1434				operator: *operator.as_eth(),1435				approved: approve,1436			}1437			.to_log(collection_id_to_address(collection.id)),1438		);1439		<PalletCommon<T>>::deposit_event(CommonEvent::ApprovedForAll(1440			collection.id,1441			owner.clone(),1442			operator.clone(),1443			approve,1444		));1445		Ok(())1446	}14471448	/// Tells whether the given `owner` approves the `operator`.1449	pub fn allowance_for_all(1450		collection: &RefungibleHandle<T>,1451		owner: &T::CrossAccountId,1452		operator: &T::CrossAccountId,1453	) -> bool {1454		<CollectionAllowance<T>>::get((collection.id, owner, operator))1455	}1456}