git.delta.rocks / unique-network / refs/commits / 9d51561e5bd0

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		let total_supply = <TotalSupply<T>>::get(collection.id)164			.checked_sub(amount)165			.ok_or(<CommonError<T>>::TokenValueTooLow)?;166167		let balance = <Balance<T>>::get((collection.id, owner))168			.checked_sub(amount)169			.ok_or(<CommonError<T>>::TokenValueTooLow)?;170171		if collection.permissions.access() == AccessMode::AllowList {172			collection.check_allowlist(owner)?;173		}174175		// =========176177		if balance == 0 {178			<Balance<T>>::remove((collection.id, owner));179			<PalletStructure<T>>::unnest_if_nested(180				owner,181				collection.id,182				TokenId::default()183			);184		} else {185			<Balance<T>>::insert((collection.id, owner), balance);186		}187		<TotalSupply<T>>::insert(collection.id, total_supply);188189		<PalletEvm<T>>::deposit_log(190			ERC20Events::Transfer {191				from: *owner.as_eth(),192				to: H160::default(),193				value: amount.into(),194			}195			.to_log(collection_id_to_address(collection.id)),196		);197		<PalletCommon<T>>::deposit_event(CommonEvent::ItemDestroyed(198			collection.id,199			TokenId::default(),200			owner.clone(),201			amount,202		));203		Ok(())204	}205206	pub fn transfer(207		collection: &FungibleHandle<T>,208		from: &T::CrossAccountId,209		to: &T::CrossAccountId,210		amount: u128,211		nesting_budget: &dyn Budget,212	) -> DispatchResult {213		ensure!(214			collection.limits.transfers_enabled(),215			<CommonError<T>>::TransferNotAllowed,216		);217218		if collection.permissions.access() == AccessMode::AllowList {219			collection.check_allowlist(from)?;220			collection.check_allowlist(to)?;221		}222		<PalletCommon<T>>::ensure_correct_receiver(to)?;223224		let balance_from = <Balance<T>>::get((collection.id, from))225			.checked_sub(amount)226			.ok_or(<CommonError<T>>::TokenValueTooLow)?;227		let balance_to = if from != to {228			Some(229				<Balance<T>>::get((collection.id, to))230					.checked_add(amount)231					.ok_or(ArithmeticError::Overflow)?,232			)233		} else {234			None235		};236237		// =========238239		<PalletStructure<T>>::try_nest_if_sent_to_token(240			from.clone(),241			to,242			collection.id,243			TokenId::default(),244			nesting_budget245		)?;246247		if let Some(balance_to) = balance_to {248			// from != to249			if balance_from == 0 {250				<Balance<T>>::remove((collection.id, from));251			} else {252				<Balance<T>>::insert((collection.id, from), balance_from);253			}254			<Balance<T>>::insert((collection.id, to), balance_to);255		}256257		<PalletEvm<T>>::deposit_log(258			ERC20Events::Transfer {259				from: *from.as_eth(),260				to: *to.as_eth(),261				value: amount.into(),262			}263			.to_log(collection_id_to_address(collection.id)),264		);265		<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(266			collection.id,267			TokenId::default(),268			from.clone(),269			to.clone(),270			amount,271		));272		Ok(())273	}274275	pub fn create_multiple_items(276		collection: &FungibleHandle<T>,277		sender: &T::CrossAccountId,278		data: BTreeMap<T::CrossAccountId, u128>,279		nesting_budget: &dyn Budget,280	) -> DispatchResult {281		if !collection.is_owner_or_admin(sender) {282			ensure!(283				collection.permissions.mint_mode(),284				<CommonError<T>>::PublicMintingNotAllowed285			);286			collection.check_allowlist(sender)?;287288			for (owner, _) in data.iter() {289				collection.check_allowlist(owner)?;290			}291		}292293		let total_supply = data294			.iter()295			.map(|(_, v)| *v)296			.try_fold(<TotalSupply<T>>::get(collection.id), |acc, v| {297				acc.checked_add(v)298			})299			.ok_or(ArithmeticError::Overflow)?;300301		let mut balances = data;302		for (k, v) in balances.iter_mut() {303			*v = <Balance<T>>::get((collection.id, &k))304				.checked_add(*v)305				.ok_or(ArithmeticError::Overflow)?;306		}307308		for (to, _) in balances.iter() {309			<PalletStructure<T>>::check_nesting(310				sender.clone(),311				to,312				collection.id,313				TokenId::default(),314				nesting_budget,315			)?;316		}317318		// =========319320		<TotalSupply<T>>::insert(collection.id, total_supply);321		for (user, amount) in balances {322			<Balance<T>>::insert((collection.id, &user), amount);323			<PalletStructure<T>>::nest_if_sent_to_token(&user, collection.id, TokenId::default());324			<PalletEvm<T>>::deposit_log(325				ERC20Events::Transfer {326					from: H160::default(),327					to: *user.as_eth(),328					value: amount.into(),329				}330				.to_log(collection_id_to_address(collection.id)),331			);332			<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(333				collection.id,334				TokenId::default(),335				user.clone(),336				amount,337			));338		}339340		Ok(())341	}342343	fn set_allowance_unchecked(344		collection: &FungibleHandle<T>,345		owner: &T::CrossAccountId,346		spender: &T::CrossAccountId,347		amount: u128,348	) {349		if amount == 0 {350			<Allowance<T>>::remove((collection.id, owner, spender));351		} else {352			<Allowance<T>>::insert((collection.id, owner, spender), amount);353		}354355		<PalletEvm<T>>::deposit_log(356			ERC20Events::Approval {357				owner: *owner.as_eth(),358				spender: *spender.as_eth(),359				value: amount.into(),360			}361			.to_log(collection_id_to_address(collection.id)),362		);363		<PalletCommon<T>>::deposit_event(CommonEvent::Approved(364			collection.id,365			TokenId(0),366			owner.clone(),367			spender.clone(),368			amount,369		));370	}371372	pub fn set_allowance(373		collection: &FungibleHandle<T>,374		owner: &T::CrossAccountId,375		spender: &T::CrossAccountId,376		amount: u128,377	) -> DispatchResult {378		if collection.permissions.access() == AccessMode::AllowList {379			collection.check_allowlist(owner)?;380			collection.check_allowlist(spender)?;381		}382383		if <Balance<T>>::get((collection.id, owner)) < amount {384			ensure!(385				collection.ignores_owned_amount(owner),386				<CommonError<T>>::CantApproveMoreThanOwned387			);388		}389390		// =========391392		Self::set_allowance_unchecked(collection, owner, spender, amount);393		Ok(())394	}395396	fn check_allowed(397		collection: &FungibleHandle<T>,398		spender: &T::CrossAccountId,399		from: &T::CrossAccountId,400		amount: u128,401		nesting_budget: &dyn Budget,402	) -> Result<Option<u128>, DispatchError> {403		if spender.conv_eq(from) {404			return Ok(None);405		}406		if collection.permissions.access() == AccessMode::AllowList {407			// `from`, `to` checked in [`transfer`]408			collection.check_allowlist(spender)?;409		}410		if let Some(source) = T::CrossTokenAddressMapping::address_to_token(from) {411			// TODO: should collection owner be allowed to perform this transfer?412			ensure!(413				<PalletStructure<T>>::check_indirectly_owned(414					spender.clone(),415					source.0,416					source.1,417					None,418					nesting_budget419				)?,420				<CommonError<T>>::ApprovedValueTooLow,421			);422			return Ok(None);423		}424		let allowance = <Allowance<T>>::get((collection.id, from, spender)).checked_sub(amount);425		if allowance.is_none() {426			ensure!(427				collection.ignores_allowance(spender),428				<CommonError<T>>::ApprovedValueTooLow429			);430		}431432		Ok(allowance)433	}434435	pub fn transfer_from(436		collection: &FungibleHandle<T>,437		spender: &T::CrossAccountId,438		from: &T::CrossAccountId,439		to: &T::CrossAccountId,440		amount: u128,441		nesting_budget: &dyn Budget,442	) -> DispatchResult {443		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;444445		// =========446447		Self::transfer(collection, from, to, amount, nesting_budget)?;448		if let Some(allowance) = allowance {449			Self::set_allowance_unchecked(collection, from, spender, allowance);450		}451		Ok(())452	}453454	pub fn burn_from(455		collection: &FungibleHandle<T>,456		spender: &T::CrossAccountId,457		from: &T::CrossAccountId,458		amount: u128,459		nesting_budget: &dyn Budget,460	) -> DispatchResult {461		let allowance = Self::check_allowed(collection, spender, from, amount, nesting_budget)?;462463		// =========464465		Self::burn(collection, from, amount)?;466		if let Some(allowance) = allowance {467			Self::set_allowance_unchecked(collection, from, spender, allowance);468		}469		Ok(())470	}471472	/// Delegated to `create_multiple_items`473	pub fn create_item(474		collection: &FungibleHandle<T>,475		sender: &T::CrossAccountId,476		data: CreateItemData<T>,477		nesting_budget: &dyn Budget,478	) -> DispatchResult {479		Self::create_multiple_items(480			collection,481			sender,482			[(data.0, data.1)].into_iter().collect(),483			nesting_budget,484		)485	}486}