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

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, solidity, types::*,29	weight,30};31use pallet_common::{32	CommonWeightInfo,33	erc::{CommonEvmHandler, PrecompileResult},34	eth::collection_id_to_address,35};36use pallet_evm::{account::CrossAccountId, PrecompileHandle};37use pallet_evm_coder_substrate::{call, dispatch_to_evm, WithRecorder};38use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};39use sp_std::vec::Vec;40use sp_core::U256;41use up_data_structs::TokenId;4243use crate::{44	Allowance, Balance, common::CommonWeights, Config, Pallet, RefungibleHandle, SelfWeightOf,45	TotalSupply, weights::WeightInfo,46};4748/// Refungible token handle contains information about token's collection and id49///50/// RefungibleTokenHandle doesn't check token's existance upon creation51pub struct RefungibleTokenHandle<T: Config>(pub RefungibleHandle<T>, pub TokenId);5253#[solidity_interface(name = ERC1633)]54impl<T: Config> RefungibleTokenHandle<T> {55	fn parent_token(&self) -> Result<Address> {56		Ok(collection_id_to_address(self.id))57	}5859	fn parent_token_id(&self) -> Result<U256> {60		Ok(self.1.into())61	}62}6364#[derive(ToLog)]65pub enum ERC20Events {66	/// @dev This event is emitted when the amount of tokens (value) is sent67	/// from the from address to the to address. In the case of minting new68	/// tokens, the transfer is usually from the 0 address while in the case69	/// of burning tokens the transfer is to 0.70	Transfer {71		#[indexed]72		from: Address,73		#[indexed]74		to: Address,75		value: U256,76	},77	/// @dev This event is emitted when the amount of tokens (value) is approved78	/// by the owner to be used by the spender.79	Approval {80		#[indexed]81		owner: Address,82		#[indexed]83		spender: Address,84		value: U256,85	},86}8788/// @title Standard ERC20 token89///90/// @dev Implementation of the basic standard token.91/// https://github.com/ethereum/EIPs/blob/master/EIPS/eip-20.md92#[solidity_interface(name = ERC20, events(ERC20Events))]93impl<T: Config> RefungibleTokenHandle<T> {94	/// @return the name of the token.95	fn name(&self) -> Result<String> {96		Ok(decode_utf16(self.name.iter().copied())97			.map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))98			.collect::<String>())99	}100101	/// @return the symbol of the token.102	fn symbol(&self) -> Result<String> {103		Ok(String::from_utf8_lossy(&self.token_prefix).into())104	}105106	/// @dev Total number of tokens in existence107	fn total_supply(&self) -> Result<U256> {108		self.consume_store_reads(1)?;109		Ok(<TotalSupply<T>>::get((self.id, self.1)).into())110	}111112	/// @dev Not supported113	fn decimals(&self) -> Result<u8> {114		// Decimals aren't supported for refungible tokens115		Ok(0)116	}117118	/// @dev Gets the balance of the specified address.119	/// @param owner The address to query the balance of.120	/// @return An uint256 representing the amount owned by the passed address.121	fn balance_of(&self, owner: Address) -> Result<U256> {122		self.consume_store_reads(1)?;123		let owner = T::CrossAccountId::from_eth(owner);124		let balance = <Balance<T>>::get((self.id, self.1, owner));125		Ok(balance.into())126	}127128	/// @dev Transfer token for a specified address129	/// @param to The address to transfer to.130	/// @param amount The amount to be transferred.131	#[weight(<CommonWeights<T>>::transfer())]132	fn transfer(&mut self, caller: Caller, to: Address, amount: U256) -> Result<bool> {133		let caller = T::CrossAccountId::from_eth(caller);134		let to = T::CrossAccountId::from_eth(to);135		let amount = amount.try_into().map_err(|_| "amount overflow")?;136		let budget = self137			.recorder138			.weight_calls_budget(<StructureWeight<T>>::find_parent());139140		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)141			.map_err(dispatch_to_evm::<T>)?;142		Ok(true)143	}144145	/// @dev Transfer tokens from one address to another146	/// @param from address The address which you want to send tokens from147	/// @param to address The address which you want to transfer to148	/// @param amount uint256 the amount of tokens to be transferred149	#[weight(<CommonWeights<T>>::transfer_from())]150	fn transfer_from(151		&mut self,152		caller: Caller,153		from: Address,154		to: Address,155		amount: U256,156	) -> Result<bool> {157		let caller = T::CrossAccountId::from_eth(caller);158		let from = T::CrossAccountId::from_eth(from);159		let to = T::CrossAccountId::from_eth(to);160		let amount = amount.try_into().map_err(|_| "amount overflow")?;161		let budget = self162			.recorder163			.weight_calls_budget(<StructureWeight<T>>::find_parent());164165		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)166			.map_err(dispatch_to_evm::<T>)?;167		Ok(true)168	}169170	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.171	/// Beware that changing an allowance with this method brings the risk that someone may use both the old172	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this173	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:174	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729175	/// @param spender The address which will spend the funds.176	/// @param amount The amount of tokens to be spent.177	#[weight(<SelfWeightOf<T>>::approve())]178	fn approve(&mut self, caller: Caller, spender: Address, amount: U256) -> Result<bool> {179		let caller = T::CrossAccountId::from_eth(caller);180		let spender = T::CrossAccountId::from_eth(spender);181		let amount = amount.try_into().map_err(|_| "amount overflow")?;182183		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)184			.map_err(dispatch_to_evm::<T>)?;185		Ok(true)186	}187188	/// @dev Function to check the amount of tokens that an owner allowed to a spender.189	/// @param owner address The address which owns the funds.190	/// @param spender address The address which will spend the funds.191	/// @return A uint256 specifying the amount of tokens still available for the spender.192	fn allowance(&self, owner: Address, spender: Address) -> Result<U256> {193		self.consume_store_reads(1)?;194		let owner = T::CrossAccountId::from_eth(owner);195		let spender = T::CrossAccountId::from_eth(spender);196197		Ok(<Allowance<T>>::get((self.id, self.1, owner, spender)).into())198	}199}200201#[solidity_interface(name = ERC20UniqueExtensions)]202impl<T: Config> RefungibleTokenHandle<T>203where204	T::AccountId: From<[u8; 32]>,205{206	/// @dev Function that burns an amount of the token of a given account,207	/// deducting from the sender's allowance for said account.208	/// @param from The account whose tokens will be burnt.209	/// @param amount The amount that will be burnt.210	#[weight(<SelfWeightOf<T>>::burn_from())]211	#[solidity(hide)]212	fn burn_from(&mut self, caller: Caller, from: Address, amount: U256) -> Result<bool> {213		let caller = T::CrossAccountId::from_eth(caller);214		let from = T::CrossAccountId::from_eth(from);215		let amount = amount.try_into().map_err(|_| "amount overflow")?;216		let budget = self217			.recorder218			.weight_calls_budget(<StructureWeight<T>>::find_parent());219220		<Pallet<T>>::burn_from(self, &caller, &from, self.1, amount, &budget)221			.map_err(dispatch_to_evm::<T>)?;222		Ok(true)223	}224225	/// @dev Function that burns an amount of the token of a given account,226	/// deducting from the sender's allowance for said account.227	/// @param from The account whose tokens will be burnt.228	/// @param amount The amount that will be burnt.229	#[weight(<SelfWeightOf<T>>::burn_from())]230	fn burn_from_cross(231		&mut self,232		caller: Caller,233		from: pallet_common::eth::CrossAddress,234		amount: U256,235	) -> Result<bool> {236		let caller = T::CrossAccountId::from_eth(caller);237		let from = from.into_sub_cross_account::<T>()?;238		let amount = amount.try_into().map_err(|_| "amount overflow")?;239		let budget = self240			.recorder241			.weight_calls_budget(<StructureWeight<T>>::find_parent());242243		<Pallet<T>>::burn_from(self, &caller, &from, self.1, amount, &budget)244			.map_err(dispatch_to_evm::<T>)?;245		Ok(true)246	}247248	/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.249	/// Beware that changing an allowance with this method brings the risk that someone may use both the old250	/// and the new allowance by unfortunate transaction ordering. One possible solution to mitigate this251	/// race condition is to first reduce the spender's allowance to 0 and set the desired value afterwards:252	/// https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729253	/// @param spender The crossaccount which will spend the funds.254	/// @param amount The amount of tokens to be spent.255	#[weight(<SelfWeightOf<T>>::approve())]256	fn approve_cross(257		&mut self,258		caller: Caller,259		spender: pallet_common::eth::CrossAddress,260		amount: U256,261	) -> Result<bool> {262		let caller = T::CrossAccountId::from_eth(caller);263		let spender = spender.into_sub_cross_account::<T>()?;264		let amount = amount.try_into().map_err(|_| "amount overflow")?;265266		<Pallet<T>>::set_allowance(self, &caller, &spender, self.1, amount)267			.map_err(dispatch_to_evm::<T>)?;268		Ok(true)269	}270	/// @dev Function that changes total amount of the tokens.271	///  Throws if `msg.sender` doesn't owns all of the tokens.272	/// @param amount New total amount of the tokens.273	#[weight(<SelfWeightOf<T>>::repartition_item())]274	fn repartition(&mut self, caller: Caller, amount: U256) -> Result<bool> {275		let caller = T::CrossAccountId::from_eth(caller);276		let amount = amount.try_into().map_err(|_| "amount overflow")?;277278		<Pallet<T>>::repartition(self, &caller, self.1, amount).map_err(dispatch_to_evm::<T>)?;279		Ok(true)280	}281282	/// @dev Transfer token for a specified address283	/// @param to The crossaccount to transfer to.284	/// @param amount The amount to be transferred.285	#[weight(<CommonWeights<T>>::transfer())]286	fn transfer_cross(287		&mut self,288		caller: Caller,289		to: pallet_common::eth::CrossAddress,290		amount: U256,291	) -> Result<bool> {292		let caller = T::CrossAccountId::from_eth(caller);293		let to = to.into_sub_cross_account::<T>()?;294		let amount = amount.try_into().map_err(|_| "amount overflow")?;295		let budget = self296			.recorder297			.weight_calls_budget(<StructureWeight<T>>::find_parent());298299		<Pallet<T>>::transfer(self, &caller, &to, self.1, amount, &budget)300			.map_err(dispatch_to_evm::<T>)?;301		Ok(true)302	}303304	/// @dev Transfer tokens from one address to another305	/// @param from The address which you want to send tokens from306	/// @param to The address which you want to transfer to307	/// @param amount the amount of tokens to be transferred308	#[weight(<CommonWeights<T>>::transfer_from())]309	fn transfer_from_cross(310		&mut self,311		caller: Caller,312		from: pallet_common::eth::CrossAddress,313		to: pallet_common::eth::CrossAddress,314		amount: U256,315	) -> Result<bool> {316		let caller = T::CrossAccountId::from_eth(caller);317		let from = from.into_sub_cross_account::<T>()?;318		let to = to.into_sub_cross_account::<T>()?;319		let amount = amount.try_into().map_err(|_| "amount overflow")?;320		let budget = self321			.recorder322			.weight_calls_budget(<StructureWeight<T>>::find_parent());323324		<Pallet<T>>::transfer_from(self, &caller, &from, &to, self.1, amount, &budget)325			.map_err(dispatch_to_evm::<T>)?;326		Ok(true)327	}328}329330impl<T: Config> RefungibleTokenHandle<T> {331	pub fn into_inner(self) -> RefungibleHandle<T> {332		self.0333	}334	pub fn common_mut(&mut self) -> &mut RefungibleHandle<T> {335		&mut self.0336	}337}338339impl<T: Config> WithRecorder<T> for RefungibleTokenHandle<T> {340	fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {341		self.0.recorder()342	}343	fn into_recorder(self) -> pallet_evm_coder_substrate::SubstrateRecorder<T> {344		self.0.into_recorder()345	}346}347348impl<T: Config> Deref for RefungibleTokenHandle<T> {349	type Target = RefungibleHandle<T>;350351	fn deref(&self) -> &Self::Target {352		&self.0353	}354}355356#[solidity_interface(357	name = UniqueRefungibleToken,358	is(ERC20, ERC20UniqueExtensions, ERC1633)359)]360impl<T: Config> RefungibleTokenHandle<T> where T::AccountId: From<[u8; 32]> {}361362generate_stubgen!(gen_impl, UniqueRefungibleTokenCall<()>, true);363generate_stubgen!(gen_iface, UniqueRefungibleTokenCall<()>, false);364365impl<T: Config> CommonEvmHandler for RefungibleTokenHandle<T>366where367	T::AccountId: From<[u8; 32]>,368{369	const CODE: &'static [u8] = include_bytes!("./stubs/UniqueRefungibleToken.raw");370371	fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {372		call::<T, UniqueRefungibleTokenCall<T>, _, _>(handle, self)373	}374}