git.delta.rocks / unique-network / refs/commits / 91e514bdbb72

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<Option<eth::CrossAddress>> {179		Ok(match Pallet::<T>::get_sponsor(contract_address) {180			Some(ref value) => Some(eth::CrossAddress::from_sub_cross_account::<T>(value)),181			None => None,182		})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		mode: SponsoringModeT,213	) -> Result<void> {214		self.recorder().consume_sload()?;215		self.recorder().consume_sstore()?;216217		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;218		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);219220		Ok(())221	}222223	/// Get current contract sponsoring rate limit224	/// @param contractAddress Contract to get sponsoring rate limit of225	/// @return uint32 Amount of blocks between two sponsored transactions226	fn sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {227		self.recorder().consume_sload()?;228229		Ok(<SponsoringRateLimit<T>>::get(contract_address)230			.try_into()231			.map_err(|_| "rate limit > u32::MAX")?)232	}233234	/// Set contract sponsoring rate limit235	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should236	///  pass between two sponsored transactions237	/// @param contractAddress Contract to change sponsoring rate limit of238	/// @param rateLimit Target rate limit239	/// @dev Only contract owner can change this setting240	fn set_sponsoring_rate_limit(241		&mut self,242		caller: caller,243		contract_address: address,244		rate_limit: uint32,245	) -> Result<void> {246		self.recorder().consume_sload()?;247		self.recorder().consume_sstore()?;248249		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;250		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());251		Ok(())252	}253254	/// Set contract sponsoring fee limit255	/// @dev Sponsoring fee limit - is maximum fee that could be spent by256	///  single transaction257	/// @param contractAddress Contract to change sponsoring fee limit of258	/// @param feeLimit Fee limit259	/// @dev Only contract owner can change this setting260	fn set_sponsoring_fee_limit(261		&mut self,262		caller: caller,263		contract_address: address,264		fee_limit: uint256,265	) -> Result<void> {266		self.recorder().consume_sload()?;267		self.recorder().consume_sstore()?;268269		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;270		<Pallet<T>>::set_sponsoring_fee_limit(contract_address, fee_limit.into())271			.map_err(dispatch_to_evm::<T>)?;272		Ok(())273	}274275	/// Get current contract sponsoring fee limit276	/// @param contractAddress Contract to get sponsoring fee limit of277	/// @return uint256 Maximum amount of fee that could be spent by single278	///  transaction279	fn sponsoring_fee_limit(&self, contract_address: address) -> Result<uint256> {280		self.recorder().consume_sload()?;281282		Ok(get_sponsoring_fee_limit::<T>(contract_address))283	}284285	/// Is specified user present in contract allow list286	/// @dev Contract owner always implicitly included287	/// @param contractAddress Contract to check allowlist of288	/// @param user User to check289	/// @return bool Is specified users exists in contract allowlist290	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {291		self.0.consume_sload()?;292		Ok(<Pallet<T>>::allowed(contract_address, user))293	}294295	/// Toggle user presence in contract allowlist296	/// @param contractAddress Contract to change allowlist of297	/// @param user Which user presence should be toggled298	/// @param isAllowed `true` if user should be allowed to be sponsored299	///  or call this contract, `false` otherwise300	/// @dev Only contract owner can change this setting301	fn toggle_allowed(302		&mut self,303		caller: caller,304		contract_address: address,305		user: address,306		is_allowed: bool,307	) -> Result<void> {308		self.recorder().consume_sload()?;309		self.recorder().consume_sstore()?;310311		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;312		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);313314		Ok(())315	}316317	/// Is this contract has allowlist access enabled318	/// @dev Allowlist always can have users, and it is used for two purposes:319	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist320	///  in case of allowlist access enabled, only users from allowlist may call this contract321	/// @param contractAddress Contract to get allowlist access of322	/// @return bool Is specified contract has allowlist access enabled323	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {324		Ok(<AllowlistEnabled<T>>::get(contract_address))325	}326327	/// Toggle contract allowlist access328	/// @param contractAddress Contract to change allowlist access of329	/// @param enabled Should allowlist access to be enabled?330	fn toggle_allowlist(331		&mut self,332		caller: caller,333		contract_address: address,334		enabled: bool,335	) -> Result<void> {336		self.recorder().consume_sload()?;337		self.recorder().consume_sstore()?;338339		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;340		<Pallet<T>>::toggle_allowlist(contract_address, enabled);341		Ok(())342	}343}344345/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]346pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);347impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>348where349	T::AccountId: AsRef<[u8; 32]>,350{351	fn is_reserved(contract: &sp_core::H160) -> bool {352		contract == &T::ContractAddress::get()353	}354355	fn is_used(contract: &sp_core::H160) -> bool {356		contract == &T::ContractAddress::get()357	}358359	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {360		// TODO: Extract to another OnMethodCall handler361		if <AllowlistEnabled<T>>::get(handle.code_address())362			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)363		{364			return Some(Err(PrecompileFailure::Revert {365				exit_status: ExitRevert::Reverted,366				output: {367					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));368					writer.string("Target contract is allowlisted");369					writer.finish()370				},371			}));372		}373374		if handle.code_address() != T::ContractAddress::get() {375			return None;376		}377378		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));379		pallet_evm_coder_substrate::call(handle, helpers)380	}381382	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {383		(contract == &T::ContractAddress::get())384			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())385	}386}387388/// Hooks into contract creation, storing owner of newly deployed contract389pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);390impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {391	fn on_create(owner: H160, contract: H160) {392		<Owner<T>>::insert(contract, owner);393	}394}395396/// Bridge to pallet-sponsoring397pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);398impl<T: Config> SponsorshipHandler<T::CrossAccountId, CallContext>399	for HelpersContractSponsoring<T>400{401	fn get_sponsor(402		who: &T::CrossAccountId,403		call_context: &CallContext,404	) -> Option<T::CrossAccountId> {405		let contract_address = call_context.contract_address;406		let mode = <Pallet<T>>::sponsoring_mode(contract_address);407		if mode == SponsoringModeT::Disabled {408			return None;409		}410411		let sponsor = match <Pallet<T>>::get_sponsor(contract_address) {412			Some(sponsor) => sponsor,413			None => return None,414		};415416		if mode == SponsoringModeT::Allowlisted417			&& !<Pallet<T>>::allowed(contract_address, *who.as_eth())418		{419			return None;420		}421		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;422423		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {424			let limit = <SponsoringRateLimit<T>>::get(contract_address);425426			let timeout = last_tx_block + limit;427			if block_number < timeout {428				return None;429			}430		}431432		let sponsored_fee_limit = get_sponsoring_fee_limit::<T>(contract_address);433434		if call_context.max_fee > sponsored_fee_limit {435			return None;436		}437438		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);439440		Some(sponsor)441	}442}443444fn get_sponsoring_fee_limit<T: Config>(contract_address: address) -> uint256 {445	<SponsoringFeeLimit<T>>::get(contract_address)446		.get(&0xffffffff)447		.cloned()448		.unwrap_or(U256::MAX)449}450451generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);452generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);