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

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//! # Refungible Pallet EVM API for token pieces18//!19//! Provides ERC-20 standart support implementation and EVM API for unique extensions for Refungible Pallet.20//! Method implementations are mostly doing parameter conversion and calling Nonfungible Pallet methods.2122extern crate alloc;2324#[cfg(not(feature = "std"))]25use alloc::format;2627use core::{28	char::{REPLACEMENT_CHARACTER, decode_utf16},29	convert::TryInto,30	ops::Deref,31};32use evm_coder::{ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};33use pallet_common::{34	CommonWeightInfo,35	erc::{CommonEvmHandler, PrecompileResult, static_property::key},36	eth::map_eth_to_id,37};38use pallet_evm::{account::CrossAccountId, PrecompileHandle};39use pallet_evm_coder_substrate::{call, dispatch_to_evm, WithRecorder};40use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};41use sp_core::H160;42use sp_std::vec::Vec;43use up_data_structs::{mapping::TokenAddressMapping, PropertyScope, TokenId};4445use crate::{46	Allowance, Balance, common::CommonWeights, Config, Pallet, RefungibleHandle, SelfWeightOf,47	TokenProperties, TotalSupply, weights::WeightInfo,48};4950pub struct RefungibleTokenHandle<T: Config>(pub RefungibleHandle<T>, pub TokenId);5152#[solidity_interface(name = "ERC1633")]53impl<T: Config> RefungibleTokenHandle<T> {54	fn parent_token(&self) -> Result<address> {55		self.consume_store_reads(2)?;56		let props = <TokenProperties<T>>::get((self.id, self.1));57		let key = key::parent_nft();5859		let key_scoped = PropertyScope::Eth60			.apply(key)61			.expect("property key shouldn't exceed length limit");62		if let Some(value) = props.get(&key_scoped) {63			Ok(H160::from_slice(value.as_slice()))64		} else {65			Ok(*T::CrossTokenAddressMapping::token_to_address(self.id, self.1).as_eth())66		}67	}6869	fn parent_token_id(&self) -> Result<uint256> {70		self.consume_store_reads(2)?;71		let props = <TokenProperties<T>>::get((self.id, self.1));72		let key = key::parent_nft();7374		let key_scoped = PropertyScope::Eth75			.apply(key)76			.expect("property key shouldn't exceed length limit");77		if let Some(value) = props.get(&key_scoped) {78			let nft_token_address = H160::from_slice(value.as_slice());79			let nft_token_account = T::CrossAccountId::from_eth(nft_token_address);80			let (_, token_id) = T::CrossTokenAddressMapping::address_to_token(&nft_token_account)81				.ok_or("parent NFT should contain NFT token address")?;8283			Ok(token_id.into())84		} else {85			Ok(self.1.into())86		}87	}88}8990#[solidity_interface(name = "ERC1633UniqueExtensions")]91impl<T: Config> RefungibleTokenHandle<T> {92	#[solidity(rename_selector = "setParentNFT")]93	#[weight(<CommonWeights<T>>::token_owner() + <SelfWeightOf<T>>::set_parent_nft_unchecked())]94	fn set_parent_nft(95		&mut self,96		caller: caller,97		collection: address,98		nft_id: uint256,99	) -> Result<bool> {100		self.consume_store_reads(1)?;101		let caller = T::CrossAccountId::from_eth(caller);102		let nft_collection = map_eth_to_id(&collection).ok_or("collection not found")?;103		let nft_token = nft_id.try_into()?;104105		<Pallet<T>>::set_parent_nft(&self.0, self.1, caller, nft_collection, nft_token)106			.map_err(dispatch_to_evm::<T>)?;107108		Ok(true)109	}110}111112#[derive(ToLog)]113pub enum ERC20Events {114	/// @dev This event is emitted when the amount of tokens (value) is sent115	/// from the from address to the to address. In the case of minting new116	/// tokens, the transfer is usually from the 0 address while in the case117	/// of burning tokens the transfer is to 0.118	Transfer {119		#[indexed]120		from: address,121		#[indexed]122		to: address,123		value: uint256,124	},125	/// @dev This event is emitted when the amount of tokens (value) is approved126	/// by the owner to be used by the spender.127	Approval {128		#[indexed]129		owner: address,130		#[indexed]131		spender: address,132		value: uint256,133	},134}135136/// @title Standard ERC20 token137///138/// @dev Implementation of the basic standard token.139/// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md140#[solidity_interface(name = "ERC20", events(ERC20Events))]141impl<T: Config> RefungibleTokenHandle<T> {142	/// @return the name of the token.143	fn name(&self) -> Result<string> {144		Ok(decode_utf16(self.name.iter().copied())145			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))146			.collect::<string>())147	}148149	/// @return the symbol of the token.150	fn symbol(&self) -> Result<string> {151		Ok(string::from_utf8_lossy(&self.token_prefix).into())152	}153154	/// @dev Total number of tokens in existence155	fn total_supply(&self) -> Result<uint256> {156		self.consume_store_reads(1)?;157		Ok(<TotalSupply<T>>::get((self.id, self.1)).into())158	}159160	/// @dev Not supported161	fn decimals(&self) -> Result<uint8> {162		// Decimals aren't supported for refungible tokens163		Ok(0)164	}165166	/// @dev Gets the balance of the specified address.167	/// @param owner The address to query the balance of.168	/// @return An uint256 representing the amount owned by the passed address.169	fn balance_of(&self, owner: address) -> Result<uint256> {170		self.consume_store_reads(1)?;171		let owner = T::CrossAccountId::from_eth(owner);172		let balance = <Balance<T>>::get((self.id, self.1, owner));173		Ok(balance.into())174	}175176	/// @dev Transfer token for a specified address177	/// @param to The address to transfer to.178	/// @param amount The amount to be transferred.179	#[weight(<CommonWeights<T>>::transfer())]180	fn transfer(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {181		let caller = T::CrossAccountId::from_eth(caller);182		let to = T::CrossAccountId::from_eth(to);183		let amount = amount.try_into().map_err(|_| "amount overflow")?;184		let budget = self185			.recorder186			.weight_calls_budget(<StructureWeight<T>>::find_parent());187188		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)189			.map_err(dispatch_to_evm::<T>)?;190		Ok(true)191	}192193	/// @dev Transfer tokens from one address to another194	/// @param from address The address which you want to send tokens from195	/// @param to address The address which you want to transfer to196	/// @param amount uint256 the amount of tokens to be transferred197	#[weight(<CommonWeights<T>>::transfer_from())]198	fn transfer_from(199		&mut self,200		caller: caller,201		from: address,202		to: address,203		amount: uint256,204	) -> Result<bool> {205		let caller = T::CrossAccountId::from_eth(caller);206		let from = T::CrossAccountId::from_eth(from);207		let to = T::CrossAccountId::from_eth(to);208		let amount = amount.try_into().map_err(|_| "amount overflow")?;209		let budget = self210			.recorder211			.weight_calls_budget(<StructureWeight<T>>::find_parent());212213		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)214			.map_err(dispatch_to_evm::<T>)?;215		Ok(true)216	}217218	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.219	/// Beware that changing an allowance with this method brings the risk that someone may use both the old220	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this221	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:222	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729223	/// @param spender The address which will spend the funds.224	/// @param amount The amount of tokens to be spent.225	#[weight(<SelfWeightOf<T>>::approve())]226	fn approve(&mut self, caller: caller, spender: address, amount: uint256) -> Result<bool> {227		let caller = T::CrossAccountId::from_eth(caller);228		let spender = T::CrossAccountId::from_eth(spender);229		let amount = amount.try_into().map_err(|_| "amount overflow")?;230231		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)232			.map_err(dispatch_to_evm::<T>)?;233		Ok(true)234	}235236	/// @dev Function to check the amount of tokens that an owner allowed to a spender.237	/// @param owner address The address which owns the funds.238	/// @param spender address The address which will spend the funds.239	/// @return A uint256 specifying the amount of tokens still available for the spender.240	fn allowance(&self, owner: address, spender: address) -> Result<uint256> {241		self.consume_store_reads(1)?;242		let owner = T::CrossAccountId::from_eth(owner);243		let spender = T::CrossAccountId::from_eth(spender);244245		Ok(<Allowance<T>>::get((self.id, self.1, owner, spender)).into())246	}247}248249#[solidity_interface(name = "ERC20UniqueExtensions")]250impl<T: Config> RefungibleTokenHandle<T> {251	/// @dev Function that burns an amount of the token of a given account,252	/// deducting from the sender's allowance for said account.253	/// @param from The account whose tokens will be burnt.254	/// @param amount The amount that will be burnt.255	#[weight(<SelfWeightOf<T>>::burn_from())]256	fn burn_from(&mut self, caller: caller, from: address, amount: uint256) -> Result<bool> {257		let caller = T::CrossAccountId::from_eth(caller);258		let from = T::CrossAccountId::from_eth(from);259		let amount = amount.try_into().map_err(|_| "amount overflow")?;260		let budget = self261			.recorder262			.weight_calls_budget(<StructureWeight<T>>::find_parent());263264		<Pallet<T>>::burn_from(self, &caller, &from, self.1, amount, &budget)265			.map_err(dispatch_to_evm::<T>)?;266		Ok(true)267	}268269	/// @dev Function that changes total amount of the tokens.270	///  Throws if `msg.sender` doesn't owns all of the tokens.271	/// @param amount New total amount of the tokens.272	#[weight(<SelfWeightOf<T>>::repartition_item())]273	fn repartition(&mut self, caller: caller, amount: uint256) -> Result<bool> {274		let caller = T::CrossAccountId::from_eth(caller);275		let amount = amount.try_into().map_err(|_| "amount overflow")?;276277		<Pallet<T>>::repartition(self, &caller, self.1, amount).map_err(dispatch_to_evm::<T>)?;278		Ok(true)279	}280}281282impl<T: Config> RefungibleTokenHandle<T> {283	pub fn into_inner(self) -> RefungibleHandle<T> {284		self.0285	}286	pub fn common_mut(&mut self) -> &mut RefungibleHandle<T> {287		&mut self.0288	}289}290291impl<T: Config> WithRecorder<T> for RefungibleTokenHandle<T> {292	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {293		self.0.recorder()294	}295	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {296		self.0.into_recorder()297	}298}299300impl<T: Config> Deref for RefungibleTokenHandle<T> {301	type Target = RefungibleHandle<T>;302303	fn deref(&self) -> &Self::Target {304		&self.0305	}306}307308#[solidity_interface(309	name = "UniqueRefungibleToken",310	is(ERC20, ERC20UniqueExtensions, ERC1633, ERC1633UniqueExtensions)311)]312impl<T: Config> RefungibleTokenHandle<T> where T::AccountId: From<[u8; 32]> {}313314generate_stubgen!(gen_impl, UniqueRefungibleTokenCall<()>, true);315generate_stubgen!(gen_iface, UniqueRefungibleTokenCall<()>, false);316317impl<T: Config> CommonEvmHandler for RefungibleTokenHandle<T>318where319	T::AccountId: From<[u8; 32]>,320{321	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungibleToken.raw");322323	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {324		call::<T, UniqueRefungibleTokenCall<T>, _, _>(handle, self)325	}326}