difftreelog
feat(evm-coder) hidden methods
in: master
Hidden methods appear in selector, and callable from outside, but do not appear in newly generated interfaces/stubs/abi files.
3 files changed
.maintain/scripts/generate_sol.shdiffbeforeafterboth--- a/.maintain/scripts/generate_sol.sh
+++ b/.maintain/scripts/generate_sol.sh
@@ -11,4 +11,6 @@
formatted=$(mktemp)
prettier --config $PRETTIER_CONFIG $raw > $formatted
+sed -i -E -e "s/.+\/\/ FORMATTING: FORCE NEWLINE//g" $formatted
+
mv $formatted $OUTPUT
crates/evm-coder/procedural/src/solidity_interface.rsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617#![allow(dead_code)]1819// NOTE: In order to understand this Rust macro better, first read this chapter20// about Procedural Macros in Rust book:21// https://doc.rust-lang.org/reference/procedural-macros.html2223use quote::{quote, ToTokens};24use inflector::cases;25use std::fmt::Write;26use syn::{27 Expr, FnArg, GenericArgument, Generics, Ident, ImplItem, ImplItemMethod, ItemImpl, Lit, Meta,28 MetaNameValue, PatType, PathArguments, ReturnType, Type,29 spanned::Spanned,30 parse::{Parse, ParseStream},31 parenthesized, Token, LitInt, LitStr,32};3334use crate::{35 fn_selector_str, parse_ident_from_pat, parse_ident_from_path, parse_path, parse_path_segment,36 parse_result_ok, pascal_ident_to_call, pascal_ident_to_snake_call, snake_ident_to_pascal,37 snake_ident_to_screaming,38};3940struct Is {41 name: Ident,42 pascal_call_name: Ident,43 snake_call_name: Ident,44 via: Option<(Type, Ident)>,45 condition: Option<Expr>,46}47impl Is {48 fn expand_call_def(&self, gen_ref: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {49 let name = &self.name;50 let pascal_call_name = &self.pascal_call_name;51 quote! {52 #name(#pascal_call_name #gen_ref)53 }54 }5556 fn expand_interface_id(&self) -> proc_macro2::TokenStream {57 let pascal_call_name = &self.pascal_call_name;58 quote! {59 interface_id ^= u32::from_be_bytes(#pascal_call_name::interface_id());60 }61 }6263 fn expand_supports_interface(64 &self,65 generics: &proc_macro2::TokenStream,66 ) -> proc_macro2::TokenStream {67 let pascal_call_name = &self.pascal_call_name;68 let condition = self.condition.as_ref().map(|condition| {69 quote! {70 (#condition) &&71 }72 });73 quote! {74 #condition <#pascal_call_name #generics>::supports_interface(this, interface_id)75 }76 }7778 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {79 let name = &self.name;80 quote! {81 Self::#name(call) => call.weight()82 }83 }8485 fn expand_variant_call(86 &self,87 call_name: &proc_macro2::Ident,88 generics: &proc_macro2::TokenStream,89 ) -> proc_macro2::TokenStream {90 let name = &self.name;91 let pascal_call_name = &self.pascal_call_name;92 let via_typ = self93 .via94 .as_ref()95 .map(|(t, _)| quote! {#t})96 .unwrap_or_else(|| quote! {Self});97 let via_map = self98 .via99 .as_ref()100 .map(|(_, i)| quote! {.#i()})101 .unwrap_or_default();102 let condition = self.condition.as_ref().map(|condition| {103 quote! {104 if ({let this = &self; (#condition)})105 }106 });107 quote! {108 #call_name::#name(call) #condition => return <#via_typ as ::evm_coder::Callable<#pascal_call_name #generics>>::call(self #via_map, Msg {109 call,110 caller: c.caller,111 value: c.value,112 })113 }114 }115116 fn expand_parse(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {117 let name = &self.name;118 let pascal_call_name = &self.pascal_call_name;119 quote! {120 if let Some(parsed_call) = <#pascal_call_name #generics>::parse(method_id, reader)? {121 return Ok(Some(Self::#name(parsed_call)))122 }123 }124 }125126 fn expand_generator(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {127 let pascal_call_name = &self.pascal_call_name;128 quote! {129 <#pascal_call_name #generics>::generate_solidity_interface(tc, is_impl);130 }131 }132133 fn expand_event_generator(&self) -> proc_macro2::TokenStream {134 let name = &self.name;135 quote! {136 #name::generate_solidity_interface(tc, is_impl);137 }138 }139}140141#[derive(Default)]142struct IsList(Vec<Is>);143impl Parse for IsList {144 fn parse(input: ParseStream) -> syn::Result<Self> {145 let mut out = vec![];146 loop {147 if input.is_empty() {148 break;149 }150 let name = input.parse::<Ident>()?;151 let lookahead = input.lookahead1();152153 let mut condition: Option<Expr> = None;154 let mut via: Option<(Type, Ident)> = None;155156 if lookahead.peek(syn::token::Paren) {157 let contents;158 parenthesized!(contents in input);159 let input = contents;160161 while !input.is_empty() {162 let lookahead = input.lookahead1();163 if lookahead.peek(Token![if]) {164 input.parse::<Token![if]>()?;165 let contents;166 parenthesized!(contents in input);167 let contents = contents.parse::<Expr>()?;168169 if condition.replace(contents).is_some() {170 return Err(syn::Error::new(input.span(), "condition is already set"));171 }172 } else if lookahead.peek(kw::via) {173 input.parse::<kw::via>()?;174 let contents;175 parenthesized!(contents in input);176177 let method = contents.parse::<Ident>()?;178 contents.parse::<kw::returns>()?;179 let ty = contents.parse::<Type>()?;180181 if via.replace((ty, method)).is_some() {182 return Err(syn::Error::new(input.span(), "via is already set"));183 }184 } else {185 return Err(lookahead.error());186 }187188 if input.peek(Token![,]) {189 input.parse::<Token![,]>()?;190 } else if !input.is_empty() {191 return Err(syn::Error::new(input.span(), "expected end"));192 }193 }194 } else if lookahead.peek(Token![,]) || input.is_empty() {195 // Pass196 } else {197 return Err(lookahead.error());198 };199 out.push(Is {200 pascal_call_name: pascal_ident_to_call(&name),201 snake_call_name: pascal_ident_to_snake_call(&name),202 name,203 via,204 condition,205 });206 if input.peek(Token![,]) {207 input.parse::<Token![,]>()?;208 continue;209 } else {210 break;211 }212 }213 Ok(Self(out))214 }215}216217pub struct InterfaceInfo {218 name: Ident,219 is: IsList,220 inline_is: IsList,221 events: IsList,222 expect_selector: Option<u32>,223}224impl Parse for InterfaceInfo {225 fn parse(input: ParseStream) -> syn::Result<Self> {226 let mut name = None;227 let mut is = None;228 let mut inline_is = None;229 let mut events = None;230 let mut expect_selector = None;231 // TODO: create proc-macro to optimize proc-macro boilerplate? :D232 loop {233 let lookahead = input.lookahead1();234 if lookahead.peek(kw::name) {235 let k = input.parse::<kw::name>()?;236 input.parse::<Token![=]>()?;237 if name.replace(input.parse::<Ident>()?).is_some() {238 return Err(syn::Error::new(k.span(), "name is already set"));239 }240 } else if lookahead.peek(kw::is) {241 let k = input.parse::<kw::is>()?;242 let contents;243 parenthesized!(contents in input);244 if is.replace(contents.parse::<IsList>()?).is_some() {245 return Err(syn::Error::new(k.span(), "is is already set"));246 }247 } else if lookahead.peek(kw::inline_is) {248 let k = input.parse::<kw::inline_is>()?;249 let contents;250 parenthesized!(contents in input);251 if inline_is.replace(contents.parse::<IsList>()?).is_some() {252 return Err(syn::Error::new(k.span(), "inline_is is already set"));253 }254 } else if lookahead.peek(kw::events) {255 let k = input.parse::<kw::events>()?;256 let contents;257 parenthesized!(contents in input);258 if events.replace(contents.parse::<IsList>()?).is_some() {259 return Err(syn::Error::new(k.span(), "events is already set"));260 }261 } else if lookahead.peek(kw::expect_selector) {262 let k = input.parse::<kw::expect_selector>()?;263 input.parse::<Token![=]>()?;264 let value = input.parse::<LitInt>()?;265 if expect_selector266 .replace(value.base10_parse::<u32>()?)267 .is_some()268 {269 return Err(syn::Error::new(k.span(), "expect_selector is already set"));270 }271 } else if input.is_empty() {272 break;273 } else {274 return Err(lookahead.error());275 }276 if input.peek(Token![,]) {277 input.parse::<Token![,]>()?;278 } else {279 break;280 }281 }282 Ok(Self {283 name: name.ok_or_else(|| syn::Error::new(input.span(), "missing name"))?,284 is: is.unwrap_or_default(),285 inline_is: inline_is.unwrap_or_default(),286 events: events.unwrap_or_default(),287 expect_selector,288 })289 }290}291292struct MethodInfo {293 rename_selector: Option<String>,294}295impl Parse for MethodInfo {296 fn parse(input: ParseStream) -> syn::Result<Self> {297 let mut rename_selector = None;298 let lookahead = input.lookahead1();299 if lookahead.peek(kw::rename_selector) {300 let k = input.parse::<kw::rename_selector>()?;301 input.parse::<Token![=]>()?;302 if rename_selector303 .replace(input.parse::<LitStr>()?.value())304 .is_some()305 {306 return Err(syn::Error::new(k.span(), "rename_selector is already set"));307 }308 }309 Ok(Self { rename_selector })310 }311}312313enum AbiType {314 // type315 Plain(Ident),316 // (type1,type2)317 Tuple(Vec<AbiType>),318 // type[]319 Vec(Box<AbiType>),320 // type[20]321 Array(Box<AbiType>, usize),322}323impl AbiType {324 fn try_from(value: &Type) -> syn::Result<Self> {325 let value = Self::try_maybe_special_from(value)?;326 if value.is_special() {327 return Err(syn::Error::new(value.span(), "unexpected special type"));328 }329 Ok(value)330 }331 fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {332 match value {333 Type::Array(arr) => {334 let wrapped = AbiType::try_from(&arr.elem)?;335 match &arr.len {336 Expr::Lit(l) => match &l.lit {337 Lit::Int(i) => {338 let num = i.base10_parse::<usize>()?;339 Ok(AbiType::Array(Box::new(wrapped), num as usize))340 }341 _ => Err(syn::Error::new(arr.len.span(), "should be int literal")),342 },343 _ => Err(syn::Error::new(arr.len.span(), "should be literal")),344 }345 }346 Type::Path(_) => {347 let path = parse_path(value)?;348 let segment = parse_path_segment(path)?;349 if segment.ident == "Vec" {350 let args = match &segment.arguments {351 PathArguments::AngleBracketed(e) => e,352 _ => {353 return Err(syn::Error::new(354 segment.arguments.span(),355 "missing Vec generic",356 ))357 }358 };359 let args = &args.args;360 if args.len() != 1 {361 return Err(syn::Error::new(362 args.span(),363 "expected only one generic for vec",364 ));365 }366 let arg = args.first().expect("first arg");367368 let ty = match arg {369 GenericArgument::Type(ty) => ty,370 _ => {371 return Err(syn::Error::new(372 arg.span(),373 "expected first generic to be type",374 ))375 }376 };377378 let wrapped = AbiType::try_from(ty)?;379 Ok(Self::Vec(Box::new(wrapped)))380 } else {381 if !segment.arguments.is_empty() {382 return Err(syn::Error::new(383 segment.arguments.span(),384 "unexpected generic arguments for non-vec type",385 ));386 }387 Ok(Self::Plain(segment.ident.clone()))388 }389 }390 Type::Tuple(t) => {391 let mut out = Vec::with_capacity(t.elems.len());392 for el in t.elems.iter() {393 out.push(AbiType::try_from(el)?)394 }395 Ok(Self::Tuple(out))396 }397 _ => Err(syn::Error::new(398 value.span(),399 "unexpected type, only arrays, plain types and tuples are supported",400 )),401 }402 }403 fn is_value(&self) -> bool {404 matches!(self, Self::Plain(v) if v == "value")405 }406 fn is_caller(&self) -> bool {407 matches!(self, Self::Plain(v) if v == "caller")408 }409 fn is_special(&self) -> bool {410 self.is_caller() || self.is_value()411 }412 fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {413 match self {414 AbiType::Plain(t) => {415 write!(buf, "{}", t)416 }417 AbiType::Tuple(t) => {418 write!(buf, "(")?;419 for (i, t) in t.iter().enumerate() {420 if i != 0 {421 write!(buf, ",")?;422 }423 t.selector_ty_buf(buf)?;424 }425 write!(buf, ")")426 }427 AbiType::Vec(v) => {428 v.selector_ty_buf(buf)?;429 write!(buf, "[]")430 }431 AbiType::Array(v, len) => {432 v.selector_ty_buf(buf)?;433 write!(buf, "[{}]", len)434 }435 }436 }437 fn selector_ty(&self) -> String {438 let mut out = String::new();439 self.selector_ty_buf(&mut out).expect("no fmt error");440 out441 }442}443impl ToTokens for AbiType {444 fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {445 match self {446 AbiType::Plain(t) => tokens.extend(quote! {#t}),447 AbiType::Tuple(t) => {448 tokens.extend(quote! {(449 #(#t),*450 )});451 }452 AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),453 AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),454 }455 }456}457458struct MethodArg {459 name: Ident,460 camel_name: String,461 ty: AbiType,462}463impl MethodArg {464 fn try_from(value: &PatType) -> syn::Result<Self> {465 let name = parse_ident_from_pat(&value.pat)?.clone();466 Ok(Self {467 camel_name: cases::camelcase::to_camel_case(&name.to_string()),468 name,469 ty: AbiType::try_maybe_special_from(&value.ty)?,470 })471 }472 fn is_value(&self) -> bool {473 self.ty.is_value()474 }475 fn is_caller(&self) -> bool {476 self.ty.is_caller()477 }478 fn is_special(&self) -> bool {479 self.ty.is_special()480 }481 fn selector_ty(&self) -> String {482 assert!(!self.is_special());483 self.ty.selector_ty()484 }485486 fn expand_call_def(&self) -> proc_macro2::TokenStream {487 assert!(!self.is_special());488 let name = &self.name;489 let ty = &self.ty;490491 quote! {492 #name: #ty493 }494 }495496 fn expand_parse(&self) -> proc_macro2::TokenStream {497 assert!(!self.is_special());498 let name = &self.name;499 quote! {500 #name: reader.abi_read()?501 }502 }503504 fn expand_call_arg(&self) -> proc_macro2::TokenStream {505 if self.is_value() {506 quote! {507 c.value.clone()508 }509 } else if self.is_caller() {510 quote! {511 c.caller.clone()512 }513 } else {514 let name = &self.name;515 quote! {516 #name517 }518 }519 }520521 fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {522 let camel_name = &self.camel_name.to_string();523 let ty = &self.ty;524 quote! {525 <NamedArgument<#ty>>::new(#camel_name)526 }527 }528}529530#[derive(PartialEq)]531enum Mutability {532 Mutable,533 View,534 Pure,535}536537/// Group all keywords for this macro. Usage example:538/// #[solidity_interface(name = "B", inline_is(A))]539mod kw {540 syn::custom_keyword!(weight);541542 syn::custom_keyword!(via);543 syn::custom_keyword!(returns);544 syn::custom_keyword!(name);545 syn::custom_keyword!(is);546 syn::custom_keyword!(inline_is);547 syn::custom_keyword!(events);548 syn::custom_keyword!(expect_selector);549550 syn::custom_keyword!(rename_selector);551}552553/// Rust methods are parsed into this structure when Solidity code is generated554struct Method {555 name: Ident,556 camel_name: String,557 pascal_name: Ident,558 screaming_name: Ident,559 selector_str: String,560 selector: u32,561 args: Vec<MethodArg>,562 has_normal_args: bool,563 has_value_args: bool,564 mutability: Mutability,565 result: Type,566 weight: Option<Expr>,567 docs: Vec<String>,568}569impl Method {570 fn try_from(value: &ImplItemMethod) -> syn::Result<Self> {571 let mut info = MethodInfo {572 rename_selector: None,573 };574 let mut docs = Vec::new();575 let mut weight = None;576 for attr in &value.attrs {577 let ident = parse_ident_from_path(&attr.path, false)?;578 if ident == "solidity" {579 info = attr.parse_args::<MethodInfo>()?;580 } else if ident == "doc" {581 let args = attr.parse_meta().unwrap();582 let value = match args {583 Meta::NameValue(MetaNameValue {584 lit: Lit::Str(str), ..585 }) => str.value(),586 _ => unreachable!(),587 };588 docs.push(value);589 } else if ident == "weight" {590 weight = Some(attr.parse_args::<Expr>()?);591 }592 }593 let ident = &value.sig.ident;594 let ident_str = ident.to_string();595 if !cases::snakecase::is_snake_case(&ident_str) {596 return Err(syn::Error::new(ident.span(), "method name should be snake_cased\nif alternative solidity name needs to be set - use #[solidity] attribute"));597 }598599 let mut mutability = Mutability::Pure;600601 if let Some(FnArg::Receiver(receiver)) = value602 .sig603 .inputs604 .iter()605 .find(|arg| matches!(arg, FnArg::Receiver(_)))606 {607 if receiver.reference.is_none() {608 return Err(syn::Error::new(609 receiver.span(),610 "receiver should be by ref",611 ));612 }613 if receiver.mutability.is_some() {614 mutability = Mutability::Mutable;615 } else {616 mutability = Mutability::View;617 }618 }619 let mut args = Vec::new();620 for typ in value621 .sig622 .inputs623 .iter()624 .filter(|arg| matches!(arg, FnArg::Typed(_)))625 {626 let typ = match typ {627 FnArg::Typed(typ) => typ,628 _ => unreachable!(),629 };630 args.push(MethodArg::try_from(typ)?);631 }632633 if mutability != Mutability::Mutable && args.iter().any(|arg| arg.is_value()) {634 return Err(syn::Error::new(635 args.iter().find(|arg| arg.is_value()).unwrap().ty.span(),636 "payable function should be mutable",637 ));638 }639640 let result = match &value.sig.output {641 ReturnType::Type(_, ty) => ty,642 _ => return Err(syn::Error::new(value.sig.output.span(), "interface method should return Result<value>\nif there is no value to return - specify void (which is alias to unit)")),643 };644 let result = parse_result_ok(result)?;645646 let camel_name = info647 .rename_selector648 .unwrap_or_else(|| cases::camelcase::to_camel_case(&ident.to_string()));649 let mut selector_str = camel_name.clone();650 selector_str.push('(');651 let mut has_normal_args = false;652 for (i, arg) in args.iter().filter(|arg| !arg.is_special()).enumerate() {653 if i != 0 {654 selector_str.push(',');655 }656 write!(selector_str, "{}", arg.selector_ty()).unwrap();657 has_normal_args = true;658 }659 let has_value_args = args.iter().any(|a| a.is_value());660 selector_str.push(')');661 let selector = fn_selector_str(&selector_str);662663 Ok(Self {664 name: ident.clone(),665 camel_name,666 pascal_name: snake_ident_to_pascal(ident),667 screaming_name: snake_ident_to_screaming(ident),668 selector_str,669 selector,670 args,671 has_normal_args,672 has_value_args,673 mutability,674 result: result.clone(),675 weight,676 docs,677 })678 }679 fn expand_call_def(&self) -> proc_macro2::TokenStream {680 let defs = self681 .args682 .iter()683 .filter(|a| !a.is_special())684 .map(|a| a.expand_call_def());685 let pascal_name = &self.pascal_name;686 let docs = &self.docs;687688 if self.has_normal_args {689 quote! {690 #(#[doc = #docs])*691 #[allow(missing_docs)]692 #pascal_name {693 #(694 #defs,695 )*696 }697 }698 } else {699 quote! {#pascal_name}700 }701 }702703 fn expand_const(&self) -> proc_macro2::TokenStream {704 let screaming_name = &self.screaming_name;705 let selector = u32::to_be_bytes(self.selector);706 let selector_str = &self.selector_str;707 quote! {708 #[doc = #selector_str]709 const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];710 }711 }712713 fn expand_interface_id(&self) -> proc_macro2::TokenStream {714 let screaming_name = &self.screaming_name;715 quote! {716 interface_id ^= u32::from_be_bytes(Self::#screaming_name);717 }718 }719720 fn expand_parse(&self) -> proc_macro2::TokenStream {721 let pascal_name = &self.pascal_name;722 let screaming_name = &self.screaming_name;723 if self.has_normal_args {724 let parsers = self725 .args726 .iter()727 .filter(|a| !a.is_special())728 .map(|a| a.expand_parse());729 quote! {730 Self::#screaming_name => return Ok(Some(Self::#pascal_name {731 #(732 #parsers,733 )*734 }))735 }736 } else {737 quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }738 }739 }740741 fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {742 let pascal_name = &self.pascal_name;743 let name = &self.name;744745 let matcher = if self.has_normal_args {746 let names = self747 .args748 .iter()749 .filter(|a| !a.is_special())750 .map(|a| &a.name);751752 quote! {{753 #(754 #names,755 )*756 }}757 } else {758 quote! {}759 };760761 let receiver = match self.mutability {762 Mutability::Mutable | Mutability::View => quote! {self.},763 Mutability::Pure => quote! {Self::},764 };765 let args = self.args.iter().map(|a| a.expand_call_arg());766767 quote! {768 #call_name::#pascal_name #matcher => {769 let result = #receiver #name(770 #(771 #args,772 )*773 )?;774 (&result).to_result()775 }776 }777 }778779 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {780 let pascal_name = &self.pascal_name;781 if let Some(weight) = &self.weight {782 let matcher = if self.has_normal_args {783 let names = self784 .args785 .iter()786 .filter(|a| !a.is_special())787 .map(|a| &a.name);788789 quote! {{790 #(791 #names,792 )*793 }}794 } else {795 quote! {}796 };797 quote! {798 Self::#pascal_name #matcher => (#weight).into()799 }800 } else {801 let matcher = if self.has_normal_args {802 quote! {{..}}803 } else {804 quote! {}805 };806 quote! {807 Self::#pascal_name #matcher => ().into()808 }809 }810 }811812 fn expand_solidity_function(&self) -> proc_macro2::TokenStream {813 let camel_name = &self.camel_name;814 let mutability = match self.mutability {815 Mutability::Mutable => quote! {SolidityMutability::Mutable},816 Mutability::View => quote! { SolidityMutability::View },817 Mutability::Pure => quote! {SolidityMutability::Pure},818 };819 let result = &self.result;820821 let args = self822 .args823 .iter()824 .filter(|a| !a.is_special())825 .map(MethodArg::expand_solidity_argument);826 let docs = &self.docs;827 let selector_str = &self.selector_str;828 let selector = self.selector;829 let is_payable = self.has_value_args;830 quote! {831 SolidityFunction {832 docs: &[#(#docs),*],833 selector_str: #selector_str,834 selector: #selector,835 name: #camel_name,836 mutability: #mutability,837 is_payable: #is_payable,838 args: (839 #(840 #args,841 )*842 ),843 result: <UnnamedArgument<#result>>::default(),844 }845 }846 }847}848849fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {850 if gen.params.is_empty() {851 return quote! {};852 }853 let params = gen.params.iter().map(|p| match p {854 syn::GenericParam::Type(id) => {855 let v = &id.ident;856 quote! {#v}857 }858 syn::GenericParam::Lifetime(lt) => {859 let v = <.lifetime;860 quote! {#v}861 }862 syn::GenericParam::Const(c) => {863 let i = &c.ident;864 quote! {#i}865 }866 });867 quote! { #(#params),* }868}869fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {870 if gen.params.is_empty() {871 return quote! {};872 }873 let list = generics_list(gen);874 quote! { <#list> }875}876fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {877 let list = generics_list(gen);878 if gen.params.len() == 1 {879 quote! {#list}880 } else {881 quote! { (#list) }882 }883}884885pub struct SolidityInterface {886 generics: Generics,887 name: Box<syn::Type>,888 info: InterfaceInfo,889 methods: Vec<Method>,890 docs: Vec<String>,891}892impl SolidityInterface {893 pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {894 let mut methods = Vec::new();895896 for item in &value.items {897 if let ImplItem::Method(method) = item {898 methods.push(Method::try_from(method)?)899 }900 }901 let mut docs = vec![];902 for attr in &value.attrs {903 let ident = parse_ident_from_path(&attr.path, false)?;904 if ident == "doc" {905 let args = attr.parse_meta().unwrap();906 let value = match args {907 Meta::NameValue(MetaNameValue {908 lit: Lit::Str(str), ..909 }) => str.value(),910 _ => unreachable!(),911 };912 docs.push(value);913 }914 }915 Ok(Self {916 generics: value.generics.clone(),917 name: value.self_ty.clone(),918 info,919 methods,920 docs,921 })922 }923 pub fn expand(self) -> proc_macro2::TokenStream {924 let name = self.name;925926 let solidity_name = self.info.name.to_string();927 let call_name = pascal_ident_to_call(&self.info.name);928 let generics = self.generics;929 let gen_ref = generics_reference(&generics);930 let gen_data = generics_data(&generics);931 let gen_where = &generics.where_clause;932933 let call_sub = self934 .info935 .inline_is936 .0937 .iter()938 .chain(self.info.is.0.iter())939 .map(|c| Is::expand_call_def(c, &gen_ref));940 let call_parse = self941 .info942 .inline_is943 .0944 .iter()945 .chain(self.info.is.0.iter())946 .map(|is| Is::expand_parse(is, &gen_ref));947 let call_variants = self948 .info949 .inline_is950 .0951 .iter()952 .chain(self.info.is.0.iter())953 .map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));954 let weight_variants = self955 .info956 .inline_is957 .0958 .iter()959 .chain(self.info.is.0.iter())960 .map(Is::expand_variant_weight);961962 let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);963 let supports_interface = self964 .info965 .is966 .0967 .iter()968 .map(|is| Is::expand_supports_interface(is, &gen_ref));969970 let calls = self.methods.iter().map(Method::expand_call_def);971 let consts = self.methods.iter().map(Method::expand_const);972 let interface_id = self.methods.iter().map(Method::expand_interface_id);973 let parsers = self.methods.iter().map(Method::expand_parse);974 let call_variants_this = self975 .methods976 .iter()977 .map(|m| Method::expand_variant_call(m, &call_name));978 let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);979 let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);980981 // TODO: Inline inline_is982 let solidity_is = self983 .info984 .is985 .0986 .iter()987 .chain(self.info.inline_is.0.iter())988 .map(|is| is.name.to_string());989 let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());990 let solidity_generators = self991 .info992 .is993 .0994 .iter()995 .chain(self.info.inline_is.0.iter())996 .map(|is| Is::expand_generator(is, &gen_ref));997 let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);998999 let docs = &self.docs;10001001 if let Some(expect_selector) = &self.info.expect_selector {1002 if !self.info.inline_is.0.is_empty() {1003 return syn::Error::new(1004 name.span(),1005 "expect_selector is not compatible with inline_is",1006 )1007 .to_compile_error();1008 }1009 let selector = self1010 .methods1011 .iter()1012 .map(|m| m.selector)1013 .fold(0, |a, b| a ^ b);10141015 if *expect_selector != selector {1016 let mut methods = String::new();1017 for meth in self.methods.iter() {1018 write!(methods, "\n- {}", meth.selector_str).expect("write to string");1019 }1020 return syn::Error::new(name.span(), format!("expected selector mismatch, expected {expect_selector:0>8x}, but implementation has {selector:0>8x}{methods}")).to_compile_error();1021 }1022 }1023 // let methods = self.methods.iter().map(Method::solidity_def);10241025 quote! {1026 #[derive(Debug)]1027 #(#[doc = #docs])*1028 pub enum #call_name #gen_ref {1029 /// Inherited method1030 ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),1031 #(1032 #calls,1033 )*1034 #(1035 #call_sub,1036 )*1037 }1038 impl #gen_ref #call_name #gen_ref {1039 #(1040 #consts1041 )*1042 /// Return this call ERC165 selector1043 pub fn interface_id() -> ::evm_coder::types::bytes4 {1044 let mut interface_id = 0;1045 #(#interface_id)*1046 #(#inline_interface_id)*1047 u32::to_be_bytes(interface_id)1048 }1049 /// Generate solidity definitions for methods described in this interface1050 pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {1051 use evm_coder::solidity::*;1052 use core::fmt::Write;1053 let interface = SolidityInterface {1054 docs: &[#(#docs),*],1055 name: #solidity_name,1056 selector: Self::interface_id(),1057 is: &["Dummy", "ERC165", #(1058 #solidity_is,1059 )* #(1060 #solidity_events_is,1061 )* ],1062 functions: (#(1063 #solidity_functions,1064 )*),1065 };10661067 let mut out = ::evm_coder::types::string::new();1068 if #solidity_name.starts_with("Inline") {1069 out.push_str("/// @dev inlined interface\n");1070 }1071 let _ = interface.format(is_impl, &mut out, tc);1072 tc.collect(out);1073 #(1074 #solidity_event_generators1075 )*1076 #(1077 #solidity_generators1078 )*1079 if is_impl {1080 tc.collect("/// @dev common stubs holder\ncontract Dummy {\n\tuint8 dummy;\n\tstring stub_error = \"this contract is implemented in native\";\n}\ncontract ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool) {\n\t\trequire(false, stub_error);\n\t\tinterfaceID;\n\t\treturn true;\n\t}\n}\n".into());1081 } else {1082 tc.collect("/// @dev common stubs holder\ninterface Dummy {\n}\ninterface ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool);\n}\n".into());1083 }1084 }1085 }1086 impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {1087 fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {1088 use ::evm_coder::abi::AbiRead;1089 match method_id {1090 ::evm_coder::ERC165Call::INTERFACE_ID => return Ok(1091 ::evm_coder::ERC165Call::parse(method_id, reader)?1092 .map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))1093 ),1094 #(1095 #parsers,1096 )*1097 _ => {},1098 }1099 #(1100 #call_parse1101 )else*1102 return Ok(None);1103 }1104 }1105 impl #generics #call_name #gen_ref1106 #gen_where1107 {1108 /// Is this contract implements specified ERC165 selector1109 pub fn supports_interface(this: &#name, interface_id: ::evm_coder::types::bytes4) -> bool {1110 interface_id != u32::to_be_bytes(0xffffff) && (1111 interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||1112 interface_id == Self::interface_id()1113 #(1114 || #supports_interface1115 )*1116 )1117 }1118 }1119 impl #generics ::evm_coder::Weighted for #call_name #gen_ref1120 #gen_where1121 {1122 #[allow(unused_variables)]1123 fn weight(&self) -> ::evm_coder::execution::DispatchInfo {1124 match self {1125 #(1126 #weight_variants,1127 )*1128 // TODO: It should be very cheap, but not free1129 Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => ::frame_support::weights::Weight::from_ref_time(100).into(),1130 #(1131 #weight_variants_this,1132 )*1133 }1134 }1135 }1136 impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name1137 #gen_where1138 {1139 #[allow(unreachable_code)] // In case of no inner calls1140 fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {1141 use ::evm_coder::abi::AbiWrite;1142 match c.call {1143 #(1144 #call_variants,1145 )*1146 #call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {1147 let mut writer = ::evm_coder::abi::AbiWriter::default();1148 writer.bool(&<#call_name #gen_ref>::supports_interface(self, interface_id));1149 return Ok(writer.into());1150 }1151 _ => {},1152 }1153 let mut writer = ::evm_coder::abi::AbiWriter::default();1154 match c.call {1155 #(1156 #call_variants_this,1157 )*1158 _ => Err(::evm_coder::execution::Error::from("method is not available").into()),1159 }1160 }1161 }1162 }1163 }1164}1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// This file is part of Unique Network.34// Unique Network is free software: you can redistribute it and/or modify5// it under the terms of the GNU General Public License as published by6// the Free Software Foundation, either version 3 of the License, or7// (at your option) any later version.89// Unique Network is distributed in the hope that it will be useful,10// but WITHOUT ANY WARRANTY; without even the implied warranty of11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the12// GNU General Public License for more details.1314// You should have received a copy of the GNU General Public License15// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.1617#![allow(dead_code)]1819// NOTE: In order to understand this Rust macro better, first read this chapter20// about Procedural Macros in Rust book:21// https://doc.rust-lang.org/reference/procedural-macros.html2223use quote::{quote, ToTokens};24use inflector::cases;25use std::fmt::Write;26use syn::{27 Expr, FnArg, GenericArgument, Generics, Ident, ImplItem, ImplItemMethod, ItemImpl, Lit, Meta,28 MetaNameValue, PatType, PathArguments, ReturnType, Type,29 spanned::Spanned,30 parse::{Parse, ParseStream},31 parenthesized, Token, LitInt, LitStr,32};3334use crate::{35 fn_selector_str, parse_ident_from_pat, parse_ident_from_path, parse_path, parse_path_segment,36 parse_result_ok, pascal_ident_to_call, pascal_ident_to_snake_call, snake_ident_to_pascal,37 snake_ident_to_screaming,38};3940struct Is {41 name: Ident,42 pascal_call_name: Ident,43 snake_call_name: Ident,44 via: Option<(Type, Ident)>,45 condition: Option<Expr>,46}47impl Is {48 fn expand_call_def(&self, gen_ref: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {49 let name = &self.name;50 let pascal_call_name = &self.pascal_call_name;51 quote! {52 #name(#pascal_call_name #gen_ref)53 }54 }5556 fn expand_interface_id(&self) -> proc_macro2::TokenStream {57 let pascal_call_name = &self.pascal_call_name;58 quote! {59 interface_id ^= u32::from_be_bytes(#pascal_call_name::interface_id());60 }61 }6263 fn expand_supports_interface(64 &self,65 generics: &proc_macro2::TokenStream,66 ) -> proc_macro2::TokenStream {67 let pascal_call_name = &self.pascal_call_name;68 let condition = self.condition.as_ref().map(|condition| {69 quote! {70 (#condition) &&71 }72 });73 quote! {74 #condition <#pascal_call_name #generics>::supports_interface(this, interface_id)75 }76 }7778 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {79 let name = &self.name;80 quote! {81 Self::#name(call) => call.weight()82 }83 }8485 fn expand_variant_call(86 &self,87 call_name: &proc_macro2::Ident,88 generics: &proc_macro2::TokenStream,89 ) -> proc_macro2::TokenStream {90 let name = &self.name;91 let pascal_call_name = &self.pascal_call_name;92 let via_typ = self93 .via94 .as_ref()95 .map(|(t, _)| quote! {#t})96 .unwrap_or_else(|| quote! {Self});97 let via_map = self98 .via99 .as_ref()100 .map(|(_, i)| quote! {.#i()})101 .unwrap_or_default();102 let condition = self.condition.as_ref().map(|condition| {103 quote! {104 if ({let this = &self; (#condition)})105 }106 });107 quote! {108 #call_name::#name(call) #condition => return <#via_typ as ::evm_coder::Callable<#pascal_call_name #generics>>::call(self #via_map, Msg {109 call,110 caller: c.caller,111 value: c.value,112 })113 }114 }115116 fn expand_parse(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {117 let name = &self.name;118 let pascal_call_name = &self.pascal_call_name;119 quote! {120 if let Some(parsed_call) = <#pascal_call_name #generics>::parse(method_id, reader)? {121 return Ok(Some(Self::#name(parsed_call)))122 }123 }124 }125126 fn expand_generator(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {127 let pascal_call_name = &self.pascal_call_name;128 quote! {129 <#pascal_call_name #generics>::generate_solidity_interface(tc, is_impl);130 }131 }132133 fn expand_event_generator(&self) -> proc_macro2::TokenStream {134 let name = &self.name;135 quote! {136 #name::generate_solidity_interface(tc, is_impl);137 }138 }139}140141#[derive(Default)]142struct IsList(Vec<Is>);143impl Parse for IsList {144 fn parse(input: ParseStream) -> syn::Result<Self> {145 let mut out = vec![];146 loop {147 if input.is_empty() {148 break;149 }150 let name = input.parse::<Ident>()?;151 let lookahead = input.lookahead1();152153 let mut condition: Option<Expr> = None;154 let mut via: Option<(Type, Ident)> = None;155156 if lookahead.peek(syn::token::Paren) {157 let contents;158 parenthesized!(contents in input);159 let input = contents;160161 while !input.is_empty() {162 let lookahead = input.lookahead1();163 if lookahead.peek(Token![if]) {164 input.parse::<Token![if]>()?;165 let contents;166 parenthesized!(contents in input);167 let contents = contents.parse::<Expr>()?;168169 if condition.replace(contents).is_some() {170 return Err(syn::Error::new(input.span(), "condition is already set"));171 }172 } else if lookahead.peek(kw::via) {173 input.parse::<kw::via>()?;174 let contents;175 parenthesized!(contents in input);176177 let method = contents.parse::<Ident>()?;178 contents.parse::<kw::returns>()?;179 let ty = contents.parse::<Type>()?;180181 if via.replace((ty, method)).is_some() {182 return Err(syn::Error::new(input.span(), "via is already set"));183 }184 } else {185 return Err(lookahead.error());186 }187188 if input.peek(Token![,]) {189 input.parse::<Token![,]>()?;190 } else if !input.is_empty() {191 return Err(syn::Error::new(input.span(), "expected end"));192 }193 }194 } else if lookahead.peek(Token![,]) || input.is_empty() {195 // Pass196 } else {197 return Err(lookahead.error());198 };199 out.push(Is {200 pascal_call_name: pascal_ident_to_call(&name),201 snake_call_name: pascal_ident_to_snake_call(&name),202 name,203 via,204 condition,205 });206 if input.peek(Token![,]) {207 input.parse::<Token![,]>()?;208 continue;209 } else {210 break;211 }212 }213 Ok(Self(out))214 }215}216217pub struct InterfaceInfo {218 name: Ident,219 is: IsList,220 inline_is: IsList,221 events: IsList,222 expect_selector: Option<u32>,223}224impl Parse for InterfaceInfo {225 fn parse(input: ParseStream) -> syn::Result<Self> {226 let mut name = None;227 let mut is = None;228 let mut inline_is = None;229 let mut events = None;230 let mut expect_selector = None;231 // TODO: create proc-macro to optimize proc-macro boilerplate? :D232 loop {233 let lookahead = input.lookahead1();234 if lookahead.peek(kw::name) {235 let k = input.parse::<kw::name>()?;236 input.parse::<Token![=]>()?;237 if name.replace(input.parse::<Ident>()?).is_some() {238 return Err(syn::Error::new(k.span(), "name is already set"));239 }240 } else if lookahead.peek(kw::is) {241 let k = input.parse::<kw::is>()?;242 let contents;243 parenthesized!(contents in input);244 if is.replace(contents.parse::<IsList>()?).is_some() {245 return Err(syn::Error::new(k.span(), "is is already set"));246 }247 } else if lookahead.peek(kw::inline_is) {248 let k = input.parse::<kw::inline_is>()?;249 let contents;250 parenthesized!(contents in input);251 if inline_is.replace(contents.parse::<IsList>()?).is_some() {252 return Err(syn::Error::new(k.span(), "inline_is is already set"));253 }254 } else if lookahead.peek(kw::events) {255 let k = input.parse::<kw::events>()?;256 let contents;257 parenthesized!(contents in input);258 if events.replace(contents.parse::<IsList>()?).is_some() {259 return Err(syn::Error::new(k.span(), "events is already set"));260 }261 } else if lookahead.peek(kw::expect_selector) {262 let k = input.parse::<kw::expect_selector>()?;263 input.parse::<Token![=]>()?;264 let value = input.parse::<LitInt>()?;265 if expect_selector266 .replace(value.base10_parse::<u32>()?)267 .is_some()268 {269 return Err(syn::Error::new(k.span(), "expect_selector is already set"));270 }271 } else if input.is_empty() {272 break;273 } else {274 return Err(lookahead.error());275 }276 if input.peek(Token![,]) {277 input.parse::<Token![,]>()?;278 } else {279 break;280 }281 }282 Ok(Self {283 name: name.ok_or_else(|| syn::Error::new(input.span(), "missing name"))?,284 is: is.unwrap_or_default(),285 inline_is: inline_is.unwrap_or_default(),286 events: events.unwrap_or_default(),287 expect_selector,288 })289 }290}291292struct MethodInfo {293 rename_selector: Option<String>,294 hide: bool,295}296impl Parse for MethodInfo {297 fn parse(input: ParseStream) -> syn::Result<Self> {298 let mut rename_selector = None;299 let mut hide = false;300 while !input.is_empty() {301 let lookahead = input.lookahead1();302 if lookahead.peek(kw::rename_selector) {303 let k = input.parse::<kw::rename_selector>()?;304 input.parse::<Token![=]>()?;305 if rename_selector306 .replace(input.parse::<LitStr>()?.value())307 .is_some()308 {309 return Err(syn::Error::new(k.span(), "rename_selector is already set"));310 }311 } else if lookahead.peek(kw::hide) {312 input.parse::<kw::hide>()?;313 hide = true;314 } else {315 return Err(lookahead.error());316 }317318 if input.peek(Token![,]) {319 input.parse::<Token![,]>()?;320 } else if !input.is_empty() {321 return Err(syn::Error::new(input.span(), "expected end"));322 }323 }324 Ok(Self {325 rename_selector,326 hide,327 })328 }329}330331enum AbiType {332 // type333 Plain(Ident),334 // (type1,type2)335 Tuple(Vec<AbiType>),336 // type[]337 Vec(Box<AbiType>),338 // type[20]339 Array(Box<AbiType>, usize),340}341impl AbiType {342 fn try_from(value: &Type) -> syn::Result<Self> {343 let value = Self::try_maybe_special_from(value)?;344 if value.is_special() {345 return Err(syn::Error::new(value.span(), "unexpected special type"));346 }347 Ok(value)348 }349 fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {350 match value {351 Type::Array(arr) => {352 let wrapped = AbiType::try_from(&arr.elem)?;353 match &arr.len {354 Expr::Lit(l) => match &l.lit {355 Lit::Int(i) => {356 let num = i.base10_parse::<usize>()?;357 Ok(AbiType::Array(Box::new(wrapped), num as usize))358 }359 _ => Err(syn::Error::new(arr.len.span(), "should be int literal")),360 },361 _ => Err(syn::Error::new(arr.len.span(), "should be literal")),362 }363 }364 Type::Path(_) => {365 let path = parse_path(value)?;366 let segment = parse_path_segment(path)?;367 if segment.ident == "Vec" {368 let args = match &segment.arguments {369 PathArguments::AngleBracketed(e) => e,370 _ => {371 return Err(syn::Error::new(372 segment.arguments.span(),373 "missing Vec generic",374 ))375 }376 };377 let args = &args.args;378 if args.len() != 1 {379 return Err(syn::Error::new(380 args.span(),381 "expected only one generic for vec",382 ));383 }384 let arg = args.first().expect("first arg");385386 let ty = match arg {387 GenericArgument::Type(ty) => ty,388 _ => {389 return Err(syn::Error::new(390 arg.span(),391 "expected first generic to be type",392 ))393 }394 };395396 let wrapped = AbiType::try_from(ty)?;397 Ok(Self::Vec(Box::new(wrapped)))398 } else {399 if !segment.arguments.is_empty() {400 return Err(syn::Error::new(401 segment.arguments.span(),402 "unexpected generic arguments for non-vec type",403 ));404 }405 Ok(Self::Plain(segment.ident.clone()))406 }407 }408 Type::Tuple(t) => {409 let mut out = Vec::with_capacity(t.elems.len());410 for el in t.elems.iter() {411 out.push(AbiType::try_from(el)?)412 }413 Ok(Self::Tuple(out))414 }415 _ => Err(syn::Error::new(416 value.span(),417 "unexpected type, only arrays, plain types and tuples are supported",418 )),419 }420 }421 fn is_value(&self) -> bool {422 matches!(self, Self::Plain(v) if v == "value")423 }424 fn is_caller(&self) -> bool {425 matches!(self, Self::Plain(v) if v == "caller")426 }427 fn is_special(&self) -> bool {428 self.is_caller() || self.is_value()429 }430 fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {431 match self {432 AbiType::Plain(t) => {433 write!(buf, "{}", t)434 }435 AbiType::Tuple(t) => {436 write!(buf, "(")?;437 for (i, t) in t.iter().enumerate() {438 if i != 0 {439 write!(buf, ",")?;440 }441 t.selector_ty_buf(buf)?;442 }443 write!(buf, ")")444 }445 AbiType::Vec(v) => {446 v.selector_ty_buf(buf)?;447 write!(buf, "[]")448 }449 AbiType::Array(v, len) => {450 v.selector_ty_buf(buf)?;451 write!(buf, "[{}]", len)452 }453 }454 }455 fn selector_ty(&self) -> String {456 let mut out = String::new();457 self.selector_ty_buf(&mut out).expect("no fmt error");458 out459 }460}461impl ToTokens for AbiType {462 fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {463 match self {464 AbiType::Plain(t) => tokens.extend(quote! {#t}),465 AbiType::Tuple(t) => {466 tokens.extend(quote! {(467 #(#t),*468 )});469 }470 AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),471 AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),472 }473 }474}475476struct MethodArg {477 name: Ident,478 camel_name: String,479 ty: AbiType,480}481impl MethodArg {482 fn try_from(value: &PatType) -> syn::Result<Self> {483 let name = parse_ident_from_pat(&value.pat)?.clone();484 Ok(Self {485 camel_name: cases::camelcase::to_camel_case(&name.to_string()),486 name,487 ty: AbiType::try_maybe_special_from(&value.ty)?,488 })489 }490 fn is_value(&self) -> bool {491 self.ty.is_value()492 }493 fn is_caller(&self) -> bool {494 self.ty.is_caller()495 }496 fn is_special(&self) -> bool {497 self.ty.is_special()498 }499 fn selector_ty(&self) -> String {500 assert!(!self.is_special());501 self.ty.selector_ty()502 }503504 fn expand_call_def(&self) -> proc_macro2::TokenStream {505 assert!(!self.is_special());506 let name = &self.name;507 let ty = &self.ty;508509 quote! {510 #name: #ty511 }512 }513514 fn expand_parse(&self) -> proc_macro2::TokenStream {515 assert!(!self.is_special());516 let name = &self.name;517 quote! {518 #name: reader.abi_read()?519 }520 }521522 fn expand_call_arg(&self) -> proc_macro2::TokenStream {523 if self.is_value() {524 quote! {525 c.value.clone()526 }527 } else if self.is_caller() {528 quote! {529 c.caller.clone()530 }531 } else {532 let name = &self.name;533 quote! {534 #name535 }536 }537 }538539 fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {540 let camel_name = &self.camel_name.to_string();541 let ty = &self.ty;542 quote! {543 <NamedArgument<#ty>>::new(#camel_name)544 }545 }546}547548#[derive(PartialEq)]549enum Mutability {550 Mutable,551 View,552 Pure,553}554555/// Group all keywords for this macro. Usage example:556/// #[solidity_interface(name = "B", inline_is(A))]557mod kw {558 syn::custom_keyword!(weight);559560 syn::custom_keyword!(via);561 syn::custom_keyword!(returns);562 syn::custom_keyword!(name);563 syn::custom_keyword!(is);564 syn::custom_keyword!(inline_is);565 syn::custom_keyword!(events);566 syn::custom_keyword!(expect_selector);567568 syn::custom_keyword!(rename_selector);569 syn::custom_keyword!(hide);570}571572/// Rust methods are parsed into this structure when Solidity code is generated573struct Method {574 name: Ident,575 camel_name: String,576 pascal_name: Ident,577 screaming_name: Ident,578 selector_str: String,579 selector: u32,580 hide: bool,581 args: Vec<MethodArg>,582 has_normal_args: bool,583 has_value_args: bool,584 mutability: Mutability,585 result: Type,586 weight: Option<Expr>,587 docs: Vec<String>,588}589impl Method {590 fn try_from(value: &ImplItemMethod) -> syn::Result<Self> {591 let mut info = MethodInfo {592 rename_selector: None,593 hide: false,594 };595 let mut docs = Vec::new();596 let mut weight = None;597 for attr in &value.attrs {598 let ident = parse_ident_from_path(&attr.path, false)?;599 if ident == "solidity" {600 info = attr.parse_args::<MethodInfo>()?;601 } else if ident == "doc" {602 let args = attr.parse_meta().unwrap();603 let value = match args {604 Meta::NameValue(MetaNameValue {605 lit: Lit::Str(str), ..606 }) => str.value(),607 _ => unreachable!(),608 };609 docs.push(value);610 } else if ident == "weight" {611 weight = Some(attr.parse_args::<Expr>()?);612 }613 }614 let ident = &value.sig.ident;615 let ident_str = ident.to_string();616 if !cases::snakecase::is_snake_case(&ident_str) {617 return Err(syn::Error::new(ident.span(), "method name should be snake_cased\nif alternative solidity name needs to be set - use #[solidity] attribute"));618 }619620 let mut mutability = Mutability::Pure;621622 if let Some(FnArg::Receiver(receiver)) = value623 .sig624 .inputs625 .iter()626 .find(|arg| matches!(arg, FnArg::Receiver(_)))627 {628 if receiver.reference.is_none() {629 return Err(syn::Error::new(630 receiver.span(),631 "receiver should be by ref",632 ));633 }634 if receiver.mutability.is_some() {635 mutability = Mutability::Mutable;636 } else {637 mutability = Mutability::View;638 }639 }640 let mut args = Vec::new();641 for typ in value642 .sig643 .inputs644 .iter()645 .filter(|arg| matches!(arg, FnArg::Typed(_)))646 {647 let typ = match typ {648 FnArg::Typed(typ) => typ,649 _ => unreachable!(),650 };651 args.push(MethodArg::try_from(typ)?);652 }653654 if mutability != Mutability::Mutable && args.iter().any(|arg| arg.is_value()) {655 return Err(syn::Error::new(656 args.iter().find(|arg| arg.is_value()).unwrap().ty.span(),657 "payable function should be mutable",658 ));659 }660661 let result = match &value.sig.output {662 ReturnType::Type(_, ty) => ty,663 _ => return Err(syn::Error::new(value.sig.output.span(), "interface method should return Result<value>\nif there is no value to return - specify void (which is alias to unit)")),664 };665 let result = parse_result_ok(result)?;666667 let camel_name = info668 .rename_selector669 .unwrap_or_else(|| cases::camelcase::to_camel_case(&ident.to_string()));670 let mut selector_str = camel_name.clone();671 selector_str.push('(');672 let mut has_normal_args = false;673 for (i, arg) in args.iter().filter(|arg| !arg.is_special()).enumerate() {674 if i != 0 {675 selector_str.push(',');676 }677 write!(selector_str, "{}", arg.selector_ty()).unwrap();678 has_normal_args = true;679 }680 let has_value_args = args.iter().any(|a| a.is_value());681 selector_str.push(')');682 let selector = fn_selector_str(&selector_str);683684 Ok(Self {685 name: ident.clone(),686 camel_name,687 pascal_name: snake_ident_to_pascal(ident),688 screaming_name: snake_ident_to_screaming(ident),689 selector_str,690 selector,691 hide: info.hide,692 args,693 has_normal_args,694 has_value_args,695 mutability,696 result: result.clone(),697 weight,698 docs,699 })700 }701 fn expand_call_def(&self) -> proc_macro2::TokenStream {702 let defs = self703 .args704 .iter()705 .filter(|a| !a.is_special())706 .map(|a| a.expand_call_def());707 let pascal_name = &self.pascal_name;708 let docs = &self.docs;709710 if self.has_normal_args {711 quote! {712 #(#[doc = #docs])*713 #[allow(missing_docs)]714 #pascal_name {715 #(716 #defs,717 )*718 }719 }720 } else {721 quote! {#pascal_name}722 }723 }724725 fn expand_const(&self) -> proc_macro2::TokenStream {726 let screaming_name = &self.screaming_name;727 let selector = u32::to_be_bytes(self.selector);728 let selector_str = &self.selector_str;729 quote! {730 #[doc = #selector_str]731 const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];732 }733 }734735 fn expand_interface_id(&self) -> proc_macro2::TokenStream {736 let screaming_name = &self.screaming_name;737 quote! {738 interface_id ^= u32::from_be_bytes(Self::#screaming_name);739 }740 }741742 fn expand_parse(&self) -> proc_macro2::TokenStream {743 let pascal_name = &self.pascal_name;744 let screaming_name = &self.screaming_name;745 if self.has_normal_args {746 let parsers = self747 .args748 .iter()749 .filter(|a| !a.is_special())750 .map(|a| a.expand_parse());751 quote! {752 Self::#screaming_name => return Ok(Some(Self::#pascal_name {753 #(754 #parsers,755 )*756 }))757 }758 } else {759 quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }760 }761 }762763 fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {764 let pascal_name = &self.pascal_name;765 let name = &self.name;766767 let matcher = if self.has_normal_args {768 let names = self769 .args770 .iter()771 .filter(|a| !a.is_special())772 .map(|a| &a.name);773774 quote! {{775 #(776 #names,777 )*778 }}779 } else {780 quote! {}781 };782783 let receiver = match self.mutability {784 Mutability::Mutable | Mutability::View => quote! {self.},785 Mutability::Pure => quote! {Self::},786 };787 let args = self.args.iter().map(|a| a.expand_call_arg());788789 quote! {790 #call_name::#pascal_name #matcher => {791 let result = #receiver #name(792 #(793 #args,794 )*795 )?;796 (&result).to_result()797 }798 }799 }800801 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {802 let pascal_name = &self.pascal_name;803 if let Some(weight) = &self.weight {804 let matcher = if self.has_normal_args {805 let names = self806 .args807 .iter()808 .filter(|a| !a.is_special())809 .map(|a| &a.name);810811 quote! {{812 #(813 #names,814 )*815 }}816 } else {817 quote! {}818 };819 quote! {820 Self::#pascal_name #matcher => (#weight).into()821 }822 } else {823 let matcher = if self.has_normal_args {824 quote! {{..}}825 } else {826 quote! {}827 };828 quote! {829 Self::#pascal_name #matcher => ().into()830 }831 }832 }833834 fn expand_solidity_function(&self) -> proc_macro2::TokenStream {835 let camel_name = &self.camel_name;836 let mutability = match self.mutability {837 Mutability::Mutable => quote! {SolidityMutability::Mutable},838 Mutability::View => quote! { SolidityMutability::View },839 Mutability::Pure => quote! {SolidityMutability::Pure},840 };841 let result = &self.result;842843 let args = self844 .args845 .iter()846 .filter(|a| !a.is_special())847 .map(MethodArg::expand_solidity_argument);848 let docs = &self.docs;849 let selector_str = &self.selector_str;850 let selector = self.selector;851 let hide = self.hide;852 let is_payable = self.has_value_args;853 quote! {854 SolidityFunction {855 docs: &[#(#docs),*],856 selector_str: #selector_str,857 selector: #selector,858 hide: #hide,859 name: #camel_name,860 mutability: #mutability,861 is_payable: #is_payable,862 args: (863 #(864 #args,865 )*866 ),867 result: <UnnamedArgument<#result>>::default(),868 }869 }870 }871}872873fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {874 if gen.params.is_empty() {875 return quote! {};876 }877 let params = gen.params.iter().map(|p| match p {878 syn::GenericParam::Type(id) => {879 let v = &id.ident;880 quote! {#v}881 }882 syn::GenericParam::Lifetime(lt) => {883 let v = <.lifetime;884 quote! {#v}885 }886 syn::GenericParam::Const(c) => {887 let i = &c.ident;888 quote! {#i}889 }890 });891 quote! { #(#params),* }892}893fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {894 if gen.params.is_empty() {895 return quote! {};896 }897 let list = generics_list(gen);898 quote! { <#list> }899}900fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {901 let list = generics_list(gen);902 if gen.params.len() == 1 {903 quote! {#list}904 } else {905 quote! { (#list) }906 }907}908909pub struct SolidityInterface {910 generics: Generics,911 name: Box<syn::Type>,912 info: InterfaceInfo,913 methods: Vec<Method>,914 docs: Vec<String>,915}916impl SolidityInterface {917 pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {918 let mut methods = Vec::new();919920 for item in &value.items {921 if let ImplItem::Method(method) = item {922 methods.push(Method::try_from(method)?)923 }924 }925 let mut docs = vec![];926 for attr in &value.attrs {927 let ident = parse_ident_from_path(&attr.path, false)?;928 if ident == "doc" {929 let args = attr.parse_meta().unwrap();930 let value = match args {931 Meta::NameValue(MetaNameValue {932 lit: Lit::Str(str), ..933 }) => str.value(),934 _ => unreachable!(),935 };936 docs.push(value);937 }938 }939 Ok(Self {940 generics: value.generics.clone(),941 name: value.self_ty.clone(),942 info,943 methods,944 docs,945 })946 }947 pub fn expand(self) -> proc_macro2::TokenStream {948 let name = self.name;949950 let solidity_name = self.info.name.to_string();951 let call_name = pascal_ident_to_call(&self.info.name);952 let generics = self.generics;953 let gen_ref = generics_reference(&generics);954 let gen_data = generics_data(&generics);955 let gen_where = &generics.where_clause;956957 let call_sub = self958 .info959 .inline_is960 .0961 .iter()962 .chain(self.info.is.0.iter())963 .map(|c| Is::expand_call_def(c, &gen_ref));964 let call_parse = self965 .info966 .inline_is967 .0968 .iter()969 .chain(self.info.is.0.iter())970 .map(|is| Is::expand_parse(is, &gen_ref));971 let call_variants = self972 .info973 .inline_is974 .0975 .iter()976 .chain(self.info.is.0.iter())977 .map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));978 let weight_variants = self979 .info980 .inline_is981 .0982 .iter()983 .chain(self.info.is.0.iter())984 .map(Is::expand_variant_weight);985986 let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);987 let supports_interface = self988 .info989 .is990 .0991 .iter()992 .map(|is| Is::expand_supports_interface(is, &gen_ref));993994 let calls = self.methods.iter().map(Method::expand_call_def);995 let consts = self.methods.iter().map(Method::expand_const);996 let interface_id = self.methods.iter().map(Method::expand_interface_id);997 let parsers = self.methods.iter().map(Method::expand_parse);998 let call_variants_this = self999 .methods1000 .iter()1001 .map(|m| Method::expand_variant_call(m, &call_name));1002 let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);1003 let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);10041005 // TODO: Inline inline_is1006 let solidity_is = self1007 .info1008 .is1009 .01010 .iter()1011 .chain(self.info.inline_is.0.iter())1012 .map(|is| is.name.to_string());1013 let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());1014 let solidity_generators = self1015 .info1016 .is1017 .01018 .iter()1019 .chain(self.info.inline_is.0.iter())1020 .map(|is| Is::expand_generator(is, &gen_ref));1021 let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);10221023 let docs = &self.docs;10241025 if let Some(expect_selector) = &self.info.expect_selector {1026 if !self.info.inline_is.0.is_empty() {1027 return syn::Error::new(1028 name.span(),1029 "expect_selector is not compatible with inline_is",1030 )1031 .to_compile_error();1032 }1033 let selector = self1034 .methods1035 .iter()1036 .map(|m| m.selector)1037 .fold(0, |a, b| a ^ b);10381039 if *expect_selector != selector {1040 let mut methods = String::new();1041 for meth in self.methods.iter() {1042 write!(methods, "\n- {}", meth.selector_str).expect("write to string");1043 }1044 return syn::Error::new(name.span(), format!("expected selector mismatch, expected {expect_selector:0>8x}, but implementation has {selector:0>8x}{methods}")).to_compile_error();1045 }1046 }1047 // let methods = self.methods.iter().map(Method::solidity_def);10481049 quote! {1050 #[derive(Debug)]1051 #(#[doc = #docs])*1052 pub enum #call_name #gen_ref {1053 /// Inherited method1054 ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),1055 #(1056 #calls,1057 )*1058 #(1059 #call_sub,1060 )*1061 }1062 impl #gen_ref #call_name #gen_ref {1063 #(1064 #consts1065 )*1066 /// Return this call ERC165 selector1067 pub fn interface_id() -> ::evm_coder::types::bytes4 {1068 let mut interface_id = 0;1069 #(#interface_id)*1070 #(#inline_interface_id)*1071 u32::to_be_bytes(interface_id)1072 }1073 /// Generate solidity definitions for methods described in this interface1074 pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {1075 use evm_coder::solidity::*;1076 use core::fmt::Write;1077 let interface = SolidityInterface {1078 docs: &[#(#docs),*],1079 name: #solidity_name,1080 selector: Self::interface_id(),1081 is: &["Dummy", "ERC165", #(1082 #solidity_is,1083 )* #(1084 #solidity_events_is,1085 )* ],1086 functions: (#(1087 #solidity_functions,1088 )*),1089 };10901091 let mut out = ::evm_coder::types::string::new();1092 if #solidity_name.starts_with("Inline") {1093 out.push_str("/// @dev inlined interface\n");1094 }1095 let _ = interface.format(is_impl, &mut out, tc);1096 tc.collect(out);1097 #(1098 #solidity_event_generators1099 )*1100 #(1101 #solidity_generators1102 )*1103 if is_impl {1104 tc.collect("/// @dev common stubs holder\ncontract Dummy {\n\tuint8 dummy;\n\tstring stub_error = \"this contract is implemented in native\";\n}\ncontract ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool) {\n\t\trequire(false, stub_error);\n\t\tinterfaceID;\n\t\treturn true;\n\t}\n}\n".into());1105 } else {1106 tc.collect("/// @dev common stubs holder\ninterface Dummy {\n}\ninterface ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool);\n}\n".into());1107 }1108 }1109 }1110 impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {1111 fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {1112 use ::evm_coder::abi::AbiRead;1113 match method_id {1114 ::evm_coder::ERC165Call::INTERFACE_ID => return Ok(1115 ::evm_coder::ERC165Call::parse(method_id, reader)?1116 .map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))1117 ),1118 #(1119 #parsers,1120 )*1121 _ => {},1122 }1123 #(1124 #call_parse1125 )else*1126 return Ok(None);1127 }1128 }1129 impl #generics #call_name #gen_ref1130 #gen_where1131 {1132 /// Is this contract implements specified ERC165 selector1133 pub fn supports_interface(this: &#name, interface_id: ::evm_coder::types::bytes4) -> bool {1134 interface_id != u32::to_be_bytes(0xffffff) && (1135 interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||1136 interface_id == Self::interface_id()1137 #(1138 || #supports_interface1139 )*1140 )1141 }1142 }1143 impl #generics ::evm_coder::Weighted for #call_name #gen_ref1144 #gen_where1145 {1146 #[allow(unused_variables)]1147 fn weight(&self) -> ::evm_coder::execution::DispatchInfo {1148 match self {1149 #(1150 #weight_variants,1151 )*1152 // TODO: It should be very cheap, but not free1153 Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => ::frame_support::weights::Weight::from_ref_time(100).into(),1154 #(1155 #weight_variants_this,1156 )*1157 }1158 }1159 }1160 impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name1161 #gen_where1162 {1163 #[allow(unreachable_code)] // In case of no inner calls1164 fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {1165 use ::evm_coder::abi::AbiWrite;1166 match c.call {1167 #(1168 #call_variants,1169 )*1170 #call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {1171 let mut writer = ::evm_coder::abi::AbiWriter::default();1172 writer.bool(&<#call_name #gen_ref>::supports_interface(self, interface_id));1173 return Ok(writer.into());1174 }1175 _ => {},1176 }1177 let mut writer = ::evm_coder::abi::AbiWriter::default();1178 match c.call {1179 #(1180 #call_variants_this,1181 )*1182 _ => Err(::evm_coder::execution::Error::from("method is not available").into()),1183 }1184 }1185 }1186 }1187 }1188}crates/evm-coder/src/solidity.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity.rs
+++ b/crates/evm-coder/src/solidity.rs
@@ -418,6 +418,7 @@
pub docs: &'static [&'static str],
pub selector_str: &'static str,
pub selector: u32,
+ pub hide: bool,
pub name: &'static str,
pub args: A,
pub result: R,
@@ -431,16 +432,21 @@
writer: &mut impl fmt::Write,
tc: &TypeCollector,
) -> fmt::Result {
+ let hide_comment = self.hide.then(|| "// ").unwrap_or("");
for doc in self.docs {
- writeln!(writer, "\t///{}", doc)?;
+ writeln!(writer, "\t{hide_comment}///{}", doc)?;
}
writeln!(
writer,
- "\t/// @dev EVM selector for this function is: 0x{:0>8x},",
+ "\t{hide_comment}/// @dev EVM selector for this function is: 0x{:0>8x},",
self.selector
)?;
- writeln!(writer, "\t/// or in textual repr: {}", self.selector_str)?;
- write!(writer, "\tfunction {}(", self.name)?;
+ writeln!(
+ writer,
+ "\t{hide_comment}/// or in textual repr: {}",
+ self.selector_str
+ )?;
+ write!(writer, "\t{hide_comment}function {}(", self.name)?;
self.args.solidity_name(writer, tc)?;
write!(writer, ")")?;
if is_impl {
@@ -463,22 +469,25 @@
}
if is_impl {
writeln!(writer, " {{")?;
- writeln!(writer, "\t\trequire(false, stub_error);")?;
+ writeln!(writer, "\t{hide_comment}\trequire(false, stub_error);")?;
self.args.solidity_get(writer)?;
match &self.mutability {
SolidityMutability::Pure => {}
- SolidityMutability::View => writeln!(writer, "\t\tdummy;")?,
- SolidityMutability::Mutable => writeln!(writer, "\t\tdummy = 0;")?,
+ SolidityMutability::View => writeln!(writer, "\t{hide_comment}\tdummy;")?,
+ SolidityMutability::Mutable => writeln!(writer, "\t{hide_comment}\tdummy = 0;")?,
}
if !self.result.is_empty() {
- write!(writer, "\t\treturn ")?;
+ write!(writer, "\t{hide_comment}\treturn ")?;
self.result.solidity_default(writer, tc)?;
writeln!(writer, ";")?;
}
- writeln!(writer, "\t}}")?;
+ writeln!(writer, "\t{hide_comment}}}")?;
} else {
writeln!(writer, ";")?;
}
+ if self.hide {
+ writeln!(writer, "// FORMATTING: FORCE NEWLINE")?;
+ }
Ok(())
}
}