git.delta.rocks / unique-network / refs/commits / 0335e511ccbf

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