difftreelog
patch: add has_pending_sponsor to evm
in: master
1 file changed
pallets/evm-contract-helpers/src/eth.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/>.1617use core::marker::PhantomData;18use evm_coder::{abi::AbiWriter, execution::Result, generate_stubgen, solidity_interface, types::*};19use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};20use pallet_evm::{21 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,22 account::CrossAccountId,23};24use sp_core::H160;25use crate::{26 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT,27};28use frame_support::traits::Get;29use up_sponsorship::SponsorshipHandler;30use sp_std::vec::Vec;3132struct ContractHelpers<T: Config>(SubstrateRecorder<T>);33impl<T: Config> WithRecorder<T> for ContractHelpers<T> {34 fn recorder(&self) -> &SubstrateRecorder<T> {35 &self.036 }3738 fn into_recorder(self) -> SubstrateRecorder<T> {39 self.040 }41}4243#[solidity_interface(name = "ContractHelpers")]44impl<T: Config> ContractHelpers<T>45where46 T::AccountId: AsRef<[u8]>,47{48 fn contract_owner(&self, contract_address: address) -> Result<address> {49 Ok(<Owner<T>>::get(contract_address))50 }5152 fn set_sponsor(53 &mut self,54 caller: caller,55 contract_address: address,56 sponsor: address,57 ) -> Result<void> {58 Pallet::<T>::set_sponsor(59 &T::CrossAccountId::from_eth(caller),60 contract_address,61 &T::CrossAccountId::from_eth(sponsor),62 )63 .map_err(dispatch_to_evm::<T>)?;64 Ok(())65 }6667 fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {68 Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)69 .map_err(dispatch_to_evm::<T>)?;70 Ok(())71 }7273 fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {74 let sponsor =75 Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;76 let sponsor_sub = pallet_common::eth::convert_cross_account_to_eth_uint256::<T>(&sponsor);77 Ok((*sponsor.as_eth(), sponsor_sub))78 }7980 fn has_sponsor(&self, contract_address: address) -> Result<bool> {81 Ok(Pallet::<T>::get_sponsor(contract_address).is_some())82 }8384 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {85 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)86 }8788 fn set_sponsoring_mode(89 &mut self,90 caller: caller,91 contract_address: address,92 mode: uint8,93 ) -> Result<void> {94 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;95 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;96 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);97 Ok(())98 }99100 fn sponsoring_mode(&self, contract_address: address) -> Result<uint8> {101 Ok(<Pallet<T>>::sponsoring_mode(contract_address).to_eth())102 }103104 fn set_sponsoring_rate_limit(105 &mut self,106 caller: caller,107 contract_address: address,108 rate_limit: uint32,109 ) -> Result<void> {110 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;111 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());112 Ok(())113 }114115 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {116 Ok(<SponsoringRateLimit<T>>::get(contract_address)117 .try_into()118 .map_err(|_| "rate limit > u32::MAX")?)119 }120121 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {122 self.0.consume_sload()?;123 Ok(<Pallet<T>>::allowed(contract_address, user))124 }125126 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {127 Ok(<AllowlistEnabled<T>>::get(contract_address))128 }129130 fn toggle_allowlist(131 &mut self,132 caller: caller,133 contract_address: address,134 enabled: bool,135 ) -> Result<void> {136 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;137 <Pallet<T>>::toggle_allowlist(contract_address, enabled);138 Ok(())139 }140141 fn toggle_allowed(142 &mut self,143 caller: caller,144 contract_address: address,145 user: address,146 allowed: bool,147 ) -> Result<void> {148 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;149 <Pallet<T>>::toggle_allowed(contract_address, user, allowed);150 Ok(())151 }152}153154pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);155impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>156where157 T::AccountId: AsRef<[u8]>,158{159 fn is_reserved(contract: &sp_core::H160) -> bool {160 contract == &T::ContractAddress::get()161 }162163 fn is_used(contract: &sp_core::H160) -> bool {164 contract == &T::ContractAddress::get()165 }166167 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {168 // TODO: Extract to another OnMethodCall handler169 if <AllowlistEnabled<T>>::get(handle.code_address())170 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)171 {172 return Some(Err(PrecompileFailure::Revert {173 exit_status: ExitRevert::Reverted,174 output: {175 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));176 writer.string("Target contract is allowlisted");177 writer.finish()178 },179 }));180 }181182 if handle.code_address() != T::ContractAddress::get() {183 return None;184 }185186 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));187 pallet_evm_coder_substrate::call(handle, helpers)188 }189190 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {191 (contract == &T::ContractAddress::get())192 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())193 }194}195196pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);197impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {198 fn on_create(owner: H160, contract: H160) {199 <Owner<T>>::insert(contract, owner);200 }201}202203pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);204impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>205 for HelpersContractSponsoring<T>206{207 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {208 let (contract, _) = call;209 let mode = <Pallet<T>>::sponsoring_mode(*contract);210 if mode == SponsoringModeT::Disabled {211 return None;212 }213214 let sponsor = match <Pallet<T>>::get_sponsor(*contract) {215 Some(sponsor) => sponsor,216 None => return None,217 };218219 if mode == SponsoringModeT::Allowlisted && !<Pallet<T>>::allowed(*contract, *who.as_eth()) {220 return None;221 }222 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;223224 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract, who.as_eth()) {225 let limit = <SponsoringRateLimit<T>>::get(contract);226227 let timeout = last_tx_block + limit;228 if block_number < timeout {229 return None;230 }231 }232233 <SponsorBasket<T>>::insert(contract, who.as_eth(), block_number);234235 Some(sponsor)236 }237}238239generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);240generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);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/>.1617use core::marker::PhantomData;18use evm_coder::{abi::AbiWriter, execution::Result, generate_stubgen, solidity_interface, types::*};19use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};20use pallet_evm::{21 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,22 account::CrossAccountId,23};24use sp_core::H160;25use up_data_structs::SponsorshipState;26use crate::{27 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT, Sponsoring,28};29use frame_support::traits::Get;30use up_sponsorship::SponsorshipHandler;31use sp_std::vec::Vec;3233struct ContractHelpers<T: Config>(SubstrateRecorder<T>);34impl<T: Config> WithRecorder<T> for ContractHelpers<T> {35 fn recorder(&self) -> &SubstrateRecorder<T> {36 &self.037 }3839 fn into_recorder(self) -> SubstrateRecorder<T> {40 self.041 }42}4344#[solidity_interface(name = "ContractHelpers")]45impl<T: Config> ContractHelpers<T>46where47 T::AccountId: AsRef<[u8]>,48{49 fn contract_owner(&self, contract_address: address) -> Result<address> {50 Ok(<Owner<T>>::get(contract_address))51 }5253 fn set_sponsor(54 &mut self,55 caller: caller,56 contract_address: address,57 sponsor: address,58 ) -> Result<void> {59 Pallet::<T>::set_sponsor(60 &T::CrossAccountId::from_eth(caller),61 contract_address,62 &T::CrossAccountId::from_eth(sponsor),63 )64 .map_err(dispatch_to_evm::<T>)?;65 Ok(())66 }6768 fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {69 Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)70 .map_err(dispatch_to_evm::<T>)?;71 Ok(())72 }7374 fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {75 let sponsor =76 Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;77 let sponsor_sub = pallet_common::eth::convert_cross_account_to_eth_uint256::<T>(&sponsor);78 Ok((*sponsor.as_eth(), sponsor_sub))79 }8081 fn has_sponsor(&self, contract_address: address) -> Result<bool> {82 Ok(Pallet::<T>::get_sponsor(contract_address).is_some())83 }8485 fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {86 Ok(match Sponsoring::<T>::get(contract_address) {87 SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,88 SponsorshipState::Unconfirmed(_) => true,89 })90 }9192 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {93 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)94 }9596 fn set_sponsoring_mode(97 &mut self,98 caller: caller,99 contract_address: address,100 mode: uint8,101 ) -> Result<void> {102 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;103 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;104 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);105 Ok(())106 }107108 fn sponsoring_mode(&self, contract_address: address) -> Result<uint8> {109 Ok(<Pallet<T>>::sponsoring_mode(contract_address).to_eth())110 }111112 fn set_sponsoring_rate_limit(113 &mut self,114 caller: caller,115 contract_address: address,116 rate_limit: uint32,117 ) -> Result<void> {118 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;119 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());120 Ok(())121 }122123 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {124 Ok(<SponsoringRateLimit<T>>::get(contract_address)125 .try_into()126 .map_err(|_| "rate limit > u32::MAX")?)127 }128129 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {130 self.0.consume_sload()?;131 Ok(<Pallet<T>>::allowed(contract_address, user))132 }133134 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {135 Ok(<AllowlistEnabled<T>>::get(contract_address))136 }137138 fn toggle_allowlist(139 &mut self,140 caller: caller,141 contract_address: address,142 enabled: bool,143 ) -> Result<void> {144 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;145 <Pallet<T>>::toggle_allowlist(contract_address, enabled);146 Ok(())147 }148149 fn toggle_allowed(150 &mut self,151 caller: caller,152 contract_address: address,153 user: address,154 allowed: bool,155 ) -> Result<void> {156 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;157 <Pallet<T>>::toggle_allowed(contract_address, user, allowed);158 Ok(())159 }160}161162pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);163impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>164where165 T::AccountId: AsRef<[u8]>,166{167 fn is_reserved(contract: &sp_core::H160) -> bool {168 contract == &T::ContractAddress::get()169 }170171 fn is_used(contract: &sp_core::H160) -> bool {172 contract == &T::ContractAddress::get()173 }174175 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {176 // TODO: Extract to another OnMethodCall handler177 if <AllowlistEnabled<T>>::get(handle.code_address())178 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)179 {180 return Some(Err(PrecompileFailure::Revert {181 exit_status: ExitRevert::Reverted,182 output: {183 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));184 writer.string("Target contract is allowlisted");185 writer.finish()186 },187 }));188 }189190 if handle.code_address() != T::ContractAddress::get() {191 return None;192 }193194 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));195 pallet_evm_coder_substrate::call(handle, helpers)196 }197198 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {199 (contract == &T::ContractAddress::get())200 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())201 }202}203204pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);205impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {206 fn on_create(owner: H160, contract: H160) {207 <Owner<T>>::insert(contract, owner);208 }209}210211pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);212impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>213 for HelpersContractSponsoring<T>214{215 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {216 let (contract, _) = call;217 let mode = <Pallet<T>>::sponsoring_mode(*contract);218 if mode == SponsoringModeT::Disabled {219 return None;220 }221222 let sponsor = match <Pallet<T>>::get_sponsor(*contract) {223 Some(sponsor) => sponsor,224 None => return None,225 };226227 if mode == SponsoringModeT::Allowlisted && !<Pallet<T>>::allowed(*contract, *who.as_eth()) {228 return None;229 }230 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;231232 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract, who.as_eth()) {233 let limit = <SponsoringRateLimit<T>>::get(contract);234235 let timeout = last_tx_block + limit;236 if block_number < timeout {237 return None;238 }239 }240241 <SponsorBasket<T>>::insert(contract, who.as_eth(), block_number);242243 Some(sponsor)244 }245}246247generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);248generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);