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

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;9394/// Derives [`ToLog`] for enum95///96/// Selectors will be derived from variant names, there is currently no way to have custom naming97/// for them98///99/// `#[indexed]`100/// Marks this field as indexed, so it will appear in [`ethereum::Log`] topics instead of data101pub use evm_coder_procedural::ToLog;102103// Api of those modules shouldn't be consumed directly, it is only exported for usage in proc macros104#[doc(hidden)]105pub mod events;106#[doc(hidden)]107pub mod solidity;108109/// Solidity type definitions (aliases from solidity name to rust type)110/// To be used in [`solidity_interface`] definitions, to make sure there is no111/// type conflict between Rust code and generated definitions112pub mod types {113	#![allow(non_camel_case_types, missing_docs)]114115	#[cfg(not(feature = "std"))]116	use alloc::{vec::Vec};117	use primitive_types::{U256, H160, H256};118119	pub type address = H160;120121	pub type uint8 = u8;122	pub type uint16 = u16;123	pub type uint32 = u32;124	pub type uint64 = u64;125	pub type uint128 = u128;126	pub type uint256 = U256;127128	pub type bytes4 = [u8; 4];129130	pub type topic = H256;131132	#[cfg(not(feature = "std"))]133	pub type string = ::alloc::string::String;134	#[cfg(feature = "std")]135	pub type string = ::std::string::String;136137	#[derive(Default, Debug)]138	pub struct bytes(pub Vec<u8>);139140	/// Solidity doesn't have `void` type, however we have special implementation141	/// for empty tuple return type142	pub type void = ();143144	//#region Special types145	/// Makes function payable146	pub type value = U256;147	/// Makes function caller-sensitive148	pub type caller = address;149	//#endregion150151	/// Ethereum typed call message, similar to solidity152	/// `msg` object.153	pub struct Msg<C> {154		pub call: C,155		/// Address of user, which called this contract.156		pub caller: H160,157		/// Payment amount to contract.158		/// Contract should reject payment, if target call is not payable,159		/// and there is no `receiver()` function defined.160		pub value: U256,161	}162163	impl From<Vec<u8>> for bytes {164		fn from(src: Vec<u8>) -> Self {165			Self(src)166		}167	}168169	impl Into<Vec<u8>> for bytes {170		fn into(self) -> Vec<u8> {171			self.0172		}173	}174175	impl bytes {176		#[must_use]177		pub fn len(&self) -> usize {178			self.0.len()179		}180181		#[must_use]182		pub fn is_empty(&self) -> bool {183			self.len() == 0184		}185	}186}187188/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro189pub trait Call: Sized {190	/// Parse call buffer into typed call enum191	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>>;192}193194/// Intended to be used as `#[weight]` output type195/// Should be same between evm-coder and substrate to avoid confusion196///197/// Isn't same thing as gas, some mapping is required between those types198pub type Weight = frame_support::weights::Weight;199200/// In substrate, we have benchmarking, which allows201/// us to not rely on gas metering, but instead predict amount of gas to execute call202pub trait Weighted: Call {203	/// Predict weight of this call204	fn weight(&self) -> DispatchInfo;205}206207/// Type callable with ethereum message, may be implemented by [`solidity_interface`] macro208/// on interface implementation, or for externally-owned real EVM contract209pub trait Callable<C: Call> {210	/// Call contract using specified call data211	fn call(&mut self, call: types::Msg<C>) -> execution::ResultWithPostInfo<AbiWriter>;212}213214/// Implementation of ERC165 is implicitly generated for all interfaces in [`solidity_interface`],215/// this structure holds parsed data for ERC165Call subvariant216///217/// Note: no [`Callable`] implementation is provided, call implementation is inlined into every218/// implementing contract219///220/// See <https://eips.ethereum.org/EIPS/eip-165>221#[derive(Debug)]222pub enum ERC165Call {223	/// ERC165 provides single method, which returns true, if contract224	/// implements specified interface225	SupportsInterface {226		/// Requested interface227		interface_id: types::bytes4,228	},229}230231impl ERC165Call {232	/// ERC165 selector is provided by standard233	pub const INTERFACE_ID: types::bytes4 = u32::to_be_bytes(0x01ffc9a7);234}235236impl Call for ERC165Call {237	fn parse(selector: types::bytes4, input: &mut AbiReader) -> execution::Result<Option<Self>> {238		if selector != Self::INTERFACE_ID {239			return Ok(None);240		}241		Ok(Some(Self::SupportsInterface {242			interface_id: input.abi_read()?,243		}))244	}245}246247/// Generate "tests", which will generate solidity code on execution and print it to stdout248/// Script at .maintain/scripts/generate_api.sh can split this output from test runtime249///250/// This macro receives type usage as second argument, but you can use anything as generics,251/// because no bounds are implied252#[macro_export]253macro_rules! generate_stubgen {254	($name:ident, $decl:ty, $is_impl:literal) => {255		#[test]256		#[ignore]257		fn $name() {258			use evm_coder::solidity::TypeCollector;259			let mut out = TypeCollector::new();260			<$decl>::generate_solidity_interface(&mut out, $is_impl);261			println!("=== SNIP START ===");262			println!("// SPDX-License-Identifier: OTHER");263			println!("// This code is automatically generated");264			println!();265			println!("pragma solidity >=0.8.0 <0.9.0;");266			println!();267			for b in out.finish() {268				println!("{}", b);269			}270			println!("=== SNIP END ===");271		}272	};273}274275#[cfg(test)]276mod tests {277	use super::*;278279	#[test]280	fn function_selector_generation() {281		assert_eq!(fn_selector!(transfer(address, uint256)), 0xa9059cbb);282	}283284	#[test]285	fn event_topic_generation() {286		assert_eq!(287			hex::encode(&event_topic!(Transfer(address, address, uint256))[..]),288			"ddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef",289		);290	}291}