rlp-derive extracted (#343)

* Move a bunch of stuff around (#10101) * Move devtools. * Merge stop_guard & rename memzero * Move price-info to miner. * Group account management * Clean up workspace members. * Move local store closer to miner. * Move clib examples. * Move registrar and hash-fetch * Move rpc_cli/rpc_client * Move stratum closer to miner. * Fix naming convention of crates. * Update Cpp examples path. * Fix paths for clib-example. * Fix removing build. * misc: bump license header to 2019 (#10135) * misc: bump license header to 2019 * misc: remove_duplicate_empty_lines.sh * misc: run license header script * commit cargo lock * Upgrade ethereum types (#10670) * cargo upgrade "ethereum-types" --all --allow-prerelease * [ethash] fix compilation errors * [ethkey] fix compilation errors * [journaldb] fix compilation errors * [dir] fix compilation errors * [ethabi] update to 0.7 * wip * [eip-712] fix compilation errors * [ethjson] fix compilation errors * [Cargo.toml] add TODO to remove patches * [ethstore] fix compilation errors * use patched keccak-hash with new primitive-types * wip * [ethcore-network-devp2p] fix compilation errors * [vm] fix compilation errors * [common-types, evm, wasm] fix compilation errors * [ethcore-db] Require AsRef instead of Deref for keys * [ethcore-blockchain] fix some compilation errors * [blooms-db] fix compilation errors Thanks a lot @dvdplm :) * we don't need no rlp ethereum feature * [ethcore] fix some compilation errors * [parity-ipfs-api] fix compilation error * [ethcore-light] fix compilation errors * [Cargo.lock] update parity-common * [ethcore-private-tx] fix some compilation errors * wip * [ethcore-private-tx] fix compilation errors * [parity-updater] fix compilation errors * [parity-rpc] fix compilation errors * [parity-bin] fix other compilation errors * update to new ethereum-types * update keccak-hash * [fastmap] fix compilation in tests * [blooms-db] fix compilation in tests * [common-types] fix compilation in tests * [triehash-ethereum] fix compilation in tests * [ethkey] fix compilation in tests * [pwasm-run-test] fix compilation errors * [wasm] fix compilation errors * [ethjson] fix compilation in tests * [eip-712] fix compilation in tests * [ethcore-blockchain] fix compilation in tests * [ethstore] fix compilation in tests * [ethstore-accounts] fix compilation in tests * [parity-hash-fetch] fix compilation in tests * [parity-whisper] fix compilation in tests * [ethcore-miner] fix compilation in tests * [ethcore-network-devp2p] fix compilation in tests * [*] upgrade rand to 0.6 * [evm] get rid of num-bigint conversions * [ethcore] downgrade trie-standardmap and criterion * [ethcore] fix some warnings * [ethcore] fix compilation in tests * [evmbin] fix compilation in tests * [updater] fix compilation in tests * [ethash] fix compilation in tests * [ethcore-secretstore] fix compilation in tests * [ethcore-sync] fix compilation in tests * [parity-rpc] fix compilation in tests * [ethcore] finally fix compilation in tests FUCK YEAH!!! * [ethstore] lazy_static is unused * [ethcore] fix test * fix up bad merge * [Cargo.toml] remove unused patches * [*] replace some git dependencies with crates.io * [Cargo.toml] remove unused lazy_static * [*] clean up * [ethcore] fix transaction_filter_deprecated test * [private-tx] fix serialization tests * fix more serialization tests * [ethkey] fix smoky test * [rpc] fix tests, please? * [ethcore] remove commented out code * Apply suggestions from code review Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * [ethstore] remove unused dev-dependency * [ethcore] remove resolved TODO * [*] resolve keccak-hash TODO * [*] s/Address::default()/Address::zero() * [rpc] remove Subscribers::new_test * [rpc] remove EthPubSubClient::new_test * [ethcore] use trie-standardmap from crates.io * [dir] fix db_root_path * [ethcore] simplify snapshot::tests::helpers::fill_storage * Apply suggestions from code review Co-Authored-By: David <dvdplm@gmail.com> * [ethcore-secretstore] resolve TODO in serialization * [ethcore-network-devp2p] resolve TODO in save_key * [Cargo.lock] update triehash * [*] use ethabi from crates.io * [ethkey] use secp256k1 from master branch * [Cargo.lock] update eth-secp256k1 * Update copyright notice 2020 (#11386) * Update copyright noticed 2020 * Update copyright in two overlooked files * rlp_derive: cleanup (#11446) * rlp_derive: update syn & co * rlp_derive: remove dummy_const * rlp_derive: remove unused attirubutes * rlp-derive: change authors * backwards compatible call_type creation_method (#11450) * rlp_derive: update syn & co * rlp_derive: remove dummy_const * rlp_derive: remove unused attirubutes * rlp-derive: change authors * rlp_derive: add rlp(default) attribute * Revert "Revert "[Trace] Distinguish between `create` and `create2` (#11311)" (#11427)" This reverts commit 5d4993b0f856bf9e0e2c78849b72e581f0cde686. * trace: backwards compatible call_type and creation_method * trace: add rlp backward compatibility tests * cleanup * i know, i hate backwards compatibility too * address review grumbles * rlp-derive: change license and add a changelog * rlp-derive: tests license header as well * add rlp-derive to workspace * rename to rlp-derive * remove unnecessary line * rlp-derive: more module docs * cargo fmt * trigger the ci * Revert "trigger the ci" This reverts commit 5f21a4f. Co-authored-by: Tomasz Drwięga <tomusdrw@users.noreply.github.com> Co-authored-by: 5chdn <5chdn@users.noreply.github.com> Co-authored-by: s3krit <pugh@s3kr.it>
paritytech · Feb 12, 2020 · 9091bf0 · 9091bf0
1 parent 5b84cd9
commit 9091bf0
Show file tree

Hide file tree

Showing 7 changed files with 427 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,7 @@ members = [
 	"parity-path",
 	"plain_hasher",
 	"rlp",
+	"rlp-derive",
 	"runtime",
 	"transaction-pool",
 	"trace-time",

diff --git a/rlp-derive/CHANGELOG.md b/rlp-derive/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+The format is based on [Keep a Changelog].
+
+[Keep a Changelog]: http://keepachangelog.com/en/1.0.0/
+
+## [Unreleased]
+
+## [0.1.0] - 2020-02-12
+- Extracted from parity-ethereum repo. [#343](https://github.com/paritytech/parity-common/pull/343)
diff --git a/rlp-derive/Cargo.toml b/rlp-derive/Cargo.toml
@@ -0,0 +1,19 @@
+[package]
+name = "rlp-derive"
+version = "0.1.0"
+authors = ["Parity Technologies <admin@parity.io>"]
+license = "MIT/Apache-2.0"
+description = "Derive macro for #[derive(RlpEncodable, RlpDecodable)]"
+homepage = "http://parity.io"
+edition = "2018"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+syn = "1.0.14"
+quote = "1.0.2"
+proc-macro2 = "1.0.8"
+
+[dev-dependencies]
+rlp = "0.4.0"
diff --git a/rlp-derive/src/de.rs b/rlp-derive/src/de.rs
@@ -0,0 +1,163 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use proc_macro2::TokenStream;
+use quote::quote;
+
+struct ParseQuotes {
+	single: TokenStream,
+	list: TokenStream,
+	takes_index: bool,
+}
+
+fn decodable_parse_quotes() -> ParseQuotes {
+	ParseQuotes { single: quote! { rlp.val_at }, list: quote! { rlp.list_at }, takes_index: true }
+}
+
+fn decodable_wrapper_parse_quotes() -> ParseQuotes {
+	ParseQuotes { single: quote! { rlp.as_val }, list: quote! { rlp.as_list }, takes_index: false }
+}
+
+pub fn impl_decodable(ast: &syn::DeriveInput) -> TokenStream {
+	let body = match ast.data {
+		syn::Data::Struct(ref s) => s,
+		_ => panic!("#[derive(RlpDecodable)] is only defined for structs."),
+	};
+
+	let mut default_attribute_encountered = false;
+	let stmts: Vec<_> = body
+		.fields
+		.iter()
+		.enumerate()
+		.map(|(i, field)| decodable_field(i, field, decodable_parse_quotes(), &mut default_attribute_encountered))
+		.collect();
+	let name = &ast.ident;
+
+	let impl_block = quote! {
+		impl rlp::Decodable for #name {
+			fn decode(rlp: &rlp::Rlp) -> Result<Self, rlp::DecoderError> {
+				let result = #name {
+					#(#stmts)*
+				};
+
+				Ok(result)
+			}
+		}
+	};
+
+	quote! {
+		const _: () = {
+			extern crate rlp;
+			#impl_block
+		};
+	}
+}
+
+pub fn impl_decodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
+	let body = match ast.data {
+		syn::Data::Struct(ref s) => s,
+		_ => panic!("#[derive(RlpDecodableWrapper)] is only defined for structs."),
+	};
+
+	let stmt = {
+		let fields: Vec<_> = body.fields.iter().collect();
+		if fields.len() == 1 {
+			let field = fields.first().expect("fields.len() == 1; qed");
+			let mut default_attribute_encountered = false;
+			decodable_field(0, field, decodable_wrapper_parse_quotes(), &mut default_attribute_encountered)
+		} else {
+			panic!("#[derive(RlpEncodableWrapper)] is only defined for structs with one field.")
+		}
+	};
+
+	let name = &ast.ident;
+
+	let impl_block = quote! {
+		impl rlp::Decodable for #name {
+			fn decode(rlp: &rlp::Rlp) -> Result<Self, rlp::DecoderError> {
+				let result = #name {
+					#stmt
+				};
+
+				Ok(result)
+			}
+		}
+	};
+
+	quote! {
+		const _: () = {
+			extern crate rlp;
+			#impl_block
+		};
+	}
+}
+
+fn decodable_field(
+	index: usize,
+	field: &syn::Field,
+	quotes: ParseQuotes,
+	default_attribute_encountered: &mut bool,
+) -> TokenStream {
+	let id = match field.ident {
+		Some(ref ident) => quote! { #ident },
+		None => {
+			let index: syn::Index = index.into();
+			quote! { #index }
+		}
+	};
+
+	let index = index - *default_attribute_encountered as usize;
+	let index = quote! { #index };
+
+	let single = quotes.single;
+	let list = quotes.list;
+
+	let attributes = &field.attrs;
+	let default = if let Some(attr) = attributes.iter().find(|attr| attr.path.is_ident("rlp")) {
+		if *default_attribute_encountered {
+			panic!("only 1 #[rlp(default)] attribute is allowed in a struct")
+		}
+		match attr.parse_args() {
+			Ok(proc_macro2::TokenTree::Ident(ident)) if ident.to_string() == "default" => {}
+			_ => panic!("only #[rlp(default)] attribute is supported"),
+		}
+		*default_attribute_encountered = true;
+		true
+	} else {
+		false
+	};
+
+	match field.ty {
+		syn::Type::Path(ref path) => {
+			let ident = &path.path.segments.first().expect("there must be at least 1 segment").ident;
+			let ident_type = ident.to_string();
+			if &ident_type == "Vec" {
+				if quotes.takes_index {
+					if default {
+						quote! { #id: #list(#index).unwrap_or_default(), }
+					} else {
+						quote! { #id: #list(#index)?, }
+					}
+				} else {
+					quote! { #id: #list()?, }
+				}
+			} else {
+				if quotes.takes_index {
+					if default {
+						quote! { #id: #single(#index).unwrap_or_default(), }
+					} else {
+						quote! { #id: #single(#index)?, }
+					}
+				} else {
+					quote! { #id: #single()?, }
+				}
+			}
+		}
+		_ => panic!("rlp_derive not supported"),
+	}
+}
diff --git a/rlp-derive/src/en.rs b/rlp-derive/src/en.rs
@@ -0,0 +1,109 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use proc_macro2::TokenStream;
+use quote::quote;
+
+pub fn impl_encodable(ast: &syn::DeriveInput) -> TokenStream {
+	let body = match ast.data {
+		syn::Data::Struct(ref s) => s,
+		_ => panic!("#[derive(RlpEncodable)] is only defined for structs."),
+	};
+
+	let stmts: Vec<_> = body.fields.iter().enumerate().map(|(i, field)| encodable_field(i, field)).collect();
+	let name = &ast.ident;
+
+	let stmts_len = stmts.len();
+	let stmts_len = quote! { #stmts_len };
+	let impl_block = quote! {
+		impl rlp::Encodable for #name {
+			fn rlp_append(&self, stream: &mut rlp::RlpStream) {
+				stream.begin_list(#stmts_len);
+				#(#stmts)*
+			}
+		}
+	};
+
+	quote! {
+		const _: () = {
+			extern crate rlp;
+			#impl_block
+		};
+	}
+}
+
+pub fn impl_encodable_wrapper(ast: &syn::DeriveInput) -> TokenStream {
+	let body = match ast.data {
+		syn::Data::Struct(ref s) => s,
+		_ => panic!("#[derive(RlpEncodableWrapper)] is only defined for structs."),
+	};
+
+	let stmt = {
+		let fields: Vec<_> = body.fields.iter().collect();
+		if fields.len() == 1 {
+			let field = fields.first().expect("fields.len() == 1; qed");
+			encodable_field(0, field)
+		} else {
+			panic!("#[derive(RlpEncodableWrapper)] is only defined for structs with one field.")
+		}
+	};
+
+	let name = &ast.ident;
+
+	let impl_block = quote! {
+		impl rlp::Encodable for #name {
+			fn rlp_append(&self, stream: &mut rlp::RlpStream) {
+				#stmt
+			}
+		}
+	};
+
+	quote! {
+		const _: () = {
+			extern crate rlp;
+			#impl_block
+		};
+	}
+}
+
+fn encodable_field(index: usize, field: &syn::Field) -> TokenStream {
+	let ident = match field.ident {
+		Some(ref ident) => quote! { #ident },
+		None => {
+			let index: syn::Index = index.into();
+			quote! { #index }
+		}
+	};
+
+	let id = quote! { self.#ident };
+
+	match field.ty {
+		syn::Type::Path(ref path) => {
+			let top_segment = path.path.segments.first().expect("there must be at least 1 segment");
+			let ident = &top_segment.ident;
+			if &ident.to_string() == "Vec" {
+				let inner_ident = match top_segment.arguments {
+					syn::PathArguments::AngleBracketed(ref angle) => {
+						let ty = angle.args.first().expect("Vec has only one angle bracketed type; qed");
+						match *ty {
+							syn::GenericArgument::Type(syn::Type::Path(ref path)) => {
+								&path.path.segments.first().expect("there must be at least 1 segment").ident
+							}
+							_ => panic!("rlp_derive not supported"),
+						}
+					}
+					_ => unreachable!("Vec has only one angle bracketed type; qed"),
+				};
+				quote! { stream.append_list::<#inner_ident, _>(&#id); }
+			} else {
+				quote! { stream.append(&#id); }
+			}
+		}
+		_ => panic!("rlp_derive not supported"),
+	}
+}
diff --git a/rlp-derive/src/lib.rs b/rlp-derive/src/lib.rs
@@ -0,0 +1,54 @@
+// Copyright 2015-2020 Parity Technologies (UK) Ltd.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+//! Derive macro for `#[derive(RlpEncodable, RlpDecodable)]`.
+//!
+//! For example of usage see `./tests/rlp.rs`.
+//!
+//! This library also supports up to 1 `#[rlp(default)]` in a struct,
+//! which is similar to [`#[serde(default)]`](https://serde.rs/field-attrs.html#default)
+//! with the caveat that we use the `Default` value if
+//! the field deserialization fails, as we don't serialize field
+//! names and there is no way to tell if it is present or not.
+
+extern crate proc_macro;
+
+mod de;
+mod en;
+
+use de::{impl_decodable, impl_decodable_wrapper};
+use en::{impl_encodable, impl_encodable_wrapper};
+use proc_macro::TokenStream;
+
+#[proc_macro_derive(RlpEncodable, attributes(rlp))]
+pub fn encodable(input: TokenStream) -> TokenStream {
+	let ast = syn::parse(input).unwrap();
+	let gen = impl_encodable(&ast);
+	gen.into()
+}
+
+#[proc_macro_derive(RlpEncodableWrapper)]
+pub fn encodable_wrapper(input: TokenStream) -> TokenStream {
+	let ast = syn::parse(input).unwrap();
+	let gen = impl_encodable_wrapper(&ast);
+	gen.into()
+}
+
+#[proc_macro_derive(RlpDecodable, attributes(rlp))]
+pub fn decodable(input: TokenStream) -> TokenStream {
+	let ast = syn::parse(input).unwrap();
+	let gen = impl_decodable(&ast);
+	gen.into()
+}
+
+#[proc_macro_derive(RlpDecodableWrapper)]
+pub fn decodable_wrapper(input: TokenStream) -> TokenStream {
+	let ast = syn::parse(input).unwrap();
+	let gen = impl_decodable_wrapper(&ast);
+	gen.into()
+}