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

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 evm_coder_procedural::AbiCoder;97pub use sha3_const;9899/// Derives [`ToLog`] for enum100///101/// Selectors will be derived from variant names, there is currently no way to have custom naming102/// for them103///104/// `#[indexed]`105/// Marks this field as indexed, so it will appear in [`ethereum::Log`] topics instead of data106pub use evm_coder_procedural::ToLog;107108// Api of those modules shouldn't be consumed directly, it is only exported for usage in proc macros109#[doc(hidden)]110pub mod events;111#[doc(hidden)]112#[cfg(feature = "stubgen")]113pub mod solidity;114115/// Sealed traits.116pub mod sealed {117	/// Not every type should be directly placed in vec.118	/// Vec encoding is not memory efficient, as every item will be padded119	/// to 32 bytes.120	/// Instead you should use specialized types (`bytes` in case of `Vec<u8>`)121	pub trait CanBePlacedInVec {}122}123124/// Solidity type definitions (aliases from solidity name to rust type)125/// To be used in [`solidity_interface`] definitions, to make sure there is no126/// type conflict between Rust code and generated definitions127pub mod types {128	#![allow(non_camel_case_types, missing_docs)]129130	#[cfg(not(feature = "std"))]131	use alloc::{vec::Vec};132	use primitive_types::{U256, H160, H256};133134	pub type address = H160;135	pub type uint8 = u8;136	pub type uint16 = u16;137	pub type uint32 = u32;138	pub type uint64 = u64;139	pub type uint128 = u128;140	pub type uint256 = U256;141	pub type bytes4 = [u8; 4];142	pub type topic = H256;143144	#[cfg(not(feature = "std"))]145	pub type string = ::alloc::string::String;146	#[cfg(feature = "std")]147	pub type string = ::std::string::String;148149	#[derive(Default, Debug, PartialEq, Eq, Clone)]150	pub struct bytes(pub Vec<u8>);151152	/// Solidity doesn't have `void` type, however we have special implementation153	/// for empty tuple return type154	pub type void = ();155156	//#region Special types157	/// Makes function payable158	pub type value = U256;159	/// Makes function caller-sensitive160	pub type caller = address;161	//#endregion162163	/// Ethereum typed call message, similar to solidity164	/// `msg` object.165	pub struct Msg<C> {166		pub call: C,167		/// Address of user, which called this contract.168		pub caller: H160,169		/// Payment amount to contract.170		/// Contract should reject payment, if target call is not payable,171		/// and there is no `receiver()` function defined.172		pub value: U256,173	}174175	impl From<Vec<u8>> for bytes {176		fn from(src: Vec<u8>) -> Self {177			Self(src)178		}179	}180181	#[allow(clippy::from_over_into)]182	impl Into<Vec<u8>> for bytes {183		fn into(self) -> Vec<u8> {184			self.0185		}186	}187188	impl bytes {189		#[must_use]190		pub fn len(&self) -> usize {191			self.0.len()192		}193194		#[must_use]195		pub fn is_empty(&self) -> bool {196			self.len() == 0197		}198	}199200	#[derive(Debug, Default)]201	pub struct Property {202		pub key: string,203		pub value: bytes,204	}205}206207/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro208pub trait Call: Sized {209	/// Parse call buffer into typed call enum210	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;211}212213/// Intended to be used as `#[weight]` output type214/// Should be same between evm-coder and substrate to avoid confusion215///216/// Isn't same thing as gas, some mapping is required between those types217pub type Weight = frame_support::weights::Weight;218219/// In substrate, we have benchmarking, which allows220/// us to not rely on gas metering, but instead predict amount of gas to execute call221pub trait Weighted: Call {222	/// Predict weight of this call223	fn weight(&self) -> DispatchInfo;224}225226/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro227/// on interface implementation, or for externally-owned real EVM contract228pub trait Callable<C: Call> {229	/// Call contract using specified call data230	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;231}232233/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],234/// this structure holds parsed data for ERC165Call subvariant235///236/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every237/// implementing contract238///239/// See <https://eips.ethereum.org/EIPS/eip-165>240#[derive(Debug)]241pub enum ERC165Call {242	/// ERC165 provides single method, which returns true, if contract243	/// implements specified interface244	SupportsInterface {245		/// Requested interface246		interface_id: types::bytes4,247	},248}249250impl ERC165Call {251	/// ERC165 selector is provided by standard252	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);253}254255impl Call for ERC165Call {256	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {257		if selector != Self::INTERFACE_ID {258			return Ok(None);259		}260		Ok(Some(Self::SupportsInterface {261			interface_id: types::bytes4::abi_read(input)?,262		}))263	}264}265266/// Generate "tests", which will generate solidity code on execution and print it to stdout267/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime268///269/// This macro receives type usage as second argument, but you can use anything as generics,270/// because no bounds are implied271#[macro_export]272macro_rules! generate_stubgen {273	($name:ident, $decl:ty, $is_impl:literal) => {274		#[cfg(feature = "stubgen")]275		#[test]276		#[ignore]277		fn $name() {278			use evm_coder::solidity::TypeCollector;279			let mut out = TypeCollector::new();280			<$decl>::generate_solidity_interface(&mut out, $is_impl);281			println!("=== SNIP START ===");282			println!("// SPDX-License-Identifier: OTHER");283			println!("// This code is automatically generated");284			println!();285			println!("pragma solidity >=0.8.0 <0.9.0;");286			println!();287			for b in out.finish() {288				println!("{}", b);289			}290			println!("=== SNIP END ===");291		}292	};293}294295#[cfg(test)]296mod tests {297	use super::*;298299	#[test]300	fn function_selector_generation() {301		assert_eq!(fn_selector!(transfer(address, uint256)), 0xa9059cbb);302	}303304	#[test]305	fn event_topic_generation() {306		assert_eq!(307			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),308			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",309		);310	}311}