git.delta.rocks / unique-network / refs/commits / 129199cd7bbe

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//! Contract execution related types1819#[cfg(not(feature = "std"))]20use alloc::string::{String, ToString};21#[cfg(feature = "std")]22use std::string::{String, ToString};2324use evm_coder::ERC165Call;25use evm_core::{ExitError, ExitFatal};2627pub use frame_support::weights::Weight;28pub use evm_coder_substrate_procedural::PreDispatch;2930/// Execution error, should be convertible between EVM and Substrate.31#[derive(Debug, Clone)]32pub enum Error {33	/// Non-fatal contract error occured34	Revert(String),35	/// EVM fatal error36	Fatal(ExitFatal),37	/// EVM normal error38	Error(ExitError),39}4041impl<E> From<E> for Error42where43	E: ToString,44{45	fn from(e: E) -> Self {46		Self::Revert(e.to_string())47	}48}4950/// To be used in [`crate::solidity_interface`] implementation.51pub type Result<T> = core::result::Result<T, Error>;52/// Return type of items in [`crate::solidity_interface`] definition53pub type ResultWithPostInfo<T> =54	core::result::Result<WithPostDispatchInfo<T>, WithPostDispatchInfo<Error>>;5556pub trait PreDispatch {57	fn dispatch_info(&self) -> DispatchInfo;58}5960impl PreDispatch for ERC165Call {61	fn dispatch_info(&self) -> DispatchInfo {62		DispatchInfo {63			// ERC165 impl should be cheap64			weight: Weight::from_parts(200, 0),65		}66	}67}6869/// Static information collected from [`crate::weight`].70pub struct DispatchInfo {71	/// Statically predicted call weight72	pub weight: Weight,73}7475impl From<Weight> for DispatchInfo {76	fn from(weight: Weight) -> Self {77		Self { weight }78	}79}80// TODO: use 2-dimensional weight after frontier upgrade81impl From<u64> for DispatchInfo {82	fn from(weight: u64) -> Self {83		Self {84			weight: Weight::from_parts(weight, 0),85		}86	}87}88impl From<()> for DispatchInfo {89	fn from(_: ()) -> Self {90		Self {91			weight: Weight::zero(),92		}93	}94}9596/// Weight information that is only available post dispatch.97/// Note: This can only be used to reduce the weight or fee, not increase it.98#[derive(Default, Clone)]99pub struct PostDispatchInfo {100	/// Actual weight consumed by call101	pub actual_weight: Option<Weight>,102}103104impl PostDispatchInfo {105	/// Calculate amount to be returned back to user106	pub fn calc_unspent(&self, info: &DispatchInfo) -> Weight {107		info.weight - self.calc_actual_weight(info)108	}109110	/// Calculate actual consumed weight, saturating to weight reported111	/// pre-dispatch112	pub fn calc_actual_weight(&self, info: &DispatchInfo) -> Weight {113		if let Some(actual_weight) = self.actual_weight {114			actual_weight.min(info.weight)115		} else {116			info.weight117		}118	}119}120121/// Wrapper for PostDispatchInfo and any user-provided data122#[derive(Clone)]123pub struct WithPostDispatchInfo<T> {124	/// User provided data125	pub data: T,126	/// Info known after dispatch127	pub post_info: PostDispatchInfo,128}129130impl<T> From<T> for WithPostDispatchInfo<T> {131	fn from(data: T) -> Self {132		Self {133			data,134			post_info: Default::default(),135		}136	}137}138#[allow(clippy::crate_in_macro_def)]139#[macro_export]140macro_rules! frontier_contract {141	(142		macro_rules! $res:ident {...}143		impl$(<$($gen:ident $(: $($(+)? $bound:ty)*)?),+ $(,)?>)? Contract for $ty:ty {...}144	) => {145		/// Generate macro to convert function return value into Contract result146		macro_rules! $res {147			($i:expr) => {{148				pallet_evm_coder_substrate::spez! {149					for res = $i;150					match<T> ::pallet_evm_coder_substrate::execution::ResultWithPostInfo<T> -> ::pallet_evm_coder_substrate::execution::ResultWithPostInfo<T> {151						res152					}153					match<T> ::pallet_evm_coder_substrate::execution::Result<T> -> ::pallet_evm_coder_substrate::execution::ResultWithPostInfo<T> {154						res155							.map(pallet_evm_coder_substrate::execution::WithPostDispatchInfo::from)156							.map_err(pallet_evm_coder_substrate::execution::WithPostDispatchInfo::from)157					}158					match<T> T -> ::pallet_evm_coder_substrate::execution::ResultWithPostInfo<T> {159						Ok(pallet_evm_coder_substrate::execution::WithPostDispatchInfo::from(res))160					}161				}162			}};163		}164		impl $(<$($gen),+>)? $crate::Contract for $ty where T: crate::Config {165			type Error = ::pallet_evm_coder_substrate::execution::Error;166			type WithPostInfo<R> = ::pallet_evm_coder_substrate::execution::WithPostDispatchInfo<R>;167			type Result<R, E> = core::result::Result<R, E>;168			fn map_post<I, O>(169				v: Self::WithPostInfo<I>,170				mapper: impl FnOnce(I) -> O,171			) -> Self::WithPostInfo<O> {172				::pallet_evm_coder_substrate::execution::WithPostDispatchInfo {173					data: mapper(v.data),174					post_info: v.post_info,175				}176			}177			fn with_default_post<V>(v: V) -> Self::WithPostInfo<V> {178				::pallet_evm_coder_substrate::execution::WithPostDispatchInfo {179					data: v,180					post_info: ::pallet_evm_coder_substrate::execution::PostDispatchInfo {181						actual_weight: None,182					},183				}184			}185		}186	};187}