From 3ac8748d5ef89984cad7c6bb73bf9a7b74abe142 Mon Sep 17 00:00:00 2001 From: Keith Yeung Date: Tue, 28 Dec 2021 22:38:11 -0800 Subject: [PATCH] Use derive macro to generate XcmWeightInfo trait (#4618) * Use derive macro to generate XcmWeightInfo trait * Move the Weight type alias out of proc macro --- Cargo.lock | 1 + xcm/procedural/Cargo.toml | 1 + xcm/procedural/src/lib.rs | 6 +++ xcm/procedural/src/weight_info.rs | 67 +++++++++++++++++++++++++++++++ xcm/src/v2/mod.rs | 9 +++-- xcm/src/v2/traits.rs | 62 ---------------------------- 6 files changed, 80 insertions(+), 66 deletions(-) create mode 100644 xcm/procedural/src/weight_info.rs diff --git a/Cargo.lock b/Cargo.lock index b76b9c24f256..09d9114ae41d 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -11861,6 +11861,7 @@ dependencies = [ name = "xcm-procedural" version = "0.1.0" dependencies = [ + "Inflector", "proc-macro2", "quote", "syn", diff --git a/xcm/procedural/Cargo.toml b/xcm/procedural/Cargo.toml index e0a28c9413dc..faeed606b378 100644 --- a/xcm/procedural/Cargo.toml +++ b/xcm/procedural/Cargo.toml @@ -11,3 +11,4 @@ proc-macro = true proc-macro2 = "1.0.36" quote = "1.0.10" syn = "1.0.83" +Inflector = "0.11.4" diff --git a/xcm/procedural/src/lib.rs b/xcm/procedural/src/lib.rs index fd6ffe55934f..8e43569b64d7 100644 --- a/xcm/procedural/src/lib.rs +++ b/xcm/procedural/src/lib.rs @@ -20,6 +20,7 @@ use proc_macro::TokenStream; mod v0; mod v1; +mod weight_info; #[proc_macro] pub fn impl_conversion_functions_for_multilocation_v0(input: TokenStream) -> TokenStream { @@ -34,3 +35,8 @@ pub fn impl_conversion_functions_for_multilocation_v1(input: TokenStream) -> Tok .unwrap_or_else(syn::Error::into_compile_error) .into() } + +#[proc_macro_derive(XcmWeightInfoTrait)] +pub fn derive_xcm_weight_info(item: TokenStream) -> TokenStream { + weight_info::derive(item) +} diff --git a/xcm/procedural/src/weight_info.rs b/xcm/procedural/src/weight_info.rs new file mode 100644 index 000000000000..6dc64b66d4eb --- /dev/null +++ b/xcm/procedural/src/weight_info.rs @@ -0,0 +1,67 @@ +// Copyright 2021 Parity Technologies (UK) Ltd. +// This file is part of Polkadot. + +// Polkadot is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. + +// Polkadot is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. + +// You should have received a copy of the GNU General Public License +// along with Polkadot. If not, see . + +use inflector::Inflector; +use quote::format_ident; + +pub fn derive(item: proc_macro::TokenStream) -> proc_macro::TokenStream { + let input: syn::DeriveInput = match syn::parse(item) { + Ok(input) => input, + Err(e) => return e.into_compile_error().into(), + }; + + let syn::DeriveInput { generics, data, .. } = input; + + match data { + syn::Data::Enum(syn::DataEnum { variants, .. }) => { + let methods = variants.into_iter().map(|syn::Variant { ident, fields, .. }| { + let snake_cased_ident = format_ident!("{}", ident.to_string().to_snake_case()); + let ref_fields = + fields.into_iter().enumerate().map(|(idx, syn::Field { ident, ty, .. })| { + let field_name = ident.unwrap_or_else(|| format_ident!("_{}", idx)); + let field_ty = match ty { + syn::Type::Reference(r) => { + // If the type is already a reference, do nothing + quote::quote!(#r) + }, + t => { + // Otherwise, make it a reference + quote::quote!(&#t) + }, + }; + + quote::quote!(#field_name: #field_ty,) + }); + quote::quote!(fn #snake_cased_ident( #(#ref_fields)* ) -> Weight;) + }); + + let res = quote::quote! { + pub trait XcmWeightInfo #generics { + #(#methods)* + } + }; + res.into() + }, + syn::Data::Struct(syn::DataStruct { struct_token, .. }) => { + let msg = "structs are not supported by 'derive(XcmWeightInfo)'"; + syn::Error::new(struct_token.span, msg).into_compile_error().into() + }, + syn::Data::Union(syn::DataUnion { union_token, .. }) => { + let msg = "unions are not supported by 'derive(XcmWeightInfo)'"; + syn::Error::new(union_token.span, msg).into_compile_error().into() + }, + } +} diff --git a/xcm/src/v2/mod.rs b/xcm/src/v2/mod.rs index 444a6ae86811..26efd0228cf1 100644 --- a/xcm/src/v2/mod.rs +++ b/xcm/src/v2/mod.rs @@ -64,9 +64,7 @@ use scale_info::TypeInfo; mod traits; -pub use traits::{ - Error, ExecuteXcm, Outcome, Result, SendError, SendResult, SendXcm, Weight, XcmWeightInfo, -}; +pub use traits::{Error, ExecuteXcm, Outcome, Result, SendError, SendResult, SendXcm}; // These parts of XCM v1 have been unchanged in XCM v2, and are re-imported here. pub use super::v1::{ Ancestor, AncestorThen, AssetId, AssetInstance, BodyId, BodyPart, Fungibility, @@ -224,6 +222,9 @@ impl From for Option { } } +/// Local weight type; execution time in picoseconds. +pub type Weight = u64; + /// Cross-Consensus Message: A message from one consensus system to another. /// /// Consensus systems that may send and receive messages include blockchains and smart contracts. @@ -232,7 +233,7 @@ impl From for Option { /// /// This is the inner XCM format and is version-sensitive. Messages are typically passed using the outer /// XCM format, known as `VersionedXcm`. -#[derive(Derivative, Encode, Decode, TypeInfo)] +#[derive(Derivative, Encode, Decode, TypeInfo, xcm_procedural::XcmWeightInfoTrait)] #[derivative(Clone(bound = ""), Eq(bound = ""), PartialEq(bound = ""), Debug(bound = ""))] #[codec(encode_bound())] #[codec(decode_bound())] diff --git a/xcm/src/v2/traits.rs b/xcm/src/v2/traits.rs index 8264039dcac5..059def0b7259 100644 --- a/xcm/src/v2/traits.rs +++ b/xcm/src/v2/traits.rs @@ -123,9 +123,6 @@ impl From for Error { pub type Result = result::Result<(), Error>; -/// Local weight type; execution time in picoseconds. -pub type Weight = u64; - /// Outcome of an XCM execution. #[derive(Clone, Encode, Decode, Eq, PartialEq, Debug, TypeInfo)] pub enum Outcome { @@ -319,62 +316,3 @@ impl SendXcm for Tuple { Err(SendError::CannotReachDestination(destination.into(), message)) } } - -/// The info needed to weight an XCM. -// TODO: Automate Generation -pub trait XcmWeightInfo { - fn withdraw_asset(assets: &MultiAssets) -> Weight; - fn reserve_asset_deposited(assets: &MultiAssets) -> Weight; - fn receive_teleported_asset(assets: &MultiAssets) -> Weight; - fn query_response(query_id: &u64, response: &Response, max_weight: &u64) -> Weight; - fn transfer_asset(assets: &MultiAssets, beneficiary: &MultiLocation) -> Weight; - fn transfer_reserve_asset(assets: &MultiAssets, dest: &MultiLocation, xcm: &Xcm<()>) -> Weight; - fn transact( - origin_type: &OriginKind, - require_weight_at_most: &u64, - call: &DoubleEncoded, - ) -> Weight; - fn hrmp_new_channel_open_request( - sender: &u32, - max_message_size: &u32, - max_capacity: &u32, - ) -> Weight; - fn hrmp_channel_accepted(recipient: &u32) -> Weight; - fn hrmp_channel_closing(initiator: &u32, sender: &u32, recipient: &u32) -> Weight; - fn clear_origin() -> Weight; - fn descend_origin(who: &InteriorMultiLocation) -> Weight; - fn report_error(query_id: &QueryId, dest: &MultiLocation, max_response_weight: &u64) -> Weight; - fn deposit_asset( - assets: &MultiAssetFilter, - max_assets: &u32, - beneficiary: &MultiLocation, - ) -> Weight; - fn deposit_reserve_asset( - assets: &MultiAssetFilter, - max_assets: &u32, - dest: &MultiLocation, - xcm: &Xcm<()>, - ) -> Weight; - fn exchange_asset(give: &MultiAssetFilter, receive: &MultiAssets) -> Weight; - fn initiate_reserve_withdraw( - assets: &MultiAssetFilter, - reserve: &MultiLocation, - xcm: &Xcm<()>, - ) -> Weight; - fn initiate_teleport(assets: &MultiAssetFilter, dest: &MultiLocation, xcm: &Xcm<()>) -> Weight; - fn query_holding( - query_id: &u64, - dest: &MultiLocation, - assets: &MultiAssetFilter, - max_response_weight: &u64, - ) -> Weight; - fn buy_execution(fees: &MultiAsset, weight_limit: &WeightLimit) -> Weight; - fn refund_surplus() -> Weight; - fn set_error_handler(xcm: &Xcm) -> Weight; - fn set_appendix(xcm: &Xcm) -> Weight; - fn clear_error() -> Weight; - fn claim_asset(assets: &MultiAssets, ticket: &MultiLocation) -> Weight; - fn trap(code: &u64) -> Weight; - fn subscribe_version(query_id: &QueryId, max_response_weight: &u64) -> Weight; - fn unsubscribe_version() -> Weight; -}