git.delta.rocks / unique-network / refs/commits / 8900b85b9a67

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 contract1819extern crate alloc;20use core::marker::PhantomData;21use evm_coder::{22	abi::{AbiWriter, AbiType},23	execution::Result,24	generate_stubgen, solidity_interface,25	types::*,26	ToLog,27};28use pallet_common::eth;29use pallet_evm::{30	ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,31	account::CrossAccountId,32};33use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};34use pallet_evm_transaction_payment::CallContext;35use sp_core::{H160, U256};36use up_data_structs::SponsorshipState;37use crate::{38	AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringFeeLimit,39	SponsoringRateLimit, SponsoringModeT, Sponsoring,40};41use frame_support::traits::Get;42use up_sponsorship::SponsorshipHandler;43use sp_std::vec::Vec;4445/// Pallet events.46#[derive(ToLog)]47pub enum ContractHelpersEvents {48	/// Contract sponsor was set.49	ContractSponsorSet {50		/// Contract address of the affected collection.51		#[indexed]52		contract_address: address,53		/// New sponsor address.54		sponsor: address,55	},5657	/// New sponsor was confirm.58	ContractSponsorshipConfirmed {59		/// Contract address of the affected collection.60		#[indexed]61		contract_address: address,62		/// New sponsor address.63		sponsor: address,64	},6566	/// Collection sponsor was removed.67	ContractSponsorRemoved {68		/// Contract address of the affected collection.69		#[indexed]70		contract_address: address,71	},72}7374/// See [`ContractHelpersCall`]75pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);76impl<T: Config> WithRecorder<T> for ContractHelpers<T> {77	fn recorder(&self) -> &SubstrateRecorder<T> {78		&self.079	}8081	fn into_recorder(self) -> SubstrateRecorder<T> {82		self.083	}84}8586/// @title Magic contract, which allows users to reconfigure other contracts87#[solidity_interface(name = ContractHelpers, events(ContractHelpersEvents))]88impl<T: Config> ContractHelpers<T>89where90	T::AccountId: AsRef<[u8; 32]>,91{92	/// Get user, which deployed specified contract93	/// @dev May return zero address in case if contract is deployed94	///  using uniquenetwork evm-migration pallet, or using other terms not95	///  intended by pallet-evm96	/// @dev Returns zero address if contract does not exists97	/// @param contractAddress Contract to get owner of98	/// @return address Owner of contract99	fn contract_owner(&self, contract_address: address) -> Result<address> {100		Ok(<Owner<T>>::get(contract_address))101	}102103	/// Set sponsor.104	/// @param contractAddress Contract for which a sponsor is being established.105	/// @param sponsor User address who set as pending sponsor.106	fn set_sponsor(107		&mut self,108		caller: caller,109		contract_address: address,110		sponsor: address,111	) -> Result<void> {112		self.recorder().consume_sload()?;113		self.recorder().consume_sstore()?;114115		Pallet::<T>::set_sponsor(116			&T::CrossAccountId::from_eth(caller),117			contract_address,118			&T::CrossAccountId::from_eth(sponsor),119		)120		.map_err(dispatch_to_evm::<T>)?;121122		Ok(())123	}124125	/// Set contract as self sponsored.126	///127	/// @param contractAddress Contract for which a self sponsoring is being enabled.128	fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {129		self.recorder().consume_sload()?;130		self.recorder().consume_sstore()?;131132		let caller = T::CrossAccountId::from_eth(caller);133134		Pallet::<T>::ensure_owner(contract_address, *caller.as_eth())135			.map_err(dispatch_to_evm::<T>)?;136137		Pallet::<T>::force_set_sponsor(138			contract_address,139			&T::CrossAccountId::from_eth(contract_address),140		)141		.map_err(dispatch_to_evm::<T>)?;142143		Ok(())144	}145146	/// Remove sponsor.147	///148	/// @param contractAddress Contract for which a sponsorship is being removed.149	fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {150		self.recorder().consume_sload()?;151		self.recorder().consume_sstore()?;152153		Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)154			.map_err(dispatch_to_evm::<T>)?;155156		Ok(())157	}158159	/// Confirm sponsorship.160	///161	/// @dev Caller must be same that set via [`setSponsor`].162	///163	/// @param contractAddress Сontract for which need to confirm sponsorship.164	fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {165		self.recorder().consume_sload()?;166		self.recorder().consume_sstore()?;167168		Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)169			.map_err(dispatch_to_evm::<T>)?;170171		Ok(())172	}173174	/// Get current sponsor.175	///176	/// @param contractAddress The contract for which a sponsor is requested.177	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.178	fn sponsor(&self, contract_address: address) -> Result<eth::OptionCrossAddress> {179		Ok(match Pallet::<T>::get_sponsor(contract_address) {180			Some(ref value) => eth::OptionCrossAddress {181				status: true,182				value: eth::CrossAddress::from_sub_cross_account::<T>(value),183			},184			None => eth::OptionCrossAddress {185				status: false,186				value: Default::default(),187			},188		})189	}190191	/// Check tat contract has confirmed sponsor.192	///193	/// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.194	/// @return **true** if contract has confirmed sponsor.195	fn has_sponsor(&self, contract_address: address) -> Result<bool> {196		Ok(Pallet::<T>::get_sponsor(contract_address).is_some())197	}198199	/// Check tat contract has pending sponsor.200	///201	/// @param contractAddress The contract for which the presence of a pending sponsor is checked.202	/// @return **true** if contract has pending sponsor.203	fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {204		Ok(match Sponsoring::<T>::get(contract_address) {205			SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,206			SponsorshipState::Unconfirmed(_) => true,207		})208	}209210	fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {211		Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)212	}213214	fn set_sponsoring_mode(215		&mut self,216		caller: caller,217		contract_address: address,218		mode: SponsoringModeT,219	) -> Result<void> {220		self.recorder().consume_sload()?;221		self.recorder().consume_sstore()?;222223		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;224		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);225226		Ok(())227	}228229	/// Get current contract sponsoring rate limit230	/// @param contractAddress Contract to get sponsoring rate limit of231	/// @return uint32 Amount of blocks between two sponsored transactions232	fn sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {233		self.recorder().consume_sload()?;234235		Ok(<SponsoringRateLimit<T>>::get(contract_address)236			.try_into()237			.map_err(|_| "rate limit > u32::MAX")?)238	}239240	/// Set contract sponsoring rate limit241	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should242	///  pass between two sponsored transactions243	/// @param contractAddress Contract to change sponsoring rate limit of244	/// @param rateLimit Target rate limit245	/// @dev Only contract owner can change this setting246	fn set_sponsoring_rate_limit(247		&mut self,248		caller: caller,249		contract_address: address,250		rate_limit: uint32,251	) -> Result<void> {252		self.recorder().consume_sload()?;253		self.recorder().consume_sstore()?;254255		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;256		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());257		Ok(())258	}259260	/// Set contract sponsoring fee limit261	/// @dev Sponsoring fee limit - is maximum fee that could be spent by262	///  single transaction263	/// @param contractAddress Contract to change sponsoring fee limit of264	/// @param feeLimit Fee limit265	/// @dev Only contract owner can change this setting266	fn set_sponsoring_fee_limit(267		&mut self,268		caller: caller,269		contract_address: address,270		fee_limit: uint256,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>>::set_sponsoring_fee_limit(contract_address, fee_limit.into())277			.map_err(dispatch_to_evm::<T>)?;278		Ok(())279	}280281	/// Get current contract sponsoring fee limit282	/// @param contractAddress Contract to get sponsoring fee limit of283	/// @return uint256 Maximum amount of fee that could be spent by single284	///  transaction285	fn sponsoring_fee_limit(&self, contract_address: address) -> Result<uint256> {286		self.recorder().consume_sload()?;287288		Ok(get_sponsoring_fee_limit::<T>(contract_address))289	}290291	/// Is specified user present in contract allow list292	/// @dev Contract owner always implicitly included293	/// @param contractAddress Contract to check allowlist of294	/// @param user User to check295	/// @return bool Is specified users exists in contract allowlist296	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {297		self.0.consume_sload()?;298		Ok(<Pallet<T>>::allowed(contract_address, user))299	}300301	/// Toggle user presence in contract allowlist302	/// @param contractAddress Contract to change allowlist of303	/// @param user Which user presence should be toggled304	/// @param isAllowed `true` if user should be allowed to be sponsored305	///  or call this contract, `false` otherwise306	/// @dev Only contract owner can change this setting307	fn toggle_allowed(308		&mut self,309		caller: caller,310		contract_address: address,311		user: address,312		is_allowed: bool,313	) -> Result<void> {314		self.recorder().consume_sload()?;315		self.recorder().consume_sstore()?;316317		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;318		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);319320		Ok(())321	}322323	/// Is this contract has allowlist access enabled324	/// @dev Allowlist always can have users, and it is used for two purposes:325	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist326	///  in case of allowlist access enabled, only users from allowlist may call this contract327	/// @param contractAddress Contract to get allowlist access of328	/// @return bool Is specified contract has allowlist access enabled329	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {330		Ok(<AllowlistEnabled<T>>::get(contract_address))331	}332333	/// Toggle contract allowlist access334	/// @param contractAddress Contract to change allowlist access of335	/// @param enabled Should allowlist access to be enabled?336	fn toggle_allowlist(337		&mut self,338		caller: caller,339		contract_address: address,340		enabled: bool,341	) -> Result<void> {342		self.recorder().consume_sload()?;343		self.recorder().consume_sstore()?;344345		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;346		<Pallet<T>>::toggle_allowlist(contract_address, enabled);347		Ok(())348	}349}350351/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]352pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);353impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>354where355	T::AccountId: AsRef<[u8; 32]>,356{357	fn is_reserved(contract: &sp_core::H160) -> bool {358		contract == &T::ContractAddress::get()359	}360361	fn is_used(contract: &sp_core::H160) -> bool {362		contract == &T::ContractAddress::get()363	}364365	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {366		// TODO: Extract to another OnMethodCall handler367		if <AllowlistEnabled<T>>::get(handle.code_address())368			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)369		{370			return Some(Err(PrecompileFailure::Revert {371				exit_status: ExitRevert::Reverted,372				output: {373					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));374					writer.string("Target contract is allowlisted");375					writer.finish()376				},377			}));378		}379380		if handle.code_address() != T::ContractAddress::get() {381			return None;382		}383384		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));385		pallet_evm_coder_substrate::call(handle, helpers)386	}387388	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {389		(contract == &T::ContractAddress::get())390			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())391	}392}393394/// Hooks into contract creation, storing owner of newly deployed contract395pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);396impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {397	fn on_create(owner: H160, contract: H160) {398		<Owner<T>>::insert(contract, owner);399	}400}401402/// Bridge to pallet-sponsoring403pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);404impl<T: Config> SponsorshipHandler<T::CrossAccountId, CallContext>405	for HelpersContractSponsoring<T>406{407	fn get_sponsor(408		who: &T::CrossAccountId,409		call_context: &CallContext,410	) -> Option<T::CrossAccountId> {411		let contract_address = call_context.contract_address;412		let mode = <Pallet<T>>::sponsoring_mode(contract_address);413		if mode == SponsoringModeT::Disabled {414			return None;415		}416417		let sponsor = match <Pallet<T>>::get_sponsor(contract_address) {418			Some(sponsor) => sponsor,419			None => return None,420		};421422		if mode == SponsoringModeT::Allowlisted423			&& !<Pallet<T>>::allowed(contract_address, *who.as_eth())424		{425			return None;426		}427		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;428429		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {430			let limit = <SponsoringRateLimit<T>>::get(contract_address);431432			let timeout = last_tx_block + limit;433			if block_number < timeout {434				return None;435			}436		}437438		let sponsored_fee_limit = get_sponsoring_fee_limit::<T>(contract_address);439440		if call_context.max_fee > sponsored_fee_limit {441			return None;442		}443444		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);445446		Some(sponsor)447	}448}449450fn get_sponsoring_fee_limit<T: Config>(contract_address: address) -> uint256 {451	<SponsoringFeeLimit<T>>::get(contract_address)452		.get(&0xffffffff)453		.cloned()454		.unwrap_or(U256::MAX)455}456457generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);458generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);