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

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#![cfg_attr(not(feature = "std"), no_std)]1819use frame_support::{ensure, BoundedVec};20use up_data_structs::{21	AccessMode, CollectionId, CustomDataLimit, MAX_REFUNGIBLE_PIECES, TokenId,22	CreateCollectionData, CreateRefungibleExData, mapping::TokenAddressMapping, budget::Budget,23};24use pallet_evm::account::CrossAccountId;25use pallet_common::{26	Error as CommonError, Event as CommonEvent, Pallet as PalletCommon, CollectionHandle,27	dispatch::CollectionDispatch,28};29use pallet_structure::Pallet as PalletStructure;30use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};31use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};32use core::ops::Deref;33use codec::{Encode, Decode, MaxEncodedLen};34use scale_info::TypeInfo;3536pub use pallet::*;37#[cfg(feature = "runtime-benchmarks")]38pub mod benchmarking;39pub mod common;40pub mod erc;41pub mod weights;42pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4344#[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]45pub struct ItemData {46	pub const_data: BoundedVec<u8, CustomDataLimit>,47	pub variable_data: BoundedVec<u8, CustomDataLimit>,48}4950#[frame_support::pallet]51pub mod pallet {52	use super::*;53	use frame_support::{Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key};54	use up_data_structs::{CollectionId, TokenId};55	use super::weights::WeightInfo;5657	#[pallet::error]58	pub enum Error<T> {59		/// Not Refungible item data used to mint in Refungible collection.60		NotRefungibleDataUsedToMintFungibleCollectionToken,61		/// Maximum refungibility exceeded62		WrongRefungiblePieces,63		/// Refungible token can't nest other tokens64		RefungibleDisallowsNesting,65		/// Item properties are not allowed66		PropertiesNotAllowed,67	}6869	#[pallet::config]70	pub trait Config:71		frame_system::Config + pallet_common::Config + pallet_structure::Config72	{73		type WeightInfo: WeightInfo;74	}7576	#[pallet::pallet]77	#[pallet::generate_store(pub(super) trait Store)]78	pub struct Pallet<T>(_);7980	#[pallet::storage]81	pub type TokensMinted<T: Config> =82		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;83	#[pallet::storage]84	pub type TokensBurnt<T: Config> =85		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;8687	#[pallet::storage]88	pub type TokenData<T: Config> = StorageNMap<89		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),90		Value = ItemData,91		QueryKind = ValueQuery,92	>;9394	#[pallet::storage]95	pub type TotalSupply<T: Config> = StorageNMap<96		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),97		Value = u128,98		QueryKind = ValueQuery,99	>;100101	/// Used to enumerate tokens owned by account102	#[pallet::storage]103	pub type Owned<T: Config> = StorageNMap<104		Key = (105			Key<Twox64Concat, CollectionId>,106			Key<Blake2_128Concat, T::CrossAccountId>,107			Key<Twox64Concat, TokenId>,108		),109		Value = bool,110		QueryKind = ValueQuery,111	>;112113	#[pallet::storage]114	pub type AccountBalance<T: Config> = StorageNMap<115		Key = (116			Key<Twox64Concat, CollectionId>,117			// Owner118			Key<Blake2_128Concat, T::CrossAccountId>,119		),120		Value = u32,121		QueryKind = ValueQuery,122	>;123124	#[pallet::storage]125	pub type Balance<T: Config> = StorageNMap<126		Key = (127			Key<Twox64Concat, CollectionId>,128			Key<Twox64Concat, TokenId>,129			// Owner130			Key<Blake2_128Concat, T::CrossAccountId>,131		),132		Value = u128,133		QueryKind = ValueQuery,134	>;135136	#[pallet::storage]137	pub type Allowance<T: Config> = StorageNMap<138		Key = (139			Key<Twox64Concat, CollectionId>,140			Key<Twox64Concat, TokenId>,141			// Owner142			Key<Blake2_128, T::CrossAccountId>,143			// Spender144			Key<Blake2_128Concat, T::CrossAccountId>,145		),146		Value = u128,147		QueryKind = ValueQuery,148	>;149}150151pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);152impl<T: Config> RefungibleHandle<T> {153	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {154		Self(inner)155	}156	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {157		self.0158	}159}160impl<T: Config> Deref for RefungibleHandle<T> {161	type Target = pallet_common::CollectionHandle<T>;162163	fn deref(&self) -> &Self::Target {164		&self.0165	}166}167168impl<T: Config> Pallet<T> {169	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {170		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)171	}172	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {173		<TotalSupply<T>>::contains_key((collection.id, token))174	}175}176177// unchecked calls skips any permission checks178impl<T: Config> Pallet<T> {179	pub fn init_collection(180		owner: T::AccountId,181		data: CreateCollectionData<T::AccountId>,182	) -> Result<CollectionId, DispatchError> {183		<PalletCommon<T>>::init_collection(owner, data)184	}185	pub fn destroy_collection(186		collection: RefungibleHandle<T>,187		sender: &T::CrossAccountId,188	) -> DispatchResult {189		let id = collection.id;190191		// =========192193		PalletCommon::destroy_collection(collection.0, sender)?;194195		<TokensMinted<T>>::remove(id);196		<TokensBurnt<T>>::remove(id);197		<TokenData<T>>::remove_prefix((id,), None);198		<TotalSupply<T>>::remove_prefix((id,), None);199		<Balance<T>>::remove_prefix((id,), None);200		<Allowance<T>>::remove_prefix((id,), None);201		<Owned<T>>::remove_prefix((id,), None);202		<AccountBalance<T>>::remove_prefix((id,), None);203		Ok(())204	}205206	pub fn burn_token(collection: &RefungibleHandle<T>, token_id: TokenId) -> DispatchResult {207		let burnt = <TokensBurnt<T>>::get(collection.id)208			.checked_add(1)209			.ok_or(ArithmeticError::Overflow)?;210211		<TokensBurnt<T>>::insert(collection.id, burnt);212		<TokenData<T>>::remove((collection.id, token_id));213		<TotalSupply<T>>::remove((collection.id, token_id));214		<Balance<T>>::remove_prefix((collection.id, token_id), None);215		<Allowance<T>>::remove_prefix((collection.id, token_id), None);216		// TODO: ERC721 transfer event217		Ok(())218	}219220	pub fn burn(221		collection: &RefungibleHandle<T>,222		owner: &T::CrossAccountId,223		token: TokenId,224		amount: u128,225	) -> DispatchResult {226		let total_supply = <TotalSupply<T>>::get((collection.id, token))227			.checked_sub(amount)228			.ok_or(<CommonError<T>>::TokenValueTooLow)?;229230		// This was probally last owner of this token?231		if total_supply == 0 {232			// Ensure user actually owns this amount233			ensure!(234				<Balance<T>>::get((collection.id, token, owner)) == amount,235				<CommonError<T>>::TokenValueTooLow236			);237			let account_balance = <AccountBalance<T>>::get((collection.id, owner))238				.checked_sub(1)239				// Should not occur240				.ok_or(ArithmeticError::Underflow)?;241242			// =========243244			<Owned<T>>::remove((collection.id, owner, token));245			<AccountBalance<T>>::insert((collection.id, owner), account_balance);246			Self::burn_token(collection, token)?;247			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(248				collection.id,249				token,250				owner.clone(),251				amount,252			));253			return Ok(());254		}255256		let balance = <Balance<T>>::get((collection.id, token, owner))257			.checked_sub(amount)258			.ok_or(<CommonError<T>>::TokenValueTooLow)?;259		let account_balance = if balance == 0 {260			<AccountBalance<T>>::get((collection.id, owner))261				.checked_sub(1)262				// Should not occur263				.ok_or(ArithmeticError::Underflow)?264		} else {265			0266		};267268		// =========269270		if balance == 0 {271			<Owned<T>>::remove((collection.id, owner, token));272			<Balance<T>>::remove((collection.id, token, owner));273			<AccountBalance<T>>::insert((collection.id, owner), account_balance);274		} else {275			<Balance<T>>::insert((collection.id, token, owner), balance);276		}277		<TotalSupply<T>>::insert((collection.id, token), total_supply);278		// TODO: ERC20 transfer event279		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(280			collection.id,281			token,282			owner.clone(),283			amount,284		));285		Ok(())286	}287288	pub fn transfer(289		collection: &RefungibleHandle<T>,290		from: &T::CrossAccountId,291		to: &T::CrossAccountId,292		token: TokenId,293		amount: u128,294		nesting_budget: &dyn Budget,295	) -> DispatchResult {296		ensure!(297			collection.limits.transfers_enabled(),298			<CommonError<T>>::TransferNotAllowed299		);300301		if collection.access == AccessMode::AllowList {302			collection.check_allowlist(from)?;303			collection.check_allowlist(to)?;304		}305		<PalletCommon<T>>::ensure_correct_receiver(to)?;306307		let balance_from = <Balance<T>>::get((collection.id, token, from))308			.checked_sub(amount)309			.ok_or(<CommonError<T>>::TokenValueTooLow)?;310		let mut create_target = false;311		let from_to_differ = from != to;312		let balance_to = if from != to {313			let old_balance = <Balance<T>>::get((collection.id, token, to));314			if old_balance == 0 {315				create_target = true;316			}317			Some(318				old_balance319					.checked_add(amount)320					.ok_or(ArithmeticError::Overflow)?,321			)322		} else {323			None324		};325326		let account_balance_from = if balance_from == 0 {327			Some(328				<AccountBalance<T>>::get((collection.id, from))329					.checked_sub(1)330					// Should not occur331					.ok_or(ArithmeticError::Underflow)?,332			)333		} else {334			None335		};336		// Account data is created in token, AccountBalance should be increased337		// But only if from != to as we shouldn't check overflow in this case338		let account_balance_to = if create_target && from_to_differ {339			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))340				.checked_add(1)341				.ok_or(ArithmeticError::Overflow)?;342			ensure!(343				account_balance_to < collection.limits.account_token_ownership_limit(),344				<CommonError<T>>::AccountTokenLimitExceeded,345			);346347			Some(account_balance_to)348		} else {349			None350		};351352		if let Some(target) = T::CrossTokenAddressMapping::address_to_token(to) {353			let handle = <CollectionHandle<T>>::try_get(target.0)?;354			let dispatch = T::CollectionDispatch::dispatch(handle);355			let dispatch = dispatch.as_dyn();356357			dispatch.check_nesting(358				from.clone(),359				(collection.id, token),360				target.1,361				nesting_budget,362			)?;363		}364365		// =========366367		if let Some(balance_to) = balance_to {368			// from != to369			if balance_from == 0 {370				<Balance<T>>::remove((collection.id, token, from));371			} else {372				<Balance<T>>::insert((collection.id, token, from), balance_from);373			}374			<Balance<T>>::insert((collection.id, token, to), balance_to);375			if let Some(account_balance_from) = account_balance_from {376				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);377				<Owned<T>>::remove((collection.id, from, token));378			}379			if let Some(account_balance_to) = account_balance_to {380				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);381				<Owned<T>>::insert((collection.id, to, token), true);382			}383		}384385		// TODO: ERC20 transfer event386		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(387			collection.id,388			token,389			from.clone(),390			to.clone(),391			amount,392		));393		Ok(())394	}395396	pub fn create_multiple_items(397		collection: &RefungibleHandle<T>,398		sender: &T::CrossAccountId,399		data: Vec<CreateRefungibleExData<T::CrossAccountId>>,400		nesting_budget: &dyn Budget,401	) -> DispatchResult {402		if !collection.is_owner_or_admin(sender) {403			ensure!(404				collection.mint_mode,405				<CommonError<T>>::PublicMintingNotAllowed406			);407			collection.check_allowlist(sender)?;408409			for item in data.iter() {410				for user in item.users.keys() {411					collection.check_allowlist(user)?;412				}413			}414		}415416		for item in data.iter() {417			for (owner, _) in item.users.iter() {418				<PalletCommon<T>>::ensure_correct_receiver(owner)?;419			}420		}421422		// Total pieces per tokens423		let totals = data424			.iter()425			.map(|data| {426				Ok(data427					.users428					.iter()429					.map(|u| u.1)430					.try_fold(0u128, |acc, v| acc.checked_add(*v))431					.ok_or(ArithmeticError::Overflow)?)432			})433			.collect::<Result<Vec<_>, DispatchError>>()?;434		for total in &totals {435			ensure!(436				*total <= MAX_REFUNGIBLE_PIECES,437				<Error<T>>::WrongRefungiblePieces438			);439		}440441		let first_token_id = <TokensMinted<T>>::get(collection.id);442		let tokens_minted = first_token_id443			.checked_add(data.len() as u32)444			.ok_or(ArithmeticError::Overflow)?;445		ensure!(446			tokens_minted < collection.limits.token_limit(),447			<CommonError<T>>::CollectionTokenLimitExceeded448		);449450		let mut balances = BTreeMap::new();451		for data in &data {452			for owner in data.users.keys() {453				let balance = balances454					.entry(owner)455					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));456				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;457458				ensure!(459					*balance <= collection.limits.account_token_ownership_limit(),460					<CommonError<T>>::AccountTokenLimitExceeded,461				);462			}463		}464465		for (i, token) in data.iter().enumerate() {466			let token_id = TokenId(first_token_id + i as u32 + 1);467			for (to, _) in token.users.iter() {468				if let Some(target) = T::CrossTokenAddressMapping::address_to_token(to) {469					let handle = <CollectionHandle<T>>::try_get(target.0)?;470					let dispatch = T::CollectionDispatch::dispatch(handle);471					let dispatch = dispatch.as_dyn();472473					dispatch.check_nesting(474						sender.clone(),475						(collection.id, token_id),476						target.1,477						nesting_budget,478					)?;479				}480			}481		}482483		// =========484485		<TokensMinted<T>>::insert(collection.id, tokens_minted);486		for (account, balance) in balances {487			<AccountBalance<T>>::insert((collection.id, account), balance);488		}489		for (i, token) in data.into_iter().enumerate() {490			let token_id = first_token_id + i as u32 + 1;491			<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);492493			<TokenData<T>>::insert(494				(collection.id, token_id),495				ItemData {496					const_data: token.const_data,497					variable_data: token.variable_data,498				},499			);500			for (user, amount) in token.users.into_iter() {501				if amount == 0 {502					continue;503				}504				<Balance<T>>::insert((collection.id, token_id, &user), amount);505				<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);506				// TODO: ERC20 transfer event507				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(508					collection.id,509					TokenId(token_id),510					user,511					amount,512				));513			}514		}515		Ok(())516	}517518	pub fn set_allowance_unchecked(519		collection: &RefungibleHandle<T>,520		sender: &T::CrossAccountId,521		spender: &T::CrossAccountId,522		token: TokenId,523		amount: u128,524	) {525		if amount == 0 {526			<Allowance<T>>::remove((collection.id, token, sender, spender));527		} else {528			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);529		}530		// TODO: ERC20 approval event531		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(532			collection.id,533			token,534			sender.clone(),535			spender.clone(),536			amount,537		))538	}539540	pub fn set_allowance(541		collection: &RefungibleHandle<T>,542		sender: &T::CrossAccountId,543		spender: &T::CrossAccountId,544		token: TokenId,545		amount: u128,546	) -> DispatchResult {547		if collection.access == AccessMode::AllowList {548			collection.check_allowlist(sender)?;549			collection.check_allowlist(spender)?;550		}551552		<PalletCommon<T>>::ensure_correct_receiver(spender)?;553554		if <Balance<T>>::get((collection.id, token, sender)) < amount {555			ensure!(556				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),557				<CommonError<T>>::CantApproveMoreThanOwned558			);559		}560561		// =========562563		Self::set_allowance_unchecked(collection, sender, spender, token, amount);564		Ok(())565	}566567	/// Returns allowance, which should be set after transaction568	fn check_allowed(569		collection: &RefungibleHandle<T>,570		spender: &T::CrossAccountId,571		from: &T::CrossAccountId,572		token: TokenId,573		amount: u128,574		nesting_budget: &dyn Budget,575	) -> Result<Option<u128>, DispatchError> {576		if spender.conv_eq(from) {577			return Ok(None);578		}579		if collection.access == AccessMode::AllowList {580			// `from`, `to` checked in [`transfer`]581			collection.check_allowlist(spender)?;582		}583		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {584			// TODO: should collection owner be allowed to perform this transfer?585			ensure!(586				<PalletStructure<T>>::check_indirectly_owned(587					spender.clone(),588					source.0,589					source.1,590					None,591					nesting_budget592				)?,593				<CommonError<T>>::ApprovedValueTooLow,594			);595			return Ok(None);596		}597		let allowance =598			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);599		if allowance.is_none() {600			ensure!(601				collection.ignores_allowance(spender),602				<CommonError<T>>::ApprovedValueTooLow603			);604		}605		Ok(allowance)606	}607608	pub fn transfer_from(609		collection: &RefungibleHandle<T>,610		spender: &T::CrossAccountId,611		from: &T::CrossAccountId,612		to: &T::CrossAccountId,613		token: TokenId,614		amount: u128,615		nesting_budget: &dyn Budget,616	) -> DispatchResult {617		let allowance =618			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;619620		// =========621622		Self::transfer(collection, from, to, token, amount, nesting_budget)?;623		if let Some(allowance) = allowance {624			Self::set_allowance_unchecked(collection, from, spender, token, allowance);625		}626		Ok(())627	}628629	pub fn burn_from(630		collection: &RefungibleHandle<T>,631		spender: &T::CrossAccountId,632		from: &T::CrossAccountId,633		token: TokenId,634		amount: u128,635		nesting_budget: &dyn Budget,636	) -> DispatchResult {637		let allowance =638			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;639640		// =========641642		Self::burn(collection, from, token, amount)?;643		if let Some(allowance) = allowance {644			Self::set_allowance_unchecked(collection, from, spender, token, allowance);645		}646		Ok(())647	}648649	pub fn set_variable_metadata(650		collection: &RefungibleHandle<T>,651		sender: &T::CrossAccountId,652		token: TokenId,653		data: BoundedVec<u8, CustomDataLimit>,654	) -> DispatchResult {655		collection.check_can_update_meta(656			sender,657			&T::CrossAccountId::from_sub(collection.owner.clone()),658		)?;659660		let token_data = <TokenData<T>>::get((collection.id, token));661662		// =========663664		<TokenData<T>>::insert(665			(collection.id, token),666			ItemData {667				variable_data: data,668				..token_data669			},670		);671		Ok(())672	}673674	/// Delegated to `create_multiple_items`675	pub fn create_item(676		collection: &RefungibleHandle<T>,677		sender: &T::CrossAccountId,678		data: CreateRefungibleExData<T::CrossAccountId>,679		nesting_budget: &dyn Budget,680	) -> DispatchResult {681		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)682	}683}