git.delta.rocks / unique-network / refs/commits / 23942aa9dbcc

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,23};24use pallet_evm::account::CrossAccountId;25use pallet_common::{26	Error as CommonError, Event as CommonEvent, Pallet as PalletCommon,27	CollectionHandle, 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	}6667	#[pallet::config]68	pub trait Config:69		frame_system::Config + pallet_common::Config + pallet_structure::Config70	{71		type WeightInfo: WeightInfo;72	}7374	#[pallet::pallet]75	#[pallet::generate_store(pub(super) trait Store)]76	pub struct Pallet<T>(_);7778	#[pallet::storage]79	pub type TokensMinted<T: Config> =80		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;81	#[pallet::storage]82	pub type TokensBurnt<T: Config> =83		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;8485	#[pallet::storage]86	pub type TokenData<T: Config> = StorageNMap<87		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),88		Value = ItemData,89		QueryKind = ValueQuery,90	>;9192	#[pallet::storage]93	pub type TotalSupply<T: Config> = StorageNMap<94		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),95		Value = u128,96		QueryKind = ValueQuery,97	>;9899	/// Used to enumerate tokens owned by account100	#[pallet::storage]101	pub type Owned<T: Config> = StorageNMap<102		Key = (103			Key<Twox64Concat, CollectionId>,104			Key<Blake2_128Concat, T::CrossAccountId>,105			Key<Twox64Concat, TokenId>,106		),107		Value = bool,108		QueryKind = ValueQuery,109	>;110111	#[pallet::storage]112	pub type AccountBalance<T: Config> = StorageNMap<113		Key = (114			Key<Twox64Concat, CollectionId>,115			// Owner116			Key<Blake2_128Concat, T::CrossAccountId>,117		),118		Value = u32,119		QueryKind = ValueQuery,120	>;121122	#[pallet::storage]123	pub type Balance<T: Config> = StorageNMap<124		Key = (125			Key<Twox64Concat, CollectionId>,126			Key<Twox64Concat, TokenId>,127			// Owner128			Key<Blake2_128Concat, T::CrossAccountId>,129		),130		Value = u128,131		QueryKind = ValueQuery,132	>;133134	#[pallet::storage]135	pub type Allowance<T: Config> = StorageNMap<136		Key = (137			Key<Twox64Concat, CollectionId>,138			Key<Twox64Concat, TokenId>,139			// Owner140			Key<Blake2_128, T::CrossAccountId>,141			// Spender142			Key<Blake2_128Concat, T::CrossAccountId>,143		),144		Value = u128,145		QueryKind = ValueQuery,146	>;147}148149pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);150impl<T: Config> RefungibleHandle<T> {151	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {152		Self(inner)153	}154	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {155		self.0156	}157}158impl<T: Config> Deref for RefungibleHandle<T> {159	type Target = pallet_common::CollectionHandle<T>;160161	fn deref(&self) -> &Self::Target {162		&self.0163	}164}165166impl<T: Config> Pallet<T> {167	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {168		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)169	}170	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {171		<TotalSupply<T>>::contains_key((collection.id, token))172	}173}174175// unchecked calls skips any permission checks176impl<T: Config> Pallet<T> {177	pub fn init_collection(178		owner: T::AccountId,179		data: CreateCollectionData<T::AccountId>,180	) -> Result<CollectionId, DispatchError> {181		<PalletCommon<T>>::init_collection(owner, data)182	}183	pub fn destroy_collection(184		collection: RefungibleHandle<T>,185		sender: &T::CrossAccountId,186	) -> DispatchResult {187		let id = collection.id;188189		// =========190191		PalletCommon::destroy_collection(collection.0, sender)?;192193		<TokensMinted<T>>::remove(id);194		<TokensBurnt<T>>::remove(id);195		<TokenData<T>>::remove_prefix((id,), None);196		<TotalSupply<T>>::remove_prefix((id,), None);197		<Balance<T>>::remove_prefix((id,), None);198		<Allowance<T>>::remove_prefix((id,), None);199		<Owned<T>>::remove_prefix((id,), None);200		<AccountBalance<T>>::remove_prefix((id,), None);201		Ok(())202	}203204	pub fn burn_token(collection: &RefungibleHandle<T>, token_id: TokenId) -> DispatchResult {205		let burnt = <TokensBurnt<T>>::get(collection.id)206			.checked_add(1)207			.ok_or(ArithmeticError::Overflow)?;208209		<TokensBurnt<T>>::insert(collection.id, burnt);210		<TokenData<T>>::remove((collection.id, token_id));211		<TotalSupply<T>>::remove((collection.id, token_id));212		<Balance<T>>::remove_prefix((collection.id, token_id), None);213		<Allowance<T>>::remove_prefix((collection.id, token_id), None);214		// TODO: ERC721 transfer event215		Ok(())216	}217218	pub fn burn(219		collection: &RefungibleHandle<T>,220		owner: &T::CrossAccountId,221		token: TokenId,222		amount: u128,223	) -> DispatchResult {224		let total_supply = <TotalSupply<T>>::get((collection.id, token))225			.checked_sub(amount)226			.ok_or(<CommonError<T>>::TokenValueTooLow)?;227228		// This was probally last owner of this token?229		if total_supply == 0 {230			// Ensure user actually owns this amount231			ensure!(232				<Balance<T>>::get((collection.id, token, owner)) == amount,233				<CommonError<T>>::TokenValueTooLow234			);235			let account_balance = <AccountBalance<T>>::get((collection.id, owner))236				.checked_sub(1)237				// Should not occur238				.ok_or(ArithmeticError::Underflow)?;239240			// =========241242			<Owned<T>>::remove((collection.id, owner, token));243			<AccountBalance<T>>::insert((collection.id, owner), account_balance);244			Self::burn_token(collection, token)?;245			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(246				collection.id,247				token,248				owner.clone(),249				amount,250			));251			return Ok(());252		}253254		let balance = <Balance<T>>::get((collection.id, token, owner))255			.checked_sub(amount)256			.ok_or(<CommonError<T>>::TokenValueTooLow)?;257		let account_balance = if balance == 0 {258			<AccountBalance<T>>::get((collection.id, owner))259				.checked_sub(1)260				// Should not occur261				.ok_or(ArithmeticError::Underflow)?262		} else {263			0264		};265266		// =========267268		if balance == 0 {269			<Owned<T>>::remove((collection.id, owner, token));270			<Balance<T>>::remove((collection.id, token, owner));271			<AccountBalance<T>>::insert((collection.id, owner), account_balance);272		} else {273			<Balance<T>>::insert((collection.id, token, owner), balance);274		}275		<TotalSupply<T>>::insert((collection.id, token), total_supply);276		// TODO: ERC20 transfer event277		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(278			collection.id,279			token,280			owner.clone(),281			amount,282		));283		Ok(())284	}285286	pub fn transfer(287		collection: &RefungibleHandle<T>,288		from: &T::CrossAccountId,289		to: &T::CrossAccountId,290		token: TokenId,291		amount: u128,292	) -> DispatchResult {293		ensure!(294			collection.limits.transfers_enabled(),295			<CommonError<T>>::TransferNotAllowed296		);297298		if collection.access == AccessMode::AllowList {299			collection.check_allowlist(from)?;300			collection.check_allowlist(to)?;301		}302		<PalletCommon<T>>::ensure_correct_receiver(to)?;303304		let balance_from = <Balance<T>>::get((collection.id, token, from))305			.checked_sub(amount)306			.ok_or(<CommonError<T>>::TokenValueTooLow)?;307		let mut create_target = false;308		let from_to_differ = from != to;309		let balance_to = if from != to {310			let old_balance = <Balance<T>>::get((collection.id, token, to));311			if old_balance == 0 {312				create_target = true;313			}314			Some(315				old_balance316					.checked_add(amount)317					.ok_or(ArithmeticError::Overflow)?,318			)319		} else {320			None321		};322323		let account_balance_from = if balance_from == 0 {324			Some(325				<AccountBalance<T>>::get((collection.id, from))326					.checked_sub(1)327					// Should not occur328					.ok_or(ArithmeticError::Underflow)?,329			)330		} else {331			None332		};333		// Account data is created in token, AccountBalance should be increased334		// But only if from != to as we shouldn't check overflow in this case335		let account_balance_to = if create_target && from_to_differ {336			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))337				.checked_add(1)338				.ok_or(ArithmeticError::Overflow)?;339			ensure!(340				account_balance_to < collection.limits.account_token_ownership_limit(),341				<CommonError<T>>::AccountTokenLimitExceeded,342			);343344			Some(account_balance_to)345		} else {346			None347		};348349		if let Some(target) = T::CrossTokenAddressMapping::address_to_token(to) {350			let handle = <CollectionHandle<T>>::try_get(target.0)?;351			let dispatch = T::CollectionDispatch::dispatch(handle);352			let dispatch = dispatch.as_dyn();353354			// =========355356			dispatch.nest_token(from.clone(), (collection.id, token), target.1)?;357		}358359		if let Some(balance_to) = balance_to {360			// from != to361			if balance_from == 0 {362				<Balance<T>>::remove((collection.id, token, from));363			} else {364				<Balance<T>>::insert((collection.id, token, from), balance_from);365			}366			<Balance<T>>::insert((collection.id, token, to), balance_to);367			if let Some(account_balance_from) = account_balance_from {368				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);369				<Owned<T>>::remove((collection.id, from, token));370			}371			if let Some(account_balance_to) = account_balance_to {372				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);373				<Owned<T>>::insert((collection.id, to, token), true);374			}375		}376377		// TODO: ERC20 transfer event378		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(379			collection.id,380			token,381			from.clone(),382			to.clone(),383			amount,384		));385		Ok(())386	}387388	pub fn create_multiple_items(389		collection: &RefungibleHandle<T>,390		sender: &T::CrossAccountId,391		data: Vec<CreateRefungibleExData<T::CrossAccountId>>,392	) -> DispatchResult {393		if !collection.is_owner_or_admin(sender) {394			ensure!(395				collection.mint_mode,396				<CommonError<T>>::PublicMintingNotAllowed397			);398			collection.check_allowlist(sender)?;399400			for item in data.iter() {401				for user in item.users.keys() {402					collection.check_allowlist(user)?;403				}404			}405		}406407		for item in data.iter() {408			for (owner, _) in item.users.iter() {409				<PalletCommon<T>>::ensure_correct_receiver(owner)?;410			}411		}412413		// Total pieces per tokens414		let totals = data415			.iter()416			.map(|data| {417				Ok(data418					.users419					.iter()420					.map(|u| u.1)421					.try_fold(0u128, |acc, v| acc.checked_add(*v))422					.ok_or(ArithmeticError::Overflow)?)423			})424			.collect::<Result<Vec<_>, DispatchError>>()?;425		for total in &totals {426			ensure!(427				*total <= MAX_REFUNGIBLE_PIECES,428				<Error<T>>::WrongRefungiblePieces429			);430		}431432		let first_token_id = <TokensMinted<T>>::get(collection.id);433		let tokens_minted = first_token_id434			.checked_add(data.len() as u32)435			.ok_or(ArithmeticError::Overflow)?;436		ensure!(437			tokens_minted < collection.limits.token_limit(),438			<CommonError<T>>::CollectionTokenLimitExceeded439		);440441		let mut balances = BTreeMap::new();442		for data in &data {443			for owner in data.users.keys() {444				let balance = balances445					.entry(owner)446					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));447				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;448449				ensure!(450					*balance <= collection.limits.account_token_ownership_limit(),451					<CommonError<T>>::AccountTokenLimitExceeded,452				);453			}454		}455456		// =========457458		<TokensMinted<T>>::insert(collection.id, tokens_minted);459		for (account, balance) in balances {460			<AccountBalance<T>>::insert((collection.id, account), balance);461		}462		for (i, token) in data.into_iter().enumerate() {463			let token_id = first_token_id + i as u32 + 1;464			<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);465466			<TokenData<T>>::insert(467				(collection.id, token_id),468				ItemData {469					const_data: token.const_data,470					variable_data: token.variable_data,471				},472			);473			for (user, amount) in token.users.into_iter() {474				if amount == 0 {475					continue;476				}477				<Balance<T>>::insert((collection.id, token_id, &user), amount);478				<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);479				// TODO: ERC20 transfer event480				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(481					collection.id,482					TokenId(token_id),483					user,484					amount,485				));486			}487		}488		Ok(())489	}490491	pub fn set_allowance_unchecked(492		collection: &RefungibleHandle<T>,493		sender: &T::CrossAccountId,494		spender: &T::CrossAccountId,495		token: TokenId,496		amount: u128,497	) {498		if amount == 0 {499			<Allowance<T>>::remove((collection.id, token, sender, spender));500		} else {501			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);502		}503		// TODO: ERC20 approval event504		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(505			collection.id,506			token,507			sender.clone(),508			spender.clone(),509			amount,510		))511	}512513	pub fn set_allowance(514		collection: &RefungibleHandle<T>,515		sender: &T::CrossAccountId,516		spender: &T::CrossAccountId,517		token: TokenId,518		amount: u128,519	) -> DispatchResult {520		if collection.access == AccessMode::AllowList {521			collection.check_allowlist(sender)?;522			collection.check_allowlist(spender)?;523		}524525		<PalletCommon<T>>::ensure_correct_receiver(spender)?;526527		if <Balance<T>>::get((collection.id, token, sender)) < amount {528			ensure!(529				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),530				<CommonError<T>>::CantApproveMoreThanOwned531			);532		}533534		// =========535536		Self::set_allowance_unchecked(collection, sender, spender, token, amount);537		Ok(())538	}539540	/// Returns allowance, which should be set after transaction541	fn check_allowed(542		collection: &RefungibleHandle<T>,543		spender: &T::CrossAccountId,544		from: &T::CrossAccountId,545		token: TokenId,546		amount: u128,547	) -> Result<Option<u128>, DispatchError> {548		if spender.conv_eq(from) {549			return Ok(None);550		}551		if collection.access == AccessMode::AllowList {552			// `from`, `to` checked in [`transfer`]553			collection.check_allowlist(spender)?;554		}555		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {556			// TODO: should collection owner be allowed to perform this transfer?557			ensure!(558				<PalletStructure<T>>::indirectly_owned(spender.clone(), source.0, source.1, 1)?,559				<CommonError<T>>::ApprovedValueTooLow,560			);561			return Ok(None);562		}563		let allowance =564			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);565		if allowance.is_none() {566			ensure!(567				collection.ignores_allowance(spender),568				<CommonError<T>>::ApprovedValueTooLow569			);570		}571		Ok(allowance)572	}573574	pub fn transfer_from(575		collection: &RefungibleHandle<T>,576		spender: &T::CrossAccountId,577		from: &T::CrossAccountId,578		to: &T::CrossAccountId,579		token: TokenId,580		amount: u128,581	) -> DispatchResult {582		let allowance = Self::check_allowed(collection, spender, from, token, amount)?;583584		// =========585586		Self::transfer(collection, from, to, token, amount)?;587		if let Some(allowance) = allowance {588			Self::set_allowance_unchecked(collection, from, spender, token, allowance);589		}590		Ok(())591	}592593	pub fn burn_from(594		collection: &RefungibleHandle<T>,595		spender: &T::CrossAccountId,596		from: &T::CrossAccountId,597		token: TokenId,598		amount: u128,599	) -> DispatchResult {600		let allowance = Self::check_allowed(collection, spender, from, token, amount)?;601602		// =========603604		Self::burn(collection, from, token, amount)?;605		if let Some(allowance) = allowance {606			Self::set_allowance_unchecked(collection, from, spender, token, allowance);607		}608		Ok(())609	}610611	pub fn set_variable_metadata(612		collection: &RefungibleHandle<T>,613		sender: &T::CrossAccountId,614		token: TokenId,615		data: BoundedVec<u8, CustomDataLimit>,616	) -> DispatchResult {617		collection.check_can_update_meta(618			sender,619			&T::CrossAccountId::from_sub(collection.owner.clone()),620		)?;621622		let token_data = <TokenData<T>>::get((collection.id, token));623624		// =========625626		<TokenData<T>>::insert(627			(collection.id, token),628			ItemData {629				variable_data: data,630				..token_data631			},632		);633		Ok(())634	}635636	/// Delegated to `create_multiple_items`637	pub fn create_item(638		collection: &RefungibleHandle<T>,639		sender: &T::CrossAccountId,640		data: CreateRefungibleExData<T::CrossAccountId>,641	) -> DispatchResult {642		Self::create_multiple_items(collection, sender, vec![data])643	}644}