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

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::{24	ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,25	account::CrossAccountId,26};27use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};28use pallet_evm_transaction_payment::CallContext;29use sp_core::{H160, U256};30use up_data_structs::SponsorshipState;31use crate::{32	AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringFeeLimit,33	SponsoringRateLimit, SponsoringModeT, Sponsoring,34};35use frame_support::traits::Get;36use up_sponsorship::SponsorshipHandler;37use sp_std::vec::Vec;3839/// Pallet events.40#[derive(ToLog)]41pub enum ContractHelpersEvents {42	/// Contract sponsor was set.43	ContractSponsorSet {44		/// Contract address of the affected collection.45		#[indexed]46		contract_address: address,47		/// New sponsor address.48		sponsor: address,49	},5051	/// New sponsor was confirm.52	ContractSponsorshipConfirmed {53		/// Contract address of the affected collection.54		#[indexed]55		contract_address: address,56		/// New sponsor address.57		sponsor: address,58	},5960	/// Collection sponsor was removed.61	ContractSponsorRemoved {62		/// Contract address of the affected collection.63		#[indexed]64		contract_address: address,65	},66}6768/// See [`ContractHelpersCall`]69pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);70impl<T: Config> WithRecorder<T> for ContractHelpers<T> {71	fn recorder(&self) -> &SubstrateRecorder<T> {72		&self.073	}7475	fn into_recorder(self) -> SubstrateRecorder<T> {76		self.077	}78}7980/// @title Magic contract, which allows users to reconfigure other contracts81#[solidity_interface(name = ContractHelpers, events(ContractHelpersEvents))]82impl<T: Config> ContractHelpers<T>83where84	T::AccountId: AsRef<[u8; 32]>,85{86	/// Get user, which deployed specified contract87	/// @dev May return zero address in case if contract is deployed88	///  using uniquenetwork evm-migration pallet, or using other terms not89	///  intended by pallet-evm90	/// @dev Returns zero address if contract does not exists91	/// @param contractAddress Contract to get owner of92	/// @return address Owner of contract93	fn contract_owner(&self, contract_address: address) -> Result<address> {94		Ok(<Owner<T>>::get(contract_address))95	}9697	/// Set sponsor.98	/// @param contractAddress Contract for which a sponsor is being established.99	/// @param sponsor User address who set as pending sponsor.100	fn set_sponsor(101		&mut self,102		caller: caller,103		contract_address: address,104		sponsor: address,105	) -> Result<void> {106		self.recorder().consume_sload()?;107		self.recorder().consume_sstore()?;108109		Pallet::<T>::set_sponsor(110			&T::CrossAccountId::from_eth(caller),111			contract_address,112			&T::CrossAccountId::from_eth(sponsor),113		)114		.map_err(dispatch_to_evm::<T>)?;115116		Ok(())117	}118119	/// Set contract as self sponsored.120	///121	/// @param contractAddress Contract for which a self sponsoring is being enabled.122	fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {123		self.recorder().consume_sload()?;124		self.recorder().consume_sstore()?;125126		let caller = T::CrossAccountId::from_eth(caller);127128		Pallet::<T>::ensure_owner(contract_address, *caller.as_eth())129			.map_err(dispatch_to_evm::<T>)?;130131		Pallet::<T>::force_set_sponsor(132			contract_address,133			&T::CrossAccountId::from_eth(contract_address),134		)135		.map_err(dispatch_to_evm::<T>)?;136137		Ok(())138	}139140	/// Remove sponsor.141	///142	/// @param contractAddress Contract for which a sponsorship is being removed.143	fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {144		self.recorder().consume_sload()?;145		self.recorder().consume_sstore()?;146147		Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)148			.map_err(dispatch_to_evm::<T>)?;149150		Ok(())151	}152153	/// Confirm sponsorship.154	///155	/// @dev Caller must be same that set via [`setSponsor`].156	///157	/// @param contractAddress Сontract for which need to confirm sponsorship.158	fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {159		self.recorder().consume_sload()?;160		self.recorder().consume_sstore()?;161162		Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)163			.map_err(dispatch_to_evm::<T>)?;164165		Ok(())166	}167168	/// Get current sponsor.169	///170	/// @param contractAddress The contract for which a sponsor is requested.171	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.172	fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {173		let sponsor =174			Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;175		let result: (address, uint256) = if sponsor.is_canonical_substrate() {176			let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);177			(Default::default(), sponsor)178		} else {179			let sponsor = *sponsor.as_eth();180			(sponsor, Default::default())181		};182		Ok(result)183	}184185	/// Check tat contract has confirmed sponsor.186	///187	/// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.188	/// @return **true** if contract has confirmed sponsor.189	fn has_sponsor(&self, contract_address: address) -> Result<bool> {190		Ok(Pallet::<T>::get_sponsor(contract_address).is_some())191	}192193	/// Check tat contract has pending sponsor.194	///195	/// @param contractAddress The contract for which the presence of a pending sponsor is checked.196	/// @return **true** if contract has pending sponsor.197	fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {198		Ok(match Sponsoring::<T>::get(contract_address) {199			SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,200			SponsorshipState::Unconfirmed(_) => true,201		})202	}203204	fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {205		Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)206	}207208	fn set_sponsoring_mode(209		&mut self,210		caller: caller,211		contract_address: address,212		// TODO: implement support for enums in evm-coder213		mode: uint8,214	) -> Result<void> {215		self.recorder().consume_sload()?;216		self.recorder().consume_sstore()?;217218		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;219		let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;220		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);221222		Ok(())223	}224225	/// Get current contract sponsoring rate limit226	/// @param contractAddress Contract to get sponsoring rate limit of227	/// @return uint32 Amount of blocks between two sponsored transactions228	fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {229		self.recorder().consume_sload()?;230231		Ok(<SponsoringRateLimit<T>>::get(contract_address)232			.try_into()233			.map_err(|_| "rate limit > u32::MAX")?)234	}235236	/// Set contract sponsoring rate limit237	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should238	///  pass between two sponsored transactions239	/// @param contractAddress Contract to change sponsoring rate limit of240	/// @param rateLimit Target rate limit241	/// @dev Only contract owner can change this setting242	fn set_sponsoring_rate_limit(243		&mut self,244		caller: caller,245		contract_address: address,246		rate_limit: uint32,247	) -> Result<void> {248		self.recorder().consume_sload()?;249		self.recorder().consume_sstore()?;250251		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;252		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());253		Ok(())254	}255256	/// Set contract sponsoring fee limit257	/// @dev Sponsoring fee limit - is maximum fee that could be spent by258	///  single transaction259	/// @param contractAddress Contract to change sponsoring fee limit of260	/// @param feeLimit Fee limit261	/// @dev Only contract owner can change this setting262	fn set_sponsoring_fee_limit(263		&mut self,264		caller: caller,265		contract_address: address,266		fee_limit: uint256,267	) -> Result<void> {268		self.recorder().consume_sload()?;269		self.recorder().consume_sstore()?;270271		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;272		<Pallet<T>>::set_sponsoring_fee_limit(contract_address, fee_limit.into())273			.map_err(dispatch_to_evm::<T>)?;274		Ok(())275	}276277	/// Get current contract sponsoring fee limit278	/// @param contractAddress Contract to get sponsoring fee limit of279	/// @return uint256 Maximum amount of fee that could be spent by single280	///  transaction281	fn get_sponsoring_fee_limit(&self, contract_address: address) -> Result<uint256> {282		self.recorder().consume_sload()?;283284		Ok(get_sponsoring_fee_limit::<T>(contract_address))285	}286287	/// Is specified user present in contract allow list288	/// @dev Contract owner always implicitly included289	/// @param contractAddress Contract to check allowlist of290	/// @param user User to check291	/// @return bool Is specified users exists in contract allowlist292	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {293		self.0.consume_sload()?;294		Ok(<Pallet<T>>::allowed(contract_address, user))295	}296297	/// Toggle user presence in contract allowlist298	/// @param contractAddress Contract to change allowlist of299	/// @param user Which user presence should be toggled300	/// @param isAllowed `true` if user should be allowed to be sponsored301	///  or call this contract, `false` otherwise302	/// @dev Only contract owner can change this setting303	fn toggle_allowed(304		&mut self,305		caller: caller,306		contract_address: address,307		user: address,308		is_allowed: bool,309	) -> Result<void> {310		self.recorder().consume_sload()?;311		self.recorder().consume_sstore()?;312313		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;314		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);315316		Ok(())317	}318319	/// Is this contract has allowlist access enabled320	/// @dev Allowlist always can have users, and it is used for two purposes:321	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist322	///  in case of allowlist access enabled, only users from allowlist may call this contract323	/// @param contractAddress Contract to get allowlist access of324	/// @return bool Is specified contract has allowlist access enabled325	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {326		Ok(<AllowlistEnabled<T>>::get(contract_address))327	}328329	/// Toggle contract allowlist access330	/// @param contractAddress Contract to change allowlist access of331	/// @param enabled Should allowlist access to be enabled?332	fn toggle_allowlist(333		&mut self,334		caller: caller,335		contract_address: address,336		enabled: bool,337	) -> Result<void> {338		self.recorder().consume_sload()?;339		self.recorder().consume_sstore()?;340341		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;342		<Pallet<T>>::toggle_allowlist(contract_address, enabled);343		Ok(())344	}345}346347/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]348pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);349impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>350where351	T::AccountId: AsRef<[u8; 32]>,352{353	fn is_reserved(contract: &sp_core::H160) -> bool {354		contract == &T::ContractAddress::get()355	}356357	fn is_used(contract: &sp_core::H160) -> bool {358		contract == &T::ContractAddress::get()359	}360361	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {362		// TODO: Extract to another OnMethodCall handler363		if <AllowlistEnabled<T>>::get(handle.code_address())364			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)365		{366			return Some(Err(PrecompileFailure::Revert {367				exit_status: ExitRevert::Reverted,368				output: {369					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));370					writer.string("Target contract is allowlisted");371					writer.finish()372				},373			}));374		}375376		if handle.code_address() != T::ContractAddress::get() {377			return None;378		}379380		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));381		pallet_evm_coder_substrate::call(handle, helpers)382	}383384	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {385		(contract == &T::ContractAddress::get())386			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())387	}388}389390/// Hooks into contract creation, storing owner of newly deployed contract391pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);392impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {393	fn on_create(owner: H160, contract: H160) {394		<Owner<T>>::insert(contract, owner);395	}396}397398/// Bridge to pallet-sponsoring399pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);400impl<T: Config> SponsorshipHandler<T::CrossAccountId, CallContext>401	for HelpersContractSponsoring<T>402{403	fn get_sponsor(404		who: &T::CrossAccountId,405		call_context: &CallContext,406	) -> Option<T::CrossAccountId> {407		let contract_address = call_context.contract_address;408		let mode = <Pallet<T>>::sponsoring_mode(contract_address);409		if mode == SponsoringModeT::Disabled {410			return None;411		}412413		let sponsor = match <Pallet<T>>::get_sponsor(contract_address) {414			Some(sponsor) => sponsor,415			None => return None,416		};417418		if mode == SponsoringModeT::Allowlisted419			&& !<Pallet<T>>::allowed(contract_address, *who.as_eth())420		{421			return None;422		}423		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;424425		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {426			let limit = <SponsoringRateLimit<T>>::get(contract_address);427428			let timeout = last_tx_block + limit;429			if block_number < timeout {430				return None;431			}432		}433434		let sponsored_fee_limit = get_sponsoring_fee_limit::<T>(contract_address);435436		if call_context.max_fee > sponsored_fee_limit {437			return None;438		}439440		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);441442		Some(sponsor)443	}444}445446fn get_sponsoring_fee_limit<T: Config>(contract_address: address) -> uint256 {447	<SponsoringFeeLimit<T>>::get(contract_address)448		.get(&0xffffffff)449		.cloned()450		.unwrap_or(U256::MAX)451}452453generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);454generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);