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

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/// Solidity type definitions (aliases from solidity name to rust type)116/// To be used in [`solidity_interface`] definitions, to make sure there is no117/// type conflict between Rust code and generated definitions118pub mod types {119	#![allow(non_camel_case_types, missing_docs)]120121	#[cfg(not(feature = "std"))]122	use alloc::{vec::Vec};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 Property {193		pub key: string,194		pub value: bytes,195	}196}197198/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro199pub trait Call: Sized {200	/// Parse call buffer into typed call enum201	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;202}203204/// Intended to be used as `#[weight]` output type205/// Should be same between evm-coder and substrate to avoid confusion206///207/// Isn't same thing as gas, some mapping is required between those types208pub type Weight = frame_support::weights::Weight;209210/// In substrate, we have benchmarking, which allows211/// us to not rely on gas metering, but instead predict amount of gas to execute call212pub trait Weighted: Call {213	/// Predict weight of this call214	fn weight(&self) -> DispatchInfo;215}216217/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro218/// on interface implementation, or for externally-owned real EVM contract219pub trait Callable<C: Call> {220	/// Call contract using specified call data221	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;222}223224/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],225/// this structure holds parsed data for ERC165Call subvariant226///227/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every228/// implementing contract229///230/// See <https://eips.ethereum.org/EIPS/eip-165>231#[derive(Debug)]232pub enum ERC165Call {233	/// ERC165 provides single method, which returns true, if contract234	/// implements specified interface235	SupportsInterface {236		/// Requested interface237		interface_id: types::bytes4,238	},239}240241impl ERC165Call {242	/// ERC165 selector is provided by standard243	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);244}245246impl Call for ERC165Call {247	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {248		if selector != Self::INTERFACE_ID {249			return Ok(None);250		}251		Ok(Some(Self::SupportsInterface {252			interface_id: types::bytes4::abi_read(input)?,253		}))254	}255}256257/// Generate "tests", which will generate solidity code on execution and print it to stdout258/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime259///260/// This macro receives type usage as second argument, but you can use anything as generics,261/// because no bounds are implied262#[macro_export]263macro_rules! generate_stubgen {264	($name:ident, $decl:ty, $is_impl:literal) => {265		#[cfg(feature = "stubgen")]266		#[test]267		#[ignore]268		fn $name() {269			use evm_coder::solidity::TypeCollector;270			let mut out = TypeCollector::new();271			<$decl>::generate_solidity_interface(&mut out, $is_impl);272			println!("=== SNIP START ===");273			println!("// SPDX-License-Identifier: OTHER");274			println!("// This code is automatically generated");275			println!();276			println!("pragma solidity >=0.8.0 <0.9.0;");277			println!();278			for b in out.finish() {279				println!("{}", b);280			}281			println!("=== SNIP END ===");282		}283	};284}285286#[cfg(test)]287mod tests {288	use super::*;289290	#[test]291	fn function_selector_generation() {292		assert_eq!(fn_selector!(transfer(address, uint256)), 0xa9059cbb);293	}294295	#[test]296	fn event_topic_generation() {297		assert_eq!(298			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),299			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",300		);301	}302}