git.delta.rocks / unique-network / refs/commits / b44fe9bf17b6

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#![cfg_attr(not(feature = "std"), no_std)]20#[cfg(not(feature = "std"))]21extern crate alloc;2223use abi::{AbiRead, AbiReader, AbiWriter};24pub use evm_coder_procedural::{event_topic, fn_selector};25pub mod abi;26pub use events::{ToLog, ToTopic};27use execution::DispatchInfo;28pub mod execution;2930/// Derives call enum implementing [`crate::Callable`], [`crate::Weighted`]31/// and [`crate::Call`] from impl block.32///33/// ## Macro syntax34///35/// `#[solidity_interface(name, is, inline_is, events)]`36/// - *name* - used in generated code, and for Call enum name37/// - *is* - used to provide inheritance in Solidity38/// - *inline_is* - same as `is`, but ERC165::SupportsInterface will work differently: For `is` SupportsInterface(A) will return true39///   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)`40///   SupportsInterface(A) will internally create a new interface that combines all methods of A and B, so SupportsInterface(A) will return41///   false.42///43/// `#[weight(value)]`44/// Can be added to every method of impl block, used for deriving [`crate::Weighted`], which45/// is used by substrate bridge.46/// - *value*: expression, which evaluates to weight required to call this method.47/// This expression can use call arguments to calculate non-constant execution time.48/// This expression should evaluate faster than actual execution does, and may provide worse case49/// than one is called.50///51/// `#[solidity_interface(rename_selector)]`52/// - *rename_selector* - by default, selector name will be generated by transforming method name53/// from snake_case to camelCase. Use this option, if other naming convention is required.54/// I.e: method `token_uri` will be automatically renamed to `tokenUri` in selector, but name55/// required by ERC721 standard is `tokenURI`, thus we need to specify `rename_selector = "tokenURI"`56/// explicitly.57///58/// Both contract and contract methods may have doccomments, which will end up in a generated59/// solidity interface file, thus you should use [solidity syntax](https://docs.soliditylang.org/en/latest/natspec-format.html) for writing documentation in this macro60///61/// ## Example62///63/// ```ignore64/// struct SuperContract;65/// struct InlineContract;66/// struct Contract;67///68/// #[derive(ToLog)]69/// enum ContractEvents {70///     Event(#[indexed] uint32),71/// }72///73/// /// @dev This contract provides function to multiply two numbers74/// #[solidity_interface(name = MyContract, is(SuperContract), inline_is(InlineContract))]75/// impl Contract {76///     /// Multiply two numbers77///     /// @param a First number78///     /// @param b Second number79///     /// @return uint32 Product of two passed numbers80///     /// @dev This function returns error in case of overflow81///     #[weight(200 + a + b)]82///     #[solidity_interface(rename_selector = "mul")]83///     fn mul(&mut self, a: uint32, b: uint32) -> Result<uint32> {84///         Ok(a.checked_mul(b).ok_or("overflow")?)85///     }86/// }87/// ```88pub use evm_coder_procedural::solidity_interface;89/// See [`solidity_interface`]90pub use evm_coder_procedural::solidity;91/// See [`solidity_interface`]92pub use evm_coder_procedural::weight;93pub use const_format;94pub use sha3_const;9596/// Derives [`ToLog`] for enum97///98/// Selectors will be derived from variant names, there is currently no way to have custom naming99/// for them100///101/// `#[indexed]`102/// Marks this field as indexed, so it will appear in [`ethereum::Log`] topics instead of data103pub use evm_coder_procedural::ToLog;104105// Api of those modules shouldn't be consumed directly, it is only exported for usage in proc macros106#[doc(hidden)]107pub mod events;108#[doc(hidden)]109pub mod solidity;110111/// Solidity type definitions (aliases from solidity name to rust type)112/// To be used in [`solidity_interface`] definitions, to make sure there is no113/// type conflict between Rust code and generated definitions114pub mod types {115	#![allow(non_camel_case_types, missing_docs)]116117	#[cfg(not(feature = "std"))]118	use alloc::{vec::Vec};119	use pallet_evm::account::CrossAccountId;120	use primitive_types::{U256, H160, H256};121122	pub type address = H160;123124	pub type uint8 = u8;125	pub type uint16 = u16;126	pub type uint32 = u32;127	pub type uint64 = u64;128	pub type uint128 = u128;129	pub type uint256 = U256;130131	pub type bytes4 = [u8; 4];132133	pub type topic = H256;134135	#[cfg(not(feature = "std"))]136	pub type string = ::alloc::string::String;137	#[cfg(feature = "std")]138	pub type string = ::std::string::String;139140	#[derive(Default, Debug)]141	pub struct bytes(pub Vec<u8>);142143	/// Solidity doesn't have `void` type, however we have special implementation144	/// for empty tuple return type145	pub type void = ();146147	//#region Special types148	/// Makes function payable149	pub type value = U256;150	/// Makes function caller-sensitive151	pub type caller = address;152	//#endregion153154	/// Ethereum typed call message, similar to solidity155	/// `msg` object.156	pub struct Msg<C> {157		pub call: C,158		/// Address of user, which called this contract.159		pub caller: H160,160		/// Payment amount to contract.161		/// Contract should reject payment, if target call is not payable,162		/// and there is no `receiver()` function defined.163		pub value: U256,164	}165166	impl From<Vec<u8>> for bytes {167		fn from(src: Vec<u8>) -> Self {168			Self(src)169		}170	}171172	impl Into<Vec<u8>> for bytes {173		fn into(self) -> Vec<u8> {174			self.0175		}176	}177178	impl bytes {179		#[must_use]180		pub fn len(&self) -> usize {181			self.0.len()182		}183184		#[must_use]185		pub fn is_empty(&self) -> bool {186			self.len() == 0187		}188	}189190	#[derive(Debug)]191	pub struct EthCrossAccount {192		pub(crate) eth: address,193		pub(crate) sub: uint256,194	}195196	impl EthCrossAccount {197		pub fn from_sub_cross_account<T>(cross_account_id: &T::CrossAccountId) -> Self198		where199			T: pallet_evm::account::Config,200			T::AccountId: AsRef<[u8; 32]>,201		{202			if cross_account_id.is_canonical_substrate() {203				Self {204					eth: Default::default(),205					sub: convert_cross_account_to_uint256::<T>(cross_account_id),206				}207			} else {208				Self {209					eth: *cross_account_id.as_eth(),210					sub: Default::default(),211				}212			}213		}214215		pub fn into_sub_cross_account<T>(&self) -> crate::execution::Result<T::CrossAccountId>216		where217			T: pallet_evm::account::Config,218			T::AccountId: From<[u8; 32]>,219		{220			if self.eth == Default::default() && self.sub == Default::default() {221				Err("All fields of cross account is zeroed".into())222			} else if self.eth == Default::default() {223				Ok(convert_uint256_to_cross_account::<T>(self.sub))224			} else if self.sub == Default::default() {225				Ok(T::CrossAccountId::from_eth(self.eth))226			} else {227				Err("All fields of cross account is non zeroed".into())228			}229		}230	}231232	impl SignatureString for EthCrossAccount {233		const SIGNATURE_STRING: &'static str = "(address,uint256)";234	}235236	pub trait SignatureString {237		const SIGNATURE_STRING: &'static str;238	}239240	/// Convert `CrossAccountId` to `uint256`.241	pub fn convert_cross_account_to_uint256<T: pallet_evm::account::Config>(242		from: &T::CrossAccountId,243	) -> uint256244	where245		T::AccountId: AsRef<[u8; 32]>,246	{247		let slice = from.as_sub().as_ref();248		uint256::from_big_endian(slice)249	}250251	/// Convert `uint256` to `CrossAccountId`.252	pub fn convert_uint256_to_cross_account<T: pallet_evm::account::Config>(253		from: uint256,254	) -> T::CrossAccountId255	where256		T::AccountId: From<[u8; 32]>,257	{258		let mut new_admin_arr = [0_u8; 32];259		from.to_big_endian(&mut new_admin_arr);260		let account_id = T::AccountId::from(new_admin_arr);261		T::CrossAccountId::from_sub(account_id)262	}263}264265/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro266pub trait Call: Sized {267	/// Parse call buffer into typed call enum268	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;269}270271/// Intended to be used as `#[weight]` output type272/// Should be same between evm-coder and substrate to avoid confusion273///274/// Isn't same thing as gas, some mapping is required between those types275pub type Weight = frame_support::weights::Weight;276277/// In substrate, we have benchmarking, which allows278/// us to not rely on gas metering, but instead predict amount of gas to execute call279pub trait Weighted: Call {280	/// Predict weight of this call281	fn weight(&self) -> DispatchInfo;282}283284/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro285/// on interface implementation, or for externally-owned real EVM contract286pub trait Callable<C: Call> {287	/// Call contract using specified call data288	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;289}290291/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],292/// this structure holds parsed data for ERC165Call subvariant293///294/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every295/// implementing contract296///297/// See <https://eips.ethereum.org/EIPS/eip-165>298#[derive(Debug)]299pub enum ERC165Call {300	/// ERC165 provides single method, which returns true, if contract301	/// implements specified interface302	SupportsInterface {303		/// Requested interface304		interface_id: types::bytes4,305	},306}307308impl ERC165Call {309	/// ERC165 selector is provided by standard310	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);311}312313impl Call for ERC165Call {314	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {315		if selector != Self::INTERFACE_ID {316			return Ok(None);317		}318		Ok(Some(Self::SupportsInterface {319			interface_id: input.abi_read()?,320		}))321	}322}323324/// Generate "tests", which will generate solidity code on execution and print it to stdout325/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime326///327/// This macro receives type usage as second argument, but you can use anything as generics,328/// because no bounds are implied329#[macro_export]330macro_rules! generate_stubgen {331	($name:ident, $decl:ty, $is_impl:literal) => {332		#[test]333		#[ignore]334		fn $name() {335			use evm_coder::solidity::TypeCollector;336			let mut out = TypeCollector::new();337			<$decl>::generate_solidity_interface(&mut out, $is_impl);338			println!("=== SNIP START ===");339			println!("// SPDX-License-Identifier: OTHER");340			println!("// This code is automatically generated");341			println!();342			println!("pragma solidity >=0.8.0 <0.9.0;");343			println!();344			for b in out.finish() {345				println!("{}", b);346			}347			println!("=== SNIP END ===");348		}349	};350}351352#[cfg(test)]353mod tests {354	use super::*;355356	#[test]357	fn function_selector_generation() {358		assert_eq!(fn_selector!(transfer(address, uint256)), 0xa9059cbb);359	}360361	// #[test]362	// fn function_selector_generation_1() {363	// 	assert_eq!(364	// 		fn_selector!(transferFromCrossAccountToCrossAccount(365	// 			EthCrossAccount,366	// 			EthCrossAccount,367	// 			uint256368	// 		)),369	// 		2543295963370	// 	);371	// }372373	#[test]374	fn event_topic_generation() {375		assert_eq!(376			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),377			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",378		);379	}380}