git.delta.rocks / unique-network / refs/commits / d190a670c95b

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,46		/// New sponsor address.47		#[indexed]48		sponsor: address,49	},5051	/// New sponsor was confirm.52	ContractSponsorshipConfirmed {53		/// Contract address of the affected collection.54		#[indexed]55		contract: address,56		/// New sponsor address.57		#[indexed]58		sponsor: address,59	},6061	/// Collection sponsor was removed.62	ContractSponsorRemoved {63		/// Contract address of the affected collection.64		#[indexed]65		contract: address,66	},67}6869/// See [`ContractHelpersCall`]70pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);71impl<T: Config> WithRecorder<T> for ContractHelpers<T> {72	fn recorder(&self) -> &SubstrateRecorder<T> {73		&self.074	}7576	fn into_recorder(self) -> SubstrateRecorder<T> {77		self.078	}79}8081/// @title Magic contract, which allows users to reconfigure other contracts82#[solidity_interface(name = ContractHelpers, events(ContractHelpersEvents))]83impl<T: Config> ContractHelpers<T>84where85	T::AccountId: AsRef<[u8; 32]>,86{87	/// Get user, which deployed specified contract88	/// @dev May return zero address in case if contract is deployed89	///  using uniquenetwork evm-migration pallet, or using other terms not90	///  intended by pallet-evm91	/// @dev Returns zero address if contract does not exists92	/// @param contractAddress Contract to get owner of93	/// @return address Owner of contract94	fn contract_owner(&self, contract_address: address) -> Result<address> {95		Ok(<Owner<T>>::get(contract_address))96	}9798	/// Set sponsor.99	/// @param contractAddress Contract for which a sponsor is being established.100	/// @param sponsor User address who set as pending sponsor.101	fn set_sponsor(102		&mut self,103		caller: caller,104		contract_address: address,105		sponsor: address,106	) -> Result<void> {107		self.recorder().consume_sload()?;108		self.recorder().consume_sstore()?;109110		Pallet::<T>::set_sponsor(111			&T::CrossAccountId::from_eth(caller),112			contract_address,113			&T::CrossAccountId::from_eth(sponsor),114		)115		.map_err(dispatch_to_evm::<T>)?;116117		Ok(())118	}119120	/// Set contract as self sponsored.121	///122	/// @param contractAddress Contract for which a self sponsoring is being enabled.123	fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {124		self.recorder().consume_sload()?;125		self.recorder().consume_sstore()?;126127		Pallet::<T>::force_set_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)128			.map_err(dispatch_to_evm::<T>)?;129130		Ok(())131	}132133	/// Remove sponsor.134	///135	/// @param contractAddress Contract for which a sponsorship is being removed.136	fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {137		self.recorder().consume_sload()?;138		self.recorder().consume_sstore()?;139140		Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)141			.map_err(dispatch_to_evm::<T>)?;142143		Ok(())144	}145146	/// Confirm sponsorship.147	///148	/// @dev Caller must be same that set via [`setSponsor`].149	///150	/// @param contractAddress Сontract for which need to confirm sponsorship.151	fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {152		self.recorder().consume_sload()?;153		self.recorder().consume_sstore()?;154155		Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)156			.map_err(dispatch_to_evm::<T>)?;157158		Ok(())159	}160161	/// Get current sponsor.162	///163	/// @param contractAddress The contract for which a sponsor is requested.164	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.165	fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {166		let sponsor =167			Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;168		let result: (address, uint256) = if sponsor.is_canonical_substrate() {169			let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);170			(Default::default(), sponsor)171		} else {172			let sponsor = *sponsor.as_eth();173			(sponsor, Default::default())174		};175		Ok(result)176	}177178	/// Check tat contract has confirmed sponsor.179	///180	/// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.181	/// @return **true** if contract has confirmed sponsor.182	fn has_sponsor(&self, contract_address: address) -> Result<bool> {183		Ok(Pallet::<T>::get_sponsor(contract_address).is_some())184	}185186	/// Check tat contract has pending sponsor.187	///188	/// @param contractAddress The contract for which the presence of a pending sponsor is checked.189	/// @return **true** if contract has pending sponsor.190	fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {191		Ok(match Sponsoring::<T>::get(contract_address) {192			SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,193			SponsorshipState::Unconfirmed(_) => true,194		})195	}196197	fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {198		Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)199	}200201	fn set_sponsoring_mode(202		&mut self,203		caller: caller,204		contract_address: address,205		// TODO: implement support for enums in evm-coder206		mode: uint8,207	) -> Result<void> {208		self.recorder().consume_sload()?;209		self.recorder().consume_sstore()?;210211		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;212		let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;213		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);214215		Ok(())216	}217218	/// Get current contract sponsoring rate limit219	/// @param contractAddress Contract to get sponsoring mode of220	/// @return uint32 Amount of blocks between two sponsored transactions221	fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {222		Ok(<SponsoringRateLimit<T>>::get(contract_address)223			.try_into()224			.map_err(|_| "rate limit > u32::MAX")?)225	}226227	/// Set contract sponsoring rate limit228	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should229	///  pass between two sponsored transactions230	/// @param contractAddress Contract to change sponsoring rate limit of231	/// @param rateLimit Target rate limit232	/// @dev Only contract owner can change this setting233	fn set_sponsoring_rate_limit(234		&mut self,235		caller: caller,236		contract_address: address,237		rate_limit: uint32,238	) -> Result<void> {239		self.recorder().consume_sload()?;240		self.recorder().consume_sstore()?;241242		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;243		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());244		Ok(())245	}246247	/// Is specified user present in contract allow list248	/// @dev Contract owner always implicitly included249	/// @param contractAddress Contract to check allowlist of250	/// @param user User to check251	/// @return bool Is specified users exists in contract allowlist252	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {253		self.0.consume_sload()?;254		Ok(<Pallet<T>>::allowed(contract_address, user))255	}256257	/// Toggle user presence in contract allowlist258	/// @param contractAddress Contract to change allowlist of259	/// @param user Which user presence should be toggled260	/// @param isAllowed `true` if user should be allowed to be sponsored261	///  or call this contract, `false` otherwise262	/// @dev Only contract owner can change this setting263	fn toggle_allowed(264		&mut self,265		caller: caller,266		contract_address: address,267		user: address,268		is_allowed: bool,269	) -> Result<void> {270		self.recorder().consume_sload()?;271		self.recorder().consume_sstore()?;272273		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;274		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);275276		Ok(())277	}278279	/// Is this contract has allowlist access enabled280	/// @dev Allowlist always can have users, and it is used for two purposes:281	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist282	///  in case of allowlist access enabled, only users from allowlist may call this contract283	/// @param contractAddress Contract to get allowlist access of284	/// @return bool Is specified contract has allowlist access enabled285	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {286		Ok(<AllowlistEnabled<T>>::get(contract_address))287	}288289	/// Toggle contract allowlist access290	/// @param contractAddress Contract to change allowlist access of291	/// @param enabled Should allowlist access to be enabled?292	fn toggle_allowlist(293		&mut self,294		caller: caller,295		contract_address: address,296		enabled: bool,297	) -> Result<void> {298		self.recorder().consume_sload()?;299		self.recorder().consume_sstore()?;300301		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;302		<Pallet<T>>::toggle_allowlist(contract_address, enabled);303		Ok(())304	}305}306307/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]308pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);309impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>310where311	T::AccountId: AsRef<[u8; 32]>,312{313	fn is_reserved(contract: &sp_core::H160) -> bool {314		contract == &T::ContractAddress::get()315	}316317	fn is_used(contract: &sp_core::H160) -> bool {318		contract == &T::ContractAddress::get()319	}320321	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {322		// TODO: Extract to another OnMethodCall handler323		if <AllowlistEnabled<T>>::get(handle.code_address())324			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)325		{326			return Some(Err(PrecompileFailure::Revert {327				exit_status: ExitRevert::Reverted,328				output: {329					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));330					writer.string("Target contract is allowlisted");331					writer.finish()332				},333			}));334		}335336		if handle.code_address() != T::ContractAddress::get() {337			return None;338		}339340		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));341		pallet_evm_coder_substrate::call(handle, helpers)342	}343344	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {345		(contract == &T::ContractAddress::get())346			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())347	}348}349350/// Hooks into contract creation, storing owner of newly deployed contract351pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);352impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {353	fn on_create(owner: H160, contract: H160) {354		<Owner<T>>::insert(contract, owner);355	}356}357358/// Bridge to pallet-sponsoring359pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);360impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>361	for HelpersContractSponsoring<T>362{363	fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {364		let (contract_address, _) = call;365		let mode = <Pallet<T>>::sponsoring_mode(*contract_address);366		if mode == SponsoringModeT::Disabled {367			return None;368		}369370		let sponsor = match <Pallet<T>>::get_sponsor(*contract_address) {371			Some(sponsor) => sponsor,372			None => return None,373		};374375		if mode == SponsoringModeT::Allowlisted376			&& !<Pallet<T>>::allowed(*contract_address, *who.as_eth())377		{378			return None;379		}380		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;381382		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {383			let limit = <SponsoringRateLimit<T>>::get(contract_address);384385			let timeout = last_tx_block + limit;386			if block_number < timeout {387				return None;388			}389		}390391		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);392393		Some(sponsor)394	}395}396397generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);398generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);