git.delta.rocks / unique-network / refs/commits / 8138c78fd9cb

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);