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

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				<PalletStructure<T>>::unnest_if_nested(260					from,261					collection.id,262					TokenId::default()263				);264			} else {265				<Balance<T>>::insert((collection.id, from), balance_from);266			}267			<Balance<T>>::insert((collection.id, to), balance_to);268		}269270		<PalletEvm<T>>::deposit_log(271			ERC20Events::Transfer {272				from: *from.as_eth(),273				to: *to.as_eth(),274				value: amount.into(),275			}276			.to_log(collection_id_to_address(collection.id)),277		);278		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(279			collection.id,280			TokenId::default(),281			from.clone(),282			to.clone(),283			amount,284		));285		Ok(())286	}287288	pub fn create_multiple_items(289		collection: &FungibleHandle<T>,290		sender: &T::CrossAccountId,291		data: BTreeMap<T::CrossAccountId, u128>,292		nesting_budget: &dyn Budget,293	) -> DispatchResult {294		if !collection.is_owner_or_admin(sender) {295			ensure!(296				collection.permissions.mint_mode(),297				<CommonError<T>>::PublicMintingNotAllowed298			);299			collection.check_allowlist(sender)?;300301			for (owner, _) in data.iter() {302				collection.check_allowlist(owner)?;303			}304		}305306		let total_supply = data307			.iter()308			.map(|(_, v)| *v)309			.try_fold(<TotalSupply<T>>::get(collection.id), |acc, v| {310				acc.checked_add(v)311			})312			.ok_or(ArithmeticError::Overflow)?;313314		let mut balances = data;315		for (k, v) in balances.iter_mut() {316			*v = <Balance<T>>::get((collection.id, &k))317				.checked_add(*v)318				.ok_or(ArithmeticError::Overflow)?;319		}320321		for (to, _) in balances.iter() {322			<PalletStructure<T>>::check_nesting(323				sender.clone(),324				to,325				collection.id,326				TokenId::default(),327				nesting_budget,328			)?;329		}330331		// =========332333		<TotalSupply<T>>::insert(collection.id, total_supply);334		for (user, amount) in balances {335			<Balance<T>>::insert((collection.id, &user), amount);336			<PalletStructure<T>>::nest_if_sent_to_token_unchecked(&user, collection.id, TokenId::default());337			<PalletEvm<T>>::deposit_log(338				ERC20Events::Transfer {339					from: H160::default(),340					to: *user.as_eth(),341					value: amount.into(),342				}343				.to_log(collection_id_to_address(collection.id)),344			);345			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(346				collection.id,347				TokenId::default(),348				user.clone(),349				amount,350			));351		}352353		Ok(())354	}355356	fn set_allowance_unchecked(357		collection: &FungibleHandle<T>,358		owner: &T::CrossAccountId,359		spender: &T::CrossAccountId,360		amount: u128,361	) {362		if amount == 0 {363			<Allowance<T>>::remove((collection.id, owner, spender));364		} else {365			<Allowance<T>>::insert((collection.id, owner, spender), amount);366		}367368		<PalletEvm<T>>::deposit_log(369			ERC20Events::Approval {370				owner: *owner.as_eth(),371				spender: *spender.as_eth(),372				value: amount.into(),373			}374			.to_log(collection_id_to_address(collection.id)),375		);376		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(377			collection.id,378			TokenId(0),379			owner.clone(),380			spender.clone(),381			amount,382		));383	}384385	pub fn set_allowance(386		collection: &FungibleHandle<T>,387		owner: &T::CrossAccountId,388		spender: &T::CrossAccountId,389		amount: u128,390	) -> DispatchResult {391		if collection.permissions.access() == AccessMode::AllowList {392			collection.check_allowlist(owner)?;393			collection.check_allowlist(spender)?;394		}395396		if <Balance<T>>::get((collection.id, owner)) < amount {397			ensure!(398				collection.ignores_owned_amount(owner),399				<CommonError<T>>::CantApproveMoreThanOwned400			);401		}402403		// =========404405		Self::set_allowance_unchecked(collection, owner, spender, amount);406		Ok(())407	}408409	fn check_allowed(410		collection: &FungibleHandle<T>,411		spender: &T::CrossAccountId,412		from: &T::CrossAccountId,413		amount: u128,414		nesting_budget: &dyn Budget,415	) -> Result<Option<u128>, DispatchError> {416		if spender.conv_eq(from) {417			return Ok(None);418		}419		if collection.permissions.access() == AccessMode::AllowList {420			// `from`, `to` checked in [`transfer`]421			collection.check_allowlist(spender)?;422		}423		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {424			// TODO: should collection owner be allowed to perform this transfer?425			ensure!(426				<PalletStructure<T>>::check_indirectly_owned(427					spender.clone(),428					source.0,429					source.1,430					None,431					nesting_budget432				)?,433				<CommonError<T>>::ApprovedValueTooLow,434			);435			return Ok(None);436		}437		let allowance = <Allowance<T>>::get((collection.id, from, spender)).checked_sub(amount);438		if allowance.is_none() {439			ensure!(440				collection.ignores_allowance(spender),441				<CommonError<T>>::ApprovedValueTooLow442			);443		}444445		Ok(allowance)446	}447448	pub fn transfer_from(449		collection: &FungibleHandle<T>,450		spender: &T::CrossAccountId,451		from: &T::CrossAccountId,452		to: &T::CrossAccountId,453		amount: u128,454		nesting_budget: &dyn Budget,455	) -> DispatchResult {456		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;457458		// =========459460		Self::transfer(collection, from, to, amount, nesting_budget)?;461		if let Some(allowance) = allowance {462			Self::set_allowance_unchecked(collection, from, spender, allowance);463		}464		Ok(())465	}466467	pub fn burn_from(468		collection: &FungibleHandle<T>,469		spender: &T::CrossAccountId,470		from: &T::CrossAccountId,471		amount: u128,472		nesting_budget: &dyn Budget,473	) -> DispatchResult {474		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;475476		// =========477478		Self::burn(collection, from, amount)?;479		if let Some(allowance) = allowance {480			Self::set_allowance_unchecked(collection, from, spender, allowance);481		}482		Ok(())483	}484485	/// Delegated to `create_multiple_items`486	pub fn create_item(487		collection: &FungibleHandle<T>,488		sender: &T::CrossAccountId,489		data: CreateItemData<T>,490		nesting_budget: &dyn Budget,491	) -> DispatchResult {492		Self::create_multiple_items(493			collection,494			sender,495			[(data.0, data.1)].into_iter().collect(),496			nesting_budget,497		)498	}499}