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

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: address,46		/// New sponsor address.47		sponsor: address,48	},4950	/// New sponsor was confirm.51	ContractSponsorshipConfirmed {52		/// Contract address of the affected collection.53		#[indexed]54		contract_address: address,55		/// New sponsor address.56		sponsor: address,57	},5859	/// Collection sponsor was removed.60	ContractSponsorRemoved {61		/// Contract address of the affected collection.62		#[indexed]63		contract_address: address,64	},65}6667/// See [`ContractHelpersCall`]68pub struct ContractHelpers<T: Config>(SubstrateRecorder<T>);69impl<T: Config> WithRecorder<T> for ContractHelpers<T> {70	fn recorder(&self) -> &SubstrateRecorder<T> {71		&self.072	}7374	fn into_recorder(self) -> SubstrateRecorder<T> {75		self.076	}77}7879/// @title Magic contract, which allows users to reconfigure other contracts80#[solidity_interface(name = ContractHelpers, events(ContractHelpersEvents))]81impl<T: Config> ContractHelpers<T>82where83	T::AccountId: AsRef<[u8; 32]>,84{85	/// Get user, which deployed specified contract86	/// @dev May return zero address in case if contract is deployed87	///  using uniquenetwork evm-migration pallet, or using other terms not88	///  intended by pallet-evm89	/// @dev Returns zero address if contract does not exists90	/// @param contractAddress Contract to get owner of91	/// @return address Owner of contract92	fn contract_owner(&self, contract_address: address) -> Result<address> {93		Ok(<Owner<T>>::get(contract_address))94	}9596	/// Set sponsor.97	/// @param contractAddress Contract for which a sponsor is being established.98	/// @param sponsor User address who set as pending sponsor.99	fn set_sponsor(100		&mut self,101		caller: caller,102		contract_address: address,103		sponsor: address,104	) -> Result<void> {105		self.recorder().consume_sload()?;106		self.recorder().consume_sstore()?;107108		Pallet::<T>::set_sponsor(109			&T::CrossAccountId::from_eth(caller),110			contract_address,111			&T::CrossAccountId::from_eth(sponsor),112		)113		.map_err(dispatch_to_evm::<T>)?;114115		Ok(())116	}117118	/// Set contract as self sponsored.119	///120	/// @param contractAddress Contract for which a self sponsoring is being enabled.121	fn self_sponsored_enable(&mut self, caller: caller, contract_address: address) -> Result<void> {122		self.recorder().consume_sload()?;123		self.recorder().consume_sstore()?;124125		let caller = T::CrossAccountId::from_eth(caller);126127		Pallet::<T>::ensure_owner(contract_address, *caller.as_eth())128			.map_err(dispatch_to_evm::<T>)?;129130		Pallet::<T>::force_set_sponsor(131			contract_address,132			&T::CrossAccountId::from_eth(contract_address),133		)134		.map_err(dispatch_to_evm::<T>)?;135136		Ok(())137	}138139	/// Remove sponsor.140	///141	/// @param contractAddress Contract for which a sponsorship is being removed.142	fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {143		self.recorder().consume_sload()?;144		self.recorder().consume_sstore()?;145146		Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)147			.map_err(dispatch_to_evm::<T>)?;148149		Ok(())150	}151152	/// Confirm sponsorship.153	///154	/// @dev Caller must be same that set via [`setSponsor`].155	///156	/// @param contractAddress Сontract for which need to confirm sponsorship.157	fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {158		self.recorder().consume_sload()?;159		self.recorder().consume_sstore()?;160161		Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)162			.map_err(dispatch_to_evm::<T>)?;163164		Ok(())165	}166167	/// Get current sponsor.168	///169	/// @param contractAddress The contract for which a sponsor is requested.170	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.171	fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {172		let sponsor =173			Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;174		Ok(pallet_common::eth::convert_cross_account_to_tuple::<T>(175			&sponsor,176		))177	}178179	/// Check tat contract has confirmed sponsor.180	///181	/// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.182	/// @return **true** if contract has confirmed sponsor.183	fn has_sponsor(&self, contract_address: address) -> Result<bool> {184		Ok(Pallet::<T>::get_sponsor(contract_address).is_some())185	}186187	/// Check tat contract has pending sponsor.188	///189	/// @param contractAddress The contract for which the presence of a pending sponsor is checked.190	/// @return **true** if contract has pending sponsor.191	fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {192		Ok(match Sponsoring::<T>::get(contract_address) {193			SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,194			SponsorshipState::Unconfirmed(_) => true,195		})196	}197198	fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {199		Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)200	}201202	fn set_sponsoring_mode(203		&mut self,204		caller: caller,205		contract_address: address,206		// TODO: implement support for enums in evm-coder207		mode: uint8,208	) -> Result<void> {209		self.recorder().consume_sload()?;210		self.recorder().consume_sstore()?;211212		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;213		let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;214		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);215216		Ok(())217	}218219	/// Get current contract sponsoring rate limit220	/// @param contractAddress Contract to get sponsoring mode of221	/// @return uint32 Amount of blocks between two sponsored transactions222	fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {223		Ok(<SponsoringRateLimit<T>>::get(contract_address)224			.try_into()225			.map_err(|_| "rate limit > u32::MAX")?)226	}227228	/// Set contract sponsoring rate limit229	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should230	///  pass between two sponsored transactions231	/// @param contractAddress Contract to change sponsoring rate limit of232	/// @param rateLimit Target rate limit233	/// @dev Only contract owner can change this setting234	fn set_sponsoring_rate_limit(235		&mut self,236		caller: caller,237		contract_address: address,238		rate_limit: uint32,239	) -> Result<void> {240		self.recorder().consume_sload()?;241		self.recorder().consume_sstore()?;242243		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;244		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());245		Ok(())246	}247248	/// Is specified user present in contract allow list249	/// @dev Contract owner always implicitly included250	/// @param contractAddress Contract to check allowlist of251	/// @param user User to check252	/// @return bool Is specified users exists in contract allowlist253	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {254		self.0.consume_sload()?;255		Ok(<Pallet<T>>::allowed(contract_address, user))256	}257258	/// Toggle user presence in contract allowlist259	/// @param contractAddress Contract to change allowlist of260	/// @param user Which user presence should be toggled261	/// @param isAllowed `true` if user should be allowed to be sponsored262	///  or call this contract, `false` otherwise263	/// @dev Only contract owner can change this setting264	fn toggle_allowed(265		&mut self,266		caller: caller,267		contract_address: address,268		user: address,269		is_allowed: bool,270	) -> Result<void> {271		self.recorder().consume_sload()?;272		self.recorder().consume_sstore()?;273274		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;275		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);276277		Ok(())278	}279280	/// Is this contract has allowlist access enabled281	/// @dev Allowlist always can have users, and it is used for two purposes:282	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist283	///  in case of allowlist access enabled, only users from allowlist may call this contract284	/// @param contractAddress Contract to get allowlist access of285	/// @return bool Is specified contract has allowlist access enabled286	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {287		Ok(<AllowlistEnabled<T>>::get(contract_address))288	}289290	/// Toggle contract allowlist access291	/// @param contractAddress Contract to change allowlist access of292	/// @param enabled Should allowlist access to be enabled?293	fn toggle_allowlist(294		&mut self,295		caller: caller,296		contract_address: address,297		enabled: bool,298	) -> Result<void> {299		self.recorder().consume_sload()?;300		self.recorder().consume_sstore()?;301302		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;303		<Pallet<T>>::toggle_allowlist(contract_address, enabled);304		Ok(())305	}306}307308/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]309pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);310impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>311where312	T::AccountId: AsRef<[u8; 32]>,313{314	fn is_reserved(contract: &sp_core::H160) -> bool {315		contract == &T::ContractAddress::get()316	}317318	fn is_used(contract: &sp_core::H160) -> bool {319		contract == &T::ContractAddress::get()320	}321322	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {323		// TODO: Extract to another OnMethodCall handler324		if <AllowlistEnabled<T>>::get(handle.code_address())325			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)326		{327			return Some(Err(PrecompileFailure::Revert {328				exit_status: ExitRevert::Reverted,329				output: {330					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));331					writer.string("Target contract is allowlisted");332					writer.finish()333				},334			}));335		}336337		if handle.code_address() != T::ContractAddress::get() {338			return None;339		}340341		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));342		pallet_evm_coder_substrate::call(handle, helpers)343	}344345	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {346		(contract == &T::ContractAddress::get())347			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())348	}349}350351/// Hooks into contract creation, storing owner of newly deployed contract352pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);353impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {354	fn on_create(owner: H160, contract: H160) {355		<Owner<T>>::insert(contract, owner);356	}357}358359/// Bridge to pallet-sponsoring360pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);361impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>362	for HelpersContractSponsoring<T>363{364	fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {365		let (contract_address, _) = call;366		let mode = <Pallet<T>>::sponsoring_mode(*contract_address);367		if mode == SponsoringModeT::Disabled {368			return None;369		}370371		let sponsor = match <Pallet<T>>::get_sponsor(*contract_address) {372			Some(sponsor) => sponsor,373			None => return None,374		};375376		if mode == SponsoringModeT::Allowlisted377			&& !<Pallet<T>>::allowed(*contract_address, *who.as_eth())378		{379			return None;380		}381		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;382383		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {384			let limit = <SponsoringRateLimit<T>>::get(contract_address);385386			let timeout = last_tx_block + limit;387			if block_number < timeout {388				return None;389			}390		}391392		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);393394		Some(sponsor)395	}396}397398generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);399generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);