git.delta.rocks / unique-network / refs/commits / 4c1a924fb18b

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#![doc = include_str!("../README.md")]18#![deny(missing_docs)]19#![macro_use]20#![cfg_attr(not(feature = "std"), no_std)]21#[cfg(not(feature = "std"))]22extern crate alloc;2324use abi::{AbiRead, AbiReader, AbiWriter};25pub use evm_coder_procedural::{event_topic, fn_selector};26pub mod abi;27pub use events::{ToLog, ToTopic};28use execution::DispatchInfo;29pub mod execution;30#[macro_use]31pub mod custom_signature;3233/// Derives call enum implementing [`crate::Callable`], [`crate::Weighted`]34/// and [`crate::Call`] from impl block.35///36/// ## Macro syntax37///38/// `#[solidity_interface(name, is, inline_is, events)]`39/// - *name* - used in generated code, and for Call enum name40/// - *is* - used to provide inheritance in Solidity41/// - *inline_is* - same as `is`, but ERC165::SupportsInterface will work differently: For `is` SupportsInterface(A) will return true42///   if A is one of the interfaces the contract is inherited from (e.g. B is created as `is(A)`). If B is created as `inline_is(A)`43///   SupportsInterface(A) will internally create a new interface that combines all methods of A and B, so SupportsInterface(A) will return44///   false.45///46/// `#[weight(value)]`47/// Can be added to every method of impl block, used for deriving [`crate::Weighted`], which48/// is used by substrate bridge.49/// - *value*: expression, which evaluates to weight required to call this method.50/// This expression can use call arguments to calculate non-constant execution time.51/// This expression should evaluate faster than actual execution does, and may provide worse case52/// than one is called.53///54/// `#[solidity_interface(rename_selector)]`55/// - *rename_selector* - by default, selector name will be generated by transforming method name56/// from snake_case to camelCase. Use this option, if other naming convention is required.57/// I.e: method `token_uri` will be automatically renamed to `tokenUri` in selector, but name58/// required by ERC721 standard is `tokenURI`, thus we need to specify `rename_selector = "tokenURI"`59/// explicitly.60///61/// Both contract and contract methods may have doccomments, which will end up in a generated62/// solidity interface file, thus you should use [solidity syntax](https://docs.soliditylang.org/en/latest/natspec-format.html) for writing documentation in this macro63///64/// ## Example65///66/// ```ignore67/// struct SuperContract;68/// struct InlineContract;69/// struct Contract;70///71/// #[derive(ToLog)]72/// enum ContractEvents {73///     Event(#[indexed] uint32),74/// }75///76/// /// @dev This contract provides function to multiply two numbers77/// #[solidity_interface(name = MyContract, is(SuperContract), inline_is(InlineContract))]78/// impl Contract {79///     /// Multiply two numbers80///     /// @param a First number81///     /// @param b Second number82///     /// @return uint32 Product of two passed numbers83///     /// @dev This function returns error in case of overflow84///     #[weight(200 + a + b)]85///     #[solidity_interface(rename_selector = "mul")]86///     fn mul(&mut self, a: uint32, b: uint32) -> Result<uint32> {87///         Ok(a.checked_mul(b).ok_or("overflow")?)88///     }89/// }90/// ```91pub use evm_coder_procedural::solidity_interface;92/// See [`solidity_interface`]93pub use evm_coder_procedural::solidity;94/// See [`solidity_interface`]95pub use evm_coder_procedural::weight;96pub use sha3_const;9798/// Derives [`ToLog`] for enum99///100/// Selectors will be derived from variant names, there is currently no way to have custom naming101/// for them102///103/// `#[indexed]`104/// Marks this field as indexed, so it will appear in [`ethereum::Log`] topics instead of data105pub use evm_coder_procedural::ToLog;106107// Api of those modules shouldn't be consumed directly, it is only exported for usage in proc macros108#[doc(hidden)]109pub mod events;110#[doc(hidden)]111pub mod solidity;112113/// Solidity type definitions (aliases from solidity name to rust type)114/// To be used in [`solidity_interface`] definitions, to make sure there is no115/// type conflict between Rust code and generated definitions116pub mod types {117	#![allow(non_camel_case_types, missing_docs)]118119	#[cfg(not(feature = "std"))]120	use alloc::{vec::Vec};121	use pallet_evm::account::CrossAccountId;122	use primitive_types::{U256, H160, H256};123	use core::str::from_utf8;124125	use crate::custom_signature::{SignatureUnit, SIGNATURE_SIZE_LIMIT};126127	pub trait Signature {128		const SIGNATURE: SignatureUnit;129130		fn as_str() -> &'static str {131			from_utf8(&Self::SIGNATURE.data[..Self::SIGNATURE.len]).expect("bad utf-8")132		}133	}134135	impl Signature for bool {136		make_signature!(new fixed("bool"));137	}138139	macro_rules! define_simple_type {140		(type $ident:ident = $ty:ty) => {141			pub type $ident = $ty;142			impl Signature for $ty {143				make_signature!(new fixed(stringify!($ident)));144			}145		};146	}147148	define_simple_type!(type address = H160);149150	define_simple_type!(type uint8 = u8);151	define_simple_type!(type uint16 = u16);152	define_simple_type!(type uint32 = u32);153	define_simple_type!(type uint64 = u64);154	define_simple_type!(type uint128 = u128);155	define_simple_type!(type uint256 = U256);156	define_simple_type!(type bytes4 = [u8; 4]);157158	define_simple_type!(type topic = H256);159160	#[cfg(not(feature = "std"))]161	define_simple_type!(type string = ::alloc::string::String);162	#[cfg(feature = "std")]163	define_simple_type!(type string = ::std::string::String);164165	#[derive(Default, Debug)]166	pub struct bytes(pub Vec<u8>);167	impl Signature for bytes {168		make_signature!(new fixed("bytes"));169	}170171	/// Solidity doesn't have `void` type, however we have special implementation172	/// for empty tuple return type173	pub type void = ();174175	//#region Special types176	/// Makes function payable177	pub type value = U256;178	/// Makes function caller-sensitive179	pub type caller = address;180	//#endregion181182	/// Ethereum typed call message, similar to solidity183	/// `msg` object.184	pub struct Msg<C> {185		pub call: C,186		/// Address of user, which called this contract.187		pub caller: H160,188		/// Payment amount to contract.189		/// Contract should reject payment, if target call is not payable,190		/// and there is no `receiver()` function defined.191		pub value: U256,192	}193194	impl From<Vec<u8>> for bytes {195		fn from(src: Vec<u8>) -> Self {196			Self(src)197		}198	}199200	#[allow(clippy::from_over_into)]201	impl Into<Vec<u8>> for bytes {202		fn into(self) -> Vec<u8> {203			self.0204		}205	}206207	impl bytes {208		#[must_use]209		pub fn len(&self) -> usize {210			self.0.len()211		}212213		#[must_use]214		pub fn is_empty(&self) -> bool {215			self.len() == 0216		}217	}218219	#[derive(Debug, Default)]220	pub struct EthCrossAccount {221		pub(crate) eth: address,222		pub(crate) sub: uint256,223	}224225	impl EthCrossAccount {226		pub fn from_sub_cross_account<T>(cross_account_id: &T::CrossAccountId) -> Self227		where228			T: pallet_evm::account::Config,229			T::AccountId: AsRef<[u8; 32]>,230		{231			if cross_account_id.is_canonical_substrate() {232				Self {233					eth: Default::default(),234					sub: convert_cross_account_to_uint256::<T>(cross_account_id),235				}236			} else {237				Self {238					eth: *cross_account_id.as_eth(),239					sub: Default::default(),240				}241			}242		}243244		pub fn into_sub_cross_account<T>(&self) -> crate::execution::Result<T::CrossAccountId>245		where246			T: pallet_evm::account::Config,247			T::AccountId: From<[u8; 32]>,248		{249			if self.eth == Default::default() && self.sub == Default::default() {250				Err("All fields of cross account is zeroed".into())251			} else if self.eth == Default::default() {252				Ok(convert_uint256_to_cross_account::<T>(self.sub))253			} else if self.sub == Default::default() {254				Ok(T::CrossAccountId::from_eth(self.eth))255			} else {256				Err("All fields of cross account is non zeroed".into())257			}258		}259	}260261	impl Signature for EthCrossAccount {262		make_signature!(new fixed("(address,uint256)"));263	}264265	/// Convert `CrossAccountId` to `uint256`.266	pub fn convert_cross_account_to_uint256<T: pallet_evm::account::Config>(267		from: &T::CrossAccountId,268	) -> uint256269	where270		T::AccountId: AsRef<[u8; 32]>,271	{272		let slice = from.as_sub().as_ref();273		uint256::from_big_endian(slice)274	}275276	/// Convert `uint256` to `CrossAccountId`.277	pub fn convert_uint256_to_cross_account<T: pallet_evm::account::Config>(278		from: uint256,279	) -> T::CrossAccountId280	where281		T::AccountId: From<[u8; 32]>,282	{283		let mut new_admin_arr = [0_u8; 32];284		from.to_big_endian(&mut new_admin_arr);285		let account_id = T::AccountId::from(new_admin_arr);286		T::CrossAccountId::from_sub(account_id)287	}288}289290/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro291pub trait Call: Sized {292	/// Parse call buffer into typed call enum293	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;294}295296/// Intended to be used as `#[weight]` output type297/// Should be same between evm-coder and substrate to avoid confusion298///299/// Isn't same thing as gas, some mapping is required between those types300pub type Weight = frame_support::weights::Weight;301302/// In substrate, we have benchmarking, which allows303/// us to not rely on gas metering, but instead predict amount of gas to execute call304pub trait Weighted: Call {305	/// Predict weight of this call306	fn weight(&self) -> DispatchInfo;307}308309/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro310/// on interface implementation, or for externally-owned real EVM contract311pub trait Callable<C: Call> {312	/// Call contract using specified call data313	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;314}315316/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],317/// this structure holds parsed data for ERC165Call subvariant318///319/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every320/// implementing contract321///322/// See <https://eips.ethereum.org/EIPS/eip-165>323#[derive(Debug)]324pub enum ERC165Call {325	/// ERC165 provides single method, which returns true, if contract326	/// implements specified interface327	SupportsInterface {328		/// Requested interface329		interface_id: types::bytes4,330	},331}332333impl ERC165Call {334	/// ERC165 selector is provided by standard335	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);336}337338impl Call for ERC165Call {339	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {340		if selector != Self::INTERFACE_ID {341			return Ok(None);342		}343		Ok(Some(Self::SupportsInterface {344			interface_id: types::bytes4::abi_read(input)?,345		}))346	}347}348349/// Generate "tests", which will generate solidity code on execution and print it to stdout350/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime351///352/// This macro receives type usage as second argument, but you can use anything as generics,353/// because no bounds are implied354#[macro_export]355macro_rules! generate_stubgen {356	($name:ident, $decl:ty, $is_impl:literal) => {357		#[test]358		#[ignore]359		fn $name() {360			use evm_coder::solidity::TypeCollector;361			let mut out = TypeCollector::new();362			<$decl>::generate_solidity_interface(&mut out, $is_impl);363			println!("=== SNIP START ===");364			println!("// SPDX-License-Identifier: OTHER");365			println!("// This code is automatically generated");366			println!();367			println!("pragma solidity >=0.8.0 <0.9.0;");368			println!();369			for b in out.finish() {370				println!("{}", b);371			}372			println!("=== SNIP END ===");373		}374	};375}376377#[cfg(test)]378mod tests {379	use super::*;380381	#[test]382	fn function_selector_generation() {383		assert_eq!(fn_selector!(transfer(address, uint256)), 0xa9059cbb);384	}385386	#[test]387	fn event_topic_generation() {388		assert_eq!(389			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),390			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",391		);392	}393}