git.delta.rocks / unique-network / refs/commits / 9d33b05e829a

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#![cfg_attr(not(feature = "std"), no_std)]1819use codec::{Decode, Encode, MaxEncodedLen};20pub use pallet::*;21pub use eth::*;22use scale_info::TypeInfo;23pub mod eth;2425#[frame_support::pallet]26pub mod pallet {27	pub use super::*;28	use frame_support::pallet_prelude::*;29	use pallet_evm_coder_substrate::DispatchResult;30	use sp_core::H160;31	use pallet_evm::account::CrossAccountId;32	use frame_system::pallet_prelude::BlockNumberFor;33	use up_data_structs::SponsorshipState;3435	#[pallet::config]36	pub trait Config:37		frame_system::Config + pallet_evm_coder_substrate::Config + pallet_evm::account::Config38	{39		type ContractAddress: Get<H160>;40		type DefaultSponsoringRateLimit: Get<Self::BlockNumber>;41	}4243	#[pallet::error]44	pub enum Error<T> {45		/// This method is only executable by owner.46		NoPermission,4748		/// No pending sponsor for contract.49		NoPendingSponsor,50	}5152	const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);5354	#[pallet::pallet]55	#[pallet::storage_version(STORAGE_VERSION)]56	#[pallet::generate_store(pub(super) trait Store)]57	pub struct Pallet<T>(_);5859	/// Store owner for contract.60	///61	/// * **Key** - contract address.62	/// * **Value** - owner for contract.63	#[pallet::storage]64	pub(super) type Owner<T: Config> =65		StorageMap<Hasher = Twox128, Key = H160, Value = H160, QueryKind = ValueQuery>;6667	#[pallet::storage]68	#[deprecated]69	pub(super) type SelfSponsoring<T: Config> =70		StorageMap<Hasher = Twox128, Key = H160, Value = bool, QueryKind = ValueQuery>;7172	#[pallet::storage]73	pub(super) type Sponsoring<T: Config> = StorageMap<74		Hasher = Twox128,75		Key = H160,76		Value = SponsorshipState<T::CrossAccountId>,77		QueryKind = ValueQuery,78	>;7980	/// Store for sponsoring mode.81	///82	/// ### Usage83	/// Prefer to delete collection from storage if mode chaged to [`Disabled`](SponsoringModeT::Disabled).84	///85	/// * **Key** - contract address.86	/// * **Value** - [`sponsoring mode`](SponsoringModeT).87	#[pallet::storage]88	pub(super) type SponsoringMode<T: Config> =89		StorageMap<Hasher = Twox128, Key = H160, Value = SponsoringModeT, QueryKind = OptionQuery>;9091	/// Storage for sponsoring rate limit in blocks.92	///93	/// * **Key** - contract address.94	/// * **Value** - amount of sponsored blocks.95	#[pallet::storage]96	pub(super) type SponsoringRateLimit<T: Config> = StorageMap<97		Hasher = Twox128,98		Key = H160,99		Value = T::BlockNumber,100		QueryKind = ValueQuery,101		OnEmpty = T::DefaultSponsoringRateLimit,102	>;103104	/// Storage for last sponsored block.105	/// 106	/// * **Key1** - contract address.107	/// * **Key2** - sponsored user address.108	/// * **Value** - last sponsored block number.109	#[pallet::storage]110	pub(super) type SponsorBasket<T: Config> = StorageDoubleMap<111		Hasher1 = Twox128,112		Key1 = H160,113		Hasher2 = Twox128,114		Key2 = H160,115		Value = T::BlockNumber,116		QueryKind = OptionQuery,117	>;118119	/// Storege for contracts with [`Allowlisted`](SponsoringModeT::Allowlisted) sponsoring mode.120	///121	/// ### Usage122	/// Prefer to delete collection from storage if mode chaged to non `Allowlisted`, than set **Value** to **false**.123	///124	/// * **Key** - contract address.125	/// * **Value** - is contract in [`Allowlisted`](SponsoringModeT::Allowlisted) mode.126	#[pallet::storage]127	pub(super) type AllowlistEnabled<T: Config> =128		StorageMap<Hasher = Twox128, Key = H160, Value = bool, QueryKind = ValueQuery>;129130	/// Storage for users that allowed for sponsorship.131	///132	/// ### Usage133	/// Prefer to delete record from storage if user no more allowed for sponsorship.134	///135	/// * **Key1** - contract address.136	/// * **Key2** - user that allowed for sponsorship.137	/// * **Value** - allowance for sponsorship.138	#[pallet::storage]139	pub(super) type Allowlist<T: Config> = StorageDoubleMap<140		Hasher1 = Twox128,141		Key1 = H160,142		Hasher2 = Twox128,143		Key2 = H160,144		Value = bool,145		QueryKind = ValueQuery,146	>;147148	#[pallet::hooks]149	impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {150		fn on_runtime_upgrade() -> Weight {151			let storage_version = StorageVersion::get::<Pallet<T>>();152			if storage_version < StorageVersion::new(1) {}153154			0155		}156	}157158	impl<T: Config> Pallet<T> {159		/// Get contract owner.160		pub fn contract_owner(contract: H160) -> H160 {161			<Owner<T>>::get(contract)162		}163		164		/// Set `sponsor` for `contract`. 165		/// 166		/// `sender` must be owner of contract.167		pub fn set_sponsor(168			sender: &T::CrossAccountId,169			contract: H160,170			sponsor: &T::CrossAccountId,171		) -> DispatchResult {172			Pallet::<T>::ensure_owner(contract, *sender.as_eth())?;173			Sponsoring::<T>::insert(174				contract,175				SponsorshipState::<T::CrossAccountId>::Unconfirmed(sponsor.clone()),176			);177			Ok(())178		}179180		/// Confirm sponsorship.181		/// 182		/// `sender` must be same that set via [`set_sponsor`].183		pub fn confirm_sponsorship(sender: &T::CrossAccountId, contract: H160) -> DispatchResult {184			match Sponsoring::<T>::get(contract) {185				SponsorshipState::Unconfirmed(sponsor) => {186					ensure!(sponsor == *sender, Error::<T>::NoPermission);187					Sponsoring::<T>::mutate_exists(contract, |state| {188						*state = Some(SponsorshipState::<T::CrossAccountId>::Confirmed(189							sponsor.clone(),190						))191					});192					Ok(())193				}194				SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => {195					Err(Error::<T>::NoPendingSponsor.into())196				}197			}198		}199200		/// Get sponsor.201		pub fn get_sponsor(contract: H160) -> Option<T::CrossAccountId> {202			match Sponsoring::<T>::get(contract) {203				SponsorshipState::Disabled | SponsorshipState::Unconfirmed(_) => None,204				SponsorshipState::Confirmed(sponsor) => Some(sponsor),205			}206		}207208		pub fn sponsoring_mode(contract: H160) -> SponsoringModeT {209			<SponsoringMode<T>>::get(contract)210				.or_else(|| {211					<SelfSponsoring<T>>::get(contract).then(|| SponsoringModeT::Allowlisted)212				})213				.unwrap_or_default()214		}215216		pub fn set_sponsoring_mode(contract: H160, mode: SponsoringModeT) {217			if mode == SponsoringModeT::Disabled {218				<SponsoringMode<T>>::remove(contract);219			} else {220				<SponsoringMode<T>>::insert(contract, mode);221			}222			<SelfSponsoring<T>>::remove(contract)223		}224225		pub fn set_sponsoring_rate_limit(contract: H160, rate_limit: T::BlockNumber) {226			<SponsoringRateLimit<T>>::insert(contract, rate_limit);227		}228229		pub fn allowed(contract: H160, user: H160) -> bool {230			<Allowlist<T>>::get(&contract, &user) || <Owner<T>>::get(&contract) == user231		}232233		pub fn toggle_allowlist(contract: H160, enabled: bool) {234			<AllowlistEnabled<T>>::insert(contract, enabled)235		}236237		pub fn toggle_allowed(contract: H160, user: H160, allowed: bool) {238			<Allowlist<T>>::insert(contract, user, allowed);239		}240241		pub fn ensure_owner(contract: H160, user: H160) -> DispatchResult {242			ensure!(<Owner<T>>::get(&contract) == user, Error::<T>::NoPermission);243			Ok(())244		}245	}246}247248#[derive(Encode, Decode, PartialEq, TypeInfo, MaxEncodedLen)]249pub enum SponsoringModeT {250	Disabled,251	Allowlisted,252	Generous,253}254255impl SponsoringModeT {256	fn from_eth(v: u8) -> Option<Self> {257		Some(match v {258			0 => Self::Disabled,259			1 => Self::Allowlisted,260			2 => Self::Generous,261			_ => return None,262		})263	}264	fn to_eth(self) -> u8 {265		match self {266			SponsoringModeT::Disabled => 0,267			SponsoringModeT::Allowlisted => 1,268			SponsoringModeT::Generous => 2,269		}270	}271}272273impl Default for SponsoringModeT {274	fn default() -> Self {275		Self::Disabled276	}277}