git.delta.rocks / unique-network / refs/commits / 540966542a36

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.2122use core::{23	char::{REPLACEMENT_CHARACTER, decode_utf16},24	convert::TryInto,25	ops::Deref,26};27use evm_coder::{28	abi::AbiType, ToLog, execution::*, generate_stubgen, solidity_interface, types::*, weight,29};30use pallet_common::{31	CommonWeightInfo,32	erc::{CommonEvmHandler, PrecompileResult},33	eth::collection_id_to_address,34};35use pallet_evm::{account::CrossAccountId, PrecompileHandle};36use pallet_evm_coder_substrate::{call, dispatch_to_evm, WithRecorder};37use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};38use sp_std::vec::Vec;39use up_data_structs::TokenId;4041use crate::{42	Allowance, Balance, common::CommonWeights, Config, Pallet, RefungibleHandle, SelfWeightOf,43	TotalSupply, weights::WeightInfo,44};4546/// Refungible token handle contains information about token's collection and id47///48/// RefungibleTokenHandle doesn't check token's existance upon creation49pub struct RefungibleTokenHandle<T: Config>(pub RefungibleHandle<T>, pub TokenId);5051#[solidity_interface(name = ERC1633)]52impl<T: Config> RefungibleTokenHandle<T> {53	fn parent_token(&self) -> Result<address> {54		Ok(collection_id_to_address(self.id))55	}5657	fn parent_token_id(&self) -> Result<uint256> {58		Ok(self.1.into())59	}60}6162#[derive(ToLog)]63pub enum ERC20Events {64	/// @dev This event is emitted when the amount of tokens (value) is sent65	/// from the from address to the to address. In the case of minting new66	/// tokens, the transfer is usually from the 0 address while in the case67	/// of burning tokens the transfer is to 0.68	Transfer {69		#[indexed]70		from: address,71		#[indexed]72		to: address,73		value: uint256,74	},75	/// @dev This event is emitted when the amount of tokens (value) is approved76	/// by the owner to be used by the spender.77	Approval {78		#[indexed]79		owner: address,80		#[indexed]81		spender: address,82		value: uint256,83	},84}8586/// @title Standard ERC20 token87///88/// @dev Implementation of the basic standard token.89/// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md90#[solidity_interface(name = ERC20, events(ERC20Events))]91impl<T: Config> RefungibleTokenHandle<T> {92	/// @return the name of the token.93	fn name(&self) -> Result<string> {94		Ok(decode_utf16(self.name.iter().copied())95			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))96			.collect::<string>())97	}9899	/// @return the symbol of the token.100	fn symbol(&self) -> Result<string> {101		Ok(string::from_utf8_lossy(&self.token_prefix).into())102	}103104	/// @dev Total number of tokens in existence105	fn total_supply(&self) -> Result<uint256> {106		self.consume_store_reads(1)?;107		Ok(<TotalSupply<T>>::get((self.id, self.1)).into())108	}109110	/// @dev Not supported111	fn decimals(&self) -> Result<uint8> {112		// Decimals aren't supported for refungible tokens113		Ok(0)114	}115116	/// @dev Gets the balance of the specified address.117	/// @param owner The address to query the balance of.118	/// @return An uint256 representing the amount owned by the passed address.119	fn balance_of(&self, owner: address) -> Result<uint256> {120		self.consume_store_reads(1)?;121		let owner = T::CrossAccountId::from_eth(owner);122		let balance = <Balance<T>>::get((self.id, self.1, owner));123		Ok(balance.into())124	}125126	/// @dev Transfer token for a specified address127	/// @param to The address to transfer to.128	/// @param amount The amount to be transferred.129	#[weight(<CommonWeights<T>>::transfer())]130	fn transfer(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {131		let caller = T::CrossAccountId::from_eth(caller);132		let to = T::CrossAccountId::from_eth(to);133		let amount = amount.try_into().map_err(|_| "amount overflow")?;134		let budget = self135			.recorder136			.weight_calls_budget(<StructureWeight<T>>::find_parent());137138		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)139			.map_err(dispatch_to_evm::<T>)?;140		Ok(true)141	}142143	/// @dev Transfer tokens from one address to another144	/// @param from address The address which you want to send tokens from145	/// @param to address The address which you want to transfer to146	/// @param amount uint256 the amount of tokens to be transferred147	#[weight(<CommonWeights<T>>::transfer_from())]148	fn transfer_from(149		&mut self,150		caller: caller,151		from: address,152		to: address,153		amount: uint256,154	) -> Result<bool> {155		let caller = T::CrossAccountId::from_eth(caller);156		let from = T::CrossAccountId::from_eth(from);157		let to = T::CrossAccountId::from_eth(to);158		let amount = amount.try_into().map_err(|_| "amount overflow")?;159		let budget = self160			.recorder161			.weight_calls_budget(<StructureWeight<T>>::find_parent());162163		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)164			.map_err(dispatch_to_evm::<T>)?;165		Ok(true)166	}167168	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.169	/// Beware that changing an allowance with this method brings the risk that someone may use both the old170	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this171	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:172	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729173	/// @param spender The address which will spend the funds.174	/// @param amount The amount of tokens to be spent.175	#[weight(<SelfWeightOf<T>>::approve())]176	fn approve(&mut self, caller: caller, spender: address, amount: uint256) -> Result<bool> {177		let caller = T::CrossAccountId::from_eth(caller);178		let spender = T::CrossAccountId::from_eth(spender);179		let amount = amount.try_into().map_err(|_| "amount overflow")?;180181		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)182			.map_err(dispatch_to_evm::<T>)?;183		Ok(true)184	}185186	/// @dev Function to check the amount of tokens that an owner allowed to a spender.187	/// @param owner address The address which owns the funds.188	/// @param spender address The address which will spend the funds.189	/// @return A uint256 specifying the amount of tokens still available for the spender.190	fn allowance(&self, owner: address, spender: address) -> Result<uint256> {191		self.consume_store_reads(1)?;192		let owner = T::CrossAccountId::from_eth(owner);193		let spender = T::CrossAccountId::from_eth(spender);194195		Ok(<Allowance<T>>::get((self.id, self.1, owner, spender)).into())196	}197}198199#[solidity_interface(name = ERC20UniqueExtensions)]200impl<T: Config> RefungibleTokenHandle<T>201where202	T::AccountId: From<[u8; 32]>,203{204	/// @dev Function that burns an amount of the token of a given account,205	/// deducting from the sender's allowance for said account.206	/// @param from The account whose tokens will be burnt.207	/// @param amount The amount that will be burnt.208	#[weight(<SelfWeightOf<T>>::burn_from())]209	fn burn_from(&mut self, caller: caller, from: address, amount: uint256) -> Result<bool> {210		let caller = T::CrossAccountId::from_eth(caller);211		let from = T::CrossAccountId::from_eth(from);212		let amount = amount.try_into().map_err(|_| "amount overflow")?;213		let budget = self214			.recorder215			.weight_calls_budget(<StructureWeight<T>>::find_parent());216217		<Pallet<T>>::burn_from(self, &caller, &from, self.1, amount, &budget)218			.map_err(dispatch_to_evm::<T>)?;219		Ok(true)220	}221222	/// @dev Function that burns an amount of the token of a given account,223	/// deducting from the sender's allowance for said account.224	/// @param from The account whose tokens will be burnt.225	/// @param amount The amount that will be burnt.226	#[weight(<SelfWeightOf<T>>::burn_from())]227	fn burn_from_cross(228		&mut self,229		caller: caller,230		from: pallet_common::eth::CrossAddress,231		amount: uint256,232	) -> Result<bool> {233		let caller = T::CrossAccountId::from_eth(caller);234		let from = from.into_sub_cross_account::<T>()?;235		let amount = amount.try_into().map_err(|_| "amount overflow")?;236		let budget = self237			.recorder238			.weight_calls_budget(<StructureWeight<T>>::find_parent());239240		<Pallet<T>>::burn_from(self, &caller, &from, self.1, amount, &budget)241			.map_err(dispatch_to_evm::<T>)?;242		Ok(true)243	}244245	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.246	/// Beware that changing an allowance with this method brings the risk that someone may use both the old247	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this248	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:249	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729250	/// @param spender The crossaccount which will spend the funds.251	/// @param amount The amount of tokens to be spent.252	#[weight(<SelfWeightOf<T>>::approve())]253	fn approve_cross(254		&mut self,255		caller: caller,256		spender: pallet_common::eth::CrossAddress,257		amount: uint256,258	) -> Result<bool> {259		let caller = T::CrossAccountId::from_eth(caller);260		let spender = spender.into_sub_cross_account::<T>()?;261		let amount = amount.try_into().map_err(|_| "amount overflow")?;262263		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)264			.map_err(dispatch_to_evm::<T>)?;265		Ok(true)266	}267	/// @dev Function that changes total amount of the tokens.268	///  Throws if `msg.sender` doesn't owns all of the tokens.269	/// @param amount New total amount of the tokens.270	#[weight(<SelfWeightOf<T>>::repartition_item())]271	fn repartition(&mut self, caller: caller, amount: uint256) -> Result<bool> {272		let caller = T::CrossAccountId::from_eth(caller);273		let amount = amount.try_into().map_err(|_| "amount overflow")?;274275		<Pallet<T>>::repartition(self, &caller, self.1, amount).map_err(dispatch_to_evm::<T>)?;276		Ok(true)277	}278279	/// @dev Transfer token for a specified address280	/// @param to The crossaccount to transfer to.281	/// @param amount The amount to be transferred.282	#[weight(<CommonWeights<T>>::transfer())]283	fn transfer_cross(284		&mut self,285		caller: caller,286		to: pallet_common::eth::CrossAddress,287		amount: uint256,288	) -> Result<bool> {289		let caller = T::CrossAccountId::from_eth(caller);290		let to = to.into_sub_cross_account::<T>()?;291		let amount = amount.try_into().map_err(|_| "amount overflow")?;292		let budget = self293			.recorder294			.weight_calls_budget(<StructureWeight<T>>::find_parent());295296		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)297			.map_err(dispatch_to_evm::<T>)?;298		Ok(true)299	}300301	/// @dev Transfer tokens from one address to another302	/// @param from The address which you want to send tokens from303	/// @param to The address which you want to transfer to304	/// @param amount the amount of tokens to be transferred305	#[weight(<CommonWeights<T>>::transfer_from())]306	fn transfer_from_cross(307		&mut self,308		caller: caller,309		from: pallet_common::eth::CrossAddress,310		to: pallet_common::eth::CrossAddress,311		amount: uint256,312	) -> Result<bool> {313		let caller = T::CrossAccountId::from_eth(caller);314		let from = from.into_sub_cross_account::<T>()?;315		let to = to.into_sub_cross_account::<T>()?;316		let amount = amount.try_into().map_err(|_| "amount overflow")?;317		let budget = self318			.recorder319			.weight_calls_budget(<StructureWeight<T>>::find_parent());320321		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)322			.map_err(dispatch_to_evm::<T>)?;323		Ok(true)324	}325}326327impl<T: Config> RefungibleTokenHandle<T> {328	pub fn into_inner(self) -> RefungibleHandle<T> {329		self.0330	}331	pub fn common_mut(&mut self) -> &mut RefungibleHandle<T> {332		&mut self.0333	}334}335336impl<T: Config> WithRecorder<T> for RefungibleTokenHandle<T> {337	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {338		self.0.recorder()339	}340	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {341		self.0.into_recorder()342	}343}344345impl<T: Config> Deref for RefungibleTokenHandle<T> {346	type Target = RefungibleHandle<T>;347348	fn deref(&self) -> &Self::Target {349		&self.0350	}351}352353#[solidity_interface(354	name = UniqueRefungibleToken,355	is(ERC20, ERC20UniqueExtensions, ERC1633)356)]357impl<T: Config> RefungibleTokenHandle<T> where T::AccountId: From<[u8; 32]> {}358359generate_stubgen!(gen_impl, UniqueRefungibleTokenCall<()>, true);360generate_stubgen!(gen_iface, UniqueRefungibleTokenCall<()>, false);361362impl<T: Config> CommonEvmHandler for RefungibleTokenHandle<T>363where364	T::AccountId: From<[u8; 32]>,365{366	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungibleToken.raw");367368	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {369		call::<T, UniqueRefungibleTokenCall<T>, _, _>(handle, self)370	}371}