git.delta.rocks / unique-network / refs/commits / 7cb20157d174

difftreelog

feat add derive macro AbiCoder for named struct to implement AbiType

Trubnikov Sergey2022-11-10parent: #152d953.patch.diff
in: master

3 files changed

addedcrates/evm-coder/procedural/src/abi_derive.rsdiffbeforeafterboth
after · crates/evm-coder/procedural/src/abi_derive.rs
1use quote::quote;23pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> proc_macro2::TokenStream {4	// dbg!(ast);5	let name = &ast.ident;6	let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);7	let abi_type = impl_abi_type(ast);8	println!("{}", abi_type);9	quote! {10		#can_be_plcaed_in_vec11		#abi_type12	}13}1415fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {16	quote! {17		impl ::evm_coder::abi::sealed::CanBePlacedInVec for #ident {}18	}19}2021fn impl_abi_type(ast: &syn::DeriveInput) -> proc_macro2::TokenStream {22	let name = &ast.ident;23	let (fields, params_count) = match &ast.data {24		syn::Data::Struct(ds) => match ds.fields {25			syn::Fields::Named(ref fields) => (26				fields.named.iter().map(|field| &field.ty),27				fields.named.len(),28			),29			syn::Fields::Unnamed(_) => todo!(),30			syn::Fields::Unit => unimplemented!("Unit structs not supported"),31		},32		syn::Data::Enum(_) => unimplemented!("Enums not supported"),33		syn::Data::Union(_) => unimplemented!("Unions not supported"),34	};3536	let mut params_signature = {37		let fields = fields.clone();38		quote!(39			#(nameof(<#fields as ::evm_coder::abi::AbiType>::SIGNATURE) fixed(","))*40		)41	};42	if params_count > 0 {43		params_signature.extend(quote!(shift_left(1)))44	};4546	let fields_for_dynamic = fields.clone();4748	quote! {49		impl ::evm_coder::abi::AbiType for #name {50			const SIGNATURE: ::evm_coder::custom_signature::SignatureUnit = ::evm_coder::make_signature!(51				new fixed("(")52				#params_signature53				fixed(")")54			);55			fn is_dynamic() -> bool {56				false57				#(58					|| <#fields_for_dynamic as ::evm_coder::abi::AbiType>::is_dynamic()59				)*60			}61			fn size() -> usize {62				0 #(+ <#fields as ::evm_coder::abi::AbiType>::size())*63			}64		}65	}66}
modifiedcrates/evm-coder/procedural/src/lib.rsdiffbeforeafterboth
--- a/crates/evm-coder/procedural/src/lib.rs
+++ b/crates/evm-coder/procedural/src/lib.rs
@@ -25,6 +25,7 @@
 	parse_macro_input, spanned::Spanned,
 };
 
+mod abi_derive;
 mod solidity_interface;
 mod to_log;
 
@@ -242,3 +243,11 @@
 	}
 	.into()
 }
+
+#[proc_macro_derive(AbiCoder)]
+pub fn abi_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
+	let ast = syn::parse(input).unwrap();
+	let ts = abi_derive::impl_abi_macro(&ast);
+	println!("{}", &ts);
+	ts.into()
+}
addedcrates/evm-coder/tests/abi_derive_generation.rsdiffbeforeafterboth
--- /dev/null
+++ b/crates/evm-coder/tests/abi_derive_generation.rs
@@ -0,0 +1,203 @@
+use evm_coder_procedural::AbiCoder;
+use evm_coder::{
+	types::*,
+	abi::{AbiType},
+};
+
+#[derive(AbiCoder)]
+struct TypeStructUnit {}
+
+#[derive(AbiCoder)]
+struct TypeStruct1SimpleParam {
+	_a: u8,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct1DynamicParam {
+	_a: String,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct2SimpleParam {
+	_a: u8,
+	_b: u32,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct2DynamicParam {
+	_a: String,
+	_b: bytes,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct2MixedParam {
+	_a: u8,
+	_b: bytes,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct1DerivedSimpleParam {
+	_a: TypeStruct1SimpleParam,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct2DerivedSimpleParam {
+	_a: TypeStruct1SimpleParam,
+	_b: TypeStruct2SimpleParam,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct1DerivedDynamicParam {
+	_a: TypeStruct1DynamicParam,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct2DerivedDynamicParam {
+	_a: TypeStruct1DynamicParam,
+	_b: TypeStruct2DynamicParam,
+}
+
+#[derive(AbiCoder)]
+struct TypeStruct3DerivedMixedParam {
+	_a: TypeStruct1SimpleParam,
+	_b: TypeStruct2DynamicParam,
+	_c: TypeStruct2MixedParam,
+}
+
+#[test]
+fn impl_abi_type_signature() {
+	assert_eq!(
+		<TypeStructUnit as AbiType>::SIGNATURE.as_str().unwrap(),
+		"()"
+	);
+	assert_eq!(
+		<TypeStruct1SimpleParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"(uint8)"
+	);
+	assert_eq!(
+		<TypeStruct1DynamicParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"(string)"
+	);
+	assert_eq!(
+		<TypeStruct2SimpleParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"(uint8,uint32)"
+	);
+	assert_eq!(
+		<TypeStruct2DynamicParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"(string,bytes)"
+	);
+	assert_eq!(
+		<TypeStruct2MixedParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"(uint8,bytes)"
+	);
+	assert_eq!(
+		<TypeStruct1DerivedSimpleParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"((uint8))"
+	);
+	assert_eq!(
+		<TypeStruct2DerivedSimpleParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"((uint8),(uint8,uint32))"
+	);
+	assert_eq!(
+		<TypeStruct1DerivedDynamicParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"((string))"
+	);
+	assert_eq!(
+		<TypeStruct2DerivedDynamicParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"((string),(string,bytes))"
+	);
+	assert_eq!(
+		<TypeStruct3DerivedMixedParam as AbiType>::SIGNATURE
+			.as_str()
+			.unwrap(),
+		"((uint8),(string,bytes),(uint8,bytes))"
+	);
+}
+
+#[test]
+fn impl_abi_type_is_dynamic() {
+	assert_eq!(<TypeStructUnit as AbiType>::is_dynamic(), false);
+	assert_eq!(<TypeStruct1SimpleParam as AbiType>::is_dynamic(), false);
+	assert_eq!(<TypeStruct1DynamicParam as AbiType>::is_dynamic(), true);
+	assert_eq!(<TypeStruct2SimpleParam as AbiType>::is_dynamic(), false);
+	assert_eq!(<TypeStruct2DynamicParam as AbiType>::is_dynamic(), true);
+	assert_eq!(<TypeStruct2MixedParam as AbiType>::is_dynamic(), true);
+	assert_eq!(
+		<TypeStruct1DerivedSimpleParam as AbiType>::is_dynamic(),
+		false
+	);
+	assert_eq!(
+		<TypeStruct2DerivedSimpleParam as AbiType>::is_dynamic(),
+		false
+	);
+	assert_eq!(
+		<TypeStruct1DerivedDynamicParam as AbiType>::is_dynamic(),
+		true
+	);
+	assert_eq!(
+		<TypeStruct2DerivedDynamicParam as AbiType>::is_dynamic(),
+		true
+	);
+	assert_eq!(
+		<TypeStruct3DerivedMixedParam as AbiType>::is_dynamic(),
+		true
+	);
+}
+
+#[test]
+fn impl_abi_type_size() {
+	const ABI_ALIGNMENT: usize = 32;
+	assert_eq!(<TypeStructUnit as AbiType>::size(), 0);
+	assert_eq!(<TypeStruct1SimpleParam as AbiType>::size(), ABI_ALIGNMENT);
+	assert_eq!(<TypeStruct1DynamicParam as AbiType>::size(), ABI_ALIGNMENT);
+	assert_eq!(
+		<TypeStruct2SimpleParam as AbiType>::size(),
+		ABI_ALIGNMENT * 2
+	);
+	assert_eq!(
+		<TypeStruct2DynamicParam as AbiType>::size(),
+		ABI_ALIGNMENT * 2
+	);
+	assert_eq!(
+		<TypeStruct2MixedParam as AbiType>::size(),
+		ABI_ALIGNMENT * 2
+	);
+	assert_eq!(
+		<TypeStruct1DerivedSimpleParam as AbiType>::size(),
+		ABI_ALIGNMENT
+	);
+	assert_eq!(
+		<TypeStruct2DerivedSimpleParam as AbiType>::size(),
+		ABI_ALIGNMENT * 3
+	);
+	assert_eq!(
+		<TypeStruct1DerivedDynamicParam as AbiType>::size(),
+		ABI_ALIGNMENT
+	);
+	assert_eq!(
+		<TypeStruct2DerivedDynamicParam as AbiType>::size(),
+		ABI_ALIGNMENT * 3
+	);
+	assert_eq!(
+		<TypeStruct3DerivedMixedParam as AbiType>::size(),
+		ABI_ALIGNMENT * 5
+	);
+}