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

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::{Error as CommonError, Event as CommonEvent, Pallet as PalletCommon};26use pallet_structure::Pallet as PalletStructure;27use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};28use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};29use core::ops::Deref;30use codec::{Encode, Decode, MaxEncodedLen};31use scale_info::TypeInfo;3233pub use pallet::*;34#[cfg(feature = "runtime-benchmarks")]35pub mod benchmarking;36pub mod common;37pub mod erc;38pub mod weights;39pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4041#[struct_versioning::versioned(version = 2, upper)]42#[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]43pub struct ItemData {44	pub const_data: BoundedVec<u8, CustomDataLimit>,4546	#[version(..2)]47	pub variable_data: BoundedVec<u8, CustomDataLimit>,48}4950#[frame_support::pallet]51pub mod pallet {52	use super::*;53	use frame_support::{54		Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key,55		traits::StorageVersion,56	};57	use frame_system::pallet_prelude::*;58	use up_data_structs::{CollectionId, TokenId};59	use super::weights::WeightInfo;6061	#[pallet::error]62	pub enum Error<T> {63		/// Not Refungible item data used to mint in Refungible collection.64		NotRefungibleDataUsedToMintFungibleCollectionToken,65		/// Maximum refungibility exceeded66		WrongRefungiblePieces,67		/// Refungible token can't nest other tokens68		RefungibleDisallowsNesting,69		/// Setting item properties is not allowed70		SettingPropertiesNotAllowed,71	}7273	#[pallet::config]74	pub trait Config:75		frame_system::Config + pallet_common::Config + pallet_structure::Config76	{77		type WeightInfo: WeightInfo;78	}7980	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);8182	#[pallet::pallet]83	#[pallet::storage_version(STORAGE_VERSION)]84	#[pallet::generate_store(pub(super) trait Store)]85	pub struct Pallet<T>(_);8687	#[pallet::storage]88	pub type TokensMinted<T: Config> =89		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;90	#[pallet::storage]91	pub type TokensBurnt<T: Config> =92		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;9394	#[pallet::storage]95	pub type TokenData<T: Config> = StorageNMap<96		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),97		Value = ItemData,98		QueryKind = ValueQuery,99	>;100101	#[pallet::storage]102	pub type TotalSupply<T: Config> = StorageNMap<103		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),104		Value = u128,105		QueryKind = ValueQuery,106	>;107108	/// Used to enumerate tokens owned by account109	#[pallet::storage]110	pub type Owned<T: Config> = StorageNMap<111		Key = (112			Key<Twox64Concat, CollectionId>,113			Key<Blake2_128Concat, T::CrossAccountId>,114			Key<Twox64Concat, TokenId>,115		),116		Value = bool,117		QueryKind = ValueQuery,118	>;119120	#[pallet::storage]121	pub type AccountBalance<T: Config> = StorageNMap<122		Key = (123			Key<Twox64Concat, CollectionId>,124			// Owner125			Key<Blake2_128Concat, T::CrossAccountId>,126		),127		Value = u32,128		QueryKind = ValueQuery,129	>;130131	#[pallet::storage]132	pub type Balance<T: Config> = StorageNMap<133		Key = (134			Key<Twox64Concat, CollectionId>,135			Key<Twox64Concat, TokenId>,136			// Owner137			Key<Blake2_128Concat, T::CrossAccountId>,138		),139		Value = u128,140		QueryKind = ValueQuery,141	>;142143	#[pallet::storage]144	pub type Allowance<T: Config> = StorageNMap<145		Key = (146			Key<Twox64Concat, CollectionId>,147			Key<Twox64Concat, TokenId>,148			// Owner149			Key<Blake2_128, T::CrossAccountId>,150			// Spender151			Key<Blake2_128Concat, T::CrossAccountId>,152		),153		Value = u128,154		QueryKind = ValueQuery,155	>;156157	#[pallet::hooks]158	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {159		fn on_runtime_upgrade() -> Weight {160			if StorageVersion::get::<Pallet<T>>() < StorageVersion::new(1) {161				<TokenData<T>>::translate_values::<ItemDataVersion1, _>(|v| {162					Some(<ItemDataVersion2>::from(v))163				})164			}165166			0167		}168	}169}170171pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);172impl<T: Config> RefungibleHandle<T> {173	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {174		Self(inner)175	}176	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {177		self.0178	}179}180impl<T: Config> Deref for RefungibleHandle<T> {181	type Target = pallet_common::CollectionHandle<T>;182183	fn deref(&self) -> &Self::Target {184		&self.0185	}186}187188impl<T: Config> Pallet<T> {189	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {190		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)191	}192	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {193		<TotalSupply<T>>::contains_key((collection.id, token))194	}195}196197// unchecked calls skips any permission checks198impl<T: Config> Pallet<T> {199	pub fn init_collection(200		owner: T::CrossAccountId,201		data: CreateCollectionData<T::AccountId>,202	) -> Result<CollectionId, DispatchError> {203		<PalletCommon<T>>::init_collection(owner, data)204	}205	pub fn destroy_collection(206		collection: RefungibleHandle<T>,207		sender: &T::CrossAccountId,208	) -> DispatchResult {209		let id = collection.id;210211		if Self::collection_has_tokens(id) {212			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());213		}214215		// =========216217		PalletCommon::destroy_collection(collection.0, sender)?;218219		<TokensMinted<T>>::remove(id);220		<TokensBurnt<T>>::remove(id);221		<TokenData<T>>::remove_prefix((id,), None);222		<TotalSupply<T>>::remove_prefix((id,), None);223		<Balance<T>>::remove_prefix((id,), None);224		<Allowance<T>>::remove_prefix((id,), None);225		<Owned<T>>::remove_prefix((id,), None);226		<AccountBalance<T>>::remove_prefix((id,), None);227		Ok(())228	}229230	fn collection_has_tokens(collection_id: CollectionId) -> bool {231		<TokenData<T>>::iter_prefix((collection_id,))232			.next()233			.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_budget,392		)?;393394		if let Some(balance_to) = balance_to {395			// from != to396			if balance_from == 0 {397				<Balance<T>>::remove((collection.id, token, from));398				<PalletStructure<T>>::unnest_if_nested(from, collection.id, token);399			} else {400				<Balance<T>>::insert((collection.id, token, from), balance_from);401			}402			<Balance<T>>::insert((collection.id, token, to), balance_to);403			if let Some(account_balance_from) = account_balance_from {404				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);405				<Owned<T>>::remove((collection.id, from, token));406			}407			if let Some(account_balance_to) = account_balance_to {408				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);409				<Owned<T>>::insert((collection.id, to, token), true);410			}411		}412413		// TODO: ERC20 transfer event414		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(415			collection.id,416			token,417			from.clone(),418			to.clone(),419			amount,420		));421		Ok(())422	}423424	pub fn create_multiple_items(425		collection: &RefungibleHandle<T>,426		sender: &T::CrossAccountId,427		data: Vec<CreateRefungibleExData<T::CrossAccountId>>,428		nesting_budget: &dyn Budget,429	) -> DispatchResult {430		if !collection.is_owner_or_admin(sender) {431			ensure!(432				collection.permissions.mint_mode(),433				<CommonError<T>>::PublicMintingNotAllowed434			);435			collection.check_allowlist(sender)?;436437			for item in data.iter() {438				for user in item.users.keys() {439					collection.check_allowlist(user)?;440				}441			}442		}443444		for item in data.iter() {445			for (owner, _) in item.users.iter() {446				<PalletCommon<T>>::ensure_correct_receiver(owner)?;447			}448		}449450		// Total pieces per tokens451		let totals = data452			.iter()453			.map(|data| {454				Ok(data455					.users456					.iter()457					.map(|u| u.1)458					.try_fold(0u128, |acc, v| acc.checked_add(*v))459					.ok_or(ArithmeticError::Overflow)?)460			})461			.collect::<Result<Vec<_>, DispatchError>>()?;462		for total in &totals {463			ensure!(464				*total <= MAX_REFUNGIBLE_PIECES,465				<Error<T>>::WrongRefungiblePieces466			);467		}468469		let first_token_id = <TokensMinted<T>>::get(collection.id);470		let tokens_minted = first_token_id471			.checked_add(data.len() as u32)472			.ok_or(ArithmeticError::Overflow)?;473		ensure!(474			tokens_minted < collection.limits.token_limit(),475			<CommonError<T>>::CollectionTokenLimitExceeded476		);477478		let mut balances = BTreeMap::new();479		for data in &data {480			for owner in data.users.keys() {481				let balance = balances482					.entry(owner)483					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));484				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;485486				ensure!(487					*balance <= collection.limits.account_token_ownership_limit(),488					<CommonError<T>>::AccountTokenLimitExceeded,489				);490			}491		}492493		for (i, token) in data.iter().enumerate() {494			let token_id = TokenId(first_token_id + i as u32 + 1);495			for (to, _) in token.users.iter() {496				<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(530					&user,531					collection.id,532					TokenId(token_id),533				);534535				// TODO: ERC20 transfer event536				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(537					collection.id,538					TokenId(token_id),539					user,540					amount,541				));542			}543		}544		Ok(())545	}546547	pub fn set_allowance_unchecked(548		collection: &RefungibleHandle<T>,549		sender: &T::CrossAccountId,550		spender: &T::CrossAccountId,551		token: TokenId,552		amount: u128,553	) {554		if amount == 0 {555			<Allowance<T>>::remove((collection.id, token, sender, spender));556		} else {557			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);558		}559		// TODO: ERC20 approval event560		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(561			collection.id,562			token,563			sender.clone(),564			spender.clone(),565			amount,566		))567	}568569	pub fn set_allowance(570		collection: &RefungibleHandle<T>,571		sender: &T::CrossAccountId,572		spender: &T::CrossAccountId,573		token: TokenId,574		amount: u128,575	) -> DispatchResult {576		if collection.permissions.access() == AccessMode::AllowList {577			collection.check_allowlist(sender)?;578			collection.check_allowlist(spender)?;579		}580581		<PalletCommon<T>>::ensure_correct_receiver(spender)?;582583		if <Balance<T>>::get((collection.id, token, sender)) < amount {584			ensure!(585				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),586				<CommonError<T>>::CantApproveMoreThanOwned587			);588		}589590		// =========591592		Self::set_allowance_unchecked(collection, sender, spender, token, amount);593		Ok(())594	}595596	/// Returns allowance, which should be set after transaction597	fn check_allowed(598		collection: &RefungibleHandle<T>,599		spender: &T::CrossAccountId,600		from: &T::CrossAccountId,601		token: TokenId,602		amount: u128,603		nesting_budget: &dyn Budget,604	) -> Result<Option<u128>, DispatchError> {605		if spender.conv_eq(from) {606			return Ok(None);607		}608		if collection.permissions.access() == AccessMode::AllowList {609			// `from`, `to` checked in [`transfer`]610			collection.check_allowlist(spender)?;611		}612		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {613			// TODO: should collection owner be allowed to perform this transfer?614			ensure!(615				<PalletStructure<T>>::check_indirectly_owned(616					spender.clone(),617					source.0,618					source.1,619					None,620					nesting_budget621				)?,622				<CommonError<T>>::ApprovedValueTooLow,623			);624			return Ok(None);625		}626		let allowance =627			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);628		if allowance.is_none() {629			ensure!(630				collection.ignores_allowance(spender),631				<CommonError<T>>::ApprovedValueTooLow632			);633		}634		Ok(allowance)635	}636637	pub fn transfer_from(638		collection: &RefungibleHandle<T>,639		spender: &T::CrossAccountId,640		from: &T::CrossAccountId,641		to: &T::CrossAccountId,642		token: TokenId,643		amount: u128,644		nesting_budget: &dyn Budget,645	) -> DispatchResult {646		let allowance =647			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;648649		// =========650651		Self::transfer(collection, from, to, token, amount, nesting_budget)?;652		if let Some(allowance) = allowance {653			Self::set_allowance_unchecked(collection, from, spender, token, allowance);654		}655		Ok(())656	}657658	pub fn burn_from(659		collection: &RefungibleHandle<T>,660		spender: &T::CrossAccountId,661		from: &T::CrossAccountId,662		token: TokenId,663		amount: u128,664		nesting_budget: &dyn Budget,665	) -> DispatchResult {666		let allowance =667			Self::check_allowed(collection, spender, from, token, amount, nesting_budget)?;668669		// =========670671		Self::burn(collection, from, token, amount)?;672		if let Some(allowance) = allowance {673			Self::set_allowance_unchecked(collection, from, spender, token, allowance);674		}675		Ok(())676	}677678	/// Delegated to `create_multiple_items`679	pub fn create_item(680		collection: &RefungibleHandle<T>,681		sender: &T::CrossAccountId,682		data: CreateRefungibleExData<T::CrossAccountId>,683		nesting_budget: &dyn Budget,684	) -> DispatchResult {685		Self::create_multiple_items(collection, sender, vec![data], nesting_budget)686	}687}