git.delta.rocks / unique-network / refs/commits / 77688fbffa89

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 core::ops::Deref;20use evm_coder::ToLog;21use frame_support::{ensure};22use pallet_evm::account::CrossAccountId;23use up_data_structs::{24	AccessMode, CollectionId, TokenId, CreateCollectionData, mapping::TokenAddressMapping,25	budget::Budget,26};27use pallet_common::{28	Error as CommonError, Event as CommonEvent, Pallet as PalletCommon,29	eth::collection_id_to_address,30};31use pallet_evm::Pallet as PalletEvm;32use pallet_structure::Pallet as PalletStructure;33use pallet_evm_coder_substrate::WithRecorder;34use sp_core::H160;35use sp_runtime::{ArithmeticError, DispatchError, DispatchResult};36use sp_std::collections::btree_map::BTreeMap;3738pub use pallet::*;3940use crate::erc::ERC20Events;41#[cfg(feature = "runtime-benchmarks")]42pub mod benchmarking;43pub mod common;44pub mod erc;45pub mod weights;4647pub type CreateItemData<T> = (<T as pallet_evm::account::Config>::CrossAccountId, u128);48pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;4950#[frame_support::pallet]51pub mod pallet {52	use frame_support::{Blake2_128, Blake2_128Concat, Twox64Concat, pallet_prelude::*, storage::Key};53	use up_data_structs::CollectionId;54	use super::weights::WeightInfo;5556	#[pallet::error]57	pub enum Error<T> {58		/// Not Fungible item data used to mint in Fungible collection.59		NotFungibleDataUsedToMintFungibleCollectionToken,60		/// Not default id passed as TokenId argument61		FungibleItemsHaveNoId,62		/// Tried to set data for fungible item63		FungibleItemsDontHaveData,64		/// Fungible token does not support nested65		FungibleDisallowsNesting,66		/// Setting item properties is not allowed67		SettingPropertiesNotAllowed,68	}6970	#[pallet::config]71	pub trait Config:72		frame_system::Config + pallet_common::Config + pallet_structure::Config + pallet_evm::Config73	{74		type WeightInfo: WeightInfo;75	}7677	#[pallet::pallet]78	#[pallet::generate_store(pub(super) trait Store)]79	pub struct Pallet<T>(_);8081	#[pallet::storage]82	pub type TotalSupply<T: Config> =83		StorageMap<Hasher = Twox64Concat, Key = CollectionId, Value = u128, QueryKind = ValueQuery>;8485	#[pallet::storage]86	pub type Balance<T: Config> = StorageNMap<87		Key = (88			Key<Twox64Concat, CollectionId>,89			Key<Blake2_128Concat, T::CrossAccountId>,90		),91		Value = u128,92		QueryKind = ValueQuery,93	>;9495	#[pallet::storage]96	pub type Allowance<T: Config> = StorageNMap<97		Key = (98			Key<Twox64Concat, CollectionId>,99			Key<Blake2_128, T::CrossAccountId>,100			Key<Blake2_128Concat, T::CrossAccountId>,101		),102		Value = u128,103		QueryKind = ValueQuery,104	>;105}106107pub struct FungibleHandle<T: Config>(pallet_common::CollectionHandle<T>);108impl<T: Config> FungibleHandle<T> {109	pub fn cast(inner: pallet_common::CollectionHandle<T>) -> Self {110		Self(inner)111	}112	pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {113		self.0114	}115	pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {116		&mut self.0117	}118}119impl<T: Config> WithRecorder<T> for FungibleHandle<T> {120	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {121		self.0.recorder()122	}123	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {124		self.0.into_recorder()125	}126}127impl<T: Config> Deref for FungibleHandle<T> {128	type Target = pallet_common::CollectionHandle<T>;129130	fn deref(&self) -> &Self::Target {131		&self.0132	}133}134135impl<T: Config> Pallet<T> {136	pub fn init_collection(137		owner: T::AccountId,138		data: CreateCollectionData<T::AccountId>,139	) -> Result<CollectionId, DispatchError> {140		<PalletCommon<T>>::init_collection(owner, data)141	}142	pub fn destroy_collection(143		collection: FungibleHandle<T>,144		sender: &T::CrossAccountId,145	) -> DispatchResult {146		let id = collection.id;147148		// =========149150		PalletCommon::destroy_collection(collection.0, sender)?;151152		<TotalSupply<T>>::remove(id);153		<Balance<T>>::remove_prefix((id,), None);154		<Allowance<T>>::remove_prefix((id,), None);155		Ok(())156	}157158	pub fn burn(159		collection: &FungibleHandle<T>,160		owner: &T::CrossAccountId,161		amount: u128,162	) -> DispatchResult {163		if collection.access == AccessMode::AllowList {164			collection.check_allowlist(owner)?;165		}166167		// =========168169		Self::burn_item_unchecked(collection, owner, amount)?;170171		<PalletEvm<T>>::deposit_log(172			ERC20Events::Transfer {173				from: *owner.as_eth(),174				to: H160::default(),175				value: amount.into(),176			}177			.to_log(collection_id_to_address(collection.id)),178		);179		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(180			collection.id,181			TokenId::default(),182			owner.clone(),183			amount,184		));185		Ok(())186	}187188	pub fn burn_item_unchecked(189		collection: &FungibleHandle<T>,190		owner: &T::CrossAccountId,191		amount: u128,192	) -> DispatchResult {193		let total_supply = <TotalSupply<T>>::get(collection.id)194			.checked_sub(amount)195			.ok_or(<CommonError<T>>::TokenValueTooLow)?;196197		let balance = <Balance<T>>::get((collection.id, owner))198			.checked_sub(amount)199			.ok_or(<CommonError<T>>::TokenValueTooLow)?;200201		if collection.permissions.access() == AccessMode::AllowList {202			collection.check_allowlist(owner)?;203		}204205		// =========206207		if balance == 0 {208			<Balance<T>>::remove((collection.id, owner));209			<PalletStructure<T>>::unnest_if_nested(210				owner,211				collection.id,212				TokenId::default()213			);214		} else {215			<Balance<T>>::insert((collection.id, owner), balance);216		}217		<TotalSupply<T>>::insert(collection.id, total_supply);218219		Ok(())220	}221222	pub fn transfer(223		collection: &FungibleHandle<T>,224		from: &T::CrossAccountId,225		to: &T::CrossAccountId,226		amount: u128,227		nesting_budget: &dyn Budget,228	) -> DispatchResult {229		ensure!(230			collection.limits.transfers_enabled(),231			<CommonError<T>>::TransferNotAllowed,232		);233234		if collection.permissions.access() == AccessMode::AllowList {235			collection.check_allowlist(from)?;236			collection.check_allowlist(to)?;237		}238		<PalletCommon<T>>::ensure_correct_receiver(to)?;239240		let balance_from = <Balance<T>>::get((collection.id, from))241			.checked_sub(amount)242			.ok_or(<CommonError<T>>::TokenValueTooLow)?;243		let balance_to = if from != to {244			Some(245				<Balance<T>>::get((collection.id, to))246					.checked_add(amount)247					.ok_or(ArithmeticError::Overflow)?,248			)249		} else {250			None251		};252253		// =========254255		<PalletStructure<T>>::try_nest_if_sent_to_token(256			from.clone(),257			to,258			collection.id,259			TokenId::default(),260			nesting_budget261		)?;262263		if let Some(balance_to) = balance_to {264			// from != to265			if balance_from == 0 {266				<Balance<T>>::remove((collection.id, from));267			} else {268				<Balance<T>>::insert((collection.id, from), balance_from);269			}270			<Balance<T>>::insert((collection.id, to), balance_to);271		}272273		<PalletEvm<T>>::deposit_log(274			ERC20Events::Transfer {275				from: *from.as_eth(),276				to: *to.as_eth(),277				value: amount.into(),278			}279			.to_log(collection_id_to_address(collection.id)),280		);281		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(282			collection.id,283			TokenId::default(),284			from.clone(),285			to.clone(),286			amount,287		));288		Ok(())289	}290291	pub fn create_multiple_items(292		collection: &FungibleHandle<T>,293		sender: &T::CrossAccountId,294		data: BTreeMap<T::CrossAccountId, u128>,295		nesting_budget: &dyn Budget,296	) -> DispatchResult {297		if !collection.is_owner_or_admin(sender) {298			ensure!(299				collection.permissions.mint_mode(),300				<CommonError<T>>::PublicMintingNotAllowed301			);302			collection.check_allowlist(sender)?;303304			for (owner, _) in data.iter() {305				collection.check_allowlist(owner)?;306			}307		}308309		let total_supply = data310			.iter()311			.map(|(_, v)| *v)312			.try_fold(<TotalSupply<T>>::get(collection.id), |acc, v| {313				acc.checked_add(v)314			})315			.ok_or(ArithmeticError::Overflow)?;316317		let mut balances = data;318		for (k, v) in balances.iter_mut() {319			*v = <Balance<T>>::get((collection.id, &k))320				.checked_add(*v)321				.ok_or(ArithmeticError::Overflow)?;322		}323324		for (to, _) in balances.iter() {325			<PalletStructure<T>>::check_nesting(326				sender.clone(),327				to,328				collection.id,329				TokenId::default(),330				nesting_budget,331			)?;332		}333334		// =========335336		<TotalSupply<T>>::insert(collection.id, total_supply);337		for (user, amount) in balances {338			<Balance<T>>::insert((collection.id, &user), amount);339			<PalletStructure<T>>::nest_if_sent_to_token(&user, collection.id, TokenId::default());340			<PalletEvm<T>>::deposit_log(341				ERC20Events::Transfer {342					from: H160::default(),343					to: *user.as_eth(),344					value: amount.into(),345				}346				.to_log(collection_id_to_address(collection.id)),347			);348			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(349				collection.id,350				TokenId::default(),351				user.clone(),352				amount,353			));354		}355356		Ok(())357	}358359	fn set_allowance_unchecked(360		collection: &FungibleHandle<T>,361		owner: &T::CrossAccountId,362		spender: &T::CrossAccountId,363		amount: u128,364	) {365		if amount == 0 {366			<Allowance<T>>::remove((collection.id, owner, spender));367		} else {368			<Allowance<T>>::insert((collection.id, owner, spender), amount);369		}370371		<PalletEvm<T>>::deposit_log(372			ERC20Events::Approval {373				owner: *owner.as_eth(),374				spender: *spender.as_eth(),375				value: amount.into(),376			}377			.to_log(collection_id_to_address(collection.id)),378		);379		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(380			collection.id,381			TokenId(0),382			owner.clone(),383			spender.clone(),384			amount,385		));386	}387388	pub fn set_allowance(389		collection: &FungibleHandle<T>,390		owner: &T::CrossAccountId,391		spender: &T::CrossAccountId,392		amount: u128,393	) -> DispatchResult {394		if collection.permissions.access() == AccessMode::AllowList {395			collection.check_allowlist(owner)?;396			collection.check_allowlist(spender)?;397		}398399		if <Balance<T>>::get((collection.id, owner)) < amount {400			ensure!(401				collection.ignores_owned_amount(owner),402				<CommonError<T>>::CantApproveMoreThanOwned403			);404		}405406		// =========407408		Self::set_allowance_unchecked(collection, owner, spender, amount);409		Ok(())410	}411412	fn check_allowed(413		collection: &FungibleHandle<T>,414		spender: &T::CrossAccountId,415		from: &T::CrossAccountId,416		amount: u128,417		nesting_budget: &dyn Budget,418	) -> Result<Option<u128>, DispatchError> {419		if spender.conv_eq(from) {420			return Ok(None);421		}422		if collection.permissions.access() == AccessMode::AllowList {423			// `from`, `to` checked in [`transfer`]424			collection.check_allowlist(spender)?;425		}426		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {427			// TODO: should collection owner be allowed to perform this transfer?428			ensure!(429				<PalletStructure<T>>::check_indirectly_owned(430					spender.clone(),431					source.0,432					source.1,433					None,434					nesting_budget435				)?,436				<CommonError<T>>::ApprovedValueTooLow,437			);438			return Ok(None);439		}440		let allowance = <Allowance<T>>::get((collection.id, from, spender)).checked_sub(amount);441		if allowance.is_none() {442			ensure!(443				collection.ignores_allowance(spender),444				<CommonError<T>>::ApprovedValueTooLow445			);446		}447448		Ok(allowance)449	}450451	pub fn transfer_from(452		collection: &FungibleHandle<T>,453		spender: &T::CrossAccountId,454		from: &T::CrossAccountId,455		to: &T::CrossAccountId,456		amount: u128,457		nesting_budget: &dyn Budget,458	) -> DispatchResult {459		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;460461		// =========462463		Self::transfer(collection, from, to, amount, nesting_budget)?;464		if let Some(allowance) = allowance {465			Self::set_allowance_unchecked(collection, from, spender, allowance);466		}467		Ok(())468	}469470	pub fn burn_from(471		collection: &FungibleHandle<T>,472		spender: &T::CrossAccountId,473		from: &T::CrossAccountId,474		amount: u128,475		nesting_budget: &dyn Budget,476	) -> DispatchResult {477		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;478479		// =========480481		Self::burn(collection, from, amount)?;482		if let Some(allowance) = allowance {483			Self::set_allowance_unchecked(collection, from, spender, allowance);484		}485		Ok(())486	}487488	/// Delegated to `create_multiple_items`489	pub fn create_item(490		collection: &FungibleHandle<T>,491		sender: &T::CrossAccountId,492		data: CreateItemData<T>,493		nesting_budget: &dyn Budget,494	) -> DispatchResult {495		Self::create_multiple_items(496			collection,497			sender,498			[(data.0, data.1)].into_iter().collect(),499			nesting_budget,500		)501	}502}