git.delta.rocks / unique-network / refs/commits / 79ec93ec606f

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,27};28use pallet_structure::Pallet as PalletStructure;29use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};30use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};31use core::ops::Deref;32use codec::{Encode, Decode, MaxEncodedLen};33use scale_info::TypeInfo;3435pub use pallet::*;36#[cfg(feature = "runtime-benchmarks")]37pub mod benchmarking;38pub mod common;39pub mod erc;40pub mod weights;41pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4243#[struct_versioning::versioned(version = 2, upper)]44#[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]45pub struct ItemData {46	pub const_data: BoundedVec<u8, CustomDataLimit>,4748	#[version(..2)]49	pub variable_data: BoundedVec<u8, CustomDataLimit>,50}5152#[frame_support::pallet]53pub mod pallet {54	use super::*;55	use frame_support::{56		Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key,57		traits::StorageVersion,58	};59	use frame_system::pallet_prelude::*;60	use up_data_structs::{CollectionId, TokenId};61	use super::weights::WeightInfo;6263	#[pallet::error]64	pub enum Error<T> {65		/// Not Refungible item data used to mint in Refungible collection.66		NotRefungibleDataUsedToMintFungibleCollectionToken,67		/// Maximum refungibility exceeded68		WrongRefungiblePieces,69		/// Refungible token can't nest other tokens70		RefungibleDisallowsNesting,71		/// Setting item properties is not allowed72		SettingPropertiesNotAllowed,73	}7475	#[pallet::config]76	pub trait Config:77		frame_system::Config + pallet_common::Config + pallet_structure::Config78	{79		type WeightInfo: WeightInfo;80	}8182	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);8384	#[pallet::pallet]85	#[pallet::storage_version(STORAGE_VERSION)]86	#[pallet::generate_store(pub(super) trait Store)]87	pub struct Pallet<T>(_);8889	#[pallet::storage]90	pub type TokensMinted<T: Config> =91		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;92	#[pallet::storage]93	pub type TokensBurnt<T: Config> =94		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;9596	#[pallet::storage]97	pub type TokenData<T: Config> = StorageNMap<98		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),99		Value = ItemData,100		QueryKind = ValueQuery,101	>;102103	#[pallet::storage]104	pub type TotalSupply<T: Config> = StorageNMap<105		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),106		Value = u128,107		QueryKind = ValueQuery,108	>;109110	/// Used to enumerate tokens owned by account111	#[pallet::storage]112	pub type Owned<T: Config> = StorageNMap<113		Key = (114			Key<Twox64Concat, CollectionId>,115			Key<Blake2_128Concat, T::CrossAccountId>,116			Key<Twox64Concat, TokenId>,117		),118		Value = bool,119		QueryKind = ValueQuery,120	>;121122	#[pallet::storage]123	pub type AccountBalance<T: Config> = StorageNMap<124		Key = (125			Key<Twox64Concat, CollectionId>,126			// Owner127			Key<Blake2_128Concat, T::CrossAccountId>,128		),129		Value = u32,130		QueryKind = ValueQuery,131	>;132133	#[pallet::storage]134	pub type Balance<T: Config> = StorageNMap<135		Key = (136			Key<Twox64Concat, CollectionId>,137			Key<Twox64Concat, TokenId>,138			// Owner139			Key<Blake2_128Concat, T::CrossAccountId>,140		),141		Value = u128,142		QueryKind = ValueQuery,143	>;144145	#[pallet::storage]146	pub type Allowance<T: Config> = StorageNMap<147		Key = (148			Key<Twox64Concat, CollectionId>,149			Key<Twox64Concat, TokenId>,150			// Owner151			Key<Blake2_128, T::CrossAccountId>,152			// Spender153			Key<Blake2_128Concat, T::CrossAccountId>,154		),155		Value = u128,156		QueryKind = ValueQuery,157	>;158159	#[pallet::hooks]160	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {161		fn on_runtime_upgrade() -> Weight {162			if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {163				<TokenData<T>>::translate_values::<ItemDataVersion1, _>(|v| {164					Some(<ItemDataVersion2>::from(v))165				})166			}167168			0169		}170	}171}172173pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);174impl<T: Config> RefungibleHandle<T> {175	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {176		Self(inner)177	}178	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {179		self.0180	}181}182impl<T: Config> Deref for RefungibleHandle<T> {183	type Target = pallet_common::CollectionHandle<T>;184185	fn deref(&self) -> &Self::Target {186		&self.0187	}188}189190impl<T: Config> Pallet<T> {191	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {192		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)193	}194	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {195		<TotalSupply<T>>::contains_key((collection.id, token))196	}197}198199// unchecked calls skips any permission checks200impl<T: Config> Pallet<T> {201	pub fn init_collection(202		owner: T::AccountId,203		data: CreateCollectionData<T::AccountId>,204	) -> Result<CollectionId, DispatchError> {205		<PalletCommon<T>>::init_collection(owner, data)206	}207	pub fn destroy_collection(208		collection: RefungibleHandle<T>,209		sender: &T::CrossAccountId,210	) -> DispatchResult {211		let id = collection.id;212213		if Self::collection_has_tokens(id) {214			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());215		}216217		// =========218219		PalletCommon::destroy_collection(collection.0, sender)?;220221		<TokensMinted<T>>::remove(id);222		<TokensBurnt<T>>::remove(id);223		<TokenData<T>>::remove_prefix((id,), None);224		<TotalSupply<T>>::remove_prefix((id,), None);225		<Balance<T>>::remove_prefix((id,), None);226		<Allowance<T>>::remove_prefix((id,), None);227		<Owned<T>>::remove_prefix((id,), None);228		<AccountBalance<T>>::remove_prefix((id,), None);229		Ok(())230	}231232	fn collection_has_tokens(collection_id: CollectionId) -> bool {233		<TokenData<T>>::iter_prefix((collection_id,)).next().is_some()234	}235236	pub fn burn_token(collection: &RefungibleHandle<T>, token_id: TokenId) -> DispatchResult {237		let burnt = <TokensBurnt<T>>::get(collection.id)238			.checked_add(1)239			.ok_or(ArithmeticError::Overflow)?;240241		<TokensBurnt<T>>::insert(collection.id, burnt);242		<TokenData<T>>::remove((collection.id, token_id));243		<TotalSupply<T>>::remove((collection.id, token_id));244		<Balance<T>>::remove_prefix((collection.id, token_id), None);245		<Allowance<T>>::remove_prefix((collection.id, token_id), None);246		// TODO: ERC721 transfer event247		Ok(())248	}249250	pub fn burn(251		collection: &RefungibleHandle<T>,252		owner: &T::CrossAccountId,253		token: TokenId,254		amount: u128,255	) -> DispatchResult {256		let total_supply = <TotalSupply<T>>::get((collection.id, token))257			.checked_sub(amount)258			.ok_or(<CommonError<T>>::TokenValueTooLow)?;259260		// This was probally last owner of this token?261		if total_supply == 0 {262			// Ensure user actually owns this amount263			ensure!(264				<Balance<T>>::get((collection.id, token, owner)) == amount,265				<CommonError<T>>::TokenValueTooLow266			);267			let account_balance = <AccountBalance<T>>::get((collection.id, owner))268				.checked_sub(1)269				// Should not occur270				.ok_or(ArithmeticError::Underflow)?;271272			// =========273274			<Owned<T>>::remove((collection.id, owner, token));275			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);276			<AccountBalance<T>>::insert((collection.id, owner), account_balance);277			Self::burn_token(collection, token)?;278			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(279				collection.id,280				token,281				owner.clone(),282				amount,283			));284			return Ok(());285		}286287		let balance = <Balance<T>>::get((collection.id, token, owner))288			.checked_sub(amount)289			.ok_or(<CommonError<T>>::TokenValueTooLow)?;290		let account_balance = if balance == 0 {291			<AccountBalance<T>>::get((collection.id, owner))292				.checked_sub(1)293				// Should not occur294				.ok_or(ArithmeticError::Underflow)?295		} else {296			0297		};298299		// =========300301		if balance == 0 {302			<Owned<T>>::remove((collection.id, owner, token));303			<PalletStructure<T>>::unnest_if_nested(owner, collection.id, token);304			<Balance<T>>::remove((collection.id, token, owner));305			<AccountBalance<T>>::insert((collection.id, owner), account_balance);306		} else {307			<Balance<T>>::insert((collection.id, token, owner), balance);308		}309		<TotalSupply<T>>::insert((collection.id, token), total_supply);310		// TODO: ERC20 transfer event311		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(312			collection.id,313			token,314			owner.clone(),315			amount,316		));317		Ok(())318	}319320	pub fn transfer(321		collection: &RefungibleHandle<T>,322		from: &T::CrossAccountId,323		to: &T::CrossAccountId,324		token: TokenId,325		amount: u128,326		nesting_budget: &dyn Budget,327	) -> DispatchResult {328		ensure!(329			collection.limits.transfers_enabled(),330			<CommonError<T>>::TransferNotAllowed331		);332333		if collection.permissions.access() == AccessMode::AllowList {334			collection.check_allowlist(from)?;335			collection.check_allowlist(to)?;336		}337		<PalletCommon<T>>::ensure_correct_receiver(to)?;338339		let balance_from = <Balance<T>>::get((collection.id, token, from))340			.checked_sub(amount)341			.ok_or(<CommonError<T>>::TokenValueTooLow)?;342		let mut create_target = false;343		let from_to_differ = from != to;344		let balance_to = if from != to {345			let old_balance = <Balance<T>>::get((collection.id, token, to));346			if old_balance == 0 {347				create_target = true;348			}349			Some(350				old_balance351					.checked_add(amount)352					.ok_or(ArithmeticError::Overflow)?,353			)354		} else {355			None356		};357358		let account_balance_from = if balance_from == 0 {359			Some(360				<AccountBalance<T>>::get((collection.id, from))361					.checked_sub(1)362					// Should not occur363					.ok_or(ArithmeticError::Underflow)?,364			)365		} else {366			None367		};368		// Account data is created in token, AccountBalance should be increased369		// But only if from != to as we shouldn't check overflow in this case370		let account_balance_to = if create_target && from_to_differ {371			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))372				.checked_add(1)373				.ok_or(ArithmeticError::Overflow)?;374			ensure!(375				account_balance_to < collection.limits.account_token_ownership_limit(),376				<CommonError<T>>::AccountTokenLimitExceeded,377			);378379			Some(account_balance_to)380		} else {381			None382		};383384		// =========385386		<PalletStructure<T>>::nest_if_sent_to_token(387			from.clone(),388			to,389			collection.id,390			token,391			nesting_budget392		)?;393394		if let Some(balance_to) = balance_to {395			// from != to396			if balance_from == 0 {397				<Balance<T>>::remove((collection.id, token, from));398			} else {399				<Balance<T>>::insert((collection.id, token, from), balance_from);400			}401			<Balance<T>>::insert((collection.id, token, to), balance_to);402			if let Some(account_balance_from) = account_balance_from {403				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);404				<Owned<T>>::remove((collection.id, from, token));405			}406			if let Some(account_balance_to) = account_balance_to {407				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);408				<Owned<T>>::insert((collection.id, to, token), true);409			}410		}411412		// TODO: ERC20 transfer event413		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(414			collection.id,415			token,416			from.clone(),417			to.clone(),418			amount,419		));420		Ok(())421	}422423	pub fn create_multiple_items(424		collection: &RefungibleHandle<T>,425		sender: &T::CrossAccountId,426		data: Vec<CreateRefungibleExData<T::CrossAccountId>>,427		nesting_budget: &dyn Budget,428	) -> DispatchResult {429		if !collection.is_owner_or_admin(sender) {430			ensure!(431				collection.permissions.mint_mode(),432				<CommonError<T>>::PublicMintingNotAllowed433			);434			collection.check_allowlist(sender)?;435436			for item in data.iter() {437				for user in item.users.keys() {438					collection.check_allowlist(user)?;439				}440			}441		}442443		for item in data.iter() {444			for (owner, _) in item.users.iter() {445				<PalletCommon<T>>::ensure_correct_receiver(owner)?;446			}447		}448449		// Total pieces per tokens450		let totals = data451			.iter()452			.map(|data| {453				Ok(data454					.users455					.iter()456					.map(|u| u.1)457					.try_fold(0u128, |acc, v| acc.checked_add(*v))458					.ok_or(ArithmeticError::Overflow)?)459			})460			.collect::<Result<Vec<_>, DispatchError>>()?;461		for total in &totals {462			ensure!(463				*total <= MAX_REFUNGIBLE_PIECES,464				<Error<T>>::WrongRefungiblePieces465			);466		}467468		let first_token_id = <TokensMinted<T>>::get(collection.id);469		let tokens_minted = first_token_id470			.checked_add(data.len() as u32)471			.ok_or(ArithmeticError::Overflow)?;472		ensure!(473			tokens_minted < collection.limits.token_limit(),474			<CommonError<T>>::CollectionTokenLimitExceeded475		);476477		let mut balances = BTreeMap::new();478		for data in &data {479			for owner in data.users.keys() {480				let balance = balances481					.entry(owner)482					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));483				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;484485				ensure!(486					*balance <= collection.limits.account_token_ownership_limit(),487					<CommonError<T>>::AccountTokenLimitExceeded,488				);489			}490		}491492		for (i, token) in data.iter().enumerate() {493			let token_id = TokenId(first_token_id + i as u32 + 1);494			for (to, _) in token.users.iter() {495496				<PalletStructure<T>>::check_nesting(497					sender.clone(),498					to,499					collection.id,500					token_id,501					nesting_budget,502				)?;503			}504		}505506		// =========507508		<TokensMinted<T>>::insert(collection.id, tokens_minted);509		for (account, balance) in balances {510			<AccountBalance<T>>::insert((collection.id, account), balance);511		}512		for (i, token) in data.into_iter().enumerate() {513			let token_id = first_token_id + i as u32 + 1;514			<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);515516			<TokenData<T>>::insert(517				(collection.id, token_id),518				ItemData {519					const_data: token.const_data,520				},521			);522523			for (user, amount) in token.users.into_iter() {524				if amount == 0 {525					continue;526				}527				<Balance<T>>::insert((collection.id, token_id, &user), amount);528				<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);529				<PalletStructure<T>>::nest_if_sent_to_token_unchecked(&user, collection.id, TokenId(token_id));530531				// TODO: ERC20 transfer event532				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(533					collection.id,534					TokenId(token_id),535					user,536					amount,537				));538			}539		}540		Ok(())541	}542543	pub fn set_allowance_unchecked(544		collection: &RefungibleHandle<T>,545		sender: &T::CrossAccountId,546		spender: &T::CrossAccountId,547		token: TokenId,548		amount: u128,549	) {550		if amount == 0 {551			<Allowance<T>>::remove((collection.id, token, sender, spender));552		} else {553			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);554		}555		// TODO: ERC20 approval event556		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(557			collection.id,558			token,559			sender.clone(),560			spender.clone(),561			amount,562		))563	}564565	pub fn set_allowance(566		collection: &RefungibleHandle<T>,567		sender: &T::CrossAccountId,568		spender: &T::CrossAccountId,569		token: TokenId,570		amount: u128,571	) -> DispatchResult {572		if collection.permissions.access() == AccessMode::AllowList {573			collection.check_allowlist(sender)?;574			collection.check_allowlist(spender)?;575		}576577		<PalletCommon<T>>::ensure_correct_receiver(spender)?;578579		if <Balance<T>>::get((collection.id, token, sender)) < amount {580			ensure!(581				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),582				<CommonError<T>>::CantApproveMoreThanOwned583			);584		}585586		// =========587588		Self::set_allowance_unchecked(collection, sender, spender, token, amount);589		Ok(())590	}591592	/// Returns allowance, which should be set after transaction593	fn check_allowed(594		collection: &RefungibleHandle<T>,595		spender: &T::CrossAccountId,596		from: &T::CrossAccountId,597		token: TokenId,598		amount: u128,599		nesting_budget: &dyn Budget,600	) -> Result<Option<u128>, DispatchError> {601		if spender.conv_eq(from) {602			return Ok(None);603		}604		if collection.permissions.access() == AccessMode::AllowList {605			// `from`, `to` checked in [`transfer`]606			collection.check_allowlist(spender)?;607		}608		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {609			// TODO: should collection owner be allowed to perform this transfer?610			ensure!(611				<PalletStructure<T>>::check_indirectly_owned(612					spender.clone(),613					source.0,614					source.1,615					None,616					nesting_budget617				)?,618				<CommonError<T>>::ApprovedValueTooLow,619			);620			return Ok(None);621		}622		let allowance =623			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);624		if allowance.is_none() {625			ensure!(626				collection.ignores_allowance(spender),627				<CommonError<T>>::ApprovedValueTooLow628			);629		}630		Ok(allowance)631	}632633	pub fn transfer_from(634		collection: &RefungibleHandle<T>,635		spender: &T::CrossAccountId,636		from: &T::CrossAccountId,637		to: &T::CrossAccountId,638		token: TokenId,639		amount: u128,640		nesting_budget: &dyn Budget,641	) -> DispatchResult {642		let allowance =643			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;644645		// =========646647		Self::transfer(collection, from, to, token, amount, nesting_budget)?;648		if let Some(allowance) = allowance {649			Self::set_allowance_unchecked(collection, from, spender, token, allowance);650		}651		Ok(())652	}653654	pub fn burn_from(655		collection: &RefungibleHandle<T>,656		spender: &T::CrossAccountId,657		from: &T::CrossAccountId,658		token: TokenId,659		amount: u128,660		nesting_budget: &dyn Budget,661	) -> DispatchResult {662		let allowance =663			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;664665		// =========666667		Self::burn(collection, from, token, amount)?;668		if let Some(allowance) = allowance {669			Self::set_allowance_unchecked(collection, from, spender, token, allowance);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}