difftreelog
misk: Generate solidity docs for struct
in: master
4 files changed
crates/evm-coder/procedural/src/abi_derive.rsdiffbeforeafterboth223pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {3pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {4 let name = &ast.ident;4 let name = &ast.ident;5 let docs = ast6 .attrs7 .iter()8 .filter_map(|attr| {9 if let Some(ps) = attr.path.segments.first() {10 if ps.ident == "doc" {11 let meta = match attr.parse_meta() {12 Ok(meta) => meta,13 Err(e) => return Some(Err(e)),14 };15 match meta {16 syn::Meta::NameValue(mnv) => match &mnv.lit {17 syn::Lit::Str(ls) => return Some(Ok(ls.value())),18 _ => unreachable!(),19 },20 _ => unreachable!(),21 }22 }23 }24 None25 })26 .collect::<syn::Result<Vec<_>>>()?;275 let (is_named_fields, field_names, field_types, params_count) = match &ast.data {28 let (is_named_fields, field_names, field_types, params_count) = match &ast.data {6 syn::Data::Struct(ds) => match ds.fields {29 syn::Data::Struct(ds) => match ds.fields {38 let solidity_type = impl_solidity_type(name, field_types.clone(), params_count);61 let solidity_type = impl_solidity_type(name, field_types.clone(), params_count);39 let solidity_type_name = impl_solidity_type_name(name, field_types.clone(), params_count);62 let solidity_type_name = impl_solidity_type_name(name, field_types.clone(), params_count);40 let solidity_struct_collect = impl_solidity_struct_collect(name, field_names, field_types);63 let solidity_struct_collect =64 impl_solidity_struct_collect(name, field_names, field_types, &docs);416542 Ok(quote! {66 Ok(quote! {43 #can_be_plcaed_in_vec67 #can_be_plcaed_in_vec259 name: &syn::Ident,283 name: &syn::Ident,260 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,284 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,261 field_types: impl Iterator<Item = &'a syn::Type> + Clone,285 field_types: impl Iterator<Item = &'a syn::Type> + Clone,286 docs: &Vec<String>,262) -> proc_macro2::TokenStream {287) -> proc_macro2::TokenStream {263 let string_name = name.to_string();288 let string_name = name.to_string();264 let name_type = field_names289 let name_type = field_names271 write!(str, "{};", #name).unwrap();296 write!(str, "{};", #name).unwrap();272 )297 )273 });298 });299 let docs = docs.iter().enumerate().map(|(i, doc)| {300 let doc = doc.trim();301 let dev = if i == 0 { " @dev" } else { "" };302 quote! {303 writeln!(str, "///{} {}", #dev, #doc).unwrap();304 }305 });274306275 quote! {307 quote! {276 #[cfg(feature = "stubgen")]308 #[cfg(feature = "stubgen")]283 use std::fmt::Write;315 use std::fmt::Write;284316285 let mut str = String::new();317 let mut str = String::new();286 writeln!(str, "/// @dev Cross account struct").unwrap();318 #(#docs)*287 writeln!(str, "struct {} {{", Self::name()).unwrap();319 writeln!(str, "struct {} {{", Self::name()).unwrap();288 #(#name_type)*320 #(#name_type)*289 writeln!(str, "}}").unwrap();321 writeln!(str, "}}").unwrap();crates/evm-coder/src/solidity/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity/impls.rs
+++ b/crates/evm-coder/src/solidity/impls.rs
@@ -1,6 +1,7 @@
use super::{TypeCollector, SolidityTypeName, SolidityType, StructCollect};
use crate::{sealed, types::*};
use core::fmt;
+use primitive_types::{U256, H160};
macro_rules! solidity_type_name {
($($ty:ty => $name:literal $simple:literal = $default:literal),* $(,)?) => {
@@ -31,13 +32,13 @@
}
solidity_type_name! {
- uint8 => "uint8" true = "0",
- uint32 => "uint32" true = "0",
- uint64 => "uint64" true = "0",
- uint128 => "uint128" true = "0",
- uint256 => "uint256" true = "0",
+ u8 => "uint8" true = "0",
+ u32 => "uint32" true = "0",
+ u64 => "uint64" true = "0",
+ u128 => "uint128" true = "0",
+ U256 => "uint256" true = "0",
bytes4 => "bytes4" true = "bytes4(0)",
- address => "address" true = "0x0000000000000000000000000000000000000000",
+ H160 => "address" true = "0x0000000000000000000000000000000000000000",
string => "string" false = "\"\"",
bytes => "bytes" false = "hex\"\"",
bool => "bool" true = "false",
crates/evm-coder/tests/abi_derive_generation.rsdiffbeforeafterboth--- a/crates/evm-coder/tests/abi_derive_generation.rs
+++ b/crates/evm-coder/tests/abi_derive_generation.rs
@@ -57,10 +57,16 @@
_b: TypeStruct2DynamicParam,
}
+/// Some docs
+/// At multi
+/// line
#[derive(AbiCoder, PartialEq, Debug)]
struct TypeStruct3DerivedMixedParam {
+ /// Docs for A
_a: TypeStruct1SimpleParam,
+ /// Docs for B
_b: TypeStruct2DynamicParam,
+ /// Docs for C
_c: TypeStruct2MixedParam,
}
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -113,6 +113,7 @@
}
}
+/// Cross account struct
#[derive(Debug, Default, AbiCoder)]
pub struct EthCrossAccount {
pub(crate) eth: address,