difftreelog
chore add docs
in: master
2 files changed
pallets/fungible/CHANGELOG.mddiffbeforeafterboth--- a/pallets/fungible/CHANGELOG.md
+++ b/pallets/fungible/CHANGELOG.md
@@ -2,6 +2,13 @@
All notable changes to this project will be documented in this file.
+
+## [0.1.5] - 2022-08-29
+
+### Added
+
+ - Implementation of `mint` and `mint_bulk` methods for ERC20 API.
+
## [v0.1.4] - 2022-08-24
### Change
pallets/fungible/src/erc.rsdiffbeforeafterboth1// 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//! ERC-20 standart support implementation.1819use core::char::{REPLACEMENT_CHARACTER, decode_utf16};20use core::convert::TryInto;21use evm_coder::{ToLog, execution::*, generate_stubgen, solidity_interface, types::*, weight};22use up_data_structs::CollectionMode;23use pallet_common::erc::{CommonEvmHandler, PrecompileResult};24use sp_std::vec::Vec;25use pallet_evm::{account::CrossAccountId, PrecompileHandle};26use pallet_evm_coder_substrate::{call, dispatch_to_evm};27use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};28use pallet_common::{CollectionHandle, erc::CollectionCall};2930use crate::{31 Allowance, Balance, Config, FungibleHandle, Pallet, SelfWeightOf, TotalSupply,32 weights::WeightInfo,33};3435#[derive(ToLog)]36pub enum ERC20Events {37 Transfer {38 #[indexed]39 from: address,40 #[indexed]41 to: address,42 value: uint256,43 },44 Approval {45 #[indexed]46 owner: address,47 #[indexed]48 spender: address,49 value: uint256,50 },51}5253#[solidity_interface(name = ERC20, events(ERC20Events))]54impl<T: Config> FungibleHandle<T> {55 fn name(&self) -> Result<string> {56 Ok(decode_utf16(self.name.iter().copied())57 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))58 .collect::<string>())59 }60 fn symbol(&self) -> Result<string> {61 Ok(string::from_utf8_lossy(&self.token_prefix).into())62 }63 fn total_supply(&self) -> Result<uint256> {64 self.consume_store_reads(1)?;65 Ok(<TotalSupply<T>>::get(self.id).into())66 }6768 fn decimals(&self) -> Result<uint8> {69 Ok(if let CollectionMode::Fungible(decimals) = &self.mode {70 *decimals71 } else {72 unreachable!()73 })74 }75 fn balance_of(&self, owner: address) -> Result<uint256> {76 self.consume_store_reads(1)?;77 let owner = T::CrossAccountId::from_eth(owner);78 let balance = <Balance<T>>::get((self.id, owner));79 Ok(balance.into())80 }81 #[weight(<SelfWeightOf<T>>::transfer())]82 fn transfer(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {83 let caller = T::CrossAccountId::from_eth(caller);84 let to = T::CrossAccountId::from_eth(to);85 let amount = amount.try_into().map_err(|_| "amount overflow")?;86 let budget = self87 .recorder88 .weight_calls_budget(<StructureWeight<T>>::find_parent());8990 <Pallet<T>>::transfer(self, &caller, &to, amount, &budget).map_err(|_| "transfer error")?;91 Ok(true)92 }93 #[weight(<SelfWeightOf<T>>::transfer_from())]94 fn transfer_from(95 &mut self,96 caller: caller,97 from: address,98 to: address,99 amount: uint256,100 ) -> Result<bool> {101 let caller = T::CrossAccountId::from_eth(caller);102 let from = T::CrossAccountId::from_eth(from);103 let to = T::CrossAccountId::from_eth(to);104 let amount = amount.try_into().map_err(|_| "amount overflow")?;105 let budget = self106 .recorder107 .weight_calls_budget(<StructureWeight<T>>::find_parent());108109 <Pallet<T>>::transfer_from(self, &caller, &from, &to, amount, &budget)110 .map_err(dispatch_to_evm::<T>)?;111 Ok(true)112 }113 #[weight(<SelfWeightOf<T>>::approve())]114 fn approve(&mut self, caller: caller, spender: address, amount: uint256) -> Result<bool> {115 let caller = T::CrossAccountId::from_eth(caller);116 let spender = T::CrossAccountId::from_eth(spender);117 let amount = amount.try_into().map_err(|_| "amount overflow")?;118119 <Pallet<T>>::set_allowance(self, &caller, &spender, amount)120 .map_err(dispatch_to_evm::<T>)?;121 Ok(true)122 }123 fn allowance(&self, owner: address, spender: address) -> Result<uint256> {124 self.consume_store_reads(1)?;125 let owner = T::CrossAccountId::from_eth(owner);126 let spender = T::CrossAccountId::from_eth(spender);127128 Ok(<Allowance<T>>::get((self.id, owner, spender)).into())129 }130}131132#[solidity_interface(name = "ERC20Mintable")]133impl<T: Config> FungibleHandle<T> {134 #[weight(<SelfWeightOf<T>>::create_item())]135 fn mint(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {136 let caller = T::CrossAccountId::from_eth(caller);137 let to = T::CrossAccountId::from_eth(to);138 let amount = amount.try_into().map_err(|_| "amount overflow")?;139 let budget = self140 .recorder141 .weight_calls_budget(<StructureWeight<T>>::find_parent());142 <Pallet<T>>::create_item(&self, &caller, (to, amount), &budget)143 .map_err(dispatch_to_evm::<T>)?;144 Ok(true)145 }146}147148#[solidity_interface(name = "ERC20UniqueExtensions")]149impl<T: Config> FungibleHandle<T> {150 #[weight(<SelfWeightOf<T>>::burn_from())]151 fn burn_from(&mut self, caller: caller, from: address, amount: uint256) -> Result<bool> {152 let caller = T::CrossAccountId::from_eth(caller);153 let from = T::CrossAccountId::from_eth(from);154 let amount = amount.try_into().map_err(|_| "amount overflow")?;155 let budget = self156 .recorder157 .weight_calls_budget(<StructureWeight<T>>::find_parent());158159 <Pallet<T>>::burn_from(self, &caller, &from, amount, &budget)160 .map_err(dispatch_to_evm::<T>)?;161 Ok(true)162 }163164 #[weight(<SelfWeightOf<T>>::create_multiple_items_ex(amounts.len() as u32))]165 fn mint_bulk(&mut self, caller: caller, amounts: Vec<(address, uint256)>) -> Result<bool> {166 let caller = T::CrossAccountId::from_eth(caller);167 let budget = self168 .recorder169 .weight_calls_budget(<StructureWeight<T>>::find_parent());170 let amounts = amounts171 .into_iter()172 .map(|(to, amount)| Ok((T::CrossAccountId::from_eth(to), amount.try_into().map_err(|_| "amount overflow")?)))173 .collect::<Result<_>>()?;174175 <Pallet<T>>::create_multiple_items(&self, &caller, amounts, &budget)176 .map_err(dispatch_to_evm::<T>)?;177 Ok(true)178 }179}180181#[solidity_interface(182 name = UniqueFungible,183 is(184 ERC20,185 ERC20Mintable,186 ERC20UniqueExtensions,187 Collection(common_mut, CollectionHandle<T>),188 )189)]190impl<T: Config> FungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}191192generate_stubgen!(gen_impl, UniqueFungibleCall<()>, true);193generate_stubgen!(gen_iface, UniqueFungibleCall<()>, false);194195impl<T: Config> CommonEvmHandler for FungibleHandle<T>196where197 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,198{199 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueFungible.raw");200201 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {202 call::<T, UniqueFungibleCall<T>, _, _>(handle, self)203 }204}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//! ERC-20 standart support implementation.1819use core::char::{REPLACEMENT_CHARACTER, decode_utf16};20use core::convert::TryInto;21use evm_coder::{ToLog, execution::*, generate_stubgen, solidity_interface, types::*, weight};22use up_data_structs::CollectionMode;23use pallet_common::erc::{CommonEvmHandler, PrecompileResult};24use sp_std::vec::Vec;25use pallet_evm::{account::CrossAccountId, PrecompileHandle};26use pallet_evm_coder_substrate::{call, dispatch_to_evm};27use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};28use pallet_common::{CollectionHandle, erc::CollectionCall};2930use crate::{31 Allowance, Balance, Config, FungibleHandle, Pallet, SelfWeightOf, TotalSupply,32 weights::WeightInfo,33};3435#[derive(ToLog)]36pub enum ERC20Events {37 Transfer {38 #[indexed]39 from: address,40 #[indexed]41 to: address,42 value: uint256,43 },44 Approval {45 #[indexed]46 owner: address,47 #[indexed]48 spender: address,49 value: uint256,50 },51}5253#[solidity_interface(name = ERC20, events(ERC20Events))]54impl<T: Config> FungibleHandle<T> {55 fn name(&self) -> Result<string> {56 Ok(decode_utf16(self.name.iter().copied())57 .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))58 .collect::<string>())59 }60 fn symbol(&self) -> Result<string> {61 Ok(string::from_utf8_lossy(&self.token_prefix).into())62 }63 fn total_supply(&self) -> Result<uint256> {64 self.consume_store_reads(1)?;65 Ok(<TotalSupply<T>>::get(self.id).into())66 }6768 fn decimals(&self) -> Result<uint8> {69 Ok(if let CollectionMode::Fungible(decimals) = &self.mode {70 *decimals71 } else {72 unreachable!()73 })74 }75 fn balance_of(&self, owner: address) -> Result<uint256> {76 self.consume_store_reads(1)?;77 let owner = T::CrossAccountId::from_eth(owner);78 let balance = <Balance<T>>::get((self.id, owner));79 Ok(balance.into())80 }81 #[weight(<SelfWeightOf<T>>::transfer())]82 fn transfer(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {83 let caller = T::CrossAccountId::from_eth(caller);84 let to = T::CrossAccountId::from_eth(to);85 let amount = amount.try_into().map_err(|_| "amount overflow")?;86 let budget = self87 .recorder88 .weight_calls_budget(<StructureWeight<T>>::find_parent());8990 <Pallet<T>>::transfer(self, &caller, &to, amount, &budget).map_err(|_| "transfer error")?;91 Ok(true)92 }93 #[weight(<SelfWeightOf<T>>::transfer_from())]94 fn transfer_from(95 &mut self,96 caller: caller,97 from: address,98 to: address,99 amount: uint256,100 ) -> Result<bool> {101 let caller = T::CrossAccountId::from_eth(caller);102 let from = T::CrossAccountId::from_eth(from);103 let to = T::CrossAccountId::from_eth(to);104 let amount = amount.try_into().map_err(|_| "amount overflow")?;105 let budget = self106 .recorder107 .weight_calls_budget(<StructureWeight<T>>::find_parent());108109 <Pallet<T>>::transfer_from(self, &caller, &from, &to, amount, &budget)110 .map_err(dispatch_to_evm::<T>)?;111 Ok(true)112 }113 #[weight(<SelfWeightOf<T>>::approve())]114 fn approve(&mut self, caller: caller, spender: address, amount: uint256) -> Result<bool> {115 let caller = T::CrossAccountId::from_eth(caller);116 let spender = T::CrossAccountId::from_eth(spender);117 let amount = amount.try_into().map_err(|_| "amount overflow")?;118119 <Pallet<T>>::set_allowance(self, &caller, &spender, amount)120 .map_err(dispatch_to_evm::<T>)?;121 Ok(true)122 }123 fn allowance(&self, owner: address, spender: address) -> Result<uint256> {124 self.consume_store_reads(1)?;125 let owner = T::CrossAccountId::from_eth(owner);126 let spender = T::CrossAccountId::from_eth(spender);127128 Ok(<Allowance<T>>::get((self.id, owner, spender)).into())129 }130}131132#[solidity_interface(name = "ERC20Mintable")]133impl<T: Config> FungibleHandle<T> {134 /// Mint tokens for `to` account.135 /// @param to account that will receive minted tokens136 /// @param amount amount of tokens to mint137 #[weight(<SelfWeightOf<T>>::create_item())]138 fn mint(&mut self, caller: caller, to: address, amount: uint256) -> Result<bool> {139 let caller = T::CrossAccountId::from_eth(caller);140 let to = T::CrossAccountId::from_eth(to);141 let amount = amount.try_into().map_err(|_| "amount overflow")?;142 let budget = self143 .recorder144 .weight_calls_budget(<StructureWeight<T>>::find_parent());145 <Pallet<T>>::create_item(&self, &caller, (to, amount), &budget)146 .map_err(dispatch_to_evm::<T>)?;147 Ok(true)148 }149}150151#[solidity_interface(name = "ERC20UniqueExtensions")]152impl<T: Config> FungibleHandle<T> {153 /// Burn tokens from account154 /// @dev Function that burns an `amount` of the tokens of a given account,155 /// deducting from the sender's allowance for said account.156 /// @param from The account whose tokens will be burnt.157 /// @param amount The amount that will be burnt.158 #[weight(<SelfWeightOf<T>>::burn_from())]159 fn burn_from(&mut self, caller: caller, from: address, amount: uint256) -> Result<bool> {160 let caller = T::CrossAccountId::from_eth(caller);161 let from = T::CrossAccountId::from_eth(from);162 let amount = amount.try_into().map_err(|_| "amount overflow")?;163 let budget = self164 .recorder165 .weight_calls_budget(<StructureWeight<T>>::find_parent());166167 <Pallet<T>>::burn_from(self, &caller, &from, amount, &budget)168 .map_err(dispatch_to_evm::<T>)?;169 Ok(true)170 }171172 /// Mint tokens for multiple accounts.173 /// @param amounts array of pairs of account address and amount174 #[weight(<SelfWeightOf<T>>::create_multiple_items_ex(amounts.len() as u32))]175 fn mint_bulk(&mut self, caller: caller, amounts: Vec<(address, uint256)>) -> Result<bool> {176 let caller = T::CrossAccountId::from_eth(caller);177 let budget = self178 .recorder179 .weight_calls_budget(<StructureWeight<T>>::find_parent());180 let amounts = amounts181 .into_iter()182 .map(|(to, amount)| Ok((T::CrossAccountId::from_eth(to), amount.try_into().map_err(|_| "amount overflow")?)))183 .collect::<Result<_>>()?;184185 <Pallet<T>>::create_multiple_items(&self, &caller, amounts, &budget)186 .map_err(dispatch_to_evm::<T>)?;187 Ok(true)188 }189}190191#[solidity_interface(192 name = UniqueFungible,193 is(194 ERC20,195 ERC20Mintable,196 ERC20UniqueExtensions,197 Collection(common_mut, CollectionHandle<T>),198 )199)]200impl<T: Config> FungibleHandle<T> where T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]> {}201202generate_stubgen!(gen_impl, UniqueFungibleCall<()>, true);203generate_stubgen!(gen_iface, UniqueFungibleCall<()>, false);204205impl<T: Config> CommonEvmHandler for FungibleHandle<T>206where207 T::AccountId: From<[u8; 32]> + AsRef<[u8; 32]>,208{209 const CODE: &'static [u8] = include_bytes!("./stubs/UniqueFungible.raw");210211 fn call(self, handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {212 call::<T, UniqueFungibleCall<T>, _, _>(handle, self)213 }214}