git.delta.rocks / unique-network / refs/commits / 2f9c8d434e2f

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,23};24use pallet_common::{Error as CommonError, Event as CommonEvent, Pallet as PalletCommon};25use pallet_evm::account::CrossAccountId;26use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};27use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};28use core::ops::Deref;29use codec::{Encode, Decode, MaxEncodedLen};30use scale_info::TypeInfo;3132pub use pallet::*;33#[cfg(feature = "runtime-benchmarks")]34pub mod benchmarking;35pub mod common;36pub mod erc;37pub mod weights;38pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;3940#[derive(Encode, Decode, Default, TypeInfo, MaxEncodedLen)]41pub struct ItemData {42	pub const_data: BoundedVec<u8, CustomDataLimit>,43	pub variable_data: BoundedVec<u8, CustomDataLimit>,44}4546#[frame_support::pallet]47pub mod pallet {48	use super::*;49	use frame_support::{Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key};50	use up_data_structs::{CollectionId, TokenId};51	use super::weights::WeightInfo;5253	#[pallet::error]54	pub enum Error<T> {55		/// Not Refungible item data used to mint in Refungible collection.56		NotRefungibleDataUsedToMintFungibleCollectionToken,57		/// Maximum refungibility exceeded58		WrongRefungiblePieces,59	}6061	#[pallet::config]62	pub trait Config: frame_system::Config + pallet_common::Config {63		type WeightInfo: WeightInfo;64	}6566	#[pallet::pallet]67	#[pallet::generate_store(pub(super) trait Store)]68	pub struct Pallet<T>(_);6970	#[pallet::storage]71	pub type TokensMinted<T: Config> =72		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;73	#[pallet::storage]74	pub type TokensBurnt<T: Config> =75		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u32, QueryKind = ValueQuery>;7677	#[pallet::storage]78	pub type TokenData<T: Config> = StorageNMap<79		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),80		Value = ItemData,81		QueryKind = ValueQuery,82	>;8384	#[pallet::storage]85	pub type TotalSupply<T: Config> = StorageNMap<86		Key = (Key<Twox64Concat, CollectionId>, Key<Twox64Concat, TokenId>),87		Value = u128,88		QueryKind = ValueQuery,89	>;9091	/// Used to enumerate tokens owned by account92	#[pallet::storage]93	pub type Owned<T: Config> = StorageNMap<94		Key = (95			Key<Twox64Concat, CollectionId>,96			Key<Blake2_128Concat, T::CrossAccountId>,97			Key<Twox64Concat, TokenId>,98		),99		Value = bool,100		QueryKind = ValueQuery,101	>;102103	#[pallet::storage]104	pub type AccountBalance<T: Config> = StorageNMap<105		Key = (106			Key<Twox64Concat, CollectionId>,107			// Owner108			Key<Blake2_128Concat, T::CrossAccountId>,109		),110		Value = u32,111		QueryKind = ValueQuery,112	>;113114	#[pallet::storage]115	pub type Balance<T: Config> = StorageNMap<116		Key = (117			Key<Twox64Concat, CollectionId>,118			Key<Twox64Concat, TokenId>,119			// Owner120			Key<Blake2_128Concat, T::CrossAccountId>,121		),122		Value = u128,123		QueryKind = ValueQuery,124	>;125126	#[pallet::storage]127	pub type Allowance<T: Config> = StorageNMap<128		Key = (129			Key<Twox64Concat, CollectionId>,130			Key<Twox64Concat, TokenId>,131			// Owner132			Key<Blake2_128, T::CrossAccountId>,133			// Spender134			Key<Blake2_128Concat, T::CrossAccountId>,135		),136		Value = u128,137		QueryKind = ValueQuery,138	>;139}140141pub struct RefungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);142impl<T: Config> RefungibleHandle<T> {143	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {144		Self(inner)145	}146	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {147		self.0148	}149}150impl<T: Config> Deref for RefungibleHandle<T> {151	type Target = pallet_common::CollectionHandle<T>;152153	fn deref(&self) -> &Self::Target {154		&self.0155	}156}157158impl<T: Config> Pallet<T> {159	pub fn total_supply(collection: &RefungibleHandle<T>) -> u32 {160		<TokensMinted<T>>::get(collection.id) - <TokensBurnt<T>>::get(collection.id)161	}162	pub fn token_exists(collection: &RefungibleHandle<T>, token: TokenId) -> bool {163		<TotalSupply<T>>::contains_key((collection.id, token))164	}165}166167// unchecked calls skips any permission checks168impl<T: Config> Pallet<T> {169	pub fn init_collection(170		owner: T::AccountId,171		data: CreateCollectionData<T::AccountId>,172	) -> Result<CollectionId, DispatchError> {173		<PalletCommon<T>>::init_collection(owner, data)174	}175	pub fn destroy_collection(176		collection: RefungibleHandle<T>,177		sender: &T::CrossAccountId,178	) -> DispatchResult {179		let id = collection.id;180181		// =========182183		PalletCommon::destroy_collection(collection.0, sender)?;184185		<TokensMinted<T>>::remove(id);186		<TokensBurnt<T>>::remove(id);187		<TokenData<T>>::remove_prefix((id,), None);188		<TotalSupply<T>>::remove_prefix((id,), None);189		<Balance<T>>::remove_prefix((id,), None);190		<Allowance<T>>::remove_prefix((id,), None);191		<Owned<T>>::remove_prefix((id,), None);192		<AccountBalance<T>>::remove_prefix((id,), None);193		Ok(())194	}195196	pub fn burn_token(collection: &RefungibleHandle<T>, token_id: TokenId) -> DispatchResult {197		let burnt = <TokensBurnt<T>>::get(collection.id)198			.checked_add(1)199			.ok_or(ArithmeticError::Overflow)?;200201		<TokensBurnt<T>>::insert(collection.id, burnt);202		<TokenData<T>>::remove((collection.id, token_id));203		<TotalSupply<T>>::remove((collection.id, token_id));204		<Balance<T>>::remove_prefix((collection.id, token_id), None);205		<Allowance<T>>::remove_prefix((collection.id, token_id), None);206		// TODO: ERC721 transfer event207		Ok(())208	}209210	pub fn burn(211		collection: &RefungibleHandle<T>,212		owner: &T::CrossAccountId,213		token: TokenId,214		amount: u128,215	) -> DispatchResult {216		let total_supply = <TotalSupply<T>>::get((collection.id, token))217			.checked_sub(amount)218			.ok_or(<CommonError<T>>::TokenValueTooLow)?;219220		// This was probally last owner of this token?221		if total_supply == 0 {222			// Ensure user actually owns this amount223			ensure!(224				<Balance<T>>::get((collection.id, token, owner)) == amount,225				<CommonError<T>>::TokenValueTooLow226			);227			let account_balance = <AccountBalance<T>>::get((collection.id, owner))228				.checked_sub(1)229				// Should not occur230				.ok_or(ArithmeticError::Underflow)?;231232			// =========233234			<Owned<T>>::remove((collection.id, owner, token));235			<AccountBalance<T>>::insert((collection.id, owner), account_balance);236			Self::burn_token(collection, token)?;237			<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(238				collection.id,239				token,240				owner.clone(),241				amount,242			));243			return Ok(());244		}245246		let balance = <Balance<T>>::get((collection.id, token, owner))247			.checked_sub(amount)248			.ok_or(<CommonError<T>>::TokenValueTooLow)?;249		let account_balance = if balance == 0 {250			<AccountBalance<T>>::get((collection.id, owner))251				.checked_sub(1)252				// Should not occur253				.ok_or(ArithmeticError::Underflow)?254		} else {255			0256		};257258		// =========259260		if balance == 0 {261			<Owned<T>>::remove((collection.id, owner, token));262			<Balance<T>>::remove((collection.id, token, owner));263			<AccountBalance<T>>::insert((collection.id, owner), account_balance);264		} else {265			<Balance<T>>::insert((collection.id, token, owner), balance);266		}267		<TotalSupply<T>>::insert((collection.id, token), total_supply);268		// TODO: ERC20 transfer event269		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(270			collection.id,271			token,272			owner.clone(),273			amount,274		));275		Ok(())276	}277278	pub fn transfer(279		collection: &RefungibleHandle<T>,280		from: &T::CrossAccountId,281		to: &T::CrossAccountId,282		token: TokenId,283		amount: u128,284	) -> DispatchResult {285		ensure!(286			collection.limits.transfers_enabled(),287			<CommonError<T>>::TransferNotAllowed288		);289290		if collection.access == AccessMode::AllowList {291			collection.check_allowlist(from)?;292			collection.check_allowlist(to)?;293		}294		<PalletCommon<T>>::ensure_correct_receiver(to)?;295296		let balance_from = <Balance<T>>::get((collection.id, token, from))297			.checked_sub(amount)298			.ok_or(<CommonError<T>>::TokenValueTooLow)?;299		let mut create_target = false;300		let from_to_differ = from != to;301		let balance_to = if from != to {302			let old_balance = <Balance<T>>::get((collection.id, token, to));303			if old_balance == 0 {304				create_target = true;305			}306			Some(307				old_balance308					.checked_add(amount)309					.ok_or(ArithmeticError::Overflow)?,310			)311		} else {312			None313		};314315		let account_balance_from = if balance_from == 0 {316			Some(317				<AccountBalance<T>>::get((collection.id, from))318					.checked_sub(1)319					// Should not occur320					.ok_or(ArithmeticError::Underflow)?,321			)322		} else {323			None324		};325		// Account data is created in token, AccountBalance should be increased326		// But only if from != to as we shouldn't check overflow in this case327		let account_balance_to = if create_target && from_to_differ {328			let account_balance_to = <AccountBalance<T>>::get((collection.id, to))329				.checked_add(1)330				.ok_or(ArithmeticError::Overflow)?;331			ensure!(332				account_balance_to < collection.limits.account_token_ownership_limit(),333				<CommonError<T>>::AccountTokenLimitExceeded,334			);335336			Some(account_balance_to)337		} else {338			None339		};340341		// =========342343		if let Some(balance_to) = balance_to {344			// from != to345			if balance_from == 0 {346				<Balance<T>>::remove((collection.id, token, from));347			} else {348				<Balance<T>>::insert((collection.id, token, from), balance_from);349			}350			<Balance<T>>::insert((collection.id, token, to), balance_to);351			if let Some(account_balance_from) = account_balance_from {352				<AccountBalance<T>>::insert((collection.id, from), account_balance_from);353				<Owned<T>>::remove((collection.id, from, token));354			}355			if let Some(account_balance_to) = account_balance_to {356				<AccountBalance<T>>::insert((collection.id, to), account_balance_to);357				<Owned<T>>::insert((collection.id, to, token), true);358			}359		}360361		// TODO: ERC20 transfer event362		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(363			collection.id,364			token,365			from.clone(),366			to.clone(),367			amount,368		));369		Ok(())370	}371372	pub fn create_multiple_items(373		collection: &RefungibleHandle<T>,374		sender: &T::CrossAccountId,375		data: Vec<CreateRefungibleExData<T::CrossAccountId>>,376	) -> DispatchResult {377		if !collection.is_owner_or_admin(sender) {378			ensure!(379				collection.mint_mode,380				<CommonError<T>>::PublicMintingNotAllowed381			);382			collection.check_allowlist(sender)?;383384			for item in data.iter() {385				for user in item.users.keys() {386					collection.check_allowlist(user)?;387				}388			}389		}390391		for item in data.iter() {392			for (owner, _) in item.users.iter() {393				<PalletCommon<T>>::ensure_correct_receiver(owner)?;394			}395		}396397		// Total pieces per tokens398		let totals = data399			.iter()400			.map(|data| {401				Ok(data402					.users403					.iter()404					.map(|u| u.1)405					.try_fold(0u128, |acc, v| acc.checked_add(*v))406					.ok_or(ArithmeticError::Overflow)?)407			})408			.collect::<Result<Vec<_>, DispatchError>>()?;409		for total in &totals {410			ensure!(411				*total <= MAX_REFUNGIBLE_PIECES,412				<Error<T>>::WrongRefungiblePieces413			);414		}415416		let first_token_id = <TokensMinted<T>>::get(collection.id);417		let tokens_minted = first_token_id418			.checked_add(data.len() as u32)419			.ok_or(ArithmeticError::Overflow)?;420		ensure!(421			tokens_minted < collection.limits.token_limit(),422			<CommonError<T>>::CollectionTokenLimitExceeded423		);424425		let mut balances = BTreeMap::new();426		for data in &data {427			for owner in data.users.keys() {428				let balance = balances429					.entry(owner)430					.or_insert_with(|| <AccountBalance<T>>::get((collection.id, owner)));431				*balance = balance.checked_add(1).ok_or(ArithmeticError::Overflow)?;432433				ensure!(434					*balance <= collection.limits.account_token_ownership_limit(),435					<CommonError<T>>::AccountTokenLimitExceeded,436				);437			}438		}439440		// =========441442		<TokensMinted<T>>::insert(collection.id, tokens_minted);443		for (account, balance) in balances {444			<AccountBalance<T>>::insert((collection.id, account), balance);445		}446		for (i, token) in data.into_iter().enumerate() {447			let token_id = first_token_id + i as u32 + 1;448			<TotalSupply<T>>::insert((collection.id, token_id), totals[i]);449450			<TokenData<T>>::insert(451				(collection.id, token_id),452				ItemData {453					const_data: token.const_data,454					variable_data: token.variable_data,455				},456			);457			for (user, amount) in token.users.into_iter() {458				if amount == 0 {459					continue;460				}461				<Balance<T>>::insert((collection.id, token_id, &user), amount);462				<Owned<T>>::insert((collection.id, &user, TokenId(token_id)), true);463				// TODO: ERC20 transfer event464				<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(465					collection.id,466					TokenId(token_id),467					user,468					amount,469				));470			}471		}472		Ok(())473	}474475	pub fn set_allowance_unchecked(476		collection: &RefungibleHandle<T>,477		sender: &T::CrossAccountId,478		spender: &T::CrossAccountId,479		token: TokenId,480		amount: u128,481	) {482		if amount == 0 {483			<Allowance<T>>::remove((collection.id, token, sender, spender));484		} else {485			<Allowance<T>>::insert((collection.id, token, sender, spender), amount);486		}487		// TODO: ERC20 approval event488		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(489			collection.id,490			token,491			sender.clone(),492			spender.clone(),493			amount,494		))495	}496497	pub fn set_allowance(498		collection: &RefungibleHandle<T>,499		sender: &T::CrossAccountId,500		spender: &T::CrossAccountId,501		token: TokenId,502		amount: u128,503	) -> DispatchResult {504		if collection.access == AccessMode::AllowList {505			collection.check_allowlist(sender)?;506			collection.check_allowlist(spender)?;507		}508509		<PalletCommon<T>>::ensure_correct_receiver(spender)?;510511		if <Balance<T>>::get((collection.id, token, sender)) < amount {512			ensure!(513				collection.ignores_owned_amount(sender) && Self::token_exists(collection, token),514				<CommonError<T>>::CantApproveMoreThanOwned515			);516		}517518		// =========519520		Self::set_allowance_unchecked(collection, sender, spender, token, amount);521		Ok(())522	}523524	pub fn transfer_from(525		collection: &RefungibleHandle<T>,526		spender: &T::CrossAccountId,527		from: &T::CrossAccountId,528		to: &T::CrossAccountId,529		token: TokenId,530		amount: u128,531	) -> DispatchResult {532		if spender.conv_eq(from) {533			return Self::transfer(collection, from, to, token, amount);534		}535		if collection.access == AccessMode::AllowList {536			// `from`, `to` checked in [`transfer`]537			collection.check_allowlist(spender)?;538		}539540		let allowance =541			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);542		if allowance.is_none() {543			ensure!(544				collection.ignores_allowance(spender),545				<CommonError<T>>::ApprovedValueTooLow546			);547		}548549		// =========550551		Self::transfer(collection, from, to, token, amount)?;552		if let Some(allowance) = allowance {553			Self::set_allowance_unchecked(collection, from, spender, token, allowance);554		}555		Ok(())556	}557558	pub fn burn_from(559		collection: &RefungibleHandle<T>,560		spender: &T::CrossAccountId,561		from: &T::CrossAccountId,562		token: TokenId,563		amount: u128,564	) -> DispatchResult {565		if spender.conv_eq(from) {566			return Self::burn(collection, from, token, amount);567		}568		if collection.access == AccessMode::AllowList {569			// `from` checked in [`burn`]570			collection.check_allowlist(spender)?;571		}572573		let allowance =574			<Allowance<T>>::get((collection.id, token, from, &spender)).checked_sub(amount);575		if allowance.is_none() {576			ensure!(577				collection.ignores_allowance(spender),578				<CommonError<T>>::ApprovedValueTooLow579			);580		}581582		// =========583584		Self::burn(collection, from, token, amount)?;585		if let Some(allowance) = allowance {586			Self::set_allowance_unchecked(collection, from, spender, token, allowance);587		}588		Ok(())589	}590591	pub fn set_variable_metadata(592		collection: &RefungibleHandle<T>,593		sender: &T::CrossAccountId,594		token: TokenId,595		data: BoundedVec<u8, CustomDataLimit>,596	) -> DispatchResult {597		collection.check_can_update_meta(598			sender,599			&T::CrossAccountId::from_sub(collection.owner.clone()),600		)?;601602		let token_data = <TokenData<T>>::get((collection.id, token));603604		// =========605606		<TokenData<T>>::insert(607			(collection.id, token),608			ItemData {609				variable_data: data,610				..token_data611			},612		);613		Ok(())614	}615616	/// Delegated to `create_multiple_items`617	pub fn create_item(618		collection: &RefungibleHandle<T>,619		sender: &T::CrossAccountId,620		data: CreateRefungibleExData<T::CrossAccountId>,621	) -> DispatchResult {622		Self::create_multiple_items(collection, sender, vec![data])623	}624}