difftreelog
Merge branch 'feature/app-staking' of https://github.com/UniqueNetwork/unique-chain into feature/app-staking
in: master
11 files changed
Cargo.lockdiffbeforeafterboth--- a/Cargo.lock
+++ b/Cargo.lock
@@ -5735,6 +5735,7 @@
name = "pallet-evm-contract-helpers"
version = "0.2.0"
dependencies = [
+ "ethereum",
"evm-coder",
"fp-evm-mapping",
"frame-support",
pallets/evm-contract-helpers/Cargo.tomldiffbeforeafterboth--- a/pallets/evm-contract-helpers/Cargo.toml
+++ b/pallets/evm-contract-helpers/Cargo.toml
@@ -9,6 +9,7 @@
"derive",
] }
log = { default-features = false, version = "0.4.14" }
+ethereum = { version = "0.12.0", default-features = false }
# Substrate
frame-support = { default-features = false, git = "https://github.com/paritytech/substrate", branch = "polkadot-v0.9.27" }
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/>.1617//! Implementation of magic contract1819use core::marker::PhantomData;20use evm_coder::{abi::AbiWriter, execution::Result, generate_stubgen, solidity_interface, types::*};21use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};22use pallet_evm::{23 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,24 account::CrossAccountId,25};26use sp_core::H160;27use up_data_structs::SponsorshipState;28use crate::{29 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT,30 Sponsoring,31};32use frame_support::traits::Get;33use up_sponsorship::SponsorshipHandler;34use sp_std::vec::Vec;3536/// See [`ContractHelpersCall`]37pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);38impl<T: Config> WithRecorder<T> for ContractHelpers<T> {39 fn recorder(&self) -> &SubstrateRecorder<T> {40 &self.041 }4243 fn into_recorder(self) -> SubstrateRecorder<T> {44 self.045 }46}4748/// @title Magic contract, which allows users to reconfigure other contracts49#[solidity_interface(name = ContractHelpers)]50impl<T: Config> ContractHelpers<T>51where52 T::AccountId: AsRef<[u8; 32]>,53{54 /// Get user, which deployed specified contract55 /// @dev May return zero address in case if contract is deployed56 /// using uniquenetwork evm-migration pallet, or using other terms not57 /// intended by pallet-evm58 /// @dev Returns zero address if contract does not exists59 /// @param contractAddress Contract to get owner of60 /// @return address Owner of contract61 fn contract_owner(&self, contract_address: address) -> Result<address> {62 Ok(<Owner<T>>::get(contract_address))63 }6465 /// Set sponsor.66 /// @param contractAddress Contract for which a sponsor is being established.67 /// @param sponsor User address who set as pending sponsor.68 fn set_sponsor(69 &mut self,70 caller: caller,71 contract_address: address,72 sponsor: address,73 ) -> Result<void> {74 self.recorder().consume_sload()?;75 self.recorder().consume_sstore()?;7677 Pallet::<T>::set_sponsor(78 &T::CrossAccountId::from_eth(caller),79 contract_address,80 &T::CrossAccountId::from_eth(sponsor),81 )82 .map_err(dispatch_to_evm::<T>)?;8384 Ok(())85 }8687 /// Set contract as self sponsored.88 ///89 /// @param contractAddress Contract for which a self sponsoring is being enabled.90 fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {91 self.recorder().consume_sload()?;92 self.recorder().consume_sstore()?;9394 Pallet::<T>::self_sponsored_enable(&T::CrossAccountId::from_eth(caller), contract_address)95 .map_err(dispatch_to_evm::<T>)?;9697 Ok(())98 }99100 /// Remove sponsor.101 ///102 /// @param contractAddress Contract for which a sponsorship is being removed.103 fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {104 self.recorder().consume_sload()?;105 self.recorder().consume_sstore()?;106107 Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)108 .map_err(dispatch_to_evm::<T>)?;109110 Ok(())111 }112113 /// Confirm sponsorship.114 ///115 /// @dev Caller must be same that set via [`setSponsor`].116 ///117 /// @param contractAddress Сontract for which need to confirm sponsorship.118 fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {119 self.recorder().consume_sload()?;120 self.recorder().consume_sstore()?;121122 Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)123 .map_err(dispatch_to_evm::<T>)?;124125 Ok(())126 }127128 /// Get current sponsor.129 ///130 /// @param contractAddress The contract for which a sponsor is requested.131 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.132 fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {133 let sponsor =134 Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;135 let result: (address, uint256) = if sponsor.is_canonical_substrate() {136 let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);137 (Default::default(), sponsor)138 } else {139 let sponsor = *sponsor.as_eth();140 (sponsor, Default::default())141 };142 Ok(result)143 }144145 /// Check tat contract has confirmed sponsor.146 ///147 /// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.148 /// @return **true** if contract has confirmed sponsor.149 fn has_sponsor(&self, contract_address: address) -> Result<bool> {150 Ok(Pallet::<T>::get_sponsor(contract_address).is_some())151 }152153 /// Check tat contract has pending sponsor.154 ///155 /// @param contractAddress The contract for which the presence of a pending sponsor is checked.156 /// @return **true** if contract has pending sponsor.157 fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {158 Ok(match Sponsoring::<T>::get(contract_address) {159 SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,160 SponsorshipState::Unconfirmed(_) => true,161 })162 }163164 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {165 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)166 }167168 fn set_sponsoring_mode(169 &mut self,170 caller: caller,171 contract_address: address,172 // TODO: implement support for enums in evm-coder173 mode: uint8,174 ) -> Result<void> {175 self.recorder().consume_sload()?;176 self.recorder().consume_sstore()?;177178 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;179 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;180 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);181182 Ok(())183 }184185 /// Get current contract sponsoring rate limit186 /// @param contractAddress Contract to get sponsoring mode of187 /// @return uint32 Amount of blocks between two sponsored transactions188 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {189 Ok(<SponsoringRateLimit<T>>::get(contract_address)190 .try_into()191 .map_err(|_| "rate limit > u32::MAX")?)192 }193194 /// Set contract sponsoring rate limit195 /// @dev Sponsoring rate limit - is a minimum amount of blocks that should196 /// pass between two sponsored transactions197 /// @param contractAddress Contract to change sponsoring rate limit of198 /// @param rateLimit Target rate limit199 /// @dev Only contract owner can change this setting200 fn set_sponsoring_rate_limit(201 &mut self,202 caller: caller,203 contract_address: address,204 rate_limit: uint32,205 ) -> Result<void> {206 self.recorder().consume_sload()?;207 self.recorder().consume_sstore()?;208209 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;210 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());211 Ok(())212 }213214 /// Is specified user present in contract allow list215 /// @dev Contract owner always implicitly included216 /// @param contractAddress Contract to check allowlist of217 /// @param user User to check218 /// @return bool Is specified users exists in contract allowlist219 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {220 self.0.consume_sload()?;221 Ok(<Pallet<T>>::allowed(contract_address, user))222 }223224 /// Toggle user presence in contract allowlist225 /// @param contractAddress Contract to change allowlist of226 /// @param user Which user presence should be toggled227 /// @param isAllowed `true` if user should be allowed to be sponsored228 /// or call this contract, `false` otherwise229 /// @dev Only contract owner can change this setting230 fn toggle_allowed(231 &mut self,232 caller: caller,233 contract_address: address,234 user: address,235 is_allowed: bool,236 ) -> Result<void> {237 self.recorder().consume_sload()?;238 self.recorder().consume_sstore()?;239240 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;241 <Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);242243 Ok(())244 }245246 /// Is this contract has allowlist access enabled247 /// @dev Allowlist always can have users, and it is used for two purposes:248 /// in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist249 /// in case of allowlist access enabled, only users from allowlist may call this contract250 /// @param contractAddress Contract to get allowlist access of251 /// @return bool Is specified contract has allowlist access enabled252 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {253 Ok(<AllowlistEnabled<T>>::get(contract_address))254 }255256 /// Toggle contract allowlist access257 /// @param contractAddress Contract to change allowlist access of258 /// @param enabled Should allowlist access to be enabled?259 fn toggle_allowlist(260 &mut self,261 caller: caller,262 contract_address: address,263 enabled: bool,264 ) -> Result<void> {265 self.recorder().consume_sload()?;266 self.recorder().consume_sstore()?;267268 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;269 <Pallet<T>>::toggle_allowlist(contract_address, enabled);270 Ok(())271 }272}273274/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]275pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);276impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>277where278 T::AccountId: AsRef<[u8; 32]>,279{280 fn is_reserved(contract: &sp_core::H160) -> bool {281 contract == &T::ContractAddress::get()282 }283284 fn is_used(contract: &sp_core::H160) -> bool {285 contract == &T::ContractAddress::get()286 }287288 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {289 // TODO: Extract to another OnMethodCall handler290 if <AllowlistEnabled<T>>::get(handle.code_address())291 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)292 {293 return Some(Err(PrecompileFailure::Revert {294 exit_status: ExitRevert::Reverted,295 output: {296 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));297 writer.string("Target contract is allowlisted");298 writer.finish()299 },300 }));301 }302303 if handle.code_address() != T::ContractAddress::get() {304 return None;305 }306307 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));308 pallet_evm_coder_substrate::call(handle, helpers)309 }310311 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {312 (contract == &T::ContractAddress::get())313 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())314 }315}316317/// Hooks into contract creation, storing owner of newly deployed contract318pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);319impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {320 fn on_create(owner: H160, contract: H160) {321 <Owner<T>>::insert(contract, owner);322 }323}324325/// Bridge to pallet-sponsoring326pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);327impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>328 for HelpersContractSponsoring<T>329{330 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {331 let (contract_address, _) = call;332 let mode = <Pallet<T>>::sponsoring_mode(*contract_address);333 if mode == SponsoringModeT::Disabled {334 return None;335 }336337 let sponsor = match <Pallet<T>>::get_sponsor(*contract_address) {338 Some(sponsor) => sponsor,339 None => return None,340 };341342 if mode == SponsoringModeT::Allowlisted343 && !<Pallet<T>>::allowed(*contract_address, *who.as_eth())344 {345 return None;346 }347 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;348349 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {350 let limit = <SponsoringRateLimit<T>>::get(contract_address);351352 let timeout = last_tx_block + limit;353 if block_number < timeout {354 return None;355 }356 }357358 <SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);359360 Some(sponsor)361 }362}363364generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);365generate_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/>.1617//! Implementation of magic contract1819use core::marker::PhantomData;20use evm_coder::{21 abi::AbiWriter, execution::Result, generate_stubgen, solidity_interface, types::*, ToLog,22};23use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};24use pallet_evm::{25 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,26 account::CrossAccountId,27};28use sp_core::H160;29use up_data_structs::SponsorshipState;30use crate::{31 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT,32 Sponsoring,33};34use frame_support::traits::Get;35use up_sponsorship::SponsorshipHandler;36use sp_std::vec::Vec;3738/// Pallet events.39#[derive(ToLog)]40pub enum ContractHelpersEvents {41 /// Contract sponsor was set.42 ContractSponsorSet {43 /// Contract address of the affected collection.44 #[indexed]45 contract_address: address,46 /// New sponsor address.47 sponsor: address,48 },4950 /// New sponsor was confirm.51 ContractSponsorshipConfirmed {52 /// Contract address of the affected collection.53 #[indexed]54 contract_address: address,55 /// New sponsor address.56 sponsor: address,57 },5859 /// Collection sponsor was removed.60 ContractSponsorRemoved {61 /// Contract address of the affected collection.62 #[indexed]63 contract_address: address,64 },65}6667/// See [`ContractHelpersCall`]68pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);69impl<T: Config> WithRecorder<T> for ContractHelpers<T> {70 fn recorder(&self) -> &SubstrateRecorder<T> {71 &self.072 }7374 fn into_recorder(self) -> SubstrateRecorder<T> {75 self.076 }77}7879/// @title Magic contract, which allows users to reconfigure other contracts80#[solidity_interface(name = ContractHelpers, events(ContractHelpersEvents))]81impl<T: Config> ContractHelpers<T>82where83 T::AccountId: AsRef<[u8; 32]>,84{85 /// Get user, which deployed specified contract86 /// @dev May return zero address in case if contract is deployed87 /// using uniquenetwork evm-migration pallet, or using other terms not88 /// intended by pallet-evm89 /// @dev Returns zero address if contract does not exists90 /// @param contractAddress Contract to get owner of91 /// @return address Owner of contract92 fn contract_owner(&self, contract_address: address) -> Result<address> {93 Ok(<Owner<T>>::get(contract_address))94 }9596 /// Set sponsor.97 /// @param contractAddress Contract for which a sponsor is being established.98 /// @param sponsor User address who set as pending sponsor.99 fn set_sponsor(100 &mut self,101 caller: caller,102 contract_address: address,103 sponsor: address,104 ) -> Result<void> {105 self.recorder().consume_sload()?;106 self.recorder().consume_sstore()?;107108 Pallet::<T>::set_sponsor(109 &T::CrossAccountId::from_eth(caller),110 contract_address,111 &T::CrossAccountId::from_eth(sponsor),112 )113 .map_err(dispatch_to_evm::<T>)?;114115 Ok(())116 }117118 /// Set contract as self sponsored.119 ///120 /// @param contractAddress Contract for which a self sponsoring is being enabled.121 fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {122 self.recorder().consume_sload()?;123 self.recorder().consume_sstore()?;124125 Pallet::<T>::force_set_sponsor(126 &T::CrossAccountId::from_eth(caller),127 contract_address,128 &T::CrossAccountId::from_eth(contract_address),129 )130 .map_err(dispatch_to_evm::<T>)?;131132 Ok(())133 }134135 /// Remove sponsor.136 ///137 /// @param contractAddress Contract for which a sponsorship is being removed.138 fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {139 self.recorder().consume_sload()?;140 self.recorder().consume_sstore()?;141142 Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)143 .map_err(dispatch_to_evm::<T>)?;144145 Ok(())146 }147148 /// Confirm sponsorship.149 ///150 /// @dev Caller must be same that set via [`setSponsor`].151 ///152 /// @param contractAddress Сontract for which need to confirm sponsorship.153 fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {154 self.recorder().consume_sload()?;155 self.recorder().consume_sstore()?;156157 Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)158 .map_err(dispatch_to_evm::<T>)?;159160 Ok(())161 }162163 /// Get current sponsor.164 ///165 /// @param contractAddress The contract for which a sponsor is requested.166 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.167 fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {168 let sponsor =169 Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;170 let result: (address, uint256) = if sponsor.is_canonical_substrate() {171 let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);172 (Default::default(), sponsor)173 } else {174 let sponsor = *sponsor.as_eth();175 (sponsor, Default::default())176 };177 Ok(result)178 }179180 /// Check tat contract has confirmed sponsor.181 ///182 /// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.183 /// @return **true** if contract has confirmed sponsor.184 fn has_sponsor(&self, contract_address: address) -> Result<bool> {185 Ok(Pallet::<T>::get_sponsor(contract_address).is_some())186 }187188 /// Check tat contract has pending sponsor.189 ///190 /// @param contractAddress The contract for which the presence of a pending sponsor is checked.191 /// @return **true** if contract has pending sponsor.192 fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {193 Ok(match Sponsoring::<T>::get(contract_address) {194 SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,195 SponsorshipState::Unconfirmed(_) => true,196 })197 }198199 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {200 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)201 }202203 fn set_sponsoring_mode(204 &mut self,205 caller: caller,206 contract_address: address,207 // TODO: implement support for enums in evm-coder208 mode: uint8,209 ) -> Result<void> {210 self.recorder().consume_sload()?;211 self.recorder().consume_sstore()?;212213 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;214 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;215 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);216217 Ok(())218 }219220 /// Get current contract sponsoring rate limit221 /// @param contractAddress Contract to get sponsoring mode of222 /// @return uint32 Amount of blocks between two sponsored transactions223 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {224 Ok(<SponsoringRateLimit<T>>::get(contract_address)225 .try_into()226 .map_err(|_| "rate limit > u32::MAX")?)227 }228229 /// Set contract sponsoring rate limit230 /// @dev Sponsoring rate limit - is a minimum amount of blocks that should231 /// pass between two sponsored transactions232 /// @param contractAddress Contract to change sponsoring rate limit of233 /// @param rateLimit Target rate limit234 /// @dev Only contract owner can change this setting235 fn set_sponsoring_rate_limit(236 &mut self,237 caller: caller,238 contract_address: address,239 rate_limit: uint32,240 ) -> Result<void> {241 self.recorder().consume_sload()?;242 self.recorder().consume_sstore()?;243244 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;245 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());246 Ok(())247 }248249 /// Is specified user present in contract allow list250 /// @dev Contract owner always implicitly included251 /// @param contractAddress Contract to check allowlist of252 /// @param user User to check253 /// @return bool Is specified users exists in contract allowlist254 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {255 self.0.consume_sload()?;256 Ok(<Pallet<T>>::allowed(contract_address, user))257 }258259 /// Toggle user presence in contract allowlist260 /// @param contractAddress Contract to change allowlist of261 /// @param user Which user presence should be toggled262 /// @param isAllowed `true` if user should be allowed to be sponsored263 /// or call this contract, `false` otherwise264 /// @dev Only contract owner can change this setting265 fn toggle_allowed(266 &mut self,267 caller: caller,268 contract_address: address,269 user: address,270 is_allowed: bool,271 ) -> Result<void> {272 self.recorder().consume_sload()?;273 self.recorder().consume_sstore()?;274275 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;276 <Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);277278 Ok(())279 }280281 /// Is this contract has allowlist access enabled282 /// @dev Allowlist always can have users, and it is used for two purposes:283 /// in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist284 /// in case of allowlist access enabled, only users from allowlist may call this contract285 /// @param contractAddress Contract to get allowlist access of286 /// @return bool Is specified contract has allowlist access enabled287 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {288 Ok(<AllowlistEnabled<T>>::get(contract_address))289 }290291 /// Toggle contract allowlist access292 /// @param contractAddress Contract to change allowlist access of293 /// @param enabled Should allowlist access to be enabled?294 fn toggle_allowlist(295 &mut self,296 caller: caller,297 contract_address: address,298 enabled: bool,299 ) -> Result<void> {300 self.recorder().consume_sload()?;301 self.recorder().consume_sstore()?;302303 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;304 <Pallet<T>>::toggle_allowlist(contract_address, enabled);305 Ok(())306 }307}308309/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]310pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);311impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>312where313 T::AccountId: AsRef<[u8; 32]>,314{315 fn is_reserved(contract: &sp_core::H160) -> bool {316 contract == &T::ContractAddress::get()317 }318319 fn is_used(contract: &sp_core::H160) -> bool {320 contract == &T::ContractAddress::get()321 }322323 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {324 // TODO: Extract to another OnMethodCall handler325 if <AllowlistEnabled<T>>::get(handle.code_address())326 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)327 {328 return Some(Err(PrecompileFailure::Revert {329 exit_status: ExitRevert::Reverted,330 output: {331 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));332 writer.string("Target contract is allowlisted");333 writer.finish()334 },335 }));336 }337338 if handle.code_address() != T::ContractAddress::get() {339 return None;340 }341342 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));343 pallet_evm_coder_substrate::call(handle, helpers)344 }345346 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {347 (contract == &T::ContractAddress::get())348 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())349 }350}351352/// Hooks into contract creation, storing owner of newly deployed contract353pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);354impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {355 fn on_create(owner: H160, contract: H160) {356 <Owner<T>>::insert(contract, owner);357 }358}359360/// Bridge to pallet-sponsoring361pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);362impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>363 for HelpersContractSponsoring<T>364{365 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {366 let (contract_address, _) = call;367 let mode = <Pallet<T>>::sponsoring_mode(*contract_address);368 if mode == SponsoringModeT::Disabled {369 return None;370 }371372 let sponsor = match <Pallet<T>>::get_sponsor(*contract_address) {373 Some(sponsor) => sponsor,374 None => return None,375 };376377 if mode == SponsoringModeT::Allowlisted378 && !<Pallet<T>>::allowed(*contract_address, *who.as_eth())379 {380 return None;381 }382 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;383384 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {385 let limit = <SponsoringRateLimit<T>>::get(contract_address);386387 let timeout = last_tx_block + limit;388 if block_number < timeout {389 return None;390 }391 }392393 <SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);394395 Some(sponsor)396 }397}398399generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);400generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);pallets/evm-contract-helpers/src/lib.rsdiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/lib.rs
+++ b/pallets/evm-contract-helpers/src/lib.rs
@@ -16,7 +16,7 @@
#![doc = include_str!("../README.md")]
#![cfg_attr(not(feature = "std"), no_std)]
-#![deny(missing_docs)]
+#![warn(missing_docs)]
use codec::{Decode, Encode, MaxEncodedLen};
pub use pallet::*;
@@ -27,18 +27,24 @@
#[frame_support::pallet]
pub mod pallet {
pub use super::*;
+ use crate::eth::ContractHelpersEvents;
use frame_support::pallet_prelude::*;
use pallet_evm_coder_substrate::DispatchResult;
use sp_core::H160;
- use pallet_evm::account::CrossAccountId;
+ use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use up_data_structs::SponsorshipState;
+ use evm_coder::ToLog;
#[pallet::config]
pub trait Config:
frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::account::Config
{
+ /// Overarching event type.
+ type Event: IsType<<Self as frame_system::Config>::Event> + From<Event<Self>>;
+
/// Address, under which magic contract will be available
type ContractAddress: Get<H160>;
+
/// In case of enabled sponsoring, but no sponsoring rate limit set,
/// this value will be used implicitly
type DefaultSponsoringRateLimit: Get<Self::BlockNumber>;
@@ -150,6 +156,32 @@
QueryKind = ValueQuery,
>;
+ #[pallet::event]
+ #[pallet::generate_deposit(pub fn deposit_event)]
+ pub enum Event<T: Config> {
+ /// Contract sponsor was set.
+ ContractSponsorSet(
+ /// Contract address of the affected collection.
+ H160,
+ /// New sponsor address.
+ T::AccountId,
+ ),
+
+ /// New sponsor was confirm.
+ ContractSponsorshipConfirmed(
+ /// Contract address of the affected collection.
+ H160,
+ /// New sponsor address.
+ T::AccountId,
+ ),
+
+ /// Collection sponsor was removed.
+ ContractSponsorRemoved(
+ /// Contract address of the affected collection.
+ H160,
+ ),
+ }
+
impl<T: Config> Pallet<T> {
/// Get contract owner.
pub fn contract_owner(contract: H160) -> H160 {
@@ -169,43 +201,108 @@
contract,
SponsorshipState::<T::CrossAccountId>::Unconfirmed(sponsor.clone()),
);
+
+ <Pallet<T>>::deposit_event(Event::<T>::ContractSponsorSet(
+ contract,
+ sponsor.as_sub().clone(),
+ ));
+ <PalletEvm<T>>::deposit_log(
+ ContractHelpersEvents::ContractSponsorSet {
+ contract_address: contract,
+ sponsor: *sponsor.as_eth(),
+ }
+ .to_log(contract),
+ );
Ok(())
}
- /// Set `contract` as self sponsored.
+ /// Set sponsor as already confirmed.
///
/// `sender` must be owner of contract.
- pub fn self_sponsored_enable(sender: &T::CrossAccountId, contract: H160) -> DispatchResult {
- Pallet::<T>::ensure_owner(contract, *sender.as_eth())?;
+ pub fn force_set_sponsor(
+ sender: &T::CrossAccountId,
+ contract_address: H160,
+ sponsor: &T::CrossAccountId,
+ ) -> DispatchResult {
+ Pallet::<T>::ensure_owner(contract_address, *sender.as_eth())?;
Sponsoring::<T>::insert(
- contract,
+ contract_address,
SponsorshipState::<T::CrossAccountId>::Confirmed(T::CrossAccountId::from_eth(
- contract,
+ contract_address,
)),
);
+
+ let eth_sponsor = *sponsor.as_eth();
+ let sub_sponsor = sponsor.as_sub().clone();
+
+ <Pallet<T>>::deposit_event(Event::<T>::ContractSponsorSet(
+ contract_address,
+ sub_sponsor.clone(),
+ ));
+ <PalletEvm<T>>::deposit_log(
+ ContractHelpersEvents::ContractSponsorSet {
+ contract_address,
+ sponsor: eth_sponsor,
+ }
+ .to_log(contract_address),
+ );
+
+ <Pallet<T>>::deposit_event(Event::<T>::ContractSponsorshipConfirmed(
+ contract_address,
+ sub_sponsor,
+ ));
+ <PalletEvm<T>>::deposit_log(
+ ContractHelpersEvents::ContractSponsorshipConfirmed {
+ contract_address,
+ sponsor: eth_sponsor,
+ }
+ .to_log(contract_address),
+ );
+
Ok(())
}
/// Remove sponsor for `contract`.
///
/// `sender` must be owner of contract.
- pub fn remove_sponsor(sender: &T::CrossAccountId, contract: H160) -> DispatchResult {
- Pallet::<T>::ensure_owner(contract, *sender.as_eth())?;
- Sponsoring::<T>::remove(contract);
+ pub fn remove_sponsor(sender: &T::CrossAccountId, contract_address: H160) -> DispatchResult {
+ Pallet::<T>::ensure_owner(contract_address, *sender.as_eth())?;
+ Sponsoring::<T>::remove(contract_address);
+
+ <Pallet<T>>::deposit_event(Event::<T>::ContractSponsorRemoved(contract_address));
+ <PalletEvm<T>>::deposit_log(
+ ContractHelpersEvents::ContractSponsorRemoved { contract_address }.to_log(contract_address),
+ );
+
Ok(())
}
/// Confirm sponsorship.
///
/// `sender` must be same that set via [`set_sponsor`].
- pub fn confirm_sponsorship(sender: &T::CrossAccountId, contract: H160) -> DispatchResult {
- match Sponsoring::<T>::get(contract) {
+ pub fn confirm_sponsorship(sender: &T::CrossAccountId, contract_address: H160) -> DispatchResult {
+ match Sponsoring::<T>::get(contract_address) {
SponsorshipState::Unconfirmed(sponsor) => {
ensure!(sponsor == *sender, Error::<T>::NoPermission);
+ let eth_sponsor = *sponsor.as_eth();
+ let sub_sponsor = sponsor.as_sub().clone();
Sponsoring::<T>::insert(
- contract,
+ contract_address,
SponsorshipState::<T::CrossAccountId>::Confirmed(sponsor),
);
+
+ <Pallet<T>>::deposit_event(Event::<T>::ContractSponsorshipConfirmed(
+ contract_address,
+ sub_sponsor,
+ ));
+ <PalletEvm<T>>::deposit_log(
+ ContractHelpersEvents::ContractSponsorshipConfirmed {
+ contract_address,
+ sponsor: eth_sponsor,
+ }
+ .to_log(contract_address),
+ );
+
Ok(())
}
SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => {
pallets/evm-contract-helpers/src/stubs/ContractHelpers.rawdiffbeforeafterbothbinary blob — no preview
pallets/evm-contract-helpers/src/stubs/ContractHelpers.soldiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/stubs/ContractHelpers.sol
+++ b/pallets/evm-contract-helpers/src/stubs/ContractHelpers.sol
@@ -21,9 +21,19 @@
}
}
+/// @dev inlined interface
+contract ContractHelpersEvents {
+ event ContractSponsorSet(address indexed contractAddress, address sponsor);
+ event ContractSponsorshipConfirmed(
+ address indexed contractAddress,
+ address sponsor
+ );
+ event ContractSponsorRemoved(address indexed contractAddress);
+}
+
/// @title Magic contract, which allows users to reconfigure other contracts
/// @dev the ERC-165 identifier for this interface is 0xd77fab70
-contract ContractHelpers is Dummy, ERC165 {
+contract ContractHelpers is Dummy, ERC165, ContractHelpersEvents {
/// Get user, which deployed specified contract
/// @dev May return zero address in case if contract is deployed
/// using uniquenetwork evm-migration pallet, or using other terms not
runtime/common/config/ethereum.rsdiffbeforeafterboth--- a/runtime/common/config/ethereum.rs
+++ b/runtime/common/config/ethereum.rs
@@ -112,6 +112,7 @@
}
impl pallet_evm_contract_helpers::Config for Runtime {
+ type Event = Event;
type ContractAddress = HelpersContractAddress;
type DefaultSponsoringRateLimit = DefaultSponsoringRateLimit;
}
runtime/common/construct_runtime/mod.rsdiffbeforeafterboth--- a/runtime/common/construct_runtime/mod.rs
+++ b/runtime/common/construct_runtime/mod.rs
@@ -85,7 +85,7 @@
Ethereum: pallet_ethereum::{Pallet, Config, Call, Storage, Event, Origin} = 101,
EvmCoderSubstrate: pallet_evm_coder_substrate::{Pallet, Storage} = 150,
- EvmContractHelpers: pallet_evm_contract_helpers::{Pallet, Storage} = 151,
+ EvmContractHelpers: pallet_evm_contract_helpers::{Pallet, Storage, Event<T>} = 151,
EvmTransactionPayment: pallet_evm_transaction_payment::{Pallet} = 152,
EvmMigration: pallet_evm_migration::{Pallet, Call, Storage} = 153,
}
tests/src/eth/api/ContractHelpers.soldiffbeforeafterboth--- a/tests/src/eth/api/ContractHelpers.sol
+++ b/tests/src/eth/api/ContractHelpers.sol
@@ -12,9 +12,19 @@
function supportsInterface(bytes4 interfaceID) external view returns (bool);
}
+/// @dev inlined interface
+interface ContractHelpersEvents {
+ event ContractSponsorSet(address indexed contractAddress, address sponsor);
+ event ContractSponsorshipConfirmed(
+ address indexed contractAddress,
+ address sponsor
+ );
+ event ContractSponsorRemoved(address indexed contractAddress);
+}
+
/// @title Magic contract, which allows users to reconfigure other contracts
/// @dev the ERC-165 identifier for this interface is 0xd77fab70
-interface ContractHelpers is Dummy, ERC165 {
+interface ContractHelpers is Dummy, ERC165, ContractHelpersEvents {
/// Get user, which deployed specified contract
/// @dev May return zero address in case if contract is deployed
/// using uniquenetwork evm-migration pallet, or using other terms not
tests/src/eth/contractSponsoring.test.tsdiffbeforeafterboth--- a/tests/src/eth/contractSponsoring.test.ts
+++ b/tests/src/eth/contractSponsoring.test.ts
@@ -24,6 +24,7 @@
SponsoringMode,
createEthAccount,
ethBalanceViaSub,
+ normalizeEvents,
} from './util/helpers';
describe('Sponsoring EVM contracts', () => {
@@ -36,6 +37,33 @@
expect(await helpers.methods.hasSponsor(flipper.options.address).call()).to.be.true;
});
+ itWeb3.only('Set self sponsored events', async ({api, web3, privateKeyWrapper}) => {
+ const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const flipper = await deployFlipper(web3, owner);
+ const helpers = contractHelpers(web3, owner);
+
+ const result = await helpers.methods.selfSponsoredEnable(flipper.options.address).send();
+ const events = normalizeEvents(result.events);
+ expect(events).to.be.deep.equal([
+ {
+ address: flipper.options.address,
+ event: 'ContractSponsorSet',
+ args: {
+ contractAddress: flipper.options.address,
+ sponsor: flipper.options.address,
+ },
+ },
+ {
+ address: flipper.options.address,
+ event: 'ContractSponsorshipConfirmed',
+ args: {
+ contractAddress: flipper.options.address,
+ sponsor: flipper.options.address,
+ },
+ },
+ ]);
+ });
+
itWeb3('Self sponsored can not be set by the address that did not deployed the contract', async ({api, web3, privateKeyWrapper}) => {
const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const notOwner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
@@ -75,6 +103,26 @@
expect(await helpers.methods.hasPendingSponsor(flipper.options.address).call()).to.be.true;
});
+ itWeb3('Set sponsor event', async ({api, web3, privateKeyWrapper}) => {
+ const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const sponsor = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const flipper = await deployFlipper(web3, owner);
+ const helpers = contractHelpers(web3, owner);
+
+ const result = await helpers.methods.setSponsor(flipper.options.address, sponsor).send();
+ const events = normalizeEvents(result.events);
+ expect(events).to.be.deep.equal([
+ {
+ address: flipper.options.address,
+ event: 'ContractSponsorSet',
+ args: {
+ contractAddress: flipper.options.address,
+ sponsor: sponsor,
+ },
+ },
+ ]);
+ });
+
itWeb3('Sponsor can not be set by the address that did not deployed the contract', async ({api, web3, privateKeyWrapper}) => {
const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const sponsor = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
@@ -97,6 +145,26 @@
expect(await helpers.methods.hasSponsor(flipper.options.address).call()).to.be.true;
});
+ itWeb3('Confirm sponsorship event', async ({api, web3, privateKeyWrapper}) => {
+ const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const sponsor = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const flipper = await deployFlipper(web3, owner);
+ const helpers = contractHelpers(web3, owner);
+ await expect(helpers.methods.setSponsor(flipper.options.address, sponsor).send()).to.be.not.rejected;
+ const result = await helpers.methods.confirmSponsorship(flipper.options.address).send({from: sponsor});
+ const events = normalizeEvents(result.events);
+ expect(events).to.be.deep.equal([
+ {
+ address: flipper.options.address,
+ event: 'ContractSponsorshipConfirmed',
+ args: {
+ contractAddress: flipper.options.address,
+ sponsor: sponsor,
+ },
+ },
+ ]);
+ });
+
itWeb3('Sponsorship can not be confirmed by the address that not pending as sponsor', async ({api, web3, privateKeyWrapper}) => {
const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const sponsor = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
@@ -160,6 +228,28 @@
expect(await helpers.methods.hasSponsor(flipper.options.address).call()).to.be.false;
});
+ itWeb3('Remove sponsor event', async ({api, web3, privateKeyWrapper}) => {
+ const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const sponsor = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
+ const flipper = await deployFlipper(web3, owner);
+ const helpers = contractHelpers(web3, owner);
+
+ await helpers.methods.setSponsor(flipper.options.address, sponsor).send();
+ await helpers.methods.confirmSponsorship(flipper.options.address).send({from: sponsor});
+
+ const result = await helpers.methods.removeSponsor(flipper.options.address).send();
+ const events = normalizeEvents(result.events);
+ expect(events).to.be.deep.equal([
+ {
+ address: flipper.options.address,
+ event: 'ContractSponsorRemoved',
+ args: {
+ contractAddress: flipper.options.address,
+ },
+ },
+ ]);
+ });
+
itWeb3('Sponsor can not be removed by the address that did not deployed the contract', async ({api, web3, privateKeyWrapper}) => {
const owner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
const notOwner = await createEthAccountWithBalance(api, web3, privateKeyWrapper);
tests/src/eth/util/contractHelpersAbi.jsondiffbeforeafterboth--- a/tests/src/eth/util/contractHelpersAbi.json
+++ b/tests/src/eth/util/contractHelpersAbi.json
@@ -1,5 +1,56 @@
[
{
+ "anonymous": false,
+ "inputs": [
+ {
+ "indexed": true,
+ "internalType": "address",
+ "name": "contractAddress",
+ "type": "address"
+ }
+ ],
+ "name": "ContractSponsorRemoved",
+ "type": "event"
+ },
+ {
+ "anonymous": false,
+ "inputs": [
+ {
+ "indexed": true,
+ "internalType": "address",
+ "name": "contractAddress",
+ "type": "address"
+ },
+ {
+ "indexed": false,
+ "internalType": "address",
+ "name": "sponsor",
+ "type": "address"
+ }
+ ],
+ "name": "ContractSponsorSet",
+ "type": "event"
+ },
+ {
+ "anonymous": false,
+ "inputs": [
+ {
+ "indexed": true,
+ "internalType": "address",
+ "name": "contractAddress",
+ "type": "address"
+ },
+ {
+ "indexed": false,
+ "internalType": "address",
+ "name": "sponsor",
+ "type": "address"
+ }
+ ],
+ "name": "ContractSponsorshipConfirmed",
+ "type": "event"
+ },
+ {
"inputs": [
{
"internalType": "address",