difftreelog
feat add FIELDS_COUNT const in AbiType trait
in: master
6 files changed
crates/evm-coder/procedural/src/abi_derive/derive_enum.rsdiffbeforeafterboth--- a/crates/evm-coder/procedural/src/abi_derive/derive_enum.rs
+++ b/crates/evm-coder/procedural/src/abi_derive/derive_enum.rs
@@ -47,10 +47,11 @@
)
}
-pub fn impl_enum_abi_type(name: &syn::Ident) -> proc_macro2::TokenStream {
+pub fn impl_enum_abi_type(name: &syn::Ident, option_count: usize) -> proc_macro2::TokenStream {
quote! {
impl ::evm_coder::abi::AbiType for #name {
const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = <u8 as ::evm_coder::abi::AbiType>::SIGNATURE;
+ const FIELDS_COUNT: usize = #option_count;
fn is_dynamic() -> bool {
<u8 as ::evm_coder::abi::AbiType>::is_dynamic()
crates/evm-coder/procedural/src/abi_derive/derive_struct.rsdiffbeforeafterboth--- a/crates/evm-coder/procedural/src/abi_derive/derive_struct.rs
+++ b/crates/evm-coder/procedural/src/abi_derive/derive_struct.rs
@@ -100,10 +100,12 @@
pub fn impl_struct_abi_type(
name: &syn::Ident,
tuple_type: proc_macro2::TokenStream,
+ fields_count: usize,
) -> proc_macro2::TokenStream {
quote! {
impl ::evm_coder::abi::AbiType for #name {
const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = <#tuple_type as ::evm_coder::abi::AbiType>::SIGNATURE;
+ const FIELDS_COUNT: usize = #fields_count;
fn is_dynamic() -> bool {
<#tuple_type as ::evm_coder::abi::AbiType>::is_dynamic()
}
crates/evm-coder/procedural/src/abi_derive/mod.rsdiffbeforeafterboth1mod derive_enum;2mod derive_struct;34use quote::quote;5use derive_struct::*;6use derive_enum::*;78pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {9 let name = &ast.ident;10 match &ast.data {11 syn::Data::Struct(ds) => expand_struct(ds, ast),12 syn::Data::Enum(de) => expand_enum(de, ast),13 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),14 }15}1617fn expand_struct(18 ds: &syn::DataStruct,19 ast: &syn::DeriveInput,20) -> syn::Result<proc_macro2::TokenStream> {21 let name = &ast.ident;22 let docs = extract_docs(&ast.attrs, false)?;23 let (is_named_fields, field_names, field_types, field_docs, params_count) = match ds.fields {24 syn::Fields::Named(ref fields) => Ok((25 true,26 fields.named.iter().enumerate().map(map_field_to_name),27 fields.named.iter().map(map_field_to_type),28 fields.named.iter().map(map_field_to_doc),29 fields.named.len(),30 )),31 syn::Fields::Unnamed(ref fields) => Ok((32 false,33 fields.unnamed.iter().enumerate().map(map_field_to_name),34 fields.unnamed.iter().map(map_field_to_type),35 fields.unnamed.iter().map(map_field_to_doc),36 fields.unnamed.len(),37 )),38 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),39 }?;4041 if params_count == 0 {42 return Err(syn::Error::new(name.span(), "Empty structs not supported"));43 };4445 let tuple_type = tuple_type(field_types.clone());46 let tuple_ref_type = tuple_ref_type(field_types.clone());47 let tuple_data = tuple_data_as_ref(is_named_fields, field_names.clone());48 let tuple_names = tuple_names(is_named_fields, field_names.clone());49 let struct_from_tuple = struct_from_tuple(name, is_named_fields, field_names.clone());5051 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);52 let abi_type = impl_struct_abi_type(name, tuple_type.clone());53 let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);54 let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);55 let solidity_type = impl_struct_solidity_type(name, field_types.clone(), params_count);56 let solidity_type_name =57 impl_struct_solidity_type_name(name, field_types.clone(), params_count);58 let solidity_struct_collect =59 impl_struct_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;6061 Ok(quote! {62 #can_be_plcaed_in_vec63 #abi_type64 #abi_read65 #abi_write66 #solidity_type67 #solidity_type_name68 #solidity_struct_collect69 })70}7172fn expand_enum(73 de: &syn::DataEnum,74 ast: &syn::DeriveInput,75) -> syn::Result<proc_macro2::TokenStream> {76 let name = &ast.ident;77 check_repr_u8(name, &ast.attrs)?;78 let docs = extract_docs(&ast.attrs, false)?;79 let option_count = check_and_count_options(de)?;80 let enum_options = de.variants.iter().map(|v| &v.ident);81 let enum_options_docs = de.variants.iter().map(|v| extract_docs(&v.attrs, true));8283 let from = impl_enum_from_u8(name, enum_options.clone());84 let solidity_option = impl_solidity_option(name, enum_options.clone());85 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);86 let abi_type = impl_enum_abi_type(name);87 let abi_read = impl_enum_abi_read(name);88 let abi_write = impl_enum_abi_write(name);89 let solidity_type_name = impl_enum_solidity_type_name(name);90 let solidity_struct_collect = impl_enum_solidity_struct_collect(91 name,92 enum_options,93 option_count,94 enum_options_docs,95 &docs,96 );9798 Ok(quote! {99 #from100 #solidity_option101 #can_be_plcaed_in_vec102 #abi_type103 #abi_read104 #abi_write105 #solidity_type_name106 #solidity_struct_collect107 })108}109110fn extract_docs(111 attrs: &[syn::Attribute],112 is_field_doc: bool,113) -> syn::Result<Vec<proc_macro2::TokenStream>> {114 attrs115 .iter()116 .filter_map(|attr| {117 if let Some(ps) = attr.path.segments.first() {118 if ps.ident == "doc" {119 let meta = match attr.parse_meta() {120 Ok(meta) => meta,121 Err(e) => return Some(Err(e)),122 };123 match meta {124 syn::Meta::NameValue(mnv) => match &mnv.lit {125 syn::Lit::Str(ls) => return Some(Ok(ls.value())),126 _ => unreachable!(),127 },128 _ => unreachable!(),129 }130 }131 }132 None133 })134 .enumerate()135 .map(|(i, doc)| {136 let doc = doc?;137 let doc = doc.trim();138 let dev = if i == 0 { " @dev" } else { "" };139 let tab = if is_field_doc { "\t" } else { "" };140 Ok(quote! {141 writeln!(str, "{}///{} {}", #tab, #dev, #doc).unwrap();142 })143 })144 .collect()145}1mod derive_enum;2mod derive_struct;34use quote::quote;5use derive_struct::*;6use derive_enum::*;78pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {9 let name = &ast.ident;10 match &ast.data {11 syn::Data::Struct(ds) => expand_struct(ds, ast),12 syn::Data::Enum(de) => expand_enum(de, ast),13 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),14 }15}1617fn expand_struct(18 ds: &syn::DataStruct,19 ast: &syn::DeriveInput,20) -> syn::Result<proc_macro2::TokenStream> {21 let name = &ast.ident;22 let docs = extract_docs(&ast.attrs, false)?;23 let (is_named_fields, field_names, field_types, field_docs, params_count) = match ds.fields {24 syn::Fields::Named(ref fields) => Ok((25 true,26 fields.named.iter().enumerate().map(map_field_to_name),27 fields.named.iter().map(map_field_to_type),28 fields.named.iter().map(map_field_to_doc),29 fields.named.len(),30 )),31 syn::Fields::Unnamed(ref fields) => Ok((32 false,33 fields.unnamed.iter().enumerate().map(map_field_to_name),34 fields.unnamed.iter().map(map_field_to_type),35 fields.unnamed.iter().map(map_field_to_doc),36 fields.unnamed.len(),37 )),38 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),39 }?;4041 if params_count == 0 {42 return Err(syn::Error::new(name.span(), "Empty structs not supported"));43 };4445 let tuple_type = tuple_type(field_types.clone());46 let tuple_ref_type = tuple_ref_type(field_types.clone());47 let tuple_data = tuple_data_as_ref(is_named_fields, field_names.clone());48 let tuple_names = tuple_names(is_named_fields, field_names.clone());49 let struct_from_tuple = struct_from_tuple(name, is_named_fields, field_names.clone());5051 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);52 let abi_type = impl_struct_abi_type(name, tuple_type.clone(), params_count);53 let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);54 let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);55 let solidity_type = impl_struct_solidity_type(name, field_types.clone(), params_count);56 let solidity_type_name =57 impl_struct_solidity_type_name(name, field_types.clone(), params_count);58 let solidity_struct_collect =59 impl_struct_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;6061 Ok(quote! {62 #can_be_plcaed_in_vec63 #abi_type64 #abi_read65 #abi_write66 #solidity_type67 #solidity_type_name68 #solidity_struct_collect69 })70}7172fn expand_enum(73 de: &syn::DataEnum,74 ast: &syn::DeriveInput,75) -> syn::Result<proc_macro2::TokenStream> {76 let name = &ast.ident;77 check_repr_u8(name, &ast.attrs)?;78 let docs = extract_docs(&ast.attrs, false)?;79 let option_count = check_and_count_options(de)?;80 let enum_options = de.variants.iter().map(|v| &v.ident);81 let enum_options_docs = de.variants.iter().map(|v| extract_docs(&v.attrs, true));8283 let from = impl_enum_from_u8(name, enum_options.clone());84 let solidity_option = impl_solidity_option(name, enum_options.clone());85 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);86 let abi_type = impl_enum_abi_type(name, option_count);87 let abi_read = impl_enum_abi_read(name);88 let abi_write = impl_enum_abi_write(name);89 let solidity_type_name = impl_enum_solidity_type_name(name);90 let solidity_struct_collect = impl_enum_solidity_struct_collect(91 name,92 enum_options,93 option_count,94 enum_options_docs,95 &docs,96 );9798 Ok(quote! {99 #from100 #solidity_option101 #can_be_plcaed_in_vec102 #abi_type103 #abi_read104 #abi_write105 #solidity_type_name106 #solidity_struct_collect107 })108}109110fn extract_docs(111 attrs: &[syn::Attribute],112 is_field_doc: bool,113) -> syn::Result<Vec<proc_macro2::TokenStream>> {114 attrs115 .iter()116 .filter_map(|attr| {117 if let Some(ps) = attr.path.segments.first() {118 if ps.ident == "doc" {119 let meta = match attr.parse_meta() {120 Ok(meta) => meta,121 Err(e) => return Some(Err(e)),122 };123 match meta {124 syn::Meta::NameValue(mnv) => match &mnv.lit {125 syn::Lit::Str(ls) => return Some(Ok(ls.value())),126 _ => unreachable!(),127 },128 _ => unreachable!(),129 }130 }131 }132 None133 })134 .enumerate()135 .map(|(i, doc)| {136 let doc = doc?;137 let doc = doc.trim();138 let dev = if i == 0 { " @dev" } else { "" };139 let tab = if is_field_doc { "\t" } else { "" };140 Ok(quote! {141 writeln!(str, "{}///{} {}", #tab, #dev, #doc).unwrap();142 })143 })144 .collect()145}crates/evm-coder/src/abi/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/abi/impls.rs
+++ b/crates/evm-coder/src/abi/impls.rs
@@ -16,6 +16,7 @@
impl AbiType for $ty {
const SIGNATURE: SignatureUnit = make_signature!(new fixed(stringify!($name)));
+ const FIELDS_COUNT: usize = 1;
fn is_dynamic() -> bool {
$dynamic
@@ -96,6 +97,7 @@
impl<T: AbiType> AbiType for &T {
const SIGNATURE: SignatureUnit = T::SIGNATURE;
+ const FIELDS_COUNT: usize = T::FIELDS_COUNT;
fn is_dynamic() -> bool {
T::is_dynamic()
@@ -125,6 +127,7 @@
impl<T: AbiType> AbiType for Vec<T> {
const SIGNATURE: SignatureUnit = make_signature!(new nameof(T::SIGNATURE) fixed("[]"));
+ const FIELDS_COUNT: usize = 1;
fn is_dynamic() -> bool {
true
@@ -139,6 +142,7 @@
impl AbiType for Property {
const SIGNATURE: SignatureUnit = make_signature!(new fixed("(string,bytes)"));
+ const FIELDS_COUNT: usize = 2;
fn is_dynamic() -> bool {
string::is_dynamic() || bytes::is_dynamic()
@@ -230,6 +234,7 @@
shift_left(1)
fixed(")")
);
+ const FIELDS_COUNT: usize = 0 $(+ {let _ = <$ident as AbiType>::FIELDS_COUNT; 1})+;
fn is_dynamic() -> bool {
false
crates/evm-coder/src/abi/traits.rsdiffbeforeafterboth--- a/crates/evm-coder/src/abi/traits.rs
+++ b/crates/evm-coder/src/abi/traits.rs
@@ -10,6 +10,9 @@
/// Signature for Etherium ABI.
const SIGNATURE: SignatureUnit;
+ /// Count of enum variants or struct fields.
+ const FIELDS_COUNT: usize;
+
/// Signature as str.
fn as_str() -> &'static str {
from_utf8(&Self::SIGNATURE.data[..Self::SIGNATURE.len]).expect("bad utf-8")
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
@@ -164,6 +164,50 @@
}
#[test]
+ fn impl_abi_type_fields_count() {
+ assert_eq!(
+ <TypeStruct1SimpleParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 1
+ );
+ assert_eq!(
+ <TypeStruct1DynamicParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 1
+ );
+ assert_eq!(
+ <TypeStruct2SimpleParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct2DynamicParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct2MixedParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct1DerivedSimpleParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 1
+ );
+ assert_eq!(
+ <TypeStruct2DerivedSimpleParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct1DerivedDynamicParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct2DerivedDynamicParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 2
+ );
+ assert_eq!(
+ <TypeStruct3DerivedMixedParam as evm_coder::abi::AbiType>::FIELDS_COUNT,
+ 3
+ );
+ }
+
+ #[test]
fn impl_abi_type_is_dynamic() {
assert_eq!(
<TypeStruct1SimpleParam as evm_coder::abi::AbiType>::is_dynamic(),