1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {4 let name = &ast.ident;5 match &ast.data {6 syn::Data::Struct(ds) => expand_struct(ds, ast),7 syn::Data::Enum(de) => expand_enum(de, ast),8 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),9 }10}1112fn expand_struct(13 ds: &syn::DataStruct,14 ast: &syn::DeriveInput,15) -> syn::Result<proc_macro2::TokenStream> {16 let name = &ast.ident;17 let docs = extract_docs(&ast.attrs, false)?;18 let (is_named_fields, field_names, field_types, field_docs, params_count) = match ds.fields {19 syn::Fields::Named(ref fields) => Ok((20 true,21 fields.named.iter().enumerate().map(map_field_to_name),22 fields.named.iter().map(map_field_to_type),23 fields.named.iter().map(map_field_to_doc),24 fields.named.len(),25 )),26 syn::Fields::Unnamed(ref fields) => Ok((27 false,28 fields.unnamed.iter().enumerate().map(map_field_to_name),29 fields.unnamed.iter().map(map_field_to_type),30 fields.unnamed.iter().map(map_field_to_doc),31 fields.unnamed.len(),32 )),33 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),34 }?;3536 if params_count == 0 {37 return Err(syn::Error::new(name.span(), "Empty structs not supported"));38 };3940 let tuple_type = tuple_type(field_types.clone());41 let tuple_ref_type = tuple_ref_type(field_types.clone());42 let tuple_data = tuple_data_as_ref(is_named_fields, field_names.clone());43 let tuple_names = tuple_names(is_named_fields, field_names.clone());44 let struct_from_tuple = struct_from_tuple(name, is_named_fields, field_names.clone());4546 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);47 let abi_type = impl_struct_abi_type(name, tuple_type.clone());48 let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);49 let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);50 let solidity_type = impl_struct_solidity_type(name, field_types.clone(), params_count);51 let solidity_type_name =52 impl_struct_solidity_type_name(name, field_types.clone(), params_count);53 let solidity_struct_collect =54 impl_struct_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;5556 Ok(quote! {57 #can_be_plcaed_in_vec58 #abi_type59 #abi_read60 #abi_write61 #solidity_type62 #solidity_type_name63 #solidity_struct_collect64 })65}6667fn expand_enum(68 de: &syn::DataEnum,69 ast: &syn::DeriveInput,70) -> syn::Result<proc_macro2::TokenStream> {71 let name = &ast.ident;72 check_repr_u8(name, &ast.attrs)?;73 let docs = extract_docs(&ast.attrs, false)?;74 let option_count = check_and_count_options(de)?;75 let enum_options = de.variants.iter().map(|v| &v.ident);76 let enum_options_docs = de.variants.iter().map(|v| extract_docs(&v.attrs, true));7778 let from = impl_enum_from_u8(name, enum_options.clone());79 let solidity_option = impl_solidity_option(name, enum_options.clone());80 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);81 let abi_type = impl_enum_abi_type(name);82 let abi_read = impl_enum_abi_read(name);83 let abi_write = impl_enum_abi_write(name);84 let solidity_type_name = impl_enum_solidity_type_name(name);85 let solidity_struct_collect = impl_enum_solidity_struct_collect(86 name,87 enum_options,88 option_count,89 enum_options_docs,90 &docs,91 );9293 Ok(quote! {94 #from95 #solidity_option96 #can_be_plcaed_in_vec97 #abi_type98 #abi_read99 #abi_write100 #solidity_type_name101 #solidity_struct_collect102 })103}104105fn impl_solidity_option<'a>(106 name: &proc_macro2::Ident,107 enum_options: impl Iterator<Item = &'a syn::Ident>,108) -> proc_macro2::TokenStream {109 let enum_options = enum_options.map(|opt| {110 let s = name.to_string() + "." + opt.to_string().as_str();111 let as_string = proc_macro2::Literal::string(s.as_str());112 quote!(#name::#opt => #as_string,)113 });114 quote!(115 #[cfg(feature = "stubgen")]116 impl ::evm_coder::solidity::SolidityEnum for #name {117 fn solidity_option(&self) -> &str {118 match Self::default() {119 #(#enum_options)*120 }121 }122 }123 )124}125126fn impl_enum_from_u8<'a>(127 name: &proc_macro2::Ident,128 enum_options: impl Iterator<Item = &'a syn::Ident>,129) -> proc_macro2::TokenStream {130 let error_str = format!("Value not convertible into enum \"{name}\"");131 let error_str = proc_macro2::Literal::string(&error_str);132 let enum_options = enum_options.enumerate().map(|(i, opt)| {133 let n = proc_macro2::Literal::u8_suffixed(i as u8);134 quote! {#n => Ok(#name::#opt),}135 });136137 quote!(138 impl TryFrom<u8> for #name {139 type Error = &'static str;140141 fn try_from(value: u8) -> ::core::result::Result<Self, Self::Error> {142 const err: &'static str = #error_str;143 match value {144 #(#enum_options)*145 _ => Err(err)146 }147 }148 }149 )150}151152fn impl_enum_abi_type(name: &syn::Ident) -> proc_macro2::TokenStream {153 quote! {154 impl ::evm_coder::abi::AbiType for #name {155 const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = <u8 as ::evm_coder::abi::AbiType>::SIGNATURE;156157 fn is_dynamic() -> bool {158 <u8 as ::evm_coder::abi::AbiType>::is_dynamic()159 }160 fn size() -> usize {161 <u8 as ::evm_coder::abi::AbiType>::size()162 }163 }164 }165}166167fn impl_enum_abi_read(name: &syn::Ident) -> proc_macro2::TokenStream {168 quote!(169 impl ::evm_coder::abi::AbiRead for #name {170 fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {171 Ok(172 <u8 as ::evm_coder::abi::AbiRead>::abi_read(reader)?173 .try_into()?174 )175 }176 }177 )178}179180fn impl_enum_abi_write(name: &syn::Ident) -> proc_macro2::TokenStream {181 quote!(182 impl ::evm_coder::abi::AbiWrite for #name {183 fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {184 ::evm_coder::abi::AbiWrite::abi_write(&(*self as u8), writer);185 }186 }187 )188}189190fn impl_enum_solidity_type_name<'a>(name: &syn::Ident) -> proc_macro2::TokenStream {191 quote!(192 #[cfg(feature = "stubgen")]193 impl ::evm_coder::solidity::SolidityTypeName for #name {194 fn solidity_name(195 writer: &mut impl ::core::fmt::Write,196 tc: &::evm_coder::solidity::TypeCollector,197 ) -> ::core::fmt::Result {198 write!(writer, "{}", tc.collect_struct::<Self>())199 }200201 fn is_simple() -> bool {202 true203 }204205 fn solidity_default(206 writer: &mut impl ::core::fmt::Write,207 tc: &::evm_coder::solidity::TypeCollector,208 ) -> ::core::fmt::Result {209 write!(writer, "{}", <#name as ::evm_coder::solidity::SolidityEnum>::solidity_option(&<#name>::default()))210 }211 }212 )213}214215fn impl_enum_solidity_struct_collect<'a>(216 name: &syn::Ident,217 enum_options: impl Iterator<Item = &'a syn::Ident>,218 option_count: usize,219 enum_options_docs: impl Iterator<Item = syn::Result<Vec<proc_macro2::TokenStream>>>,220 docs: &[proc_macro2::TokenStream],221) -> proc_macro2::TokenStream {222 let string_name = name.to_string();223 let enum_options = enum_options224 .zip(enum_options_docs)225 .enumerate()226 .map(|(i, (opt, doc))| {227 let opt = proc_macro2::Literal::string(opt.to_string().as_str());228 let doc = doc.expect("Doc parsing error");229 let comma = if i != option_count - 1 { "," } else { "" };230 quote! {231 #(#doc)*232 writeln!(str, "\t{}{}", #opt, #comma).expect("Enum format option");233 }234 });235236 quote!(237 #[cfg(feature = "stubgen")]238 impl ::evm_coder::solidity::StructCollect for #name {239 fn name() -> String {240 #string_name.into()241 }242243 fn declaration() -> String {244 use std::fmt::Write;245246 let mut str = String::new();247 #(#docs)*248 writeln!(str, "enum {} {{", <Self as ::evm_coder::solidity::StructCollect>::name()).unwrap();249 #(#enum_options)*250 writeln!(str, "}}").unwrap();251 str252 }253 }254 )255}256257fn check_and_count_options(de: &syn::DataEnum) -> syn::Result<usize> {258 let mut count = 0;259 for error in de.variants.iter().filter_map(|v| {260 if !v.fields.is_empty() {261 Some(Err(syn::Error::new(262 v.ident.span(),263 "Enumeration parameters should not have fields",264 )))265 } else if v.discriminant.is_some() {266 Some(Err(syn::Error::new(267 v.ident.span(),268 "Enumeration options should not have an explicit specified value",269 )))270 } else {271 count += 1;272 None273 }274 }) {275 return error;276 }277278 Ok(count)279}280281fn check_repr_u8(name: &syn::Ident, attrs: &Vec<syn::Attribute>) -> syn::Result<()> {282 let mut has_repr = false;283 for attr in attrs.iter() {284 if attr.path.is_ident("repr") {285 has_repr = true;286 match attr.parse_meta()? {287 syn::Meta::List(p) => {288 for nm in p.nested.iter() {289 match nm {290 syn::NestedMeta::Meta(m) => match m {291 syn::Meta::Path(p) => {292 if !p.is_ident("u8") {293 return Err(syn::Error::new(294 p.segments295 .first()296 .expect("repr segments are empty")297 .ident298 .span(),299 "Enum is not \"repr(u8)\"",300 ));301 }302 }303 _ => {}304 },305 _ => {}306 }307 }308 }309 _ => {}310 };311 }312 }313314 if !has_repr {315 return Err(syn::Error::new(name.span(), "Enum is not \"repr(u8)\""));316 }317318 Ok(())319}320321fn tuple_type<'a>(322 field_types: impl Iterator<Item = &'a syn::Type> + Clone,323) -> proc_macro2::TokenStream {324 let field_types = field_types.map(|ty| quote!(#ty,));325 quote! {(#(#field_types)*)}326}327328fn tuple_ref_type<'a>(329 field_types: impl Iterator<Item = &'a syn::Type> + Clone,330) -> proc_macro2::TokenStream {331 let field_types = field_types.map(|ty| quote!(&#ty,));332 quote! {(#(#field_types)*)}333}334335fn tuple_data_as_ref(336 is_named_fields: bool,337 field_names: impl Iterator<Item = syn::Ident> + Clone,338) -> proc_macro2::TokenStream {339 let field_names = field_names.enumerate().map(|(i, field)| {340 if is_named_fields {341 quote!(&self.#field,)342 } else {343 let field = proc_macro2::Literal::usize_unsuffixed(i);344 quote!(&self.#field,)345 }346 });347 quote! {(#(#field_names)*)}348}349350fn tuple_names(351 is_named_fields: bool,352 field_names: impl Iterator<Item = syn::Ident> + Clone,353) -> proc_macro2::TokenStream {354 let field_names = field_names.enumerate().map(|(i, field)| {355 if is_named_fields {356 quote!(#field,)357 } else {358 let field = proc_macro2::Ident::new(359 format!("field{}", i).as_str(),360 proc_macro2::Span::call_site(),361 );362 quote!(#field,)363 }364 });365 quote! {(#(#field_names)*)}366}367368fn struct_from_tuple(369 name: &syn::Ident,370 is_named_fields: bool,371 field_names: impl Iterator<Item = syn::Ident> + Clone,372) -> proc_macro2::TokenStream {373 let field_names = field_names.enumerate().map(|(i, field)| {374 if is_named_fields {375 quote!(#field,)376 } else {377 let field = proc_macro2::Ident::new(378 format!("field{}", i).as_str(),379 proc_macro2::Span::call_site(),380 );381 quote!(#field,)382 }383 });384385 if is_named_fields {386 quote! {#name {#(#field_names)*}}387 } else {388 quote! {#name (#(#field_names)*)}389 }390}391392fn extract_docs(393 attrs: &[syn::Attribute],394 is_field_doc: bool,395) -> syn::Result<Vec<proc_macro2::TokenStream>> {396 attrs397 .iter()398 .filter_map(|attr| {399 if let Some(ps) = attr.path.segments.first() {400 if ps.ident == "doc" {401 let meta = match attr.parse_meta() {402 Ok(meta) => meta,403 Err(e) => return Some(Err(e)),404 };405 match meta {406 syn::Meta::NameValue(mnv) => match &mnv.lit {407 syn::Lit::Str(ls) => return Some(Ok(ls.value())),408 _ => unreachable!(),409 },410 _ => unreachable!(),411 }412 }413 }414 None415 })416 .enumerate()417 .map(|(i, doc)| {418 let doc = doc?;419 let doc = doc.trim();420 let dev = if i == 0 { " @dev" } else { "" };421 let tab = if is_field_doc { "\t" } else { "" };422 Ok(quote! {423 writeln!(str, "{}///{} {}", #tab, #dev, #doc).unwrap();424 })425 })426 .collect()427}428429fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {430 match field.1.ident.as_ref() {431 Some(name) => name.clone(),432 None => {433 let mut name = "field".to_string();434 name.push_str(field.0.to_string().as_str());435 syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())436 }437 }438}439440fn map_field_to_type(field: &syn::Field) -> &syn::Type {441 &field.ty442}443444fn map_field_to_doc(field: &syn::Field) -> syn::Result<Vec<proc_macro2::TokenStream>> {445 extract_docs(&field.attrs, true)446}447448fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {449 quote! {450 impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}451 }452}453454fn impl_struct_abi_type(455 name: &syn::Ident,456 tuple_type: proc_macro2::TokenStream,457) -> proc_macro2::TokenStream {458 quote! {459 impl ::evm_coder::abi::AbiType for #name {460 const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = <#tuple_type as ::evm_coder::abi::AbiType>::SIGNATURE;461 fn is_dynamic() -> bool {462 <#tuple_type as ::evm_coder::abi::AbiType>::is_dynamic()463 }464 fn size() -> usize {465 <#tuple_type as ::evm_coder::abi::AbiType>::size()466 }467 }468 }469}470471fn impl_struct_abi_read(472 name: &syn::Ident,473 tuple_type: proc_macro2::TokenStream,474 tuple_names: proc_macro2::TokenStream,475 struct_from_tuple: proc_macro2::TokenStream,476) -> proc_macro2::TokenStream {477 quote!(478 impl ::evm_coder::abi::AbiRead for #name {479 fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {480 let #tuple_names = <#tuple_type as ::evm_coder::abi::AbiRead>::abi_read(reader)?;481 Ok(#struct_from_tuple)482 }483 }484 )485}486487fn impl_struct_abi_write(488 name: &syn::Ident,489 _is_named_fields: bool,490 tuple_type: proc_macro2::TokenStream,491 tuple_data: proc_macro2::TokenStream,492) -> proc_macro2::TokenStream {493 quote!(494 impl ::evm_coder::abi::AbiWrite for #name {495 fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {496 <#tuple_type as ::evm_coder::abi::AbiWrite>::abi_write(&#tuple_data, writer)497 }498 }499 )500}501502fn impl_struct_solidity_type<'a>(503 name: &syn::Ident,504 field_types: impl Iterator<Item = &'a syn::Type> + Clone,505 params_count: usize,506) -> proc_macro2::TokenStream {507 let len = proc_macro2::Literal::usize_suffixed(params_count);508 quote! {509 #[cfg(feature = "stubgen")]510 impl ::evm_coder::solidity::SolidityType for #name {511 fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {512 let mut collected =513 Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());514 #({515 let mut out = String::new();516 <#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)517 .expect("no fmt error");518 collected.push(out);519 })*520 collected521 }522523 fn len() -> usize {524 #len525 }526 }527 }528}529530fn impl_struct_solidity_type_name<'a>(531 name: &syn::Ident,532 field_types: impl Iterator<Item = &'a syn::Type> + Clone,533 params_count: usize,534) -> proc_macro2::TokenStream {535 let arg_dafaults = field_types.enumerate().map(|(i, ty)| {536 let mut defult_value = quote!(<#ty as ::evm_coder::solidity::SolidityTypeName537 >::solidity_default(writer, tc)?;);538 let last_item = params_count - 1;539 if i != last_item {540 defult_value.extend(quote! {write!(writer, ",")?;})541 }542 defult_value543 });544545 quote! {546 #[cfg(feature = "stubgen")]547 impl ::evm_coder::solidity::SolidityTypeName for #name {548 fn solidity_name(549 writer: &mut impl ::core::fmt::Write,550 tc: &::evm_coder::solidity::TypeCollector,551 ) -> ::core::fmt::Result {552 write!(writer, "{}", tc.collect_struct::<Self>())553 }554555 fn is_simple() -> bool {556 false557 }558559 fn solidity_default(560 writer: &mut impl ::core::fmt::Write,561 tc: &::evm_coder::solidity::TypeCollector,562 ) -> ::core::fmt::Result {563 write!(writer, "{}(", tc.collect_struct::<Self>())?;564565 #(#arg_dafaults)*566567 write!(writer, ")")568 }569 }570 }571}572573fn impl_struct_solidity_struct_collect<'a>(574 name: &syn::Ident,575 field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,576 field_types: impl Iterator<Item = &'a syn::Type> + Clone,577 field_docs: impl Iterator<Item = syn::Result<Vec<proc_macro2::TokenStream>>> + Clone,578 docs: &[proc_macro2::TokenStream],579) -> syn::Result<proc_macro2::TokenStream> {580 let string_name = name.to_string();581 let name_type = field_names582 .into_iter()583 .zip(field_types)584 .zip(field_docs)585 .map(|((name, ty), doc)| {586 let field_docs = doc.expect("Doc parse error");587 let name = format!("{}", name);588 quote!(589 #(#field_docs)*590 write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();591 writeln!(str, "{};", #name).unwrap();592 )593 });594595 Ok(quote! {596 #[cfg(feature = "stubgen")]597 impl ::evm_coder::solidity::StructCollect for #name {598 fn name() -> String {599 #string_name.into()600 }601602 fn declaration() -> String {603 use std::fmt::Write;604605 let mut str = String::new();606 #(#docs)*607 writeln!(str, "struct {} {{", Self::name()).unwrap();608 #(#name_type)*609 writeln!(str, "}}").unwrap();610 str611 }612 }613 })614}