git.delta.rocks / unique-network / refs/commits / 90ad566cc7e8

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 core::{cmp::Ordering, ops::Deref};9192use evm_coder::ToLog;93use frame_support::{ensure, storage::with_transaction, transactional};94pub use pallet::*;95use pallet_common::{96	eth::collection_id_to_address, Error as CommonError, Event as CommonEvent,97	Pallet as PalletCommon,98};99use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};100use pallet_evm_coder_substrate::WithRecorder;101use pallet_structure::Pallet as PalletStructure;102use sp_core::{Get, H160};103use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};104use sp_std::{collections::btree_map::BTreeMap, vec, vec::Vec};105use up_data_structs::{106	budget::Budget, mapping::TokenAddressMapping, AccessMode, CollectionId, CreateCollectionData,107	CreateRefungibleExMultipleOwners, PropertiesPermissionMap, Property, PropertyKey,108	PropertyKeyPermission, PropertyScope, PropertyValue, TokenId, TokenOwnerError,109	TokenProperties as TokenPropertiesT, MAX_REFUNGIBLE_PIECES,110};111112use crate::{erc::ERC721Events, erc_token::ERC20Events};113#[cfg(feature = "runtime-benchmarks")]114pub mod benchmarking;115pub mod common;116pub mod erc;117pub mod erc_token;118pub mod weights;119120pub type CreateItemData<T> =121	CreateRefungibleExMultipleOwners<<T as pallet_evm::Config>::CrossAccountId>;122pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;123124#[frame_support::pallet]125pub mod pallet {126	use frame_support::{127		pallet_prelude::*, storage::Key, traits::StorageVersion, Blake2_128, Blake2_128Concat,128		Twox64Concat,129	};130	use up_data_structs::{CollectionId, TokenId};131132	use super::{weights::WeightInfo, *};133134	#[pallet::error]135	pub enum Error<T> {136		/// Not Refungible item data used to mint in Refungible collection.137		NotRefungibleDataUsedToMintFungibleCollectionToken,138		/// Maximum refungibility exceeded.139		WrongRefungiblePieces,140		/// Refungible token can't be repartitioned by user who isn't owns all pieces.141		RepartitionWhileNotOwningAllPieces,142		/// Refungible token can't nest other tokens.143		RefungibleDisallowsNesting,144		/// Setting item properties is not allowed.145		SettingPropertiesNotAllowed,146	}147148	#[pallet::config]149	pub trait Config:150		frame_system::Config + pallet_common::Config + pallet_structure::Config151	{152		type WeightInfo: WeightInfo;153	}154155	const STORAGE_VERSION: StorageVersion = StorageVersion::new(2);156157	#[pallet::pallet]158	#[pallet::storage_version(STORAGE_VERSION)]159	pub struct Pallet<T>(_);160161	/// Total amount of minted tokens in a collection.162	#[pallet::storage]163	pub type TokensMinted<T: Config> =164		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;165166	/// Amount of tokens burnt in a collection.167	#[pallet::storage]168	pub type TokensBurnt<T: Config> =169		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;170171	/// Amount of pieces a refungible token is split into.172	#[pallet::storage]173	#[pallet::getter(fn token_properties)]174	pub type TokenProperties<T: Config> = StorageNMap<175		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),176		Value = TokenPropertiesT,177		QueryKind = OptionQuery,178	>;179180	/// Total amount of pieces for token181	#[pallet::storage]182	pub type TotalSupply<T: Config> = StorageNMap<183		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),184		Value = u128,185		QueryKind = ValueQuery,186	>;187188	/// Used to enumerate tokens owned by account.189	#[pallet::storage]190	pub type Owned<T: Config> = StorageNMap<191		Key = (192			Key<Twox64Concat, CollectionId>,193			Key<Blake2_128Concat, T::CrossAccountId>,194			Key<Twox64Concat, TokenId>,195		),196		Value = bool,197		QueryKind = ValueQuery,198	>;199200	/// Amount of tokens (not pieces) partially owned by an account within a collection.201	#[pallet::storage]202	pub type AccountBalance<T: Config> = StorageNMap<203		Key = (204			Key<Twox64Concat, CollectionId>,205			// Owner206			Key<Blake2_128Concat, T::CrossAccountId>,207		),208		Value = u32,209		QueryKind = ValueQuery,210	>;211212	/// Amount of token pieces owned by account.213	#[pallet::storage]214	pub type Balance<T: Config> = StorageNMap<215		Key = (216			Key<Twox64Concat, CollectionId>,217			Key<Twox64Concat, TokenId>,218			// Owner219			Key<Blake2_128Concat, T::CrossAccountId>,220		),221		Value = u128,222		QueryKind = ValueQuery,223	>;224225	/// Allowance set by a token owner for another user to perform one of certain transactions on a number of pieces of a token.226	#[pallet::storage]227	pub type Allowance<T: Config> = StorageNMap<228		Key = (229			Key<Twox64Concat, CollectionId>,230			Key<Twox64Concat, TokenId>,231			// Owner232			Key<Blake2_128, T::CrossAccountId>,233			// Spender234			Key<Blake2_128Concat, T::CrossAccountId>,235		),236		Value = u128,237		QueryKind = ValueQuery,238	>;239240	/// Spender set by a wallet owner that could perform certain transactions on all tokens in the wallet.241	#[pallet::storage]242	pub type CollectionAllowance<T: Config> = StorageNMap<243		Key = (244			Key<Twox64Concat, CollectionId>,245			Key<Blake2_128Concat, T::CrossAccountId>, // Owner246			Key<Blake2_128Concat, T::CrossAccountId>, // Spender247		),248		Value = bool,249		QueryKind = ValueQuery,250	>;251}252253pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);254impl<T: Config> RefungibleHandle<T> {255	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {256		Self(inner)257	}258	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {259		self.0260	}261	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {262		&mut self.0263	}264}265266impl<T: Config> Deref for RefungibleHandle<T> {267	type Target = pallet_common::CollectionHandle<T>;268269	fn deref(&self) -> &Self::Target {270		&self.0271	}272}273274impl<T: Config> WithRecorder<T> for RefungibleHandle<T> {275	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {276		self.0.recorder()277	}278	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {279		self.0.into_recorder()280	}281}282283impl<T: Config> Pallet<T> {284	/// Get number of RFT tokens in collection285	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {286		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)287	}288289	/// Check that RFT token exists290	///291	/// - `token`: Token ID.292	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {293		<TotalSupply<T>>::contains_key((collection.id, token))294	}295}296297// unchecked calls skips any permission checks298impl<T: Config> Pallet<T> {299	/// Create RFT collection300	///301	/// `init_collection` will take non-refundable deposit for collection creation.302	///303	/// - `data`: Contains settings for collection limits and permissions.304	pub fn init_collection(305		owner: T::CrossAccountId,306		payer: T::CrossAccountId,307		data: CreateCollectionData<T::CrossAccountId>,308	) -> Result<CollectionId, DispatchError> {309		<PalletCommon<T>>::init_collection(owner, payer, data)310	}311312	/// Destroy RFT collection313	///314	/// `destroy_collection` will throw error if collection contains any tokens.315	/// Only owner can destroy collection.316	pub fn destroy_collection(317		collection: RefungibleHandle<T>,318		sender: &T::CrossAccountId,319	) -> DispatchResult {320		let id = collection.id;321322		if Self::collection_has_tokens(id) {323			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());324		}325326		// =========327328		PalletCommon::destroy_collection(collection.0, sender)?;329330		<TokensMinted<T>>::remove(id);331		<TokensBurnt<T>>::remove(id);332		let _ = <TotalSupply<T>>::clear_prefix((id,), u32::MAX, None);333		let _ = <Balance<T>>::clear_prefix((id,), u32::MAX, None);334		let _ = <Allowance<T>>::clear_prefix((id,), u32::MAX, None);335		let _ = <Owned<T>>::clear_prefix((id,), u32::MAX, None);336		let _ = <AccountBalance<T>>::clear_prefix((id,), u32::MAX, None);337		Ok(())338	}339340	fn collection_has_tokens(collection_id: CollectionId) -> bool {341		<TotalSupply<T>>::iter_prefix((collection_id,))342			.next()343			.is_some()344	}345346	pub fn burn_token_unchecked(347		collection: &RefungibleHandle<T>,348		owner: &T::CrossAccountId,349		token_id: TokenId,350	) -> DispatchResult {351		let burnt = <TokensBurnt<T>>::get(collection.id)352			.checked_add(1)353			.ok_or(ArithmeticError::Overflow)?;354355		<TokensBurnt<T>>::insert(collection.id, burnt);356		<TokenProperties<T>>::remove((collection.id, token_id));357		<TotalSupply<T>>::remove((collection.id, token_id));358		let _ = <Balance<T>>::clear_prefix((collection.id, token_id), u32::MAX, None);359		let _ = <Allowance<T>>::clear_prefix((collection.id, token_id), u32::MAX, None);360		<PalletEvm<T>>::deposit_log(361			ERC721Events::Transfer {362				from: *owner.as_eth(),363				to: H160::default(),364				token_id: token_id.into(),365			}366			.to_log(collection_id_to_address(collection.id)),367		);368		Ok(())369	}370371	/// Burn RFT token pieces372	///373	/// `burn` will decrease total amount of token pieces and amount owned by sender.374	/// `burn` can be called even if there are multiple owners of the RFT token.375	/// If sender wouldn't have any pieces left after `burn` than she will stop being376	/// one of the owners of the token. If there is no account that owns any pieces of377	/// the token than token will be burned too.378	///379	/// - `amount`: Amount of token pieces to burn.380	/// - `token`: Token who's pieces should be burned381	/// - `collection`: Collection that contains the token382	pub fn burn(383		collection: &RefungibleHandle<T>,384		owner: &T::CrossAccountId,385		token: TokenId,386		amount: u128,387	) -> DispatchResult {388		if <Balance<T>>::get((collection.id, token, owner)) == 0 {389			return Err(<CommonError<T>>::TokenValueTooLow.into());390		}391392		let total_supply = <TotalSupply<T>>::get((collection.id, token))393			.checked_sub(amount)394			.ok_or(<CommonError<T>>::TokenValueTooLow)?;395396		// This was probally last owner of this token?397		if total_supply == 0 {398			// Ensure user actually owns this amount399			ensure!(400				<Balance<T>>::get((collection.id, token, owner)) == amount,401				<CommonError<T>>::TokenValueTooLow402			);403			let account_balance = <AccountBalance<T>>::get((collection.id, owner))404				.checked_sub(1)405				// Should not occur406				.ok_or(ArithmeticError::Underflow)?;407408			// =========409410			<Owned<T>>::remove((collection.id, owner, token));411			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);412			<AccountBalance<T>>::insert((collection.id, owner), account_balance);413			Self::burn_token_unchecked(collection, owner, token)?;414			<PalletEvm<T>>::deposit_log(415				ERC20Events::Transfer {416					from: *owner.as_eth(),417					to: H160::default(),418					value: amount.into(),419				}420				.to_log(collection_id_to_address(collection.id)),421			);422			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(423				collection.id,424				token,425				owner.clone(),426				amount,427			));428			return Ok(());429		}430431		let balance = <Balance<T>>::get((collection.id, token, owner))432			.checked_sub(amount)433			.ok_or(<CommonError<T>>::TokenValueTooLow)?;434		let account_balance = if balance == 0 {435			<AccountBalance<T>>::get((collection.id, owner))436				.checked_sub(1)437				// Should not occur438				.ok_or(ArithmeticError::Underflow)?439		} else {440			0441		};442443		// =========444445		if balance == 0 {446			<Owned<T>>::remove((collection.id, owner, token));447			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);448			<Balance<T>>::remove((collection.id, token, owner));449			<AccountBalance<T>>::insert((collection.id, owner), account_balance);450451			if let Ok(user) = Self::token_owner(collection.id, token) {452				<PalletEvm<T>>::deposit_log(453					ERC721Events::Transfer {454						from: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,455						to: *user.as_eth(),456						token_id: token.into(),457					}458					.to_log(collection_id_to_address(collection.id)),459				);460			}461		} else {462			<Balance<T>>::insert((collection.id, token, owner), balance);463		}464		<TotalSupply<T>>::insert((collection.id, token), total_supply);465466		<PalletEvm<T>>::deposit_log(467			ERC20Events::Transfer {468				from: *owner.as_eth(),469				to: H160::default(),470				value: amount.into(),471			}472			.to_log(T::EvmTokenAddressMapping::token_to_address(473				collection.id,474				token,475			)),476		);477		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(478			collection.id,479			token,480			owner.clone(),481			amount,482		));483		Ok(())484	}485486	/// A batch operation to add, edit or remove properties for a token.487	/// It sets or removes a token's properties according to488	/// `properties_updates` contents:489	/// * sets a property under the <key> with the value provided `(<key>, Some(<value>))`490	/// * removes a property under the <key> if the value is `None` `(<key>, None)`.491	///492	/// - `nesting_budget`: Limit for searching parents in-depth to check ownership.493	///494	/// All affected properties should have `mutable` permission495	/// to be **deleted** or to be **set more than once**,496	/// and the sender should have permission to edit those properties.497	///498	/// This function fires an event for each property change.499	/// In case of an error, all the changes (including the events) will be reverted500	/// since the function is transactional.501	#[transactional]502	fn modify_token_properties(503		collection: &RefungibleHandle<T>,504		sender: &T::CrossAccountId,505		token_id: TokenId,506		properties_updates: impl Iterator<Item = (PropertyKey, Option<PropertyValue>)>,507		nesting_budget: &dyn Budget,508	) -> DispatchResult {509		let mut property_writer =510			pallet_common::property_writer_for_existing_token(collection, sender);511512		property_writer.write_token_properties(513			sender,514			token_id,515			properties_updates,516			nesting_budget,517			erc::ERC721TokenEvent::TokenChanged {518				token_id: token_id.into(),519			}520			.to_log(T::ContractAddress::get()),521		)522	}523524	pub fn next_token_id(collection: &RefungibleHandle<T>) -> Result<TokenId, DispatchError> {525		let next_token_id = <TokensMinted<T>>::get(collection.id)526			.checked_add(1)527			.ok_or(<CommonError<T>>::CollectionTokenLimitExceeded)?;528529		ensure!(530			collection.limits.token_limit() >= next_token_id,531			<CommonError<T>>::CollectionTokenLimitExceeded532		);533534		Ok(TokenId(next_token_id))535	}536537	pub fn set_token_properties(538		collection: &RefungibleHandle<T>,539		sender: &T::CrossAccountId,540		token_id: TokenId,541		properties: impl Iterator<Item = Property>,542		nesting_budget: &dyn Budget,543	) -> DispatchResult {544		Self::modify_token_properties(545			collection,546			sender,547			token_id,548			properties.map(|p| (p.key, Some(p.value))),549			nesting_budget,550		)551	}552553	pub fn set_token_property(554		collection: &RefungibleHandle<T>,555		sender: &T::CrossAccountId,556		token_id: TokenId,557		property: Property,558		nesting_budget: &dyn Budget,559	) -> DispatchResult {560		Self::set_token_properties(561			collection,562			sender,563			token_id,564			[property].into_iter(),565			nesting_budget,566		)567	}568569	pub fn delete_token_properties(570		collection: &RefungibleHandle<T>,571		sender: &T::CrossAccountId,572		token_id: TokenId,573		property_keys: impl Iterator<Item = PropertyKey>,574		nesting_budget: &dyn Budget,575	) -> DispatchResult {576		Self::modify_token_properties(577			collection,578			sender,579			token_id,580			property_keys.into_iter().map(|key| (key, None)),581			nesting_budget,582		)583	}584585	pub fn delete_token_property(586		collection: &RefungibleHandle<T>,587		sender: &T::CrossAccountId,588		token_id: TokenId,589		property_key: PropertyKey,590		nesting_budget: &dyn Budget,591	) -> DispatchResult {592		Self::delete_token_properties(593			collection,594			sender,595			token_id,596			[property_key].into_iter(),597			nesting_budget,598		)599	}600601	/// Transfer RFT token pieces from one account to another.602	///603	/// If the sender is no longer owns any pieces after the `transfer` than she stops being an owner of the token.604	///605	/// - `from`: Owner of token pieces to transfer.606	/// - `to`: Recepient of transfered token pieces.607	/// - `amount`: Amount of token pieces to transfer.608	/// - `token`: Token whos pieces should be transfered609	/// - `collection`: Collection that contains the token610	pub fn transfer(611		collection: &RefungibleHandle<T>,612		from: &T::CrossAccountId,613		to: &T::CrossAccountId,614		token: TokenId,615		amount: u128,616		nesting_budget: &dyn Budget,617	) -> DispatchResult {618		ensure!(619			collection.limits.transfers_enabled(),620			<CommonError<T>>::TransferNotAllowed621		);622623		if collection.permissions.access() == AccessMode::AllowList {624			collection.check_allowlist(from)?;625			collection.check_allowlist(to)?;626		}627		<PalletCommon<T>>::ensure_correct_receiver(to)?;628629		let initial_balance_from = <Balance<T>>::get((collection.id, token, from));630631		if initial_balance_from == 0 {632			return Err(<CommonError<T>>::TokenValueTooLow.into());633		}634635		let updated_balance_from = initial_balance_from636			.checked_sub(amount)637			.ok_or(<CommonError<T>>::TokenValueTooLow)?;638		let mut create_target = false;639		let from_to_differ = from != to;640		let updated_balance_to = if from != to && amount != 0 {641			let old_balance = <Balance<T>>::get((collection.id, token, to));642			if old_balance == 0 {643				create_target = true;644			}645			Some(646				old_balance647					.checked_add(amount)648					.ok_or(ArithmeticError::Overflow)?,649			)650		} else {651			None652		};653654		let account_balance_from = if updated_balance_from == 0 {655			Some(656				<AccountBalance<T>>::get((collection.id, from))657					.checked_sub(1)658					// Should not occur659					.ok_or(ArithmeticError::Underflow)?,660			)661		} else {662			None663		};664		// Account data is created in token, AccountBalance should be increased665		// But only if from != to as we shouldn't check overflow in this case666		let account_balance_to = if create_target && from_to_differ {667			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))668				.checked_add(1)669				.ok_or(ArithmeticError::Overflow)?;670			ensure!(671				account_balance_to < collection.limits.account_token_ownership_limit(),672				<CommonError<T>>::AccountTokenLimitExceeded,673			);674675			Some(account_balance_to)676		} else {677			None678		};679680		// =========681682		if let Some(updated_balance_to) = updated_balance_to {683			// from != to && amount != 0684685			<PalletStructure<T>>::nest_if_sent_to_token(686				from.clone(),687				to,688				collection.id,689				token,690				nesting_budget,691			)?;692693			if updated_balance_from == 0 {694				<Balance<T>>::remove((collection.id, token, from));695				<PalletStructure<T>>::unnest_if_nested(from, collection.id, token);696			} else {697				<Balance<T>>::insert((collection.id, token, from), updated_balance_from);698			}699			<Balance<T>>::insert((collection.id, token, to), updated_balance_to);700			if let Some(account_balance_from) = account_balance_from {701				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);702				<Owned<T>>::remove((collection.id, from, token));703			}704			if let Some(account_balance_to) = account_balance_to {705				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);706				<Owned<T>>::insert((collection.id, to, token), true);707			}708		}709710		<PalletEvm<T>>::deposit_log(711			ERC20Events::Transfer {712				from: *from.as_eth(),713				to: *to.as_eth(),714				value: amount.into(),715			}716			.to_log(T::EvmTokenAddressMapping::token_to_address(717				collection.id,718				token,719			)),720		);721722		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(723			collection.id,724			token,725			from.clone(),726			to.clone(),727			amount,728		));729730		let total_supply = <TotalSupply<T>>::get((collection.id, token));731732		if amount == total_supply {733			// if token was fully owned by `from` and will be fully owned by `to` after transfer734			<PalletEvm<T>>::deposit_log(735				ERC721Events::Transfer {736					from: *from.as_eth(),737					to: *to.as_eth(),738					token_id: token.into(),739				}740				.to_log(collection_id_to_address(collection.id)),741			);742		} else if let Some(updated_balance_to) = updated_balance_to {743			// if `from` not equals `to`. This condition is needed to avoid sending event744			// when `from` fully owns token and sends part of token pieces to itself.745			if initial_balance_from == total_supply {746				// if token was fully owned by `from` and will be only partially owned by `to`747				// and `from` after transfer748				<PalletEvm<T>>::deposit_log(749					ERC721Events::Transfer {750						from: *from.as_eth(),751						to: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,752						token_id: token.into(),753					}754					.to_log(collection_id_to_address(collection.id)),755				);756			} else if updated_balance_to == total_supply {757				// if token was partially owned by `from` and will be fully owned by `to` after transfer758				<PalletEvm<T>>::deposit_log(759					ERC721Events::Transfer {760						from: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,761						to: *to.as_eth(),762						token_id: token.into(),763					}764					.to_log(collection_id_to_address(collection.id)),765				);766			}767		}768769		Ok(())770	}771772	/// Batched operation to create multiple RFT tokens.773	///774	/// Same as `create_item` but creates multiple tokens.775	///776	/// - `data`: Same as 'data` in `create_item` but contains data for multiple tokens.777	pub fn create_multiple_items(778		collection: &RefungibleHandle<T>,779		sender: &T::CrossAccountId,780		data: Vec<CreateItemData<T>>,781		nesting_budget: &dyn Budget,782	) -> DispatchResult {783		if !collection.is_owner_or_admin(sender) {784			ensure!(785				collection.permissions.mint_mode(),786				<CommonError<T>>::PublicMintingNotAllowed787			);788			collection.check_allowlist(sender)?;789790			for item in data.iter() {791				for user in item.users.keys() {792					collection.check_allowlist(user)?;793				}794			}795		}796797		for item in data.iter() {798			for (owner, _) in item.users.iter() {799				<PalletCommon<T>>::ensure_correct_receiver(owner)?;800			}801		}802803		// Total pieces per tokens804		let totals = data805			.iter()806			.map(|data| {807				Ok(data808					.users809					.iter()810					.map(|u| u.1)811					.try_fold(0u128, |acc, v| acc.checked_add(*v))812					.ok_or(ArithmeticError::Overflow)?)813			})814			.collect::<Result<Vec<_>, DispatchError>>()?;815		for total in &totals {816			ensure!(817				*total <= MAX_REFUNGIBLE_PIECES,818				<Error<T>>::WrongRefungiblePieces819			);820		}821822		let first_token_id = <TokensMinted<T>>::get(collection.id);823		let tokens_minted = first_token_id824			.checked_add(data.len() as u32)825			.ok_or(ArithmeticError::Overflow)?;826		ensure!(827			tokens_minted < collection.limits.token_limit(),828			<CommonError<T>>::CollectionTokenLimitExceeded829		);830831		let mut balances = BTreeMap::new();832		for data in &data {833			for owner in data.users.keys() {834				let balance = balances835					.entry(owner)836					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));837				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;838839				ensure!(840					*balance <= collection.limits.account_token_ownership_limit(),841					<CommonError<T>>::AccountTokenLimitExceeded,842				);843			}844		}845846		for (i, token) in data.iter().enumerate() {847			let token_id = TokenId(first_token_id + i as u32 + 1);848			for (to, _) in token.users.iter() {849				<PalletStructure<T>>::check_nesting(850					sender.clone(),851					to,852					collection.id,853					token_id,854					nesting_budget,855				)?;856			}857		}858859		// =========860861		let mut property_writer = pallet_common::property_writer_for_new_token(collection, sender);862863		with_transaction(|| {864			for (i, data) in data.iter().enumerate() {865				let token_id = first_token_id + i as u32 + 1;866				<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);867868				let token = TokenId(token_id);869870				let mut mint_target_is_sender = true;871				for (user, amount) in data.users.iter() {872					if *amount == 0 {873						continue;874					}875876					mint_target_is_sender = mint_target_is_sender && sender.conv_eq(user);877878					<Balance<T>>::insert((collection.id, token_id, &user), amount);879					<Owned<T>>::insert((collection.id, &user, token), true);880					<PalletStructure<T>>::nest_if_sent_to_token_unchecked(881						user,882						collection.id,883						token,884					);885				}886887				if let Err(e) = property_writer.write_token_properties(888					mint_target_is_sender,889					token,890					data.properties.clone().into_iter(),891					erc::ERC721TokenEvent::TokenChanged {892						token_id: token.into(),893					}894					.to_log(T::ContractAddress::get()),895				) {896					return TransactionOutcome::Rollback(Err(e));897				}898			}899			TransactionOutcome::Commit(Ok(()))900		})?;901902		<TokensMinted<T>>::insert(collection.id, tokens_minted);903904		for (account, balance) in balances {905			<AccountBalance<T>>::insert((collection.id, account), balance);906		}907908		for (i, token) in data.into_iter().enumerate() {909			let token_id = first_token_id + i as u32 + 1;910911			let receivers = token912				.users913				.into_iter()914				.filter(|(_, amount)| *amount > 0)915				.collect::<Vec<_>>();916917			if let [(user, _)] = receivers.as_slice() {918				// if there is exactly one receiver919				<PalletEvm<T>>::deposit_log(920					ERC721Events::Transfer {921						from: H160::default(),922						to: *user.as_eth(),923						token_id: token_id.into(),924					}925					.to_log(collection_id_to_address(collection.id)),926				);927			} else if let [_, ..] = receivers.as_slice() {928				// if there is more than one receiver929				<PalletEvm<T>>::deposit_log(930					ERC721Events::Transfer {931						from: H160::default(),932						to: erc::ADDRESS_FOR_PARTIALLY_OWNED_TOKENS,933						token_id: token_id.into(),934					}935					.to_log(collection_id_to_address(collection.id)),936				);937			}938939			for (user, amount) in receivers.into_iter() {940				<PalletEvm<T>>::deposit_log(941					ERC20Events::Transfer {942						from: H160::default(),943						to: *user.as_eth(),944						value: amount.into(),945					}946					.to_log(T::EvmTokenAddressMapping::token_to_address(947						collection.id,948						TokenId(token_id),949					)),950				);951				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(952					collection.id,953					TokenId(token_id),954					user,955					amount,956				));957			}958		}959		Ok(())960	}961962	pub fn set_allowance_unchecked(963		collection: &RefungibleHandle<T>,964		sender: &T::CrossAccountId,965		spender: &T::CrossAccountId,966		token: TokenId,967		amount: u128,968	) {969		if amount == 0 {970			<Allowance<T>>::remove((collection.id, token, sender, spender));971		} else {972			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);973		}974975		<PalletEvm<T>>::deposit_log(976			ERC20Events::Approval {977				owner: *sender.as_eth(),978				spender: *spender.as_eth(),979				value: amount.into(),980			}981			.to_log(T::EvmTokenAddressMapping::token_to_address(982				collection.id,983				token,984			)),985		);986		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(987			collection.id,988			token,989			sender.clone(),990			spender.clone(),991			amount,992		))993	}994995	/// Set allowance for the spender to `transfer` or `burn` sender's token pieces.996	///997	/// - `amount`: Amount of token pieces the spender is allowed to `transfer` or `burn.998	pub fn set_allowance(999		collection: &RefungibleHandle<T>,1000		sender: &T::CrossAccountId,1001		spender: &T::CrossAccountId,1002		token: TokenId,1003		amount: u128,1004	) -> DispatchResult {1005		if collection.permissions.access() == AccessMode::AllowList {1006			collection.check_allowlist(sender)?;1007			collection.check_allowlist(spender)?;1008		}10091010		<PalletCommon<T>>::ensure_correct_receiver(spender)?;10111012		if <Balance<T>>::get((collection.id, token, sender)) < amount {1013			ensure!(1014				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),1015				<CommonError<T>>::CantApproveMoreThanOwned1016			);1017		}10181019		// =========10201021		Self::set_allowance_unchecked(collection, sender, spender, token, amount);1022		Ok(())1023	}10241025	/// Set allowance to spend from sender's eth mirror1026	///1027	/// - `from`: Address of sender's eth mirror.1028	/// - `to`: Adress of spender.1029	/// - `amount`: Amount of token pieces the spender is allowed to `transfer` or `burn.1030	pub fn set_allowance_from(1031		collection: &RefungibleHandle<T>,1032		sender: &T::CrossAccountId,1033		from: &T::CrossAccountId,1034		to: &T::CrossAccountId,1035		token_id: TokenId,1036		amount: u128,1037	) -> DispatchResult {1038		if collection.permissions.access() == AccessMode::AllowList {1039			collection.check_allowlist(sender)?;1040			collection.check_allowlist(from)?;1041			collection.check_allowlist(to)?;1042		}10431044		<PalletCommon<T>>::ensure_correct_receiver(to)?;10451046		ensure!(1047			sender.conv_eq(from),1048			<CommonError<T>>::AddressIsNotEthMirror1049		);10501051		if <Balance<T>>::get((collection.id, token_id, from)) < amount {1052			ensure!(1053				collection.limits.owner_can_transfer()1054					&& (collection.is_owner_or_admin(sender) || collection.is_owner_or_admin(from))1055					&& Self::token_exists(collection, token_id),1056				<CommonError<T>>::CantApproveMoreThanOwned1057			);1058		}10591060		// =========10611062		Self::set_allowance_unchecked(collection, from, to, token_id, amount);1063		Ok(())1064	}10651066	/// Returns allowance, which should be set after transaction1067	fn check_allowed(1068		collection: &RefungibleHandle<T>,1069		spender: &T::CrossAccountId,1070		from: &T::CrossAccountId,1071		token: TokenId,1072		amount: u128,1073		nesting_budget: &dyn Budget,1074	) -> Result<Option<u128>, DispatchError> {1075		if spender.conv_eq(from) {1076			return Ok(None);1077		}1078		if collection.permissions.access() == AccessMode::AllowList {1079			// `from`, `to` checked in [`transfer`]1080			collection.check_allowlist(spender)?;1081		}10821083		if collection.ignores_token_restrictions(spender) {1084			return Ok(Self::compute_allowance_decrease(1085				collection, token, from, spender, amount,1086			));1087		}10881089		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {1090			// TODO: should collection owner be allowed to perform this transfer?1091			ensure!(1092				<PalletStructure<T>>::check_indirectly_owned(1093					spender.clone(),1094					source.0,1095					source.1,1096					None,1097					nesting_budget1098				)?,1099				<CommonError<T>>::ApprovedValueTooLow,1100			);1101			return Ok(None);1102		}11031104		let allowance = Self::compute_allowance_decrease(collection, token, from, spender, amount);1105		if allowance.is_some() {1106			return Ok(allowance);1107		}11081109		// Allowance (if any) would be reduced if spender is also wallet operator1110		if <CollectionAllowance<T>>::get((collection.id, from, spender)) {1111			return Ok(allowance);1112		}11131114		Err(<CommonError<T>>::ApprovedValueTooLow.into())1115	}11161117	/// Returns `Some(amount)` if the `spender` have allowance to spend this amount.1118	/// Otherwise, it returns `None`.1119	fn compute_allowance_decrease(1120		collection: &RefungibleHandle<T>,1121		token: TokenId,1122		from: &T::CrossAccountId,1123		spender: &T::CrossAccountId,1124		amount: u128,1125	) -> Option<u128> {1126		<Allowance<T>>::get((collection.id, token, from, spender)).checked_sub(amount)1127	}11281129	/// Transfer RFT token pieces from one account to another.1130	///1131	/// Same as the [`transfer`] but spender doesn't needs to be an owner of the token pieces.1132	/// The owner should set allowance for the spender to transfer pieces.1133	///1134	/// [`transfer`]: struct.Pallet.html#method.transfer1135	pub fn transfer_from(1136		collection: &RefungibleHandle<T>,1137		spender: &T::CrossAccountId,1138		from: &T::CrossAccountId,1139		to: &T::CrossAccountId,1140		token: TokenId,1141		amount: u128,1142		nesting_budget: &dyn Budget,1143	) -> DispatchResult {1144		let allowance =1145			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;11461147		// =========11481149		Self::transfer(collection, from, to, token, amount, nesting_budget)?;1150		if let Some(allowance) = allowance {1151			Self::set_allowance_unchecked(collection, from, spender, token, allowance);1152		}1153		Ok(())1154	}11551156	/// Burn RFT token pieces from the account.1157	///1158	/// Same as the [`burn`] but spender doesn't need to be an owner of the token pieces. The owner should1159	/// set allowance for the spender to burn pieces1160	///1161	/// [`burn`]: struct.Pallet.html#method.burn1162	pub fn burn_from(1163		collection: &RefungibleHandle<T>,1164		spender: &T::CrossAccountId,1165		from: &T::CrossAccountId,1166		token: TokenId,1167		amount: u128,1168		nesting_budget: &dyn Budget,1169	) -> DispatchResult {1170		let allowance =1171			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;11721173		// =========11741175		Self::burn(collection, from, token, amount)?;1176		if let Some(allowance) = allowance {1177			Self::set_allowance_unchecked(collection, from, spender, token, allowance);1178		}1179		Ok(())1180	}11811182	/// Create RFT token.1183	///1184	/// The sender should be the owner/admin of the collection or collection should be configured1185	/// to allow public minting.1186	///1187	/// - `data`: Contains list of users who will become the owners of the token pieces and amount1188	///   of token pieces they will receive.1189	pub fn create_item(1190		collection: &RefungibleHandle<T>,1191		sender: &T::CrossAccountId,1192		data: CreateItemData<T>,1193		nesting_budget: &dyn Budget,1194	) -> DispatchResult {1195		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)1196	}11971198	/// Repartition RFT token.1199	///1200	/// `repartition` will set token balance of the sender and total amount of token pieces.1201	/// Sender should own all of the token pieces. `repartition' could be done even if some1202	/// token pieces were burned before.1203	///1204	/// - `amount`: Total amount of token pieces that the token will have after `repartition`.1205	pub fn repartition(1206		collection: &RefungibleHandle<T>,1207		owner: &T::CrossAccountId,1208		token: TokenId,1209		amount: u128,1210	) -> DispatchResult {1211		ensure!(1212			amount <= MAX_REFUNGIBLE_PIECES,1213			<Error<T>>::WrongRefungiblePieces1214		);1215		ensure!(amount > 0, <CommonError<T>>::TokenValueTooLow);1216		// Ensure user owns all pieces1217		let total_pieces = Self::total_pieces(collection.id, token).unwrap_or(u128::MAX);1218		let balance = <Balance<T>>::get((collection.id, token, owner));1219		ensure!(1220			total_pieces == balance,1221			<Error<T>>::RepartitionWhileNotOwningAllPieces1222		);12231224		<Balance<T>>::insert((collection.id, token, owner), amount);1225		<TotalSupply<T>>::insert((collection.id, token), amount);12261227		match total_pieces.cmp(&amount) {1228			Ordering::Less => {1229				let mint_amount = amount - total_pieces;1230				<PalletEvm<T>>::deposit_log(1231					ERC20Events::Transfer {1232						from: H160::default(),1233						to: *owner.as_eth(),1234						value: mint_amount.into(),1235					}1236					.to_log(T::EvmTokenAddressMapping::token_to_address(1237						collection.id,1238						token,1239					)),1240				);1241				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(1242					collection.id,1243					token,1244					owner.clone(),1245					mint_amount,1246				));1247			}1248			Ordering::Greater => {1249				let burn_amount = total_pieces - amount;1250				<PalletEvm<T>>::deposit_log(1251					ERC20Events::Transfer {1252						from: *owner.as_eth(),1253						to: H160::default(),1254						value: burn_amount.into(),1255					}1256					.to_log(T::EvmTokenAddressMapping::token_to_address(1257						collection.id,1258						token,1259					)),1260				);1261				<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(1262					collection.id,1263					token,1264					owner.clone(),1265					burn_amount,1266				));1267			}1268			Ordering::Equal => {}1269		}12701271		Ok(())1272	}12731274	fn token_owner(1275		collection_id: CollectionId,1276		token_id: TokenId,1277	) -> Result<T::CrossAccountId, TokenOwnerError> {1278		let mut owner = None;1279		let mut count = 0;1280		for key in Balance::<T>::iter_key_prefix((collection_id, token_id)) {1281			count += 1;1282			if count > 1 {1283				return Err(TokenOwnerError::MultipleOwners);1284			}1285			owner = Some(key);1286		}1287		owner.ok_or(TokenOwnerError::NotFound)1288	}12891290	fn total_pieces(collection_id: CollectionId, token_id: TokenId) -> Option<u128> {1291		<TotalSupply<T>>::try_get((collection_id, token_id)).ok()1292	}12931294	pub fn set_collection_properties(1295		collection: &RefungibleHandle<T>,1296		sender: &T::CrossAccountId,1297		properties: Vec<Property>,1298	) -> DispatchResult {1299		<PalletCommon<T>>::set_collection_properties(collection, sender, properties.into_iter())1300	}13011302	pub fn delete_collection_properties(1303		collection: &RefungibleHandle<T>,1304		sender: &T::CrossAccountId,1305		property_keys: Vec<PropertyKey>,1306	) -> DispatchResult {1307		<PalletCommon<T>>::delete_collection_properties(1308			collection,1309			sender,1310			property_keys.into_iter(),1311		)1312	}13131314	pub fn set_token_property_permissions(1315		collection: &RefungibleHandle<T>,1316		sender: &T::CrossAccountId,1317		property_permissions: Vec<PropertyKeyPermission>,1318	) -> DispatchResult {1319		<PalletCommon<T>>::set_token_property_permissions(collection, sender, property_permissions)1320	}13211322	pub fn token_property_permission(collection_id: CollectionId) -> PropertiesPermissionMap {1323		<PalletCommon<T>>::property_permissions(collection_id)1324	}13251326	pub fn set_scoped_token_property_permissions(1327		collection: &RefungibleHandle<T>,1328		sender: &T::CrossAccountId,1329		scope: PropertyScope,1330		property_permissions: Vec<PropertyKeyPermission>,1331	) -> DispatchResult {1332		<PalletCommon<T>>::set_scoped_token_property_permissions(1333			collection,1334			sender,1335			scope,1336			property_permissions,1337		)1338	}13391340	/// Returns 10 token in no particular order.1341	///1342	/// There is no direct way to get token holders in ascending order,1343	/// since `iter_prefix` returns values in no particular order.1344	/// Therefore, getting the 10 largest holders with a large value of holders1345	/// can lead to impact memory allocation + sorting with  `n * log (n)`.1346	pub fn token_owners(1347		collection_id: CollectionId,1348		token: TokenId,1349	) -> Option<Vec<T::CrossAccountId>> {1350		let res: Vec<T::CrossAccountId> = <Balance<T>>::iter_prefix((collection_id, token))1351			.map(|(owner, _amount)| owner)1352			.take(10)1353			.collect();13541355		if res.is_empty() {1356			None1357		} else {1358			Some(res)1359		}1360	}13611362	/// Sets or unsets the approval of a given operator.1363	///1364	/// The `operator` is allowed to transfer all token pieces of the `owner` on their behalf.1365	/// - `owner`: Token owner1366	/// - `operator`: Operator1367	/// - `approve`: Should operator status be granted or revoked?1368	pub fn set_allowance_for_all(1369		collection: &RefungibleHandle<T>,1370		owner: &T::CrossAccountId,1371		spender: &T::CrossAccountId,1372		approve: bool,1373	) -> DispatchResult {1374		<PalletCommon<T>>::set_allowance_for_all(1375			collection,1376			owner,1377			spender,1378			approve,1379			|| <CollectionAllowance<T>>::insert((collection.id, owner, spender), approve),1380			ERC721Events::ApprovalForAll {1381				owner: *owner.as_eth(),1382				operator: *spender.as_eth(),1383				approved: approve,1384			}1385			.to_log(collection_id_to_address(collection.id)),1386		)1387	}13881389	/// Tells whether the given `owner` approves the `operator`.1390	pub fn allowance_for_all(1391		collection: &RefungibleHandle<T>,1392		owner: &T::CrossAccountId,1393		spender: &T::CrossAccountId,1394	) -> bool {1395		<CollectionAllowance<T>>::get((collection.id, owner, spender))1396	}13971398	pub fn repair_item(collection: &RefungibleHandle<T>, token: TokenId) -> DispatchResult {1399		<TokenProperties<T>>::mutate((collection.id, token), |properties| {1400			if let Some(properties) = properties {1401				properties.recompute_consumed_space();1402			}1403		});14041405		Ok(())1406	}1407}