git.delta.rocks / unique-network / refs/commits / 5af31166e6db

--- a/crates/evm-coder/procedural/src/solidity_interface.rs
+++ b/crates/evm-coder/procedural/src/solidity_interface.rs
@@ -16,6 +16,10 @@
 
 #![allow(dead_code)]
 
+// NOTE: In order to understand this Rust macro better, first read this chapter
+// about Procedural Macros in Rust book:
+// https://doc.rust-lang.org/reference/procedural-macros.html
+
 use quote::{quote, ToTokens};
 use inflector::cases;
 use std::fmt::Write;
@@ -485,6 +489,8 @@
 	Pure,
 }
 
+/// Group all keywords for this macro. Usage example:
+/// #[solidity_interface(name = "B", inline_is(A))]
 mod kw {
 	syn::custom_keyword!(weight);
 
@@ -498,6 +504,7 @@
 	syn::custom_keyword!(rename_selector);
 }
 
+/// Rust methods are parsed into this structure when Solidity code is generated
 struct Method {
 	name: Ident,
 	camel_name: String,

--- a/crates/evm-coder/src/execution.rs
+++ b/crates/evm-coder/src/execution.rs
@@ -78,7 +78,7 @@
 		info.weight - self.calc_actual_weight(info)
 	}
 
-	/// Calculate actual cansumed weight, saturating to weight reported
+	/// Calculate actual consumed weight, saturating to weight reported
 	/// pre-dispatch
 	pub fn calc_actual_weight(&self, info: &DispatchInfo) -> Weight {
 		if let Some(actual_weight) = self.actual_weight {

34///34///
35/// `#[solidity_interface(name, is, inline_is, events)]`35/// `#[solidity_interface(name, is, inline_is, events)]`
36/// - *name* - used in generated code, and for Call enum name36/// - *name* - used in generated code, and for Call enum name
37/// - *is* - used to provide call inheritance, not found methods will be delegated to all contracts37/// - *is* - used to provide inheritance in Solidity
38/// specified in is/inline_is38/// - *inline_is* - same as `is`, but ERC165::SupportsInterface will work differently: For `is` SupportsInterface(A) will return true
39/// - *inline_is* - same as is, but selectors for passed contracts will be used by derived ERC16539///   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 return
40/// implementation41///   false.
41///42///
42/// `#[weight(value)]`43/// `#[weight(value)]`
43/// Can be added to every method of impl block, used for deriving [`crate::Weighted`], which44/// Can be added to every method of impl block, used for deriving [`crate::Weighted`], which
44/// is used by substrate bridge.45/// is used by substrate bridge.
45/// - *value*: expression, which evaluates to weight required to call this method.46/// - *value*: expression, which evaluates to weight required to call this method.
46/// This expression can use call arguments to calculate non-constant execution time.47/// This expression can use call arguments to calculate non-constant execution time.
47/// This expression should evaluate faster than actual execution does, and may provide worser case48/// This expression should evaluate faster than actual execution does, and may provide worse case
48/// than one is called.49/// than one is called.
49///50///
50/// `#[solidity_interface(rename_selector)]`51/// `#[solidity_interface(rename_selector)]`