difftreelog
path: Add sponsorship for CrossAccountId.
in: master
2 files changed
pallets/evm-contract-helpers/src/eth.rsdiffbeforeafterboth1// 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/>.1617use core::marker::PhantomData;18use evm_coder::{19 abi::AbiWriter,20 execution::{Result, Error},21 generate_stubgen, solidity_interface,22 types::*,23};24use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};25use pallet_evm::{26 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,27 account::CrossAccountId,28};29use sp_core::H160;30use crate::{31 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT,32};33use frame_support::traits::Get;34use up_sponsorship::SponsorshipHandler;35use sp_std::vec::Vec;3637struct ContractHelpers<T: Config>(SubstrateRecorder<T>);38impl<T: Config> WithRecorder<T> for ContractHelpers<T> {39 fn recorder(&self) -> &SubstrateRecorder<T> {40 &self.041 }4243 fn into_recorder(self) -> SubstrateRecorder<T> {44 self.045 }46}4748#[solidity_interface(name = "ContractHelpers")]49impl<T: Config> ContractHelpers<T> {50 fn contract_owner(&self, contract_address: address) -> Result<address> {51 Ok(<Owner<T>>::get(contract_address))52 }5354 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {55 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)56 }5758 /// Deprecated59 fn toggle_sponsoring(60 &mut self,61 caller: caller,62 contract_address: address,63 enabled: bool,64 ) -> Result<void> {65 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;66 <Pallet<T>>::toggle_sponsoring(contract_address, enabled);67 Ok(())68 }6970 fn set_sponsoring_mode(71 &mut self,72 caller: caller,73 contract_address: address,74 mode: uint8,75 ) -> Result<void> {76 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;77 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;78 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);79 Ok(())80 }8182 fn sponsoring_mode(&self, contract_address: address) -> Result<uint8> {83 Ok(<Pallet<T>>::sponsoring_mode(contract_address).to_eth())84 }8586 fn set_sponsoring_rate_limit(87 &mut self,88 caller: caller,89 contract_address: address,90 rate_limit: uint32,91 ) -> Result<void> {92 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;93 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());94 Ok(())95 }9697 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {98 Ok(<SponsoringRateLimit<T>>::get(contract_address)99 .try_into()100 .map_err(|_| "rate limit > u32::MAX")?)101 }102103 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {104 self.0.consume_sload()?;105 Ok(<Pallet<T>>::allowed(contract_address, user))106 }107108 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {109 Ok(<AllowlistEnabled<T>>::get(contract_address))110 }111112 fn toggle_allowlist(113 &mut self,114 caller: caller,115 contract_address: address,116 enabled: bool,117 ) -> Result<void> {118 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;119 <Pallet<T>>::toggle_allowlist(contract_address, enabled);120 Ok(())121 }122123 fn toggle_allowed(124 &mut self,125 caller: caller,126 contract_address: address,127 user: address,128 allowed: bool,129 ) -> Result<void> {130 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;131 <Pallet<T>>::toggle_allowed(contract_address, user, allowed);132 Ok(())133 }134}135136pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);137impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T> {138 fn is_reserved(contract: &sp_core::H160) -> bool {139 contract == &T::ContractAddress::get()140 }141142 fn is_used(contract: &sp_core::H160) -> bool {143 contract == &T::ContractAddress::get()144 }145146 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {147 // TODO: Extract to another OnMethodCall handler148 if <AllowlistEnabled<T>>::get(handle.code_address())149 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)150 {151 return Some(Err(PrecompileFailure::Revert {152 exit_status: ExitRevert::Reverted,153 output: {154 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));155 writer.string("Target contract is allowlisted");156 writer.finish()157 },158 }));159 }160161 if handle.code_address() != T::ContractAddress::get() {162 return None;163 }164165 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));166 pallet_evm_coder_substrate::call(handle, helpers)167 }168169 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {170 (contract == &T::ContractAddress::get())171 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())172 }173}174175pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);176impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {177 fn on_create(owner: H160, contract: H160) {178 <Owner<T>>::insert(contract, owner);179 }180}181182pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);183impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>184 for HelpersContractSponsoring<T>185{186 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {187 let (contract, _) = call;188 let mode = <Pallet<T>>::sponsoring_mode(*contract);189 if mode == SponsoringModeT::Disabled {190 return None;191 }192193 if mode == SponsoringModeT::Allowlisted && !<Pallet<T>>::allowed(*contract, *who.as_eth()) {194 return None;195 }196 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;197198 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract, who.as_eth()) {199 let limit = <SponsoringRateLimit<T>>::get(contract);200201 let timeout = last_tx_block + limit;202 if block_number < timeout {203 return None;204 }205 }206207 <SponsorBasket<T>>::insert(contract, who.as_eth(), block_number);208209 let sponsor = T::CrossAccountId::from_eth(*contract);210 Some(sponsor)211 }212}213214generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);215generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);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/>.1617use core::marker::PhantomData;18use evm_coder::{19 abi::AbiWriter,20 execution::{Result, Error},21 generate_stubgen, solidity_interface,22 types::*,23};24use pallet_evm_coder_substrate::{SubstrateRecorder, WithRecorder, dispatch_to_evm};25use pallet_evm::{26 ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,27 account::CrossAccountId,28};29use sp_core::H160;30use crate::{31 AllowlistEnabled, Config, Owner, Pallet, SponsorBasket, SponsoringRateLimit, SponsoringModeT,32};33use frame_support::traits::Get;34use up_sponsorship::SponsorshipHandler;35use sp_std::vec::Vec;3637struct ContractHelpers<T: Config>(SubstrateRecorder<T>);38impl<T: Config> WithRecorder<T> for ContractHelpers<T> {39 fn recorder(&self) -> &SubstrateRecorder<T> {40 &self.041 }4243 fn into_recorder(self) -> SubstrateRecorder<T> {44 self.045 }46}4748#[solidity_interface(name = "ContractHelpers")]49impl<T: Config> ContractHelpers<T> {50 fn contract_owner(&self, contract_address: address) -> Result<address> {51 Ok(<Owner<T>>::get(contract_address))52 }5354 fn set_sponsor(55 &mut self,56 caller: caller,57 contract_address: address,58 sponsor: address,59 ) -> Result<void> {60 Pallet::<T>::set_sponsor(61 &T::CrossAccountId::from_eth(caller),62 contract_address,63 &T::CrossAccountId::from_eth(sponsor),64 )65 .map_err(dispatch_to_evm::<T>)?;66 Ok(())67 }6869 fn confirm_sponsorship(&mut self, caller: caller, contract_address: address) -> Result<void> {70 Pallet::<T>::confirm_sponsorship(&T::CrossAccountId::from_eth(caller), contract_address)71 .map_err(dispatch_to_evm::<T>)?;72 Ok(())73 }7475 fn get_sponsor(&self, contract_address: address) -> Result<address> {76 let sponsor =77 Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?;78 Ok(*sponsor.as_eth())79 }8081 fn sponsoring_enabled(&self, contract_address: address) -> Result<bool> {82 Ok(<Pallet<T>>::sponsoring_mode(contract_address) != SponsoringModeT::Disabled)83 }8485 /// Deprecated86 fn toggle_sponsoring(87 &mut self,88 caller: caller,89 contract_address: address,90 enabled: bool,91 ) -> Result<void> {92 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;93 <Pallet<T>>::toggle_sponsoring(contract_address, enabled);94 Ok(())95 }9697 fn set_sponsoring_mode(98 &mut self,99 caller: caller,100 contract_address: address,101 mode: uint8,102 ) -> Result<void> {103 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;104 let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;105 <Pallet<T>>::set_sponsoring_mode(contract_address, mode);106 Ok(())107 }108109 fn sponsoring_mode(&self, contract_address: address) -> Result<uint8> {110 Ok(<Pallet<T>>::sponsoring_mode(contract_address).to_eth())111 }112113 fn set_sponsoring_rate_limit(114 &mut self,115 caller: caller,116 contract_address: address,117 rate_limit: uint32,118 ) -> Result<void> {119 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;120 <Pallet<T>>::set_sponsoring_rate_limit(contract_address, rate_limit.into());121 Ok(())122 }123124 fn get_sponsoring_rate_limit(&self, contract_address: address) -> Result<uint32> {125 Ok(<SponsoringRateLimit<T>>::get(contract_address)126 .try_into()127 .map_err(|_| "rate limit > u32::MAX")?)128 }129130 fn allowed(&self, contract_address: address, user: address) -> Result<bool> {131 self.0.consume_sload()?;132 Ok(<Pallet<T>>::allowed(contract_address, user))133 }134135 fn allowlist_enabled(&self, contract_address: address) -> Result<bool> {136 Ok(<AllowlistEnabled<T>>::get(contract_address))137 }138139 fn toggle_allowlist(140 &mut self,141 caller: caller,142 contract_address: address,143 enabled: bool,144 ) -> Result<void> {145 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;146 <Pallet<T>>::toggle_allowlist(contract_address, enabled);147 Ok(())148 }149150 fn toggle_allowed(151 &mut self,152 caller: caller,153 contract_address: address,154 user: address,155 allowed: bool,156 ) -> Result<void> {157 <Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;158 <Pallet<T>>::toggle_allowed(contract_address, user, allowed);159 Ok(())160 }161}162163pub struct HelpersOnMethodCall<T: Config>(PhantomData<*const T>);164impl<T: Config> OnMethodCall<T> for HelpersOnMethodCall<T> {165 fn is_reserved(contract: &sp_core::H160) -> bool {166 contract == &T::ContractAddress::get()167 }168169 fn is_used(contract: &sp_core::H160) -> bool {170 contract == &T::ContractAddress::get()171 }172173 fn call(handle: &mut impl PrecompileHandle) -> Option<PrecompileResult> {174 // TODO: Extract to another OnMethodCall handler175 if <AllowlistEnabled<T>>::get(handle.code_address())176 && !<Pallet<T>>::allowed(handle.code_address(), handle.context().caller)177 {178 return Some(Err(PrecompileFailure::Revert {179 exit_status: ExitRevert::Reverted,180 output: {181 let mut writer = AbiWriter::new_call(evm_coder::fn_selector!(Error(string)));182 writer.string("Target contract is allowlisted");183 writer.finish()184 },185 }));186 }187188 if handle.code_address() != T::ContractAddress::get() {189 return None;190 }191192 let helpers = ContractHelpers::<T>(SubstrateRecorder::<T>::new(handle.remaining_gas()));193 pallet_evm_coder_substrate::call(handle, helpers)194 }195196 fn get_code(contract: &sp_core::H160) -> Option<Vec<u8>> {197 (contract == &T::ContractAddress::get())198 .then(|| include_bytes!("./stubs/ContractHelpers.raw").to_vec())199 }200}201202pub struct HelpersOnCreate<T: Config>(PhantomData<*const T>);203impl<T: Config> OnCreate<T> for HelpersOnCreate<T> {204 fn on_create(owner: H160, contract: H160) {205 <Owner<T>>::insert(contract, owner);206 }207}208209pub struct HelpersContractSponsoring<T: Config>(PhantomData<*const T>);210impl<T: Config> SponsorshipHandler<T::CrossAccountId, (H160, Vec<u8>)>211 for HelpersContractSponsoring<T>212{213 fn get_sponsor(who: &T::CrossAccountId, call: &(H160, Vec<u8>)) -> Option<T::CrossAccountId> {214 let (contract, _) = call;215 let mode = <Pallet<T>>::sponsoring_mode(*contract);216 if mode == SponsoringModeT::Disabled {217 return None;218 }219220 let sponsor = match <Pallet<T>>::get_sponsor(*contract) {221 Some(sponsor) => sponsor,222 None => return None,223 };224225 if mode == SponsoringModeT::Allowlisted && !<Pallet<T>>::allowed(*contract, *who.as_eth()) {226 return None;227 }228 let block_number = <frame_system::Pallet<T>>::block_number() as T::BlockNumber;229230 if let Some(last_tx_block) = <SponsorBasket<T>>::get(contract, who.as_eth()) {231 let limit = <SponsoringRateLimit<T>>::get(contract);232233 let timeout = last_tx_block + limit;234 if block_number < timeout {235 return None;236 }237 }238239 <SponsorBasket<T>>::insert(contract, who.as_eth(), block_number);240241 Some(sponsor)242 }243}244245generate_stubgen!(contract_helpers_impl, ContractHelpersCall<()>, true);246generate_stubgen!(contract_helpers_iface, ContractHelpersCall<()>, false);pallets/evm-contract-helpers/src/lib.rsdiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/lib.rs
+++ b/pallets/evm-contract-helpers/src/lib.rs
@@ -15,7 +15,6 @@
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
#![cfg_attr(not(feature = "std"), no_std)]
-#![feature(is_some_with)]
use codec::{Decode, Encode, MaxEncodedLen};
pub use pallet::*;
@@ -27,9 +26,11 @@
pub mod pallet {
pub use super::*;
use frame_support::pallet_prelude::*;
+ use pallet_evm_coder_substrate::DispatchResult;
use sp_core::H160;
use pallet_evm::account::CrossAccountId;
use frame_system::pallet_prelude::BlockNumberFor;
+ use up_data_structs::SponsorshipState;
#[pallet::config]
pub trait Config:
@@ -44,8 +45,8 @@
/// This method is only executable by owner.
NoPermission,
- /// Contract has no owner.
- NoContractOwner,
+ /// No pending sponsor for contract.
+ NoPendingSponsor,
}
const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);
@@ -68,11 +69,19 @@
pub(super) type SelfSponsoring<T: Config> =
StorageMap<Hasher = Twox128, Key = H160, Value = bool, QueryKind = ValueQuery>;
+ #[pallet::storage]
+ pub(super) type Sponsoring<T: Config> = StorageMap<
+ Hasher = Twox128,
+ Key = H160,
+ Value = SponsorshipState<T::CrossAccountId>,
+ QueryKind = ValueQuery,
+ >;
+
/// Store for sponsoring mode.
- ///
+ ///
/// ### Usage
/// Prefer to delete collection from storage if mode chaged to [`Disabled`](SponsoringModeT::Disabled).
- ///
+ ///
/// * **Key** - contract address.
/// * **Value** - [`sponsoring mode`](SponsoringModeT).
#[pallet::storage]
@@ -80,7 +89,7 @@
StorageMap<Hasher = Twox128, Key = H160, Value = SponsoringModeT, QueryKind = OptionQuery>;
/// Storage for sponsoring rate limit in blocks.
- ///
+ ///
/// * **Key** - contract address.
/// * **Value** - amount of sponsored blocks.
#[pallet::storage]
@@ -103,16 +112,24 @@
>;
/// Storege for contracts with [`Allowlisted`](SponsoringModeT::Allowlisted) sponsoring mode.
- ///
+ ///
/// ### Usage
/// Prefer to delete collection from storage if mode chaged to non `Allowlisted`, than set **Value** to **false**.
- ///
+ ///
/// * **Key** - contract address.
/// * **Value** - is contract in [`Allowlisted`](SponsoringModeT::Allowlisted) mode.
#[pallet::storage]
pub(super) type AllowlistEnabled<T: Config> =
StorageMap<Hasher = Twox128, Key = H160, Value = bool, QueryKind = ValueQuery>;
+ /// Storage for users that allowed for sponsorship.
+ ///
+ /// ### Usage
+ /// Prefer to delete record from storage if user no more allowed for sponsorship.
+ ///
+ /// * **Key1** - contract address.
+ /// * **Key2** - user that allowed for sponsorship.
+ /// * **Value** - allowance for sponsorship.
#[pallet::storage]
pub(super) type Allowlist<T: Config> = StorageDoubleMap<
Hasher1 = Twox128,
@@ -127,14 +144,45 @@
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_runtime_upgrade() -> Weight {
let storage_version = StorageVersion::get::<Pallet<T>>();
- if storage_version < StorageVersion::new(1) {
- }
+ if storage_version < StorageVersion::new(1) {}
0
}
}
impl<T: Config> Pallet<T> {
+ pub fn set_sponsor(
+ sender: &T::CrossAccountId,
+ contract: H160,
+ sponsor: &T::CrossAccountId,
+ ) -> DispatchResult {
+ Pallet::<T>::ensure_owner(contract, *sender.as_eth())?;
+ Sponsoring::<T>::insert(
+ contract,
+ SponsorshipState::<T::CrossAccountId>::Unconfirmed(sponsor.clone()),
+ );
+ Ok(())
+ }
+
+ pub fn confirm_sponsorship(sender: &T::CrossAccountId, contract: H160) -> DispatchResult {
+ match Sponsoring::<T>::get(contract) {
+ SponsorshipState::Unconfirmed(sponsor) => {
+ ensure!(sponsor == *sender, Error::<T>::NoPermission);
+ Ok(())
+ }
+ SponsorshipState::Disabled | SponsorshipState::Confirmed(_) => {
+ Err(Error::<T>::NoPendingSponsor.into())
+ }
+ }
+ }
+
+ pub fn get_sponsor(contract: H160) -> Option<T::CrossAccountId> {
+ match Sponsoring::<T>::get(contract) {
+ SponsorshipState::Disabled | SponsorshipState::Unconfirmed(_) => None,
+ SponsorshipState::Confirmed(sponsor) => Some(sponsor),
+ }
+ }
+
pub fn sponsoring_mode(contract: H160) -> SponsoringModeT {
<SponsoringMode<T>>::get(contract)
.or_else(|| {
@@ -142,6 +190,7 @@
})
.unwrap_or_default()
}
+
pub fn set_sponsoring_mode(contract: H160, mode: SponsoringModeT) {
if mode == SponsoringModeT::Disabled {
<SponsoringMode<T>>::remove(contract);