git.delta.rocks / unique-network / refs/commits / b3e1096e44dd

difftreelog

fix AbiWrite implementations

Trubnikov Sergey2022-11-14parent: #d535fba.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	// dbg!(ast);5	let name = &ast.ident;6	let (is_named_fields, field_names, field_types, params_count) = match &ast.data {7		syn::Data::Struct(ds) => match ds.fields {8			syn::Fields::Named(ref fields) => Ok((9				true,10				fields.named.iter().enumerate().map(map_field_to_name),11				fields.named.iter().map(map_field_to_type),12				fields.named.len(),13			)),14			syn::Fields::Unnamed(ref fields) => Ok((15				false,16				fields.unnamed.iter().enumerate().map(map_field_to_name),17				fields.unnamed.iter().map(map_field_to_type),18				fields.unnamed.len(),19			)),20			syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),21		},22		syn::Data::Enum(_) => Err(syn::Error::new(name.span(), "Enums not supported")),23		syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),24	}?;2526	if params_count == 0 {27		return Err(syn::Error::new(name.span(), "Empty structs not supported"));28	};2930	let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);31	let abi_type = impl_abi_type(name, field_types.clone());32	let abi_read = impl_abi_read(name, is_named_fields, field_names.clone(), field_types);33	let abi_write = impl_abi_write(name, is_named_fields, params_count, field_names);34	println!("{}", abi_write);35	Ok(quote! {36		#can_be_plcaed_in_vec37		#abi_type38		#abi_read39		#abi_write40	})41}4243fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {44	quote! {45		impl ::evm_coder::abi::sealed::CanBePlacedInVec for #ident {}46	}47}4849fn map_field_to_name(field: (usize, &syn::Field)) -> syn::Ident {50	match field.1.ident.as_ref() {51		Some(name) => name.clone(),52		None => {53			let mut name = "field".to_string();54			name.push_str(field.0.to_string().as_str());55			syn::Ident::new(name.as_str(), proc_macro2::Span::call_site())56		}57	}58}5960fn map_field_to_type<'a>(field: &'a syn::Field) -> &'a syn::Type {61	&field.ty62}6364fn impl_abi_type<'a>(65	name: &syn::Ident,66	field_types: impl Iterator<Item = &'a syn::Type> + Clone,67) -> proc_macro2::TokenStream {68	let mut params_signature = {69		let types = field_types.clone();70		quote!(71			#(nameof(<#types as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*72		)73	};7475	params_signature.extend(quote!(shift_left(1)));7677	let fields_for_dynamic = field_types.clone();7879	quote! {80		impl ::evm_coder::abi::AbiType for #name {81			const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(82				new fixed("(")83				#params_signature84				fixed(")")85			);86			fn is_dynamic() -> bool {87				false88				#(89					|| <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()90				)*91			}92			fn size() -> usize {93				0 #(+ <#field_types as ::evm_coder::abi::AbiType>::size())*94			}95		}96	}97}9899fn impl_abi_read<'a>(100	name: &syn::Ident,101	is_named_fields: bool,102	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,103	field_types: impl Iterator<Item = &'a syn::Type> + Clone,104) -> proc_macro2::TokenStream {105	let field_names1 = field_names.clone();106107	let struct_constructor = if is_named_fields {108		quote!(Ok(Self { #(#field_names1),* }))109	} else {110		quote!(Ok(Self ( #(#field_names1),* )))111	};112	quote!(113		impl ::evm_coder::abi::AbiRead for #name {114			fn abi_read(reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Self> {115				let size = if !<Self as ::evm_coder::abi::AbiType>::is_dynamic() {116					Some(<Self as ::evm_coder::abi::AbiType>::size())117				} else {118					None119				};120				let mut subresult = reader.subresult(size)?;121				#(122					let #field_names = <#field_types as ::evm_coder::abi::AbiRead>::abi_read(&mut subresult)?;123				)*124125				#struct_constructor126			}127		}128	)129}130131fn impl_abi_write<'a>(132	name: &syn::Ident,133	is_named_fields: bool,134	params_count: usize,135	field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,136) -> proc_macro2::TokenStream {137	let abi_write = if is_named_fields {138		quote!(139			#(140				self.#field_names.abi_write(writer);141			)*142		)143	} else {144		let field_names = (0..params_count)145			.into_iter()146			.map(proc_macro2::Literal::usize_unsuffixed);147		quote!(148			#(149				self.#field_names.abi_write(writer);150			)*151		)152	};153	quote!(154		impl ::evm_coder::abi::AbiWrite for #name {155			fn abi_write(&self, writer: &mut ::evm_coder::abi::AbiWriter) {156				#abi_write157			}158		}159	)160}
modifiedcrates/evm-coder/src/abi/impls.rsdiffbeforeafterboth
--- a/crates/evm-coder/src/abi/impls.rs
+++ b/crates/evm-coder/src/abi/impls.rs
@@ -310,11 +310,11 @@
 		#[allow(non_snake_case)]
 		impl<$($ident),+> AbiWrite for ($($ident,)+)
 		where
-			$($ident: AbiWrite,)+
+			$($ident: AbiWrite + AbiType,)+
 		{
 			fn abi_write(&self, writer: &mut AbiWriter) {
 				let ($($ident,)+) = self;
-				if writer.is_dynamic {
+				if <Self as AbiType>::is_dynamic() {
 					let mut sub = AbiWriter::new();
 					$($ident.abi_write(&mut sub);)+
 					writer.write_subresult(sub);
modifiedcrates/evm-coder/src/lib.rsdiffbeforeafterboth
--- a/crates/evm-coder/src/lib.rs
+++ b/crates/evm-coder/src/lib.rs
@@ -137,7 +137,7 @@
 	#[cfg(feature = "std")]
 	pub type string = ::std::string::String;
 
-	#[derive(Default, Debug, PartialEq)]
+	#[derive(Default, Debug, PartialEq, Clone)]
 	pub struct bytes(pub Vec<u8>);
 
 	/// Solidity doesn't have `void` type, however we have special implementation
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
@@ -1,64 +1,64 @@
 use evm_coder_procedural::AbiCoder;
 use evm_coder::{
 	types::*,
-	abi::{AbiType},
+	abi::{AbiType, AbiRead, AbiWrite},
 };
 
 // TODO: move to build_failed tests
-// #[derive(AbiCoder)]
+// #[derive(AbiCoder, PartialEq, Debug)]
 // struct TypeStructUnit {}
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct1SimpleParam {
 	_a: u8,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct1DynamicParam {
 	_a: String,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct2SimpleParam {
 	_a: u8,
 	_b: u32,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct2DynamicParam {
 	_a: String,
 	_b: bytes,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct2MixedParam {
 	_a: u8,
 	_b: bytes,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct1DerivedSimpleParam {
 	_a: TypeStruct1SimpleParam,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct2DerivedSimpleParam {
 	_a: TypeStruct1SimpleParam,
 	_b: TypeStruct2SimpleParam,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct1DerivedDynamicParam {
 	_a: TypeStruct1DynamicParam,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct2DerivedDynamicParam {
 	_a: TypeStruct1DynamicParam,
 	_b: TypeStruct2DynamicParam,
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TypeStruct3DerivedMixedParam {
 	_a: TypeStruct1SimpleParam,
 	_b: TypeStruct2DynamicParam,
@@ -200,34 +200,34 @@
 	);
 }
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct1SimpleParam(u8);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct1DynamicParam(String);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct2SimpleParam(u8, u32);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct2DynamicParam(String, bytes);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct2MixedParam(u8, bytes);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct1DerivedSimpleParam(TupleStruct1SimpleParam);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct2DerivedSimpleParam(TupleStruct1SimpleParam, TupleStruct2SimpleParam);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct1DerivedDynamicParam(TupleStruct1DynamicParam);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct2DerivedDynamicParam(TupleStruct1DynamicParam, TupleStruct2DynamicParam);
 
-#[derive(AbiCoder)]
+#[derive(AbiCoder, PartialEq, Debug)]
 struct TupleStruct3DerivedMixedParam(
 	TupleStruct1SimpleParam,
 	TupleStruct2DynamicParam,
@@ -406,7 +406,66 @@
 	);
 }
 
-// #[test]
-// fn impl_abi_read() {
-// 	TypeStruct1SimpleParam::
-// }
+fn test_impl<TypeStruct, TupleStruct, Tuple>(
+	type_struct_data: TypeStruct,
+	tuple_struct_data: TupleStruct,
+	tuple_data: Tuple,
+) where
+	TypeStruct: AbiWrite + AbiRead + std::cmp::PartialEq + std::fmt::Debug,
+	Tuple: AbiWrite + AbiRead + std::cmp::PartialEq + std::fmt::Debug,
+{
+	use evm_coder::abi::{AbiReader, AbiWriter};
+	const FUNCTION_IDENTIFIER: u32 = 0xdeadbeef;
+
+	let mut writer = AbiWriter::new_call(FUNCTION_IDENTIFIER);
+	tuple_data.abi_write(&mut writer);
+	let encoded_tuple = writer.finish();
+
+	let mut writer = AbiWriter::new_call(FUNCTION_IDENTIFIER);
+	type_struct_data.abi_write(&mut writer);
+	let encoded_struct = writer.finish();
+
+	similar_asserts::assert_eq!(encoded_tuple, encoded_struct);
+
+	// let (_, mut decoder) = AbiReader::new_call(&encoded_tuple).unwrap();
+	// let restored_struct_data = <TypeStruct>::abi_read(&mut decoder).unwrap();
+	// assert_eq!(restored_struct_data, type_struct_data);
+
+	// let (_, mut decoder) = AbiReader::new_call(&encoded_struct).unwrap();
+	// let restored_tuple_data = <Tuple>::abi_read(&mut decoder).unwrap();
+	// assert_eq!(restored_tuple_data, tuple_data);
+}
+
+#[test]
+fn codec_struct_1_simple() {
+	let _a = 0xff;
+	test_impl::<TypeStruct1SimpleParam, TupleStruct1SimpleParam, (uint8,)>(
+		TypeStruct1SimpleParam { _a },
+		TupleStruct1SimpleParam(_a),
+		(_a,),
+	);
+}
+
+#[test]
+fn codec_struct_1_dynamic() {
+	let _a: String = "some string".into();
+	test_impl::<TypeStruct1DynamicParam, TupleStruct1DynamicParam, (String,)>(
+		TypeStruct1DynamicParam { _a: _a.clone() },
+		TupleStruct1DynamicParam(_a.clone()),
+		(_a,),
+	);
+}
+
+#[test]
+fn codec_struct_2_dynamic() {
+	let _a: String = "some string".into();
+	let _b: bytes = bytes(vec![0x11, 0x22, 0x33]);
+	test_impl::<TypeStruct2DynamicParam, TupleStruct2DynamicParam, (String, bytes)>(
+		TypeStruct2DynamicParam {
+			_a: _a.clone(),
+			_b: _b.clone(),
+		},
+		TupleStruct2DynamicParam(_a.clone(), _b.clone()),
+		(_a, _b),
+	);
+}