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 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		if Self::collection_has_tokens(id) {149			return Err(<CommonError<T>>::CantDestroyNotEmptyCollection.into());150		}151152		// =========153154		PalletCommon::destroy_collection(collection.0, sender)?;155156		<TotalSupply<T>>::remove(id);157		<Balance<T>>::remove_prefix((id,), None);158		<Allowance<T>>::remove_prefix((id,), None);159		Ok(())160	}161162	fn collection_has_tokens(collection_id: CollectionId) -> bool {163		<TotalSupply<T>>::get(collection_id) != 0164	}165166	pub fn burn(167		collection: &FungibleHandle<T>,168		owner: &T::CrossAccountId,169		amount: u128,170	) -> DispatchResult {171		let total_supply = <TotalSupply<T>>::get(collection.id)172			.checked_sub(amount)173			.ok_or(<CommonError<T>>::TokenValueTooLow)?;174175		let balance = <Balance<T>>::get((collection.id, owner))176			.checked_sub(amount)177			.ok_or(<CommonError<T>>::TokenValueTooLow)?;178179		if collection.permissions.access() == AccessMode::AllowList {180			collection.check_allowlist(owner)?;181		}182183		// =========184185		if balance == 0 {186			<Balance<T>>::remove((collection.id, owner));187			<PalletStructure<T>>::unnest_if_nested(188				owner,189				collection.id,190				TokenId::default()191			);192		} else {193			<Balance<T>>::insert((collection.id, owner), balance);194		}195		<TotalSupply<T>>::insert(collection.id, total_supply);196197		<PalletEvm<T>>::deposit_log(198			ERC20Events::Transfer {199				from: *owner.as_eth(),200				to: H160::default(),201				value: amount.into(),202			}203			.to_log(collection_id_to_address(collection.id)),204		);205		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(206			collection.id,207			TokenId::default(),208			owner.clone(),209			amount,210		));211		Ok(())212	}213214	pub fn transfer(215		collection: &FungibleHandle<T>,216		from: &T::CrossAccountId,217		to: &T::CrossAccountId,218		amount: u128,219		nesting_budget: &dyn Budget,220	) -> DispatchResult {221		ensure!(222			collection.limits.transfers_enabled(),223			<CommonError<T>>::TransferNotAllowed,224		);225226		if collection.permissions.access() == AccessMode::AllowList {227			collection.check_allowlist(from)?;228			collection.check_allowlist(to)?;229		}230		<PalletCommon<T>>::ensure_correct_receiver(to)?;231232		let balance_from = <Balance<T>>::get((collection.id, from))233			.checked_sub(amount)234			.ok_or(<CommonError<T>>::TokenValueTooLow)?;235		let balance_to = if from != to {236			Some(237				<Balance<T>>::get((collection.id, to))238					.checked_add(amount)239					.ok_or(ArithmeticError::Overflow)?,240			)241		} else {242			None243		};244245		// =========246247		<PalletStructure<T>>::nest_if_sent_to_token(248			from.clone(),249			to,250			collection.id,251			TokenId::default(),252			nesting_budget253		)?;254255		if let Some(balance_to) = balance_to {256			// from != to257			if balance_from == 0 {258				<Balance<T>>::remove((collection.id, from));259			} else {260				<Balance<T>>::insert((collection.id, from), balance_from);261			}262			<Balance<T>>::insert((collection.id, to), balance_to);263		}264265		<PalletEvm<T>>::deposit_log(266			ERC20Events::Transfer {267				from: *from.as_eth(),268				to: *to.as_eth(),269				value: amount.into(),270			}271			.to_log(collection_id_to_address(collection.id)),272		);273		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(274			collection.id,275			TokenId::default(),276			from.clone(),277			to.clone(),278			amount,279		));280		Ok(())281	}282283	pub fn create_multiple_items(284		collection: &FungibleHandle<T>,285		sender: &T::CrossAccountId,286		data: BTreeMap<T::CrossAccountId, u128>,287		nesting_budget: &dyn Budget,288	) -> DispatchResult {289		if !collection.is_owner_or_admin(sender) {290			ensure!(291				collection.permissions.mint_mode(),292				<CommonError<T>>::PublicMintingNotAllowed293			);294			collection.check_allowlist(sender)?;295296			for (owner, _) in data.iter() {297				collection.check_allowlist(owner)?;298			}299		}300301		let total_supply = data302			.iter()303			.map(|(_, v)| *v)304			.try_fold(<TotalSupply<T>>::get(collection.id), |acc, v| {305				acc.checked_add(v)306			})307			.ok_or(ArithmeticError::Overflow)?;308309		let mut balances = data;310		for (k, v) in balances.iter_mut() {311			*v = <Balance<T>>::get((collection.id, &k))312				.checked_add(*v)313				.ok_or(ArithmeticError::Overflow)?;314		}315316		for (to, _) in balances.iter() {317			<PalletStructure<T>>::check_nesting(318				sender.clone(),319				to,320				collection.id,321				TokenId::default(),322				nesting_budget,323			)?;324		}325326		// =========327328		<TotalSupply<T>>::insert(collection.id, total_supply);329		for (user, amount) in balances {330			<Balance<T>>::insert((collection.id, &user), amount);331			<PalletStructure<T>>::nest_if_sent_to_token_unchecked(&user, collection.id, TokenId::default());332			<PalletEvm<T>>::deposit_log(333				ERC20Events::Transfer {334					from: H160::default(),335					to: *user.as_eth(),336					value: amount.into(),337				}338				.to_log(collection_id_to_address(collection.id)),339			);340			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(341				collection.id,342				TokenId::default(),343				user.clone(),344				amount,345			));346		}347348		Ok(())349	}350351	fn set_allowance_unchecked(352		collection: &FungibleHandle<T>,353		owner: &T::CrossAccountId,354		spender: &T::CrossAccountId,355		amount: u128,356	) {357		if amount == 0 {358			<Allowance<T>>::remove((collection.id, owner, spender));359		} else {360			<Allowance<T>>::insert((collection.id, owner, spender), amount);361		}362363		<PalletEvm<T>>::deposit_log(364			ERC20Events::Approval {365				owner: *owner.as_eth(),366				spender: *spender.as_eth(),367				value: amount.into(),368			}369			.to_log(collection_id_to_address(collection.id)),370		);371		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(372			collection.id,373			TokenId(0),374			owner.clone(),375			spender.clone(),376			amount,377		));378	}379380	pub fn set_allowance(381		collection: &FungibleHandle<T>,382		owner: &T::CrossAccountId,383		spender: &T::CrossAccountId,384		amount: u128,385	) -> DispatchResult {386		if collection.permissions.access() == AccessMode::AllowList {387			collection.check_allowlist(owner)?;388			collection.check_allowlist(spender)?;389		}390391		if <Balance<T>>::get((collection.id, owner)) < amount {392			ensure!(393				collection.ignores_owned_amount(owner),394				<CommonError<T>>::CantApproveMoreThanOwned395			);396		}397398		// =========399400		Self::set_allowance_unchecked(collection, owner, spender, amount);401		Ok(())402	}403404	fn check_allowed(405		collection: &FungibleHandle<T>,406		spender: &T::CrossAccountId,407		from: &T::CrossAccountId,408		amount: u128,409		nesting_budget: &dyn Budget,410	) -> Result<Option<u128>, DispatchError> {411		if spender.conv_eq(from) {412			return Ok(None);413		}414		if collection.permissions.access() == AccessMode::AllowList {415			// `from`, `to` checked in [`transfer`]416			collection.check_allowlist(spender)?;417		}418		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {419			// TODO: should collection owner be allowed to perform this transfer?420			ensure!(421				<PalletStructure<T>>::check_indirectly_owned(422					spender.clone(),423					source.0,424					source.1,425					None,426					nesting_budget427				)?,428				<CommonError<T>>::ApprovedValueTooLow,429			);430			return Ok(None);431		}432		let allowance = <Allowance<T>>::get((collection.id, from, spender)).checked_sub(amount);433		if allowance.is_none() {434			ensure!(435				collection.ignores_allowance(spender),436				<CommonError<T>>::ApprovedValueTooLow437			);438		}439440		Ok(allowance)441	}442443	pub fn transfer_from(444		collection: &FungibleHandle<T>,445		spender: &T::CrossAccountId,446		from: &T::CrossAccountId,447		to: &T::CrossAccountId,448		amount: u128,449		nesting_budget: &dyn Budget,450	) -> DispatchResult {451		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;452453		// =========454455		Self::transfer(collection, from, to, amount, nesting_budget)?;456		if let Some(allowance) = allowance {457			Self::set_allowance_unchecked(collection, from, spender, allowance);458		}459		Ok(())460	}461462	pub fn burn_from(463		collection: &FungibleHandle<T>,464		spender: &T::CrossAccountId,465		from: &T::CrossAccountId,466		amount: u128,467		nesting_budget: &dyn Budget,468	) -> DispatchResult {469		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;470471		// =========472473		Self::burn(collection, from, amount)?;474		if let Some(allowance) = allowance {475			Self::set_allowance_unchecked(collection, from, spender, allowance);476		}477		Ok(())478	}479480	/// Delegated to `create_multiple_items`481	pub fn create_item(482		collection: &FungibleHandle<T>,483		sender: &T::CrossAccountId,484		data: CreateItemData<T>,485		nesting_budget: &dyn Budget,486	) -> DispatchResult {487		Self::create_multiple_items(488			collection,489			sender,490			[(data.0, data.1)].into_iter().collect(),491			nesting_budget,492		)493	}494}