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

difftreelog

fix use while instead of loop

Daniel Shiposha2022-09-19parent: #4cc1096.patch.diff
in: master

1 file changed

modifiedcrates/evm-coder/procedural/src/solidity_interface.rsdiffbeforeafterboth
before · crates/evm-coder/procedural/src/solidity_interface.rs
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				loop {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::<Token![,]>()?;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 if input.is_empty() {185						break;186					} else {187						return Err(lookahead.error());188					}189190					if input.peek(Token![,]) {191						input.parse::<Token![,]>()?;192					} else {193						break;194					}195				}196			} else if lookahead.peek(Token![,]) || input.is_empty() {197				// Pass198			} else {199				return Err(lookahead.error());200			};201			out.push(Is {202				pascal_call_name: pascal_ident_to_call(&name),203				snake_call_name: pascal_ident_to_snake_call(&name),204				name,205				via,206				condition,207			});208			if input.peek(Token![,]) {209				input.parse::<Token![,]>()?;210				continue;211			} else {212				break;213			}214		}215		Ok(Self(out))216	}217}218219pub struct InterfaceInfo {220	name: Ident,221	is: IsList,222	inline_is: IsList,223	events: IsList,224	expect_selector: Option<u32>,225}226impl Parse for InterfaceInfo {227	fn parse(input: ParseStream) -> syn::Result<Self> {228		let mut name = None;229		let mut is = None;230		let mut inline_is = None;231		let mut events = None;232		let mut expect_selector = None;233		// TODO: create proc-macro to optimize proc-macro boilerplate? :D234		loop {235			let lookahead = input.lookahead1();236			if lookahead.peek(kw::name) {237				let k = input.parse::<kw::name>()?;238				input.parse::<Token![=]>()?;239				if name.replace(input.parse::<Ident>()?).is_some() {240					return Err(syn::Error::new(k.span(), "name is already set"));241				}242			} else if lookahead.peek(kw::is) {243				let k = input.parse::<kw::is>()?;244				let contents;245				parenthesized!(contents in input);246				if is.replace(contents.parse::<IsList>()?).is_some() {247					return Err(syn::Error::new(k.span(), "is is already set"));248				}249			} else if lookahead.peek(kw::inline_is) {250				let k = input.parse::<kw::inline_is>()?;251				let contents;252				parenthesized!(contents in input);253				if inline_is.replace(contents.parse::<IsList>()?).is_some() {254					return Err(syn::Error::new(k.span(), "inline_is is already set"));255				}256			} else if lookahead.peek(kw::events) {257				let k = input.parse::<kw::events>()?;258				let contents;259				parenthesized!(contents in input);260				if events.replace(contents.parse::<IsList>()?).is_some() {261					return Err(syn::Error::new(k.span(), "events is already set"));262				}263			} else if lookahead.peek(kw::expect_selector) {264				let k = input.parse::<kw::expect_selector>()?;265				input.parse::<Token![=]>()?;266				let value = input.parse::<LitInt>()?;267				if expect_selector268					.replace(value.base10_parse::<u32>()?)269					.is_some()270				{271					return Err(syn::Error::new(k.span(), "expect_selector is already set"));272				}273			} else if input.is_empty() {274				break;275			} else {276				return Err(lookahead.error());277			}278			if input.peek(Token![,]) {279				input.parse::<Token![,]>()?;280			} else {281				break;282			}283		}284		Ok(Self {285			name: name.ok_or_else(|| syn::Error::new(input.span(), "missing name"))?,286			is: is.unwrap_or_default(),287			inline_is: inline_is.unwrap_or_default(),288			events: events.unwrap_or_default(),289			expect_selector,290		})291	}292}293294struct MethodInfo {295	rename_selector: Option<String>,296}297impl Parse for MethodInfo {298	fn parse(input: ParseStream) -> syn::Result<Self> {299		let mut rename_selector = None;300		let lookahead = input.lookahead1();301		if lookahead.peek(kw::rename_selector) {302			let k = input.parse::<kw::rename_selector>()?;303			input.parse::<Token![=]>()?;304			if rename_selector305				.replace(input.parse::<LitStr>()?.value())306				.is_some()307			{308				return Err(syn::Error::new(k.span(), "rename_selector is already set"));309			}310		}311		Ok(Self { rename_selector })312	}313}314315enum AbiType {316	// type317	Plain(Ident),318	// (type1,type2)319	Tuple(Vec<AbiType>),320	// type[]321	Vec(Box<AbiType>),322	// type[20]323	Array(Box<AbiType>, usize),324}325impl AbiType {326	fn try_from(value: &Type) -> syn::Result<Self> {327		let value = Self::try_maybe_special_from(value)?;328		if value.is_special() {329			return Err(syn::Error::new(value.span(), "unexpected special type"));330		}331		Ok(value)332	}333	fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {334		match value {335			Type::Array(arr) => {336				let wrapped = AbiType::try_from(&arr.elem)?;337				match &arr.len {338					Expr::Lit(l) => match &l.lit {339						Lit::Int(i) => {340							let num = i.base10_parse::<usize>()?;341							Ok(AbiType::Array(Box::new(wrapped), num as usize))342						}343						_ => Err(syn::Error::new(arr.len.span(), "should be int literal")),344					},345					_ => Err(syn::Error::new(arr.len.span(), "should be literal")),346				}347			}348			Type::Path(_) => {349				let path = parse_path(value)?;350				let segment = parse_path_segment(path)?;351				if segment.ident == "Vec" {352					let args = match &segment.arguments {353						PathArguments::AngleBracketed(e) => e,354						_ => {355							return Err(syn::Error::new(356								segment.arguments.span(),357								"missing Vec generic",358							))359						}360					};361					let args = &args.args;362					if args.len() != 1 {363						return Err(syn::Error::new(364							args.span(),365							"expected only one generic for vec",366						));367					}368					let arg = args.first().expect("first arg");369370					let ty = match arg {371						GenericArgument::Type(ty) => ty,372						_ => {373							return Err(syn::Error::new(374								arg.span(),375								"expected first generic to be type",376							))377						}378					};379380					let wrapped = AbiType::try_from(ty)?;381					Ok(Self::Vec(Box::new(wrapped)))382				} else {383					if !segment.arguments.is_empty() {384						return Err(syn::Error::new(385							segment.arguments.span(),386							"unexpected generic arguments for non-vec type",387						));388					}389					Ok(Self::Plain(segment.ident.clone()))390				}391			}392			Type::Tuple(t) => {393				let mut out = Vec::with_capacity(t.elems.len());394				for el in t.elems.iter() {395					out.push(AbiType::try_from(el)?)396				}397				Ok(Self::Tuple(out))398			}399			_ => Err(syn::Error::new(400				value.span(),401				"unexpected type, only arrays, plain types and tuples are supported",402			)),403		}404	}405	fn is_value(&self) -> bool {406		matches!(self, Self::Plain(v) if v == "value")407	}408	fn is_caller(&self) -> bool {409		matches!(self, Self::Plain(v) if v == "caller")410	}411	fn is_special(&self) -> bool {412		self.is_caller() || self.is_value()413	}414	fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {415		match self {416			AbiType::Plain(t) => {417				write!(buf, "{}", t)418			}419			AbiType::Tuple(t) => {420				write!(buf, "(")?;421				for (i, t) in t.iter().enumerate() {422					if i != 0 {423						write!(buf, ",")?;424					}425					t.selector_ty_buf(buf)?;426				}427				write!(buf, ")")428			}429			AbiType::Vec(v) => {430				v.selector_ty_buf(buf)?;431				write!(buf, "[]")432			}433			AbiType::Array(v, len) => {434				v.selector_ty_buf(buf)?;435				write!(buf, "[{}]", len)436			}437		}438	}439	fn selector_ty(&self) -> String {440		let mut out = String::new();441		self.selector_ty_buf(&mut out).expect("no fmt error");442		out443	}444}445impl ToTokens for AbiType {446	fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {447		match self {448			AbiType::Plain(t) => tokens.extend(quote! {#t}),449			AbiType::Tuple(t) => {450				tokens.extend(quote! {(451					#(#t),*452				)});453			}454			AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),455			AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),456		}457	}458}459460struct MethodArg {461	name: Ident,462	camel_name: String,463	ty: AbiType,464}465impl MethodArg {466	fn try_from(value: &PatType) -> syn::Result<Self> {467		let name = parse_ident_from_pat(&value.pat)?.clone();468		Ok(Self {469			camel_name: cases::camelcase::to_camel_case(&name.to_string()),470			name,471			ty: AbiType::try_maybe_special_from(&value.ty)?,472		})473	}474	fn is_value(&self) -> bool {475		self.ty.is_value()476	}477	fn is_caller(&self) -> bool {478		self.ty.is_caller()479	}480	fn is_special(&self) -> bool {481		self.ty.is_special()482	}483	fn selector_ty(&self) -> String {484		assert!(!self.is_special());485		self.ty.selector_ty()486	}487488	fn expand_call_def(&self) -> proc_macro2::TokenStream {489		assert!(!self.is_special());490		let name = &self.name;491		let ty = &self.ty;492493		quote! {494			#name: #ty495		}496	}497498	fn expand_parse(&self) -> proc_macro2::TokenStream {499		assert!(!self.is_special());500		let name = &self.name;501		quote! {502			#name: reader.abi_read()?503		}504	}505506	fn expand_call_arg(&self) -> proc_macro2::TokenStream {507		if self.is_value() {508			quote! {509				c.value.clone()510			}511		} else if self.is_caller() {512			quote! {513				c.caller.clone()514			}515		} else {516			let name = &self.name;517			quote! {518				#name519			}520		}521	}522523	fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {524		let camel_name = &self.camel_name.to_string();525		let ty = &self.ty;526		quote! {527			<NamedArgument<#ty>>::new(#camel_name)528		}529	}530}531532#[derive(PartialEq)]533enum Mutability {534	Mutable,535	View,536	Pure,537}538539/// Group all keywords for this macro. Usage example:540/// #[solidity_interface(name = "B", inline_is(A))]541mod kw {542	syn::custom_keyword!(weight);543544	syn::custom_keyword!(via);545	syn::custom_keyword!(name);546	syn::custom_keyword!(is);547	syn::custom_keyword!(inline_is);548	syn::custom_keyword!(events);549	syn::custom_keyword!(expect_selector);550551	syn::custom_keyword!(rename_selector);552}553554/// Rust methods are parsed into this structure when Solidity code is generated555struct Method {556	name: Ident,557	camel_name: String,558	pascal_name: Ident,559	screaming_name: Ident,560	selector_str: String,561	selector: u32,562	args: Vec<MethodArg>,563	has_normal_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		selector_str.push(')');660		let selector = fn_selector_str(&selector_str);661662		Ok(Self {663			name: ident.clone(),664			camel_name,665			pascal_name: snake_ident_to_pascal(ident),666			screaming_name: snake_ident_to_screaming(ident),667			selector_str,668			selector,669			args,670			has_normal_args,671			mutability,672			result: result.clone(),673			weight,674			docs,675		})676	}677	fn expand_call_def(&self) -> proc_macro2::TokenStream {678		let defs = self679			.args680			.iter()681			.filter(|a| !a.is_special())682			.map(|a| a.expand_call_def());683		let pascal_name = &self.pascal_name;684		let docs = &self.docs;685686		if self.has_normal_args {687			quote! {688				#(#[doc = #docs])*689				#[allow(missing_docs)]690				#pascal_name {691					#(692						#defs,693					)*694				}695			}696		} else {697			quote! {#pascal_name}698		}699	}700701	fn expand_const(&self) -> proc_macro2::TokenStream {702		let screaming_name = &self.screaming_name;703		let selector = u32::to_be_bytes(self.selector);704		let selector_str = &self.selector_str;705		quote! {706			#[doc = #selector_str]707			const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];708		}709	}710711	fn expand_interface_id(&self) -> proc_macro2::TokenStream {712		let screaming_name = &self.screaming_name;713		quote! {714			interface_id ^= u32::from_be_bytes(Self::#screaming_name);715		}716	}717718	fn expand_parse(&self) -> proc_macro2::TokenStream {719		let pascal_name = &self.pascal_name;720		let screaming_name = &self.screaming_name;721		if self.has_normal_args {722			let parsers = self723				.args724				.iter()725				.filter(|a| !a.is_special())726				.map(|a| a.expand_parse());727			quote! {728				Self::#screaming_name => return Ok(Some(Self::#pascal_name {729					#(730						#parsers,731					)*732				}))733			}734		} else {735			quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }736		}737	}738739	fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {740		let pascal_name = &self.pascal_name;741		let name = &self.name;742743		let matcher = if self.has_normal_args {744			let names = self745				.args746				.iter()747				.filter(|a| !a.is_special())748				.map(|a| &a.name);749750			quote! {{751				#(752					#names,753				)*754			}}755		} else {756			quote! {}757		};758759		let receiver = match self.mutability {760			Mutability::Mutable | Mutability::View => quote! {self.},761			Mutability::Pure => quote! {Self::},762		};763		let args = self.args.iter().map(|a| a.expand_call_arg());764765		quote! {766			#call_name::#pascal_name #matcher => {767				let result = #receiver #name(768					#(769						#args,770					)*771				)?;772				(&result).to_result()773			}774		}775	}776777	fn expand_variant_weight(&self) -> proc_macro2::TokenStream {778		let pascal_name = &self.pascal_name;779		if let Some(weight) = &self.weight {780			let matcher = if self.has_normal_args {781				let names = self782					.args783					.iter()784					.filter(|a| !a.is_special())785					.map(|a| &a.name);786787				quote! {{788					#(789						#names,790					)*791				}}792			} else {793				quote! {}794			};795			quote! {796				Self::#pascal_name #matcher => (#weight).into()797			}798		} else {799			let matcher = if self.has_normal_args {800				quote! {{..}}801			} else {802				quote! {}803			};804			quote! {805				Self::#pascal_name #matcher => ().into()806			}807		}808	}809810	fn expand_solidity_function(&self) -> proc_macro2::TokenStream {811		let camel_name = &self.camel_name;812		let mutability = match self.mutability {813			Mutability::Mutable => quote! {SolidityMutability::Mutable},814			Mutability::View => quote! { SolidityMutability::View },815			Mutability::Pure => quote! {SolidityMutability::Pure},816		};817		let result = &self.result;818819		let args = self820			.args821			.iter()822			.filter(|a| !a.is_special())823			.map(MethodArg::expand_solidity_argument);824		let docs = &self.docs;825		let selector_str = &self.selector_str;826		let selector = self.selector;827828		quote! {829			SolidityFunction {830				docs: &[#(#docs),*],831				selector_str: #selector_str,832				selector: #selector,833				name: #camel_name,834				mutability: #mutability,835				args: (836					#(837						#args,838					)*839				),840				result: <UnnamedArgument<#result>>::default(),841			}842		}843	}844}845846fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {847	if gen.params.is_empty() {848		return quote! {};849	}850	let params = gen.params.iter().map(|p| match p {851		syn::GenericParam::Type(id) => {852			let v = &id.ident;853			quote! {#v}854		}855		syn::GenericParam::Lifetime(lt) => {856			let v = &lt.lifetime;857			quote! {#v}858		}859		syn::GenericParam::Const(c) => {860			let i = &c.ident;861			quote! {#i}862		}863	});864	quote! { #(#params),* }865}866fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {867	if gen.params.is_empty() {868		return quote! {};869	}870	let list = generics_list(gen);871	quote! { <#list> }872}873fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {874	let list = generics_list(gen);875	if gen.params.len() == 1 {876		quote! {#list}877	} else {878		quote! { (#list) }879	}880}881882pub struct SolidityInterface {883	generics: Generics,884	name: Box<syn::Type>,885	info: InterfaceInfo,886	methods: Vec<Method>,887	docs: Vec<String>,888}889impl SolidityInterface {890	pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {891		let mut methods = Vec::new();892893		for item in &value.items {894			if let ImplItem::Method(method) = item {895				methods.push(Method::try_from(method)?)896			}897		}898		let mut docs = vec![];899		for attr in &value.attrs {900			let ident = parse_ident_from_path(&attr.path, false)?;901			if ident == "doc" {902				let args = attr.parse_meta().unwrap();903				let value = match args {904					Meta::NameValue(MetaNameValue {905						lit: Lit::Str(str), ..906					}) => str.value(),907					_ => unreachable!(),908				};909				docs.push(value);910			}911		}912		Ok(Self {913			generics: value.generics.clone(),914			name: value.self_ty.clone(),915			info,916			methods,917			docs,918		})919	}920	pub fn expand(self) -> proc_macro2::TokenStream {921		let name = self.name;922923		let solidity_name = self.info.name.to_string();924		let call_name = pascal_ident_to_call(&self.info.name);925		let generics = self.generics;926		let gen_ref = generics_reference(&generics);927		let gen_data = generics_data(&generics);928		let gen_where = &generics.where_clause;929930		let call_sub = self931			.info932			.inline_is933			.0934			.iter()935			.chain(self.info.is.0.iter())936			.map(|c| Is::expand_call_def(c, &gen_ref));937		let call_parse = self938			.info939			.inline_is940			.0941			.iter()942			.chain(self.info.is.0.iter())943			.map(|is| Is::expand_parse(is, &gen_ref));944		let call_variants = self945			.info946			.inline_is947			.0948			.iter()949			.chain(self.info.is.0.iter())950			.map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));951		let weight_variants = self952			.info953			.inline_is954			.0955			.iter()956			.chain(self.info.is.0.iter())957			.map(Is::expand_variant_weight);958959		let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);960		let supports_interface = self961			.info962			.is963			.0964			.iter()965			.map(|is| Is::expand_supports_interface(is, &gen_ref));966967		let calls = self.methods.iter().map(Method::expand_call_def);968		let consts = self.methods.iter().map(Method::expand_const);969		let interface_id = self.methods.iter().map(Method::expand_interface_id);970		let parsers = self.methods.iter().map(Method::expand_parse);971		let call_variants_this = self972			.methods973			.iter()974			.map(|m| Method::expand_variant_call(m, &call_name));975		let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);976		let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);977978		// TODO: Inline inline_is979		let solidity_is = self980			.info981			.is982			.0983			.iter()984			.chain(self.info.inline_is.0.iter())985			.map(|is| is.name.to_string());986		let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());987		let solidity_generators = self988			.info989			.is990			.0991			.iter()992			.chain(self.info.inline_is.0.iter())993			.map(|is| Is::expand_generator(is, &gen_ref));994		let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);995996		let docs = &self.docs;997998		if let Some(expect_selector) = &self.info.expect_selector {999			if !self.info.inline_is.0.is_empty() {1000				return syn::Error::new(1001					name.span(),1002					"expect_selector is not compatible with inline_is",1003				)1004				.to_compile_error();1005			}1006			let selector = self1007				.methods1008				.iter()1009				.map(|m| m.selector)1010				.fold(0, |a, b| a ^ b);10111012			if *expect_selector != selector {1013				let mut methods = String::new();1014				for meth in self.methods.iter() {1015					write!(methods, "\n- {}", meth.selector_str).expect("write to string");1016				}1017				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();1018			}1019		}1020		// let methods = self.methods.iter().map(Method::solidity_def);10211022		quote! {1023			#[derive(Debug)]1024			#(#[doc = #docs])*1025			pub enum #call_name #gen_ref {1026				/// Inherited method1027				ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),1028				#(1029					#calls,1030				)*1031				#(1032					#call_sub,1033				)*1034			}1035			impl #gen_ref #call_name #gen_ref {1036				#(1037					#consts1038				)*1039				/// Return this call ERC165 selector1040				pub fn interface_id() -> ::evm_coder::types::bytes4 {1041					let mut interface_id = 0;1042					#(#interface_id)*1043					#(#inline_interface_id)*1044					u32::to_be_bytes(interface_id)1045				}1046				/// Generate solidity definitions for methods described in this interface1047				pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {1048					use evm_coder::solidity::*;1049					use core::fmt::Write;1050					let interface = SolidityInterface {1051						docs: &[#(#docs),*],1052						name: #solidity_name,1053						selector: Self::interface_id(),1054						is: &["Dummy", "ERC165", #(1055							#solidity_is,1056						)* #(1057							#solidity_events_is,1058						)* ],1059						functions: (#(1060							#solidity_functions,1061						)*),1062					};10631064					let mut out = ::evm_coder::types::string::new();1065					if #solidity_name.starts_with("Inline") {1066						out.push_str("/// @dev inlined interface\n");1067					}1068					let _ = interface.format(is_impl, &mut out, tc);1069					tc.collect(out);1070					#(1071						#solidity_event_generators1072					)*1073					#(1074						#solidity_generators1075					)*1076					if is_impl {1077						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());1078					} else {1079						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());1080					}1081				}1082			}1083			impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {1084				fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {1085					use ::evm_coder::abi::AbiRead;1086					match method_id {1087						::evm_coder::ERC165Call::INTERFACE_ID => return Ok(1088							::evm_coder::ERC165Call::parse(method_id, reader)?1089							.map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))1090						),1091						#(1092							#parsers,1093						)*1094						_ => {},1095					}1096					#(1097						#call_parse1098					)else*1099					return Ok(None);1100				}1101			}1102			impl #generics #call_name #gen_ref1103			#gen_where1104			{1105				/// Is this contract implements specified ERC165 selector1106				pub fn supports_interface(this: &#name, interface_id: ::evm_coder::types::bytes4) -> bool {1107					interface_id != u32::to_be_bytes(0xffffff) && (1108						interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||1109						interface_id == Self::interface_id()1110						#(1111							|| #supports_interface1112						)*1113					)1114				}1115			}1116			impl #generics ::evm_coder::Weighted for #call_name #gen_ref1117			#gen_where1118			{1119				#[allow(unused_variables)]1120				fn weight(&self) -> ::evm_coder::execution::DispatchInfo {1121					match self {1122						#(1123							#weight_variants,1124						)*1125						// TODO: It should be very cheap, but not free1126						Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => 100u64.into(),1127						#(1128							#weight_variants_this,1129						)*1130					}1131				}1132			}1133			impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name1134			#gen_where1135			{1136				#[allow(unreachable_code)] // In case of no inner calls1137				fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {1138					use ::evm_coder::abi::AbiWrite;1139					match c.call {1140						#(1141							#call_variants,1142						)*1143						#call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {1144							let mut writer = ::evm_coder::abi::AbiWriter::default();1145							writer.bool(&<#call_name #gen_ref>::supports_interface(self, interface_id));1146							return Ok(writer.into());1147						}1148						_ => {},1149					}1150					let mut writer = ::evm_coder::abi::AbiWriter::default();1151					match c.call {1152						#(1153							#call_variants_this,1154						)*1155						_ => Err(::evm_coder::execution::Error::from("method is not available").into()),1156					}1157				}1158			}1159		}1160	}1161}
after · crates/evm-coder/procedural/src/solidity_interface.rs
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::<Token![,]>()?;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 if input.peek(Token![,]) {185						input.parse::<Token![,]>()?;186					} else {187						return Err(lookahead.error());188					}189				}190			} else if lookahead.peek(Token![,]) || input.is_empty() {191				// Pass192			} else {193				return Err(lookahead.error());194			};195			out.push(Is {196				pascal_call_name: pascal_ident_to_call(&name),197				snake_call_name: pascal_ident_to_snake_call(&name),198				name,199				via,200				condition,201			});202			if input.peek(Token![,]) {203				input.parse::<Token![,]>()?;204				continue;205			} else {206				break;207			}208		}209		Ok(Self(out))210	}211}212213pub struct InterfaceInfo {214	name: Ident,215	is: IsList,216	inline_is: IsList,217	events: IsList,218	expect_selector: Option<u32>,219}220impl Parse for InterfaceInfo {221	fn parse(input: ParseStream) -> syn::Result<Self> {222		let mut name = None;223		let mut is = None;224		let mut inline_is = None;225		let mut events = None;226		let mut expect_selector = None;227		// TODO: create proc-macro to optimize proc-macro boilerplate? :D228		loop {229			let lookahead = input.lookahead1();230			if lookahead.peek(kw::name) {231				let k = input.parse::<kw::name>()?;232				input.parse::<Token![=]>()?;233				if name.replace(input.parse::<Ident>()?).is_some() {234					return Err(syn::Error::new(k.span(), "name is already set"));235				}236			} else if lookahead.peek(kw::is) {237				let k = input.parse::<kw::is>()?;238				let contents;239				parenthesized!(contents in input);240				if is.replace(contents.parse::<IsList>()?).is_some() {241					return Err(syn::Error::new(k.span(), "is is already set"));242				}243			} else if lookahead.peek(kw::inline_is) {244				let k = input.parse::<kw::inline_is>()?;245				let contents;246				parenthesized!(contents in input);247				if inline_is.replace(contents.parse::<IsList>()?).is_some() {248					return Err(syn::Error::new(k.span(), "inline_is is already set"));249				}250			} else if lookahead.peek(kw::events) {251				let k = input.parse::<kw::events>()?;252				let contents;253				parenthesized!(contents in input);254				if events.replace(contents.parse::<IsList>()?).is_some() {255					return Err(syn::Error::new(k.span(), "events is already set"));256				}257			} else if lookahead.peek(kw::expect_selector) {258				let k = input.parse::<kw::expect_selector>()?;259				input.parse::<Token![=]>()?;260				let value = input.parse::<LitInt>()?;261				if expect_selector262					.replace(value.base10_parse::<u32>()?)263					.is_some()264				{265					return Err(syn::Error::new(k.span(), "expect_selector is already set"));266				}267			} else if input.is_empty() {268				break;269			} else {270				return Err(lookahead.error());271			}272			if input.peek(Token![,]) {273				input.parse::<Token![,]>()?;274			} else {275				break;276			}277		}278		Ok(Self {279			name: name.ok_or_else(|| syn::Error::new(input.span(), "missing name"))?,280			is: is.unwrap_or_default(),281			inline_is: inline_is.unwrap_or_default(),282			events: events.unwrap_or_default(),283			expect_selector,284		})285	}286}287288struct MethodInfo {289	rename_selector: Option<String>,290}291impl Parse for MethodInfo {292	fn parse(input: ParseStream) -> syn::Result<Self> {293		let mut rename_selector = None;294		let lookahead = input.lookahead1();295		if lookahead.peek(kw::rename_selector) {296			let k = input.parse::<kw::rename_selector>()?;297			input.parse::<Token![=]>()?;298			if rename_selector299				.replace(input.parse::<LitStr>()?.value())300				.is_some()301			{302				return Err(syn::Error::new(k.span(), "rename_selector is already set"));303			}304		}305		Ok(Self { rename_selector })306	}307}308309enum AbiType {310	// type311	Plain(Ident),312	// (type1,type2)313	Tuple(Vec<AbiType>),314	// type[]315	Vec(Box<AbiType>),316	// type[20]317	Array(Box<AbiType>, usize),318}319impl AbiType {320	fn try_from(value: &Type) -> syn::Result<Self> {321		let value = Self::try_maybe_special_from(value)?;322		if value.is_special() {323			return Err(syn::Error::new(value.span(), "unexpected special type"));324		}325		Ok(value)326	}327	fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {328		match value {329			Type::Array(arr) => {330				let wrapped = AbiType::try_from(&arr.elem)?;331				match &arr.len {332					Expr::Lit(l) => match &l.lit {333						Lit::Int(i) => {334							let num = i.base10_parse::<usize>()?;335							Ok(AbiType::Array(Box::new(wrapped), num as usize))336						}337						_ => Err(syn::Error::new(arr.len.span(), "should be int literal")),338					},339					_ => Err(syn::Error::new(arr.len.span(), "should be literal")),340				}341			}342			Type::Path(_) => {343				let path = parse_path(value)?;344				let segment = parse_path_segment(path)?;345				if segment.ident == "Vec" {346					let args = match &segment.arguments {347						PathArguments::AngleBracketed(e) => e,348						_ => {349							return Err(syn::Error::new(350								segment.arguments.span(),351								"missing Vec generic",352							))353						}354					};355					let args = &args.args;356					if args.len() != 1 {357						return Err(syn::Error::new(358							args.span(),359							"expected only one generic for vec",360						));361					}362					let arg = args.first().expect("first arg");363364					let ty = match arg {365						GenericArgument::Type(ty) => ty,366						_ => {367							return Err(syn::Error::new(368								arg.span(),369								"expected first generic to be type",370							))371						}372					};373374					let wrapped = AbiType::try_from(ty)?;375					Ok(Self::Vec(Box::new(wrapped)))376				} else {377					if !segment.arguments.is_empty() {378						return Err(syn::Error::new(379							segment.arguments.span(),380							"unexpected generic arguments for non-vec type",381						));382					}383					Ok(Self::Plain(segment.ident.clone()))384				}385			}386			Type::Tuple(t) => {387				let mut out = Vec::with_capacity(t.elems.len());388				for el in t.elems.iter() {389					out.push(AbiType::try_from(el)?)390				}391				Ok(Self::Tuple(out))392			}393			_ => Err(syn::Error::new(394				value.span(),395				"unexpected type, only arrays, plain types and tuples are supported",396			)),397		}398	}399	fn is_value(&self) -> bool {400		matches!(self, Self::Plain(v) if v == "value")401	}402	fn is_caller(&self) -> bool {403		matches!(self, Self::Plain(v) if v == "caller")404	}405	fn is_special(&self) -> bool {406		self.is_caller() || self.is_value()407	}408	fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {409		match self {410			AbiType::Plain(t) => {411				write!(buf, "{}", t)412			}413			AbiType::Tuple(t) => {414				write!(buf, "(")?;415				for (i, t) in t.iter().enumerate() {416					if i != 0 {417						write!(buf, ",")?;418					}419					t.selector_ty_buf(buf)?;420				}421				write!(buf, ")")422			}423			AbiType::Vec(v) => {424				v.selector_ty_buf(buf)?;425				write!(buf, "[]")426			}427			AbiType::Array(v, len) => {428				v.selector_ty_buf(buf)?;429				write!(buf, "[{}]", len)430			}431		}432	}433	fn selector_ty(&self) -> String {434		let mut out = String::new();435		self.selector_ty_buf(&mut out).expect("no fmt error");436		out437	}438}439impl ToTokens for AbiType {440	fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {441		match self {442			AbiType::Plain(t) => tokens.extend(quote! {#t}),443			AbiType::Tuple(t) => {444				tokens.extend(quote! {(445					#(#t),*446				)});447			}448			AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),449			AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),450		}451	}452}453454struct MethodArg {455	name: Ident,456	camel_name: String,457	ty: AbiType,458}459impl MethodArg {460	fn try_from(value: &PatType) -> syn::Result<Self> {461		let name = parse_ident_from_pat(&value.pat)?.clone();462		Ok(Self {463			camel_name: cases::camelcase::to_camel_case(&name.to_string()),464			name,465			ty: AbiType::try_maybe_special_from(&value.ty)?,466		})467	}468	fn is_value(&self) -> bool {469		self.ty.is_value()470	}471	fn is_caller(&self) -> bool {472		self.ty.is_caller()473	}474	fn is_special(&self) -> bool {475		self.ty.is_special()476	}477	fn selector_ty(&self) -> String {478		assert!(!self.is_special());479		self.ty.selector_ty()480	}481482	fn expand_call_def(&self) -> proc_macro2::TokenStream {483		assert!(!self.is_special());484		let name = &self.name;485		let ty = &self.ty;486487		quote! {488			#name: #ty489		}490	}491492	fn expand_parse(&self) -> proc_macro2::TokenStream {493		assert!(!self.is_special());494		let name = &self.name;495		quote! {496			#name: reader.abi_read()?497		}498	}499500	fn expand_call_arg(&self) -> proc_macro2::TokenStream {501		if self.is_value() {502			quote! {503				c.value.clone()504			}505		} else if self.is_caller() {506			quote! {507				c.caller.clone()508			}509		} else {510			let name = &self.name;511			quote! {512				#name513			}514		}515	}516517	fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {518		let camel_name = &self.camel_name.to_string();519		let ty = &self.ty;520		quote! {521			<NamedArgument<#ty>>::new(#camel_name)522		}523	}524}525526#[derive(PartialEq)]527enum Mutability {528	Mutable,529	View,530	Pure,531}532533/// Group all keywords for this macro. Usage example:534/// #[solidity_interface(name = "B", inline_is(A))]535mod kw {536	syn::custom_keyword!(weight);537538	syn::custom_keyword!(via);539	syn::custom_keyword!(name);540	syn::custom_keyword!(is);541	syn::custom_keyword!(inline_is);542	syn::custom_keyword!(events);543	syn::custom_keyword!(expect_selector);544545	syn::custom_keyword!(rename_selector);546}547548/// Rust methods are parsed into this structure when Solidity code is generated549struct Method {550	name: Ident,551	camel_name: String,552	pascal_name: Ident,553	screaming_name: Ident,554	selector_str: String,555	selector: u32,556	args: Vec<MethodArg>,557	has_normal_args: bool,558	mutability: Mutability,559	result: Type,560	weight: Option<Expr>,561	docs: Vec<String>,562}563impl Method {564	fn try_from(value: &ImplItemMethod) -> syn::Result<Self> {565		let mut info = MethodInfo {566			rename_selector: None,567		};568		let mut docs = Vec::new();569		let mut weight = None;570		for attr in &value.attrs {571			let ident = parse_ident_from_path(&attr.path, false)?;572			if ident == "solidity" {573				info = attr.parse_args::<MethodInfo>()?;574			} else if ident == "doc" {575				let args = attr.parse_meta().unwrap();576				let value = match args {577					Meta::NameValue(MetaNameValue {578						lit: Lit::Str(str), ..579					}) => str.value(),580					_ => unreachable!(),581				};582				docs.push(value);583			} else if ident == "weight" {584				weight = Some(attr.parse_args::<Expr>()?);585			}586		}587		let ident = &value.sig.ident;588		let ident_str = ident.to_string();589		if !cases::snakecase::is_snake_case(&ident_str) {590			return Err(syn::Error::new(ident.span(), "method name should be snake_cased\nif alternative solidity name needs to be set - use #[solidity] attribute"));591		}592593		let mut mutability = Mutability::Pure;594595		if let Some(FnArg::Receiver(receiver)) = value596			.sig597			.inputs598			.iter()599			.find(|arg| matches!(arg, FnArg::Receiver(_)))600		{601			if receiver.reference.is_none() {602				return Err(syn::Error::new(603					receiver.span(),604					"receiver should be by ref",605				));606			}607			if receiver.mutability.is_some() {608				mutability = Mutability::Mutable;609			} else {610				mutability = Mutability::View;611			}612		}613		let mut args = Vec::new();614		for typ in value615			.sig616			.inputs617			.iter()618			.filter(|arg| matches!(arg, FnArg::Typed(_)))619		{620			let typ = match typ {621				FnArg::Typed(typ) => typ,622				_ => unreachable!(),623			};624			args.push(MethodArg::try_from(typ)?);625		}626627		if mutability != Mutability::Mutable && args.iter().any(|arg| arg.is_value()) {628			return Err(syn::Error::new(629				args.iter().find(|arg| arg.is_value()).unwrap().ty.span(),630				"payable function should be mutable",631			));632		}633634		let result = match &value.sig.output {635			ReturnType::Type(_, ty) => ty,636			_ => 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)")),637		};638		let result = parse_result_ok(result)?;639640		let camel_name = info641			.rename_selector642			.unwrap_or_else(|| cases::camelcase::to_camel_case(&ident.to_string()));643		let mut selector_str = camel_name.clone();644		selector_str.push('(');645		let mut has_normal_args = false;646		for (i, arg) in args.iter().filter(|arg| !arg.is_special()).enumerate() {647			if i != 0 {648				selector_str.push(',');649			}650			write!(selector_str, "{}", arg.selector_ty()).unwrap();651			has_normal_args = true;652		}653		selector_str.push(')');654		let selector = fn_selector_str(&selector_str);655656		Ok(Self {657			name: ident.clone(),658			camel_name,659			pascal_name: snake_ident_to_pascal(ident),660			screaming_name: snake_ident_to_screaming(ident),661			selector_str,662			selector,663			args,664			has_normal_args,665			mutability,666			result: result.clone(),667			weight,668			docs,669		})670	}671	fn expand_call_def(&self) -> proc_macro2::TokenStream {672		let defs = self673			.args674			.iter()675			.filter(|a| !a.is_special())676			.map(|a| a.expand_call_def());677		let pascal_name = &self.pascal_name;678		let docs = &self.docs;679680		if self.has_normal_args {681			quote! {682				#(#[doc = #docs])*683				#[allow(missing_docs)]684				#pascal_name {685					#(686						#defs,687					)*688				}689			}690		} else {691			quote! {#pascal_name}692		}693	}694695	fn expand_const(&self) -> proc_macro2::TokenStream {696		let screaming_name = &self.screaming_name;697		let selector = u32::to_be_bytes(self.selector);698		let selector_str = &self.selector_str;699		quote! {700			#[doc = #selector_str]701			const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];702		}703	}704705	fn expand_interface_id(&self) -> proc_macro2::TokenStream {706		let screaming_name = &self.screaming_name;707		quote! {708			interface_id ^= u32::from_be_bytes(Self::#screaming_name);709		}710	}711712	fn expand_parse(&self) -> proc_macro2::TokenStream {713		let pascal_name = &self.pascal_name;714		let screaming_name = &self.screaming_name;715		if self.has_normal_args {716			let parsers = self717				.args718				.iter()719				.filter(|a| !a.is_special())720				.map(|a| a.expand_parse());721			quote! {722				Self::#screaming_name => return Ok(Some(Self::#pascal_name {723					#(724						#parsers,725					)*726				}))727			}728		} else {729			quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }730		}731	}732733	fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {734		let pascal_name = &self.pascal_name;735		let name = &self.name;736737		let matcher = if self.has_normal_args {738			let names = self739				.args740				.iter()741				.filter(|a| !a.is_special())742				.map(|a| &a.name);743744			quote! {{745				#(746					#names,747				)*748			}}749		} else {750			quote! {}751		};752753		let receiver = match self.mutability {754			Mutability::Mutable | Mutability::View => quote! {self.},755			Mutability::Pure => quote! {Self::},756		};757		let args = self.args.iter().map(|a| a.expand_call_arg());758759		quote! {760			#call_name::#pascal_name #matcher => {761				let result = #receiver #name(762					#(763						#args,764					)*765				)?;766				(&result).to_result()767			}768		}769	}770771	fn expand_variant_weight(&self) -> proc_macro2::TokenStream {772		let pascal_name = &self.pascal_name;773		if let Some(weight) = &self.weight {774			let matcher = if self.has_normal_args {775				let names = self776					.args777					.iter()778					.filter(|a| !a.is_special())779					.map(|a| &a.name);780781				quote! {{782					#(783						#names,784					)*785				}}786			} else {787				quote! {}788			};789			quote! {790				Self::#pascal_name #matcher => (#weight).into()791			}792		} else {793			let matcher = if self.has_normal_args {794				quote! {{..}}795			} else {796				quote! {}797			};798			quote! {799				Self::#pascal_name #matcher => ().into()800			}801		}802	}803804	fn expand_solidity_function(&self) -> proc_macro2::TokenStream {805		let camel_name = &self.camel_name;806		let mutability = match self.mutability {807			Mutability::Mutable => quote! {SolidityMutability::Mutable},808			Mutability::View => quote! { SolidityMutability::View },809			Mutability::Pure => quote! {SolidityMutability::Pure},810		};811		let result = &self.result;812813		let args = self814			.args815			.iter()816			.filter(|a| !a.is_special())817			.map(MethodArg::expand_solidity_argument);818		let docs = &self.docs;819		let selector_str = &self.selector_str;820		let selector = self.selector;821822		quote! {823			SolidityFunction {824				docs: &[#(#docs),*],825				selector_str: #selector_str,826				selector: #selector,827				name: #camel_name,828				mutability: #mutability,829				args: (830					#(831						#args,832					)*833				),834				result: <UnnamedArgument<#result>>::default(),835			}836		}837	}838}839840fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {841	if gen.params.is_empty() {842		return quote! {};843	}844	let params = gen.params.iter().map(|p| match p {845		syn::GenericParam::Type(id) => {846			let v = &id.ident;847			quote! {#v}848		}849		syn::GenericParam::Lifetime(lt) => {850			let v = &lt.lifetime;851			quote! {#v}852		}853		syn::GenericParam::Const(c) => {854			let i = &c.ident;855			quote! {#i}856		}857	});858	quote! { #(#params),* }859}860fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {861	if gen.params.is_empty() {862		return quote! {};863	}864	let list = generics_list(gen);865	quote! { <#list> }866}867fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {868	let list = generics_list(gen);869	if gen.params.len() == 1 {870		quote! {#list}871	} else {872		quote! { (#list) }873	}874}875876pub struct SolidityInterface {877	generics: Generics,878	name: Box<syn::Type>,879	info: InterfaceInfo,880	methods: Vec<Method>,881	docs: Vec<String>,882}883impl SolidityInterface {884	pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {885		let mut methods = Vec::new();886887		for item in &value.items {888			if let ImplItem::Method(method) = item {889				methods.push(Method::try_from(method)?)890			}891		}892		let mut docs = vec![];893		for attr in &value.attrs {894			let ident = parse_ident_from_path(&attr.path, false)?;895			if ident == "doc" {896				let args = attr.parse_meta().unwrap();897				let value = match args {898					Meta::NameValue(MetaNameValue {899						lit: Lit::Str(str), ..900					}) => str.value(),901					_ => unreachable!(),902				};903				docs.push(value);904			}905		}906		Ok(Self {907			generics: value.generics.clone(),908			name: value.self_ty.clone(),909			info,910			methods,911			docs,912		})913	}914	pub fn expand(self) -> proc_macro2::TokenStream {915		let name = self.name;916917		let solidity_name = self.info.name.to_string();918		let call_name = pascal_ident_to_call(&self.info.name);919		let generics = self.generics;920		let gen_ref = generics_reference(&generics);921		let gen_data = generics_data(&generics);922		let gen_where = &generics.where_clause;923924		let call_sub = self925			.info926			.inline_is927			.0928			.iter()929			.chain(self.info.is.0.iter())930			.map(|c| Is::expand_call_def(c, &gen_ref));931		let call_parse = self932			.info933			.inline_is934			.0935			.iter()936			.chain(self.info.is.0.iter())937			.map(|is| Is::expand_parse(is, &gen_ref));938		let call_variants = self939			.info940			.inline_is941			.0942			.iter()943			.chain(self.info.is.0.iter())944			.map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));945		let weight_variants = self946			.info947			.inline_is948			.0949			.iter()950			.chain(self.info.is.0.iter())951			.map(Is::expand_variant_weight);952953		let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);954		let supports_interface = self955			.info956			.is957			.0958			.iter()959			.map(|is| Is::expand_supports_interface(is, &gen_ref));960961		let calls = self.methods.iter().map(Method::expand_call_def);962		let consts = self.methods.iter().map(Method::expand_const);963		let interface_id = self.methods.iter().map(Method::expand_interface_id);964		let parsers = self.methods.iter().map(Method::expand_parse);965		let call_variants_this = self966			.methods967			.iter()968			.map(|m| Method::expand_variant_call(m, &call_name));969		let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);970		let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);971972		// TODO: Inline inline_is973		let solidity_is = self974			.info975			.is976			.0977			.iter()978			.chain(self.info.inline_is.0.iter())979			.map(|is| is.name.to_string());980		let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());981		let solidity_generators = self982			.info983			.is984			.0985			.iter()986			.chain(self.info.inline_is.0.iter())987			.map(|is| Is::expand_generator(is, &gen_ref));988		let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);989990		let docs = &self.docs;991992		if let Some(expect_selector) = &self.info.expect_selector {993			if !self.info.inline_is.0.is_empty() {994				return syn::Error::new(995					name.span(),996					"expect_selector is not compatible with inline_is",997				)998				.to_compile_error();999			}1000			let selector = self1001				.methods1002				.iter()1003				.map(|m| m.selector)1004				.fold(0, |a, b| a ^ b);10051006			if *expect_selector != selector {1007				let mut methods = String::new();1008				for meth in self.methods.iter() {1009					write!(methods, "\n- {}", meth.selector_str).expect("write to string");1010				}1011				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();1012			}1013		}1014		// let methods = self.methods.iter().map(Method::solidity_def);10151016		quote! {1017			#[derive(Debug)]1018			#(#[doc = #docs])*1019			pub enum #call_name #gen_ref {1020				/// Inherited method1021				ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),1022				#(1023					#calls,1024				)*1025				#(1026					#call_sub,1027				)*1028			}1029			impl #gen_ref #call_name #gen_ref {1030				#(1031					#consts1032				)*1033				/// Return this call ERC165 selector1034				pub fn interface_id() -> ::evm_coder::types::bytes4 {1035					let mut interface_id = 0;1036					#(#interface_id)*1037					#(#inline_interface_id)*1038					u32::to_be_bytes(interface_id)1039				}1040				/// Generate solidity definitions for methods described in this interface1041				pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {1042					use evm_coder::solidity::*;1043					use core::fmt::Write;1044					let interface = SolidityInterface {1045						docs: &[#(#docs),*],1046						name: #solidity_name,1047						selector: Self::interface_id(),1048						is: &["Dummy", "ERC165", #(1049							#solidity_is,1050						)* #(1051							#solidity_events_is,1052						)* ],1053						functions: (#(1054							#solidity_functions,1055						)*),1056					};10571058					let mut out = ::evm_coder::types::string::new();1059					if #solidity_name.starts_with("Inline") {1060						out.push_str("/// @dev inlined interface\n");1061					}1062					let _ = interface.format(is_impl, &mut out, tc);1063					tc.collect(out);1064					#(1065						#solidity_event_generators1066					)*1067					#(1068						#solidity_generators1069					)*1070					if is_impl {1071						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());1072					} else {1073						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());1074					}1075				}1076			}1077			impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {1078				fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {1079					use ::evm_coder::abi::AbiRead;1080					match method_id {1081						::evm_coder::ERC165Call::INTERFACE_ID => return Ok(1082							::evm_coder::ERC165Call::parse(method_id, reader)?1083							.map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))1084						),1085						#(1086							#parsers,1087						)*1088						_ => {},1089					}1090					#(1091						#call_parse1092					)else*1093					return Ok(None);1094				}1095			}1096			impl #generics #call_name #gen_ref1097			#gen_where1098			{1099				/// Is this contract implements specified ERC165 selector1100				pub fn supports_interface(this: &#name, interface_id: ::evm_coder::types::bytes4) -> bool {1101					interface_id != u32::to_be_bytes(0xffffff) && (1102						interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||1103						interface_id == Self::interface_id()1104						#(1105							|| #supports_interface1106						)*1107					)1108				}1109			}1110			impl #generics ::evm_coder::Weighted for #call_name #gen_ref1111			#gen_where1112			{1113				#[allow(unused_variables)]1114				fn weight(&self) -> ::evm_coder::execution::DispatchInfo {1115					match self {1116						#(1117							#weight_variants,1118						)*1119						// TODO: It should be very cheap, but not free1120						Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => 100u64.into(),1121						#(1122							#weight_variants_this,1123						)*1124					}1125				}1126			}1127			impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name1128			#gen_where1129			{1130				#[allow(unreachable_code)] // In case of no inner calls1131				fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {1132					use ::evm_coder::abi::AbiWrite;1133					match c.call {1134						#(1135							#call_variants,1136						)*1137						#call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {1138							let mut writer = ::evm_coder::abi::AbiWriter::default();1139							writer.bool(&<#call_name #gen_ref>::supports_interface(self, interface_id));1140							return Ok(writer.into());1141						}1142						_ => {},1143					}1144					let mut writer = ::evm_coder::abi::AbiWriter::default();1145					match c.call {1146						#(1147							#call_variants_this,1148						)*1149						_ => Err(::evm_coder::execution::Error::from("method is not available").into()),1150					}1151				}1152			}1153		}1154	}1155}