git.delta.rocks / unique-network / refs/commits / 837c29c459b6

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(128			&T::CrossAccountId::from_eth(caller),129			contract_address,130			&T::CrossAccountId::from_eth(contract_address),131		)132		.map_err(dispatch_to_evm::<T>)?;133134		Ok(())135	}136137	/// Remove sponsor.138	///139	/// @param contractAddress Contract for which a sponsorship is being removed.140	fn remove_sponsor(&mut self, caller: caller, contract_address: address) -> Result<void> {141		self.recorder().consume_sload()?;142		self.recorder().consume_sstore()?;143144		Pallet::<T>::remove_sponsor(&T::CrossAccountId::from_eth(caller), contract_address)145			.map_err(dispatch_to_evm::<T>)?;146147		Ok(())148	}149150	/// Confirm sponsorship.151	///152	/// @dev Caller must be same that set via [`setSponsor`].153	///154	/// @param contractAddress Сontract for which need to confirm sponsorship.155	fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {156		self.recorder().consume_sload()?;157		self.recorder().consume_sstore()?;158159		Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)160			.map_err(dispatch_to_evm::<T>)?;161162		Ok(())163	}164165	/// Get current sponsor.166	///167	/// @param contractAddress The contract for which a sponsor is requested.168	/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.169	fn get_sponsor(&self, contract_address: address) -> Result<(address, uint256)> {170		let sponsor =171			Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;172		let result: (address, uint256) = if sponsor.is_canonical_substrate() {173			let sponsor = pallet_common::eth::convert_cross_account_to_uint256::<T>(&sponsor);174			(Default::default(), sponsor)175		} else {176			let sponsor = *sponsor.as_eth();177			(sponsor, Default::default())178		};179		Ok(result)180	}181182	/// Check tat contract has confirmed sponsor.183	///184	/// @param contractAddress The contract for which the presence of a confirmed sponsor is checked.185	/// @return **true** if contract has confirmed sponsor.186	fn has_sponsor(&self, contract_address: address) -> Result<bool> {187		Ok(Pallet::<T>::get_sponsor(contract_address).is_some())188	}189190	/// Check tat contract has pending sponsor.191	///192	/// @param contractAddress The contract for which the presence of a pending sponsor is checked.193	/// @return **true** if contract has pending sponsor.194	fn has_pending_sponsor(&self, contract_address: address) -> Result<bool> {195		Ok(match Sponsoring::<T>::get(contract_address) {196			SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => false,197			SponsorshipState::Unconfirmed(_) => true,198		})199	}200201	fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {202		Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)203	}204205	fn set_sponsoring_mode(206		&mut self,207		caller: caller,208		contract_address: address,209		// TODO: implement support for enums in evm-coder210		mode: uint8,211	) -> Result<void> {212		self.recorder().consume_sload()?;213		self.recorder().consume_sstore()?;214215		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;216		let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;217		<Pallet<T>>::set_sponsoring_mode(contract_address, mode);218219		Ok(())220	}221222	/// Get current contract sponsoring rate limit223	/// @param contractAddress Contract to get sponsoring mode of224	/// @return uint32 Amount of blocks between two sponsored transactions225	fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {226		Ok(<SponsoringRateLimit<T>>::get(contract_address)227			.try_into()228			.map_err(|_| "rate limit > u32::MAX")?)229	}230231	/// Set contract sponsoring rate limit232	/// @dev Sponsoring rate limit - is a minimum amount of blocks that should233	///  pass between two sponsored transactions234	/// @param contractAddress Contract to change sponsoring rate limit of235	/// @param rateLimit Target rate limit236	/// @dev Only contract owner can change this setting237	fn set_sponsoring_rate_limit(238		&mut self,239		caller: caller,240		contract_address: address,241		rate_limit: uint32,242	) -> Result<void> {243		self.recorder().consume_sload()?;244		self.recorder().consume_sstore()?;245246		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;247		<Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());248		Ok(())249	}250251	/// Is specified user present in contract allow list252	/// @dev Contract owner always implicitly included253	/// @param contractAddress Contract to check allowlist of254	/// @param user User to check255	/// @return bool Is specified users exists in contract allowlist256	fn allowed(&self, contract_address: address, user: address) -> Result<bool> {257		self.0.consume_sload()?;258		Ok(<Pallet<T>>::allowed(contract_address, user))259	}260261	/// Toggle user presence in contract allowlist262	/// @param contractAddress Contract to change allowlist of263	/// @param user Which user presence should be toggled264	/// @param isAllowed `true` if user should be allowed to be sponsored265	///  or call this contract, `false` otherwise266	/// @dev Only contract owner can change this setting267	fn toggle_allowed(268		&mut self,269		caller: caller,270		contract_address: address,271		user: address,272		is_allowed: bool,273	) -> Result<void> {274		self.recorder().consume_sload()?;275		self.recorder().consume_sstore()?;276277		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;278		<Pallet<T>>::toggle_allowed(contract_address, user, is_allowed);279280		Ok(())281	}282283	/// Is this contract has allowlist access enabled284	/// @dev Allowlist always can have users, and it is used for two purposes:285	///  in case of allowlist sponsoring mode, users will be sponsored if they exist in allowlist286	///  in case of allowlist access enabled, only users from allowlist may call this contract287	/// @param contractAddress Contract to get allowlist access of288	/// @return bool Is specified contract has allowlist access enabled289	fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {290		Ok(<AllowlistEnabled<T>>::get(contract_address))291	}292293	/// Toggle contract allowlist access294	/// @param contractAddress Contract to change allowlist access of295	/// @param enabled Should allowlist access to be enabled?296	fn toggle_allowlist(297		&mut self,298		caller: caller,299		contract_address: address,300		enabled: bool,301	) -> Result<void> {302		self.recorder().consume_sload()?;303		self.recorder().consume_sstore()?;304305		<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;306		<Pallet<T>>::toggle_allowlist(contract_address, enabled);307		Ok(())308	}309}310311/// Implements [`OnMethodCall`], which delegates call to [`ContractHelpers`]312pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);313impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T>314where315	T::AccountId: AsRef<[u8; 32]>,316{317	fn is_reserved(contract: &sp_core::H160) -> bool {318		contract == &T::ContractAddress::get()319	}320321	fn is_used(contract: &sp_core::H160) -> bool {322		contract == &T::ContractAddress::get()323	}324325	fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {326		// TODO: Extract to another OnMethodCall handler327		if <AllowlistEnabled<T>>::get(handle.code_address())328			&& !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)329		{330			return Some(Err(PrecompileFailure::Revert {331				exit_status: ExitRevert::Reverted,332				output: {333					let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));334					writer.string("Target contract is allowlisted");335					writer.finish()336				},337			}));338		}339340		if handle.code_address() != T::ContractAddress::get() {341			return None;342		}343344		let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));345		pallet_evm_coder_substrate::call(handle, helpers)346	}347348	fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {349		(contract == &T::ContractAddress::get())350			.then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())351	}352}353354/// Hooks into contract creation, storing owner of newly deployed contract355pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);356impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {357	fn on_create(owner: H160, contract: H160) {358		<Owner<T>>::insert(contract, owner);359	}360}361362/// Bridge to pallet-sponsoring363pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);364impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>365	for HelpersContractSponsoring<T>366{367	fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {368		let (contract_address, _) = call;369		let mode = <Pallet<T>>::sponsoring_mode(*contract_address);370		if mode == SponsoringModeT::Disabled {371			return None;372		}373374		let sponsor = match <Pallet<T>>::get_sponsor(*contract_address) {375			Some(sponsor) => sponsor,376			None => return None,377		};378379		if mode == SponsoringModeT::Allowlisted380			&& !<Pallet<T>>::allowed(*contract_address, *who.as_eth())381		{382			return None;383		}384		let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;385386		if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract_address, who.as_eth()) {387			let limit = <SponsoringRateLimit<T>>::get(contract_address);388389			let timeout = last_tx_block + limit;390			if block_number < timeout {391				return None;392			}393		}394395		<SponsorBasket<T>>::insert(contract_address, who.as_eth(), block_number);396397		Some(sponsor)398	}399}400401generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);402generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);