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

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)]111#[cfg(feature = "stubgen")]112pub mod solidity;113114/// Solidity type definitions (aliases from solidity name to rust type)115/// To be used in [`solidity_interface`] definitions, to make sure there is no116/// type conflict between Rust code and generated definitions117pub mod types {118	#![allow(non_camel_case_types, missing_docs)]119120	#[cfg(not(feature = "std"))]121	use alloc::{vec::Vec};122	use pallet_evm::account::CrossAccountId;123	use primitive_types::{U256, H160, H256};124125	pub type address = H160;126	pub type uint8 = u8;127	pub type uint16 = u16;128	pub type uint32 = u32;129	pub type uint64 = u64;130	pub type uint128 = u128;131	pub type uint256 = U256;132	pub type bytes4 = [u8; 4];133	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, PartialEq, Clone)]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	#[allow(clippy::from_over_into)]173	impl Into<Vec<u8>> for bytes {174		fn into(self) -> Vec<u8> {175			self.0176		}177	}178179	impl bytes {180		#[must_use]181		pub fn len(&self) -> usize {182			self.0.len()183		}184185		#[must_use]186		pub fn is_empty(&self) -> bool {187			self.len() == 0188		}189	}190191	#[derive(Debug, Default)]192	pub struct EthCrossAccount {193		pub(crate) eth: address,194		pub(crate) sub: uint256,195	}196197	impl EthCrossAccount {198		pub fn from_sub_cross_account<T>(cross_account_id: &T::CrossAccountId) -> Self199		where200			T: pallet_evm::Config,201			T::AccountId: AsRef<[u8; 32]>,202		{203			if cross_account_id.is_canonical_substrate() {204				Self {205					eth: Default::default(),206					sub: convert_cross_account_to_uint256::<T>(cross_account_id),207				}208			} else {209				Self {210					eth: *cross_account_id.as_eth(),211					sub: Default::default(),212				}213			}214		}215216		pub fn into_sub_cross_account<T>(&self) -> crate::execution::Result<T::CrossAccountId>217		where218			T: pallet_evm::Config,219			T::AccountId: From<[u8; 32]>,220		{221			if self.eth == Default::default() && self.sub == Default::default() {222				Err("All fields of cross account is zeroed".into())223			} else if self.eth == Default::default() {224				Ok(convert_uint256_to_cross_account::<T>(self.sub))225			} else if self.sub == Default::default() {226				Ok(T::CrossAccountId::from_eth(self.eth))227			} else {228				Err("All fields of cross account is non zeroed".into())229			}230		}231	}232233	/// Convert `CrossAccountId` to `uint256`.234	pub fn convert_cross_account_to_uint256<T: pallet_evm::Config>(235		from: &T::CrossAccountId,236	) -> uint256237	where238		T::AccountId: AsRef<[u8; 32]>,239	{240		let slice = from.as_sub().as_ref();241		uint256::from_big_endian(slice)242	}243244	/// Convert `uint256` to `CrossAccountId`.245	pub fn convert_uint256_to_cross_account<T: pallet_evm::Config>(246		from: uint256,247	) -> T::CrossAccountId248	where249		T::AccountId: From<[u8; 32]>,250	{251		let mut new_admin_arr = [0_u8; 32];252		from.to_big_endian(&mut new_admin_arr);253		let account_id = T::AccountId::from(new_admin_arr);254		T::CrossAccountId::from_sub(account_id)255	}256257	#[derive(Debug, Default)]258	pub struct Property {259		pub key: string,260		pub value: bytes,261	}262}263264/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro265pub trait Call: Sized {266	/// Parse call buffer into typed call enum267	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;268}269270/// Intended to be used as `#[weight]` output type271/// Should be same between evm-coder and substrate to avoid confusion272///273/// Isn't same thing as gas, some mapping is required between those types274pub type Weight = frame_support::weights::Weight;275276/// In substrate, we have benchmarking, which allows277/// us to not rely on gas metering, but instead predict amount of gas to execute call278pub trait Weighted: Call {279	/// Predict weight of this call280	fn weight(&self) -> DispatchInfo;281}282283/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro284/// on interface implementation, or for externally-owned real EVM contract285pub trait Callable<C: Call> {286	/// Call contract using specified call data287	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;288}289290/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],291/// this structure holds parsed data for ERC165Call subvariant292///293/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every294/// implementing contract295///296/// See <https://eips.ethereum.org/EIPS/eip-165>297#[derive(Debug)]298pub enum ERC165Call {299	/// ERC165 provides single method, which returns true, if contract300	/// implements specified interface301	SupportsInterface {302		/// Requested interface303		interface_id: types::bytes4,304	},305}306307impl ERC165Call {308	/// ERC165 selector is provided by standard309	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);310}311312impl Call for ERC165Call {313	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {314		if selector != Self::INTERFACE_ID {315			return Ok(None);316		}317		Ok(Some(Self::SupportsInterface {318			interface_id: types::bytes4::abi_read(input)?,319		}))320	}321}322323/// Generate "tests", which will generate solidity code on execution and print it to stdout324/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime325///326/// This macro receives type usage as second argument, but you can use anything as generics,327/// because no bounds are implied328#[macro_export]329macro_rules! generate_stubgen {330	($name:ident, $decl:ty, $is_impl:literal) => {331		#[cfg(feature = "stubgen")]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 event_topic_generation() {363		assert_eq!(364			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),365			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",366		);367	}368}