git.delta.rocks / unique-network / refs/commits / 12eee8195c76

difftreelog

misk: Generate solidity docs for struct

Trubnikov Sergey2022-11-21parent: #3e03fdf.patch.diff
in: master

4 files changed

modifiedcrates/evm-coder/procedural/src/abi_derive.rsdiffbeforeafterboth
before · crates/evm-coder/procedural/src/abi_derive.rs
1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {4	let name = &ast.ident;5	let (is_named_fields, field_names, field_types, params_count) = match &ast.data {6		syn::Data::Struct(ds) => match ds.fields {7			syn::Fields::Named(ref fields) => Ok((8				true,9				fields.named.iter().enumerate().map(map_field_to_name),10				fields.named.iter().map(map_field_to_type),11				fields.named.len(),12			)),13			syn::Fields::Unnamed(ref fields) => Ok((14				false,15				fields.unnamed.iter().enumerate().map(map_field_to_name),16				fields.unnamed.iter().map(map_field_to_type),17				fields.unnamed.len(),18			)),19			syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),20		},21		syn::Data::Enum(_) => Err(syn::Error::new(name.span(), "Enums not supported")),22		syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),23	}?;2425	if params_count == 0 {26		return Err(syn::Error::new(name.span(), "Empty structs not supported"));27	};2829	let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);30	let abi_type = impl_abi_type(name, field_types.clone());31	let abi_read = impl_abi_read(32		name,33		is_named_fields,34		field_names.clone(),35		field_types.clone(),36	);37	let abi_write = impl_abi_write(name, is_named_fields, params_count, field_names.clone());38	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);40	let solidity_struct_collect = impl_solidity_struct_collect(name, field_names, field_types);4142	Ok(quote! {43		#can_be_plcaed_in_vec44		#abi_type45		#abi_read46		#abi_write47		#solidity_type48		#solidity_type_name49		#solidity_struct_collect50	})51}5253fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {54	quote! {55		impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}56	}57}5859fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {60	match field.1.ident.as_ref() {61		Some(name) => name.clone(),62		None => {63			let mut name = "field".to_string();64			name.push_str(field.0.to_string().as_str());65			syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())66		}67	}68}6970fn map_field_to_type<'a>(field: &'a syn::Field) -> &'a syn::Type {71	&field.ty72}7374fn impl_abi_type<'a>(75	name: &syn::Ident,76	field_types: impl Iterator<Item = &'a syn::Type> + Clone,77) -> proc_macro2::TokenStream {78	let mut params_signature = {79		let types = field_types.clone();80		quote!(81			#(nameof(<#types as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*82		)83	};8485	params_signature.extend(quote!(shift_left(1)));8687	let fields_for_dynamic = field_types.clone();8889	quote! {90		impl ::evm_coder::abi::AbiType for #name {91			const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(92				new fixed("(")93				#params_signature94				fixed(")")95			);96			fn is_dynamic() -> bool {97				false98				#(99					|| <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()100				)*101			}102			fn size() -> usize {103				0 #(+ <#field_types as ::evm_coder::abi::AbiType>::size())*104			}105		}106	}107}108109fn impl_abi_read<'a>(110	name: &syn::Ident,111	is_named_fields: bool,112	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,113	field_types: impl Iterator<Item = &'a syn::Type> + Clone,114) -> proc_macro2::TokenStream {115	let field_names1 = field_names.clone();116117	let struct_constructor = if is_named_fields {118		quote!(Ok(Self { #(#field_names1),* }))119	} else {120		quote!(Ok(Self ( #(#field_names1),* )))121	};122	quote!(123		impl ::evm_coder::abi::AbiRead for #name {124			fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {125				let is_dynamic = <Self as ::evm_coder::abi::AbiType>::is_dynamic();126				let size = if !is_dynamic {127					Some(<Self as ::evm_coder::abi::AbiType>::size())128				} else {129					None130				};131				let mut subresult = reader.subresult(size)?;132				#(133					let #field_names = {134						let value = <#field_types as ::evm_coder::abi::AbiRead>::abi_read(&mut subresult)?;135						if !is_dynamic {subresult.bytes_read(<#field_types as ::evm_coder::abi::AbiType>::size())};136						value137					};138				)*139140				#struct_constructor141			}142		}143	)144}145146fn impl_abi_write<'a>(147	name: &syn::Ident,148	is_named_fields: bool,149	params_count: usize,150	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,151) -> proc_macro2::TokenStream {152	let abi_write = if is_named_fields {153		quote!(154			#(155				::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);156			)*157		)158	} else {159		let field_names = (0..params_count)160			.into_iter()161			.map(proc_macro2::Literal::usize_unsuffixed);162		quote!(163			#(164				::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);165			)*166		)167	};168	quote!(169		impl ::evm_coder::abi::AbiWrite for #name {170			fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {171				if <Self as ::evm_coder::abi::AbiType>::is_dynamic() {172					let mut sub = ::evm_coder::abi::AbiWriter::new();173					{174						let sub = &mut sub;175						#abi_write176					}177					writer.write_subresult(sub);178				} else {179					let sub = writer;180					#abi_write181				}182			}183		}184	)185}186187fn impl_solidity_type<'a>(188	name: &syn::Ident,189	field_types: impl Iterator<Item = &'a syn::Type> + Clone,190	params_count: usize,191) -> proc_macro2::TokenStream {192	let len = proc_macro2::Literal::usize_suffixed(params_count);193	quote! {194		#[cfg(feature = "stubgen")]195		impl ::evm_coder::solidity::SolidityType for #name {196			fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {197				let mut collected =198					Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());199				#({200					let mut out = String::new();201					<#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)202						.expect("no fmt error");203					collected.push(out);204				})*205				collected206			}207208			fn len() -> usize {209				#len210			}211		}212	}213}214215fn impl_solidity_type_name<'a>(216	name: &syn::Ident,217	field_types: impl Iterator<Item = &'a syn::Type> + Clone,218	params_count: usize,219) -> proc_macro2::TokenStream {220	let arg_dafaults = field_types.enumerate().map(|(i, ty)| {221		let mut defult_value = quote!(<#ty as ::evm_coder::solidity::SolidityTypeName222			>::solidity_default(writer, tc)?;);223		let last_item = params_count - 1;224		if i != last_item {225			defult_value.extend(quote! {write!(writer, ",")?;})226		}227		defult_value228	});229230	quote! {231		#[cfg(feature = "stubgen")]232		impl ::evm_coder::solidity::SolidityTypeName for #name {233			fn solidity_name(234				writer: &mut impl ::core::fmt::Write,235				tc: &::evm_coder::solidity::TypeCollector,236			) -> ::core::fmt::Result {237				write!(writer, "{}", tc.collect_struct::<Self>())238			}239240			fn is_simple() -> bool {241				false242			}243244			fn solidity_default(245				writer: &mut impl ::core::fmt::Write,246				tc: &::evm_coder::solidity::TypeCollector,247			) -> ::core::fmt::Result {248				write!(writer, "{}(", tc.collect_struct::<Self>())?;249250				#(#arg_dafaults)*251252				write!(writer, ")")253			}254		}255	}256}257258fn impl_solidity_struct_collect<'a>(259	name: &syn::Ident,260	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,261	field_types: impl Iterator<Item = &'a syn::Type> + Clone,262) -> proc_macro2::TokenStream {263	let string_name = name.to_string();264	let name_type = field_names265		.into_iter()266		.zip(field_types.into_iter())267		.map(|(name, ty)| {268			let name = format!("{}", name);269			quote!(270				write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();271				write!(str, "{};", #name).unwrap();272			)273		});274275	quote! {276		#[cfg(feature = "stubgen")]277		impl ::evm_coder::solidity::StructCollect for #name {278			fn name() -> String {279				#string_name.into()280			}281282			fn declaration() -> String {283				use std::fmt::Write;284285				let mut str = String::new();286				writeln!(str, "/// @dev Cross account struct").unwrap();287				writeln!(str, "struct {} {{", Self::name()).unwrap();288				#(#name_type)*289				writeln!(str, "}}").unwrap();290				str291			}292		}293	}294}
after · crates/evm-coder/procedural/src/abi_derive.rs
1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {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<_>>>()?;2728	let (is_named_fields, field_names, field_types, params_count) = match &ast.data {29		syn::Data::Struct(ds) => match ds.fields {30			syn::Fields::Named(ref fields) => Ok((31				true,32				fields.named.iter().enumerate().map(map_field_to_name),33				fields.named.iter().map(map_field_to_type),34				fields.named.len(),35			)),36			syn::Fields::Unnamed(ref fields) => Ok((37				false,38				fields.unnamed.iter().enumerate().map(map_field_to_name),39				fields.unnamed.iter().map(map_field_to_type),40				fields.unnamed.len(),41			)),42			syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),43		},44		syn::Data::Enum(_) => Err(syn::Error::new(name.span(), "Enums not supported")),45		syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),46	}?;4748	if params_count == 0 {49		return Err(syn::Error::new(name.span(), "Empty structs not supported"));50	};5152	let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);53	let abi_type = impl_abi_type(name, field_types.clone());54	let abi_read = impl_abi_read(55		name,56		is_named_fields,57		field_names.clone(),58		field_types.clone(),59	);60	let abi_write = impl_abi_write(name, is_named_fields, params_count, field_names.clone());61	let solidity_type = impl_solidity_type(name, field_types.clone(), params_count);62	let solidity_type_name = impl_solidity_type_name(name, field_types.clone(), params_count);63	let solidity_struct_collect =64		impl_solidity_struct_collect(name, field_names, field_types, &docs);6566	Ok(quote! {67		#can_be_plcaed_in_vec68		#abi_type69		#abi_read70		#abi_write71		#solidity_type72		#solidity_type_name73		#solidity_struct_collect74	})75}7677fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {78	quote! {79		impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}80	}81}8283fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {84	match field.1.ident.as_ref() {85		Some(name) => name.clone(),86		None => {87			let mut name = "field".to_string();88			name.push_str(field.0.to_string().as_str());89			syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())90		}91	}92}9394fn map_field_to_type<'a>(field: &'a syn::Field) -> &'a syn::Type {95	&field.ty96}9798fn impl_abi_type<'a>(99	name: &syn::Ident,100	field_types: impl Iterator<Item = &'a syn::Type> + Clone,101) -> proc_macro2::TokenStream {102	let mut params_signature = {103		let types = field_types.clone();104		quote!(105			#(nameof(<#types as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*106		)107	};108109	params_signature.extend(quote!(shift_left(1)));110111	let fields_for_dynamic = field_types.clone();112113	quote! {114		impl ::evm_coder::abi::AbiType for #name {115			const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(116				new fixed("(")117				#params_signature118				fixed(")")119			);120			fn is_dynamic() -> bool {121				false122				#(123					|| <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()124				)*125			}126			fn size() -> usize {127				0 #(+ <#field_types as ::evm_coder::abi::AbiType>::size())*128			}129		}130	}131}132133fn impl_abi_read<'a>(134	name: &syn::Ident,135	is_named_fields: bool,136	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,137	field_types: impl Iterator<Item = &'a syn::Type> + Clone,138) -> proc_macro2::TokenStream {139	let field_names1 = field_names.clone();140141	let struct_constructor = if is_named_fields {142		quote!(Ok(Self { #(#field_names1),* }))143	} else {144		quote!(Ok(Self ( #(#field_names1),* )))145	};146	quote!(147		impl ::evm_coder::abi::AbiRead for #name {148			fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {149				let is_dynamic = <Self as ::evm_coder::abi::AbiType>::is_dynamic();150				let size = if !is_dynamic {151					Some(<Self as ::evm_coder::abi::AbiType>::size())152				} else {153					None154				};155				let mut subresult = reader.subresult(size)?;156				#(157					let #field_names = {158						let value = <#field_types as ::evm_coder::abi::AbiRead>::abi_read(&mut subresult)?;159						if !is_dynamic {subresult.bytes_read(<#field_types as ::evm_coder::abi::AbiType>::size())};160						value161					};162				)*163164				#struct_constructor165			}166		}167	)168}169170fn impl_abi_write<'a>(171	name: &syn::Ident,172	is_named_fields: bool,173	params_count: usize,174	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,175) -> proc_macro2::TokenStream {176	let abi_write = if is_named_fields {177		quote!(178			#(179				::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);180			)*181		)182	} else {183		let field_names = (0..params_count)184			.into_iter()185			.map(proc_macro2::Literal::usize_unsuffixed);186		quote!(187			#(188				::evm_coder::abi::AbiWrite::abi_write(&self.#field_names, sub);189			)*190		)191	};192	quote!(193		impl ::evm_coder::abi::AbiWrite for #name {194			fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {195				if <Self as ::evm_coder::abi::AbiType>::is_dynamic() {196					let mut sub = ::evm_coder::abi::AbiWriter::new();197					{198						let sub = &mut sub;199						#abi_write200					}201					writer.write_subresult(sub);202				} else {203					let sub = writer;204					#abi_write205				}206			}207		}208	)209}210211fn impl_solidity_type<'a>(212	name: &syn::Ident,213	field_types: impl Iterator<Item = &'a syn::Type> + Clone,214	params_count: usize,215) -> proc_macro2::TokenStream {216	let len = proc_macro2::Literal::usize_suffixed(params_count);217	quote! {218		#[cfg(feature = "stubgen")]219		impl ::evm_coder::solidity::SolidityType for #name {220			fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {221				let mut collected =222					Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());223				#({224					let mut out = String::new();225					<#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)226						.expect("no fmt error");227					collected.push(out);228				})*229				collected230			}231232			fn len() -> usize {233				#len234			}235		}236	}237}238239fn impl_solidity_type_name<'a>(240	name: &syn::Ident,241	field_types: impl Iterator<Item = &'a syn::Type> + Clone,242	params_count: usize,243) -> proc_macro2::TokenStream {244	let arg_dafaults = field_types.enumerate().map(|(i, ty)| {245		let mut defult_value = quote!(<#ty as ::evm_coder::solidity::SolidityTypeName246			>::solidity_default(writer, tc)?;);247		let last_item = params_count - 1;248		if i != last_item {249			defult_value.extend(quote! {write!(writer, ",")?;})250		}251		defult_value252	});253254	quote! {255		#[cfg(feature = "stubgen")]256		impl ::evm_coder::solidity::SolidityTypeName for #name {257			fn solidity_name(258				writer: &mut impl ::core::fmt::Write,259				tc: &::evm_coder::solidity::TypeCollector,260			) -> ::core::fmt::Result {261				write!(writer, "{}", tc.collect_struct::<Self>())262			}263264			fn is_simple() -> bool {265				false266			}267268			fn solidity_default(269				writer: &mut impl ::core::fmt::Write,270				tc: &::evm_coder::solidity::TypeCollector,271			) -> ::core::fmt::Result {272				write!(writer, "{}(", tc.collect_struct::<Self>())?;273274				#(#arg_dafaults)*275276				write!(writer, ")")277			}278		}279	}280}281282fn impl_solidity_struct_collect<'a>(283	name: &syn::Ident,284	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,285	field_types: impl Iterator<Item = &'a syn::Type> + Clone,286	docs: &Vec<String>,287) -> proc_macro2::TokenStream {288	let string_name = name.to_string();289	let name_type = field_names290		.into_iter()291		.zip(field_types.into_iter())292		.map(|(name, ty)| {293			let name = format!("{}", name);294			quote!(295				write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();296				write!(str, "{};", #name).unwrap();297			)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	});306307	quote! {308		#[cfg(feature = "stubgen")]309		impl ::evm_coder::solidity::StructCollect for #name {310			fn name() -> String {311				#string_name.into()312			}313314			fn declaration() -> String {315				use std::fmt::Write;316317				let mut str = String::new();318				#(#docs)*319				writeln!(str, "struct {} {{", Self::name()).unwrap();320				#(#name_type)*321				writeln!(str, "}}").unwrap();322				str323			}324		}325	}326}
modifiedcrates/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",
modifiedcrates/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,
 }
 
modifiedpallets/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,