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

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_interface, types::*, weight};33use pallet_common::{34	CommonWeightInfo,35	erc::{CommonEvmHandler, PrecompileResult}, eth::collection_id_to_address,36};37use pallet_evm::{account::CrossAccountId, PrecompileHandle};38use pallet_evm_coder_substrate::{call, dispatch_to_evm, WithRecorder};39use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};40use sp_std::vec::Vec;41use up_data_structs::TokenId;4243use crate::{44	Allowance, Balance, common::CommonWeights, Config, Pallet, RefungibleHandle, SelfWeightOf,45	TotalSupply, weights::WeightInfo,46};4748pub struct RefungibleTokenHandle<T: Config>(pub RefungibleHandle<T>, pub TokenId);4950#[solidity_interface(name = ERC1633)]51impl<T: Config> RefungibleTokenHandle<T> {52	fn parent_token(&self) -> Result<address> {53		Ok(collection_id_to_address(self.id))54	}5556	fn parent_token_id(&self) -> Result<uint256> {57		Ok(self.1.into())58	}59}6061#[derive(ToLog)]62pub enum ERC20Events {63	/// @dev This event is emitted when the amount of tokens (value) is sent64	/// from the from address to the to address. In the case of minting new65	/// tokens, the transfer is usually from the 0 address while in the case66	/// of burning tokens the transfer is to 0.67	Transfer {68		#[indexed]69		from: address,70		#[indexed]71		to: address,72		value: uint256,73	},74	/// @dev This event is emitted when the amount of tokens (value) is approved75	/// by the owner to be used by the spender.76	Approval {77		#[indexed]78		owner: address,79		#[indexed]80		spender: address,81		value: uint256,82	},83}8485/// @title Standard ERC20 token86///87/// @dev Implementation of the basic standard token.88/// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md89#[solidity_interface(name = ERC20, events(ERC20Events))]90impl<T: Config> RefungibleTokenHandle<T> {91	/// @return the name of the token.92	fn name(&self) -> Result<string> {93		Ok(decode_utf16(self.name.iter().copied())94			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))95			.collect::<string>())96	}9798	/// @return the symbol of the token.99	fn symbol(&self) -> Result<string> {100		Ok(string::from_utf8_lossy(&self.token_prefix).into())101	}102103	/// @dev Total number of tokens in existence104	fn total_supply(&self) -> Result<uint256> {105		self.consume_store_reads(1)?;106		Ok(<TotalSupply<T>>::get((self.id, self.1)).into())107	}108109	/// @dev Not supported110	fn decimals(&self) -> Result<uint8> {111		// Decimals aren't supported for refungible tokens112		Ok(0)113	}114115	/// @dev Gets the balance of the specified address.116	/// @param owner The address to query the balance of.117	/// @return An uint256 representing the amount owned by the passed address.118	fn balance_of(&self, owner: address) -> Result<uint256> {119		self.consume_store_reads(1)?;120		let owner = T::CrossAccountId::from_eth(owner);121		let balance = <Balance<T>>::get((self.id, self.1, owner));122		Ok(balance.into())123	}124125	/// @dev Transfer token for a specified address126	/// @param to The address to transfer to.127	/// @param amount The amount to be transferred.128	#[weight(<CommonWeights<T>>::transfer())]129	fn transfer(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {130		let caller = T::CrossAccountId::from_eth(caller);131		let to = T::CrossAccountId::from_eth(to);132		let amount = amount.try_into().map_err(|_| "amount overflow")?;133		let budget = self134			.recorder135			.weight_calls_budget(<StructureWeight<T>>::find_parent());136137		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)138			.map_err(dispatch_to_evm::<T>)?;139		Ok(true)140	}141142	/// @dev Transfer tokens from one address to another143	/// @param from address The address which you want to send tokens from144	/// @param to address The address which you want to transfer to145	/// @param amount uint256 the amount of tokens to be transferred146	#[weight(<CommonWeights<T>>::transfer_from())]147	fn transfer_from(148		&mut self,149		caller: caller,150		from: address,151		to: address,152		amount: uint256,153	) -> Result<bool> {154		let caller = T::CrossAccountId::from_eth(caller);155		let from = T::CrossAccountId::from_eth(from);156		let to = T::CrossAccountId::from_eth(to);157		let amount = amount.try_into().map_err(|_| "amount overflow")?;158		let budget = self159			.recorder160			.weight_calls_budget(<StructureWeight<T>>::find_parent());161162		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)163			.map_err(dispatch_to_evm::<T>)?;164		Ok(true)165	}166167	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.168	/// Beware that changing an allowance with this method brings the risk that someone may use both the old169	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this170	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:171	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729172	/// @param spender The address which will spend the funds.173	/// @param amount The amount of tokens to be spent.174	#[weight(<SelfWeightOf<T>>::approve())]175	fn approve(&mut self, caller: caller, spender: address, amount: uint256) -> Result<bool> {176		let caller = T::CrossAccountId::from_eth(caller);177		let spender = T::CrossAccountId::from_eth(spender);178		let amount = amount.try_into().map_err(|_| "amount overflow")?;179180		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)181			.map_err(dispatch_to_evm::<T>)?;182		Ok(true)183	}184185	/// @dev Function to check the amount of tokens that an owner allowed to a spender.186	/// @param owner address The address which owns the funds.187	/// @param spender address The address which will spend the funds.188	/// @return A uint256 specifying the amount of tokens still available for the spender.189	fn allowance(&self, owner: address, spender: address) -> Result<uint256> {190		self.consume_store_reads(1)?;191		let owner = T::CrossAccountId::from_eth(owner);192		let spender = T::CrossAccountId::from_eth(spender);193194		Ok(<Allowance<T>>::get((self.id, self.1, owner, spender)).into())195	}196}197198#[solidity_interface(name = ERC20UniqueExtensions)]199impl<T: Config> RefungibleTokenHandle<T> {200	/// @dev Function that burns an amount of the token of a given account,201	/// deducting from the sender's allowance for said account.202	/// @param from The account whose tokens will be burnt.203	/// @param amount The amount that will be burnt.204	#[weight(<SelfWeightOf<T>>::burn_from())]205	fn burn_from(&mut self, caller: caller, from: address, amount: uint256) -> Result<bool> {206		let caller = T::CrossAccountId::from_eth(caller);207		let from = T::CrossAccountId::from_eth(from);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>>::burn_from(self, &caller, &from, self.1, amount, &budget)214			.map_err(dispatch_to_evm::<T>)?;215		Ok(true)216	}217218	/// @dev Function that changes total amount of the tokens.219	///  Throws if `msg.sender` doesn't owns all of the tokens.220	/// @param amount New total amount of the tokens.221	#[weight(<SelfWeightOf<T>>::repartition_item())]222	fn repartition(&mut self, caller: caller, amount: uint256) -> Result<bool> {223		let caller = T::CrossAccountId::from_eth(caller);224		let amount = amount.try_into().map_err(|_| "amount overflow")?;225226		<Pallet<T>>::repartition(self, &caller, self.1, amount).map_err(dispatch_to_evm::<T>)?;227		Ok(true)228	}229}230231impl<T: Config> RefungibleTokenHandle<T> {232	pub fn into_inner(self) -> RefungibleHandle<T> {233		self.0234	}235	pub fn common_mut(&mut self) -> &mut RefungibleHandle<T> {236		&mut self.0237	}238}239240impl<T: Config> WithRecorder<T> for RefungibleTokenHandle<T> {241	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {242		self.0.recorder()243	}244	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {245		self.0.into_recorder()246	}247}248249impl<T: Config> Deref for RefungibleTokenHandle<T> {250	type Target = RefungibleHandle<T>;251252	fn deref(&self) -> &Self::Target {253		&self.0254	}255}256257#[solidity_interface(258	name = UniqueRefungibleToken,259	is(ERC20, ERC20UniqueExtensions, ERC1633)260)]261impl<T: Config> RefungibleTokenHandle<T> where T::AccountId: From<[u8; 32]> {}262263generate_stubgen!(gen_impl, UniqueRefungibleTokenCall<()>, true);264generate_stubgen!(gen_iface, UniqueRefungibleTokenCall<()>, false);265266impl<T: Config> CommonEvmHandler for RefungibleTokenHandle<T>267where268	T::AccountId: From<[u8; 32]>,269{270	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungibleToken.raw");271272	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {273		call::<T, UniqueRefungibleTokenCall<T>, _, _>(handle, self)274	}275}