difftreelog
feat delegate erc call to other struct
in: master
9 files changed
crates/evm-coder-macros/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)]1819use quote::quote;20use darling::{FromMeta, ToTokens};21use inflector::cases;22use std::fmt::Write;23use syn::{24 Expr, FnArg, GenericArgument, Generics, Ident, ImplItem, ImplItemMethod, ItemImpl, Lit, Meta,25 MetaNameValue, NestedMeta, PatType, Path, PathArguments, ReturnType, Type, spanned::Spanned,26};2728use crate::{29 fn_selector_str, parse_ident_from_pat, parse_ident_from_path, parse_path, parse_path_segment,30 parse_result_ok, pascal_ident_to_call, pascal_ident_to_snake_call, snake_ident_to_pascal,31 snake_ident_to_screaming,32};3334struct Is {35 name: Ident,36 pascal_call_name: Ident,37 snake_call_name: Ident,38}39impl Is {40 fn try_from(path: &Path) -> syn::Result<Self> {41 let name = parse_ident_from_path(path, false)?.clone();42 Ok(Self {43 pascal_call_name: pascal_ident_to_call(&name),44 snake_call_name: pascal_ident_to_snake_call(&name),45 name,46 })47 }4849 fn expand_call_def(&self, gen_ref: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {50 let name = &self.name;51 let pascal_call_name = &self.pascal_call_name;52 quote! {53 #name(#pascal_call_name #gen_ref)54 }55 }5657 fn expand_interface_id(&self) -> proc_macro2::TokenStream {58 let pascal_call_name = &self.pascal_call_name;59 quote! {60 interface_id ^= u32::from_be_bytes(#pascal_call_name::interface_id());61 }62 }6364 fn expand_supports_interface(65 &self,66 generics: &proc_macro2::TokenStream,67 ) -> proc_macro2::TokenStream {68 let pascal_call_name = &self.pascal_call_name;69 quote! {70 <#pascal_call_name #generics>::supports_interface(interface_id)71 }72 }7374 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {75 let name = &self.name;76 quote! {77 Self::#name(call) => call.weight()78 }79 }8081 fn expand_variant_call(82 &self,83 call_name: &proc_macro2::Ident,84 generics: &proc_macro2::TokenStream,85 ) -> proc_macro2::TokenStream {86 let name = &self.name;87 let pascal_call_name = &self.pascal_call_name;88 quote! {89 #call_name::#name(call) => return <Self as ::evm_coder::Callable<#pascal_call_name #generics>>::call(self, Msg {90 call,91 caller: c.caller,92 value: c.value,93 })94 }95 }9697 fn expand_parse(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {98 let name = &self.name;99 let pascal_call_name = &self.pascal_call_name;100 quote! {101 if let Some(parsed_call) = <#pascal_call_name #generics>::parse(method_id, reader)? {102 return Ok(Some(Self::#name(parsed_call)))103 }104 }105 }106107 fn expand_generator(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {108 let pascal_call_name = &self.pascal_call_name;109 quote! {110 <#pascal_call_name #generics>::generate_solidity_interface(tc, is_impl);111 }112 }113114 fn expand_event_generator(&self) -> proc_macro2::TokenStream {115 let name = &self.name;116 quote! {117 #name::generate_solidity_interface(tc, is_impl);118 }119 }120}121122#[derive(Default)]123struct IsList(Vec<Is>);124impl FromMeta for IsList {125 fn from_list(items: &[NestedMeta]) -> darling::Result<Self> {126 let mut out = Vec::new();127 for item in items {128 match item {129 NestedMeta::Meta(Meta::Path(path)) => out.push(Is::try_from(path)?),130 _ => return Err(syn::Error::new(item.span(), "expected path").into()),131 }132 }133 Ok(Self(out))134 }135}136137#[derive(FromMeta)]138pub struct InterfaceInfo {139 name: Ident,140 #[darling(default)]141 is: IsList,142 #[darling(default)]143 inline_is: IsList,144 #[darling(default)]145 events: IsList,146}147148#[derive(FromMeta)]149struct MethodInfo {150 #[darling(default)]151 rename_selector: Option<String>,152}153154enum AbiType {155 // type156 Plain(Ident),157 // (type1,type2)158 Tuple(Vec<AbiType>),159 // type[]160 Vec(Box<AbiType>),161 // type[20]162 Array(Box<AbiType>, usize),163}164impl AbiType {165 fn try_from(value: &Type) -> syn::Result<Self> {166 let value = Self::try_maybe_special_from(value)?;167 if value.is_special() {168 return Err(syn::Error::new(value.span(), "unexpected special type"));169 }170 Ok(value)171 }172 fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {173 match value {174 Type::Array(arr) => {175 let wrapped = AbiType::try_from(&arr.elem)?;176 match &arr.len {177 Expr::Lit(l) => match &l.lit {178 Lit::Int(i) => {179 let num = i.base10_parse::<usize>()?;180 Ok(AbiType::Array(Box::new(wrapped), num as usize))181 }182 _ => Err(syn::Error::new(arr.len.span(), "should be int literal")),183 },184 _ => Err(syn::Error::new(arr.len.span(), "should be literal")),185 }186 }187 Type::Path(_) => {188 let path = parse_path(value)?;189 let segment = parse_path_segment(path)?;190 if segment.ident == "Vec" {191 let args = match &segment.arguments {192 PathArguments::AngleBracketed(e) => e,193 _ => {194 return Err(syn::Error::new(195 segment.arguments.span(),196 "missing Vec generic",197 ))198 }199 };200 let args = &args.args;201 if args.len() != 1 {202 return Err(syn::Error::new(203 args.span(),204 "expected only one generic for vec",205 ));206 }207 let arg = args.first().unwrap();208209 let ty = match arg {210 GenericArgument::Type(ty) => ty,211 _ => {212 return Err(syn::Error::new(213 arg.span(),214 "expected first generic to be type",215 ))216 }217 };218219 let wrapped = AbiType::try_from(ty)?;220 Ok(Self::Vec(Box::new(wrapped)))221 } else {222 if !segment.arguments.is_empty() {223 return Err(syn::Error::new(224 segment.arguments.span(),225 "unexpected generic arguments for non-vec type",226 ));227 }228 Ok(Self::Plain(segment.ident.clone()))229 }230 }231 Type::Tuple(t) => {232 let mut out = Vec::with_capacity(t.elems.len());233 for el in t.elems.iter() {234 out.push(AbiType::try_from(el)?)235 }236 Ok(Self::Tuple(out))237 }238 _ => Err(syn::Error::new(239 value.span(),240 "unexpected type, only arrays, plain types and tuples are supported",241 )),242 }243 }244 fn is_value(&self) -> bool {245 matches!(self, Self::Plain(v) if v == "value")246 }247 fn is_caller(&self) -> bool {248 matches!(self, Self::Plain(v) if v == "caller")249 }250 fn is_special(&self) -> bool {251 self.is_caller() || self.is_value()252 }253 fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {254 match self {255 AbiType::Plain(t) => {256 write!(buf, "{}", t)257 }258 AbiType::Tuple(t) => {259 write!(buf, "(")?;260 for (i, t) in t.iter().enumerate() {261 if i != 0 {262 write!(buf, ",")?;263 }264 t.selector_ty_buf(buf)?;265 }266 write!(buf, ")")267 }268 AbiType::Vec(v) => {269 v.selector_ty_buf(buf)?;270 write!(buf, "[]")271 }272 AbiType::Array(v, len) => {273 v.selector_ty_buf(buf)?;274 write!(buf, "[{}]", len)275 }276 }277 }278 fn selector_ty(&self) -> String {279 let mut out = String::new();280 self.selector_ty_buf(&mut out).expect("no fmt error");281 out282 }283}284impl ToTokens for AbiType {285 fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {286 match self {287 AbiType::Plain(t) => tokens.extend(quote! {#t}),288 AbiType::Tuple(t) => {289 tokens.extend(quote! {(290 #(#t),*291 )});292 }293 AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),294 AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),295 }296 }297}298299struct MethodArg {300 name: Ident,301 camel_name: String,302 ty: AbiType,303}304impl MethodArg {305 fn try_from(value: &PatType) -> syn::Result<Self> {306 let name = parse_ident_from_pat(&value.pat)?.clone();307 Ok(Self {308 camel_name: cases::camelcase::to_camel_case(&name.to_string()),309 name,310 ty: AbiType::try_maybe_special_from(&value.ty)?,311 })312 }313 fn is_value(&self) -> bool {314 self.ty.is_value()315 }316 fn is_caller(&self) -> bool {317 self.ty.is_caller()318 }319 fn is_special(&self) -> bool {320 self.ty.is_special()321 }322 fn selector_ty(&self) -> String {323 assert!(!self.is_special());324 self.ty.selector_ty()325 }326327 fn expand_call_def(&self) -> proc_macro2::TokenStream {328 assert!(!self.is_special());329 let name = &self.name;330 let ty = &self.ty;331332 quote! {333 #name: #ty334 }335 }336337 fn expand_parse(&self) -> proc_macro2::TokenStream {338 assert!(!self.is_special());339 let name = &self.name;340 quote! {341 #name: reader.abi_read()?342 }343 }344345 fn expand_call_arg(&self) -> proc_macro2::TokenStream {346 if self.is_value() {347 quote! {348 c.value.clone()349 }350 } else if self.is_caller() {351 quote! {352 c.caller.clone()353 }354 } else {355 let name = &self.name;356 quote! {357 #name358 }359 }360 }361362 fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {363 let camel_name = &self.camel_name.to_string();364 let ty = &self.ty;365 quote! {366 <NamedArgument<#ty>>::new(#camel_name)367 }368 }369}370371#[derive(PartialEq)]372enum Mutability {373 Mutable,374 View,375 Pure,376}377378pub struct WeightAttr(syn::Expr);379380mod keyword {381 syn::custom_keyword!(weight);382}383384impl syn::parse::Parse for WeightAttr {385 fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {386 input.parse::<syn::Token![#]>()?;387 let content;388 syn::bracketed!(content in input);389 content.parse::<keyword::weight>()?;390391 let weight_content;392 syn::parenthesized!(weight_content in content);393 Ok(WeightAttr(weight_content.parse::<syn::Expr>()?))394 }395}396397struct Method {398 name: Ident,399 camel_name: String,400 pascal_name: Ident,401 screaming_name: Ident,402 selector_str: String,403 selector: u32,404 args: Vec<MethodArg>,405 has_normal_args: bool,406 mutability: Mutability,407 result: Type,408 weight: Option<Expr>,409 docs: Vec<String>,410}411impl Method {412 fn try_from(value: &ImplItemMethod) -> syn::Result<Self> {413 let mut info = MethodInfo {414 rename_selector: None,415 };416 let mut docs = Vec::new();417 let mut weight = None;418 for attr in &value.attrs {419 let ident = parse_ident_from_path(&attr.path, false)?;420 if ident == "solidity" {421 let args = attr.parse_meta().unwrap();422 info = MethodInfo::from_meta(&args).unwrap();423 } else if ident == "doc" {424 let args = attr.parse_meta().unwrap();425 let value = match args {426 Meta::NameValue(MetaNameValue {427 lit: Lit::Str(str), ..428 }) => str.value(),429 _ => unreachable!(),430 };431 docs.push(value);432 } else if ident == "weight" {433 weight = Some(syn::parse2::<WeightAttr>(attr.to_token_stream())?.0);434 }435 }436 let ident = &value.sig.ident;437 let ident_str = ident.to_string();438 if !cases::snakecase::is_snake_case(&ident_str) {439 return Err(syn::Error::new(ident.span(), "method name should be snake_cased\nif alternative solidity name needs to be set - use #[solidity] attribute"));440 }441442 let mut mutability = Mutability::Pure;443444 if let Some(FnArg::Receiver(receiver)) = value445 .sig446 .inputs447 .iter()448 .find(|arg| matches!(arg, FnArg::Receiver(_)))449 {450 if receiver.reference.is_none() {451 return Err(syn::Error::new(452 receiver.span(),453 "receiver should be by ref",454 ));455 }456 if receiver.mutability.is_some() {457 mutability = Mutability::Mutable;458 } else {459 mutability = Mutability::View;460 }461 }462 let mut args = Vec::new();463 for typ in value464 .sig465 .inputs466 .iter()467 .filter(|arg| matches!(arg, FnArg::Typed(_)))468 {469 let typ = match typ {470 FnArg::Typed(typ) => typ,471 _ => unreachable!(),472 };473 args.push(MethodArg::try_from(typ)?);474 }475476 if mutability != Mutability::Mutable && args.iter().any(|arg| arg.is_value()) {477 return Err(syn::Error::new(478 args.iter().find(|arg| arg.is_value()).unwrap().ty.span(),479 "payable function should be mutable",480 ));481 }482483 let result = match &value.sig.output {484 ReturnType::Type(_, ty) => ty,485 _ => 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)")),486 };487 let result = parse_result_ok(result)?;488489 let camel_name = info490 .rename_selector491 .unwrap_or_else(|| cases::camelcase::to_camel_case(&ident.to_string()));492 let mut selector_str = camel_name.clone();493 selector_str.push('(');494 let mut has_normal_args = false;495 for (i, arg) in args.iter().filter(|arg| !arg.is_special()).enumerate() {496 if i != 0 {497 selector_str.push(',');498 }499 write!(selector_str, "{}", arg.selector_ty()).unwrap();500 has_normal_args = true;501 }502 selector_str.push(')');503 let selector = fn_selector_str(&selector_str);504505 Ok(Self {506 name: ident.clone(),507 camel_name,508 pascal_name: snake_ident_to_pascal(ident),509 screaming_name: snake_ident_to_screaming(ident),510 selector_str,511 selector,512 args,513 has_normal_args,514 mutability,515 result: result.clone(),516 weight,517 docs,518 })519 }520 fn expand_call_def(&self) -> proc_macro2::TokenStream {521 let defs = self522 .args523 .iter()524 .filter(|a| !a.is_special())525 .map(|a| a.expand_call_def());526 let pascal_name = &self.pascal_name;527528 if self.has_normal_args {529 quote! {530 #pascal_name {531 #(532 #defs,533 )*534 }535 }536 } else {537 quote! {#pascal_name}538 }539 }540541 fn expand_const(&self) -> proc_macro2::TokenStream {542 let screaming_name = &self.screaming_name;543 let selector = u32::to_be_bytes(self.selector);544 let selector_str = &self.selector_str;545 quote! {546 #[doc = #selector_str]547 const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];548 }549 }550551 fn expand_interface_id(&self) -> proc_macro2::TokenStream {552 let screaming_name = &self.screaming_name;553 quote! {554 interface_id ^= u32::from_be_bytes(Self::#screaming_name);555 }556 }557558 fn expand_parse(&self) -> proc_macro2::TokenStream {559 let pascal_name = &self.pascal_name;560 let screaming_name = &self.screaming_name;561 if self.has_normal_args {562 let parsers = self563 .args564 .iter()565 .filter(|a| !a.is_special())566 .map(|a| a.expand_parse());567 quote! {568 Self::#screaming_name => return Ok(Some(Self::#pascal_name {569 #(570 #parsers,571 )*572 }))573 }574 } else {575 quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }576 }577 }578579 fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {580 let pascal_name = &self.pascal_name;581 let name = &self.name;582583 let matcher = if self.has_normal_args {584 let names = self585 .args586 .iter()587 .filter(|a| !a.is_special())588 .map(|a| &a.name);589590 quote! {{591 #(592 #names,593 )*594 }}595 } else {596 quote! {}597 };598599 let receiver = match self.mutability {600 Mutability::Mutable | Mutability::View => quote! {self.},601 Mutability::Pure => quote! {Self::},602 };603 let args = self.args.iter().map(|a| a.expand_call_arg());604605 quote! {606 #call_name::#pascal_name #matcher => {607 let result = #receiver #name(608 #(609 #args,610 )*611 )?;612 (&result).to_result()613 }614 }615 }616617 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {618 let pascal_name = &self.pascal_name;619 if let Some(weight) = &self.weight {620 let matcher = if self.has_normal_args {621 let names = self622 .args623 .iter()624 .filter(|a| !a.is_special())625 .map(|a| &a.name);626627 quote! {{628 #(629 #names,630 )*631 }}632 } else {633 quote! {}634 };635 quote! {636 Self::#pascal_name #matcher => (#weight).into()637 }638 } else {639 let matcher = if self.has_normal_args {640 quote! {{..}}641 } else {642 quote! {}643 };644 quote! {645 Self::#pascal_name #matcher => ().into()646 }647 }648 }649650 fn expand_solidity_function(&self) -> proc_macro2::TokenStream {651 let camel_name = &self.camel_name;652 let mutability = match self.mutability {653 Mutability::Mutable => quote! {SolidityMutability::Mutable},654 Mutability::View => quote! { SolidityMutability::View },655 Mutability::Pure => quote! {SolidityMutability::Pure},656 };657 let result = &self.result;658659 let args = self660 .args661 .iter()662 .filter(|a| !a.is_special())663 .map(MethodArg::expand_solidity_argument);664 let docs = self.docs.iter();665 let selector = format!("{} {:0>8x}", self.selector_str, self.selector);666667 quote! {668 SolidityFunction {669 docs: &[#(#docs),*],670 selector: #selector,671 name: #camel_name,672 mutability: #mutability,673 args: (674 #(675 #args,676 )*677 ),678 result: <UnnamedArgument<#result>>::default(),679 }680 }681 }682}683684fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {685 if gen.params.is_empty() {686 return quote! {};687 }688 let params = gen.params.iter().map(|p| match p {689 syn::GenericParam::Type(id) => {690 let v = &id.ident;691 quote! {#v}692 }693 syn::GenericParam::Lifetime(lt) => {694 let v = <.lifetime;695 quote! {#v}696 }697 syn::GenericParam::Const(c) => {698 let i = &c.ident;699 quote! {#i}700 }701 });702 quote! { #(#params),* }703}704fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {705 if gen.params.is_empty() {706 return quote! {};707 }708 let list = generics_list(gen);709 quote! { <#list> }710}711fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {712 let list = generics_list(gen);713 if gen.params.len() == 1 {714 quote! {#list}715 } else {716 quote! { (#list) }717 }718}719720pub struct SolidityInterface {721 generics: Generics,722 name: Box<syn::Type>,723 info: InterfaceInfo,724 methods: Vec<Method>,725}726impl SolidityInterface {727 pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {728 let mut methods = Vec::new();729730 for item in &value.items {731 if let ImplItem::Method(method) = item {732 methods.push(Method::try_from(method)?)733 }734 }735 Ok(Self {736 generics: value.generics.clone(),737 name: value.self_ty.clone(),738 info,739 methods,740 })741 }742 pub fn expand(self) -> proc_macro2::TokenStream {743 let name = self.name;744745 let solidity_name = self.info.name.to_string();746 let call_name = pascal_ident_to_call(&self.info.name);747 let generics = self.generics;748 let gen_ref = generics_reference(&generics);749 let gen_data = generics_data(&generics);750751 let call_sub = self752 .info753 .inline_is754 .0755 .iter()756 .chain(self.info.is.0.iter())757 .map(|c| Is::expand_call_def(c, &gen_ref));758 let call_parse = self759 .info760 .inline_is761 .0762 .iter()763 .chain(self.info.is.0.iter())764 .map(|is| Is::expand_parse(is, &gen_ref));765 let call_variants = self766 .info767 .inline_is768 .0769 .iter()770 .chain(self.info.is.0.iter())771 .map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));772 let weight_variants = self773 .info774 .inline_is775 .0776 .iter()777 .chain(self.info.is.0.iter())778 .map(Is::expand_variant_weight);779780 let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);781 let supports_interface = self782 .info783 .is784 .0785 .iter()786 .map(|is| Is::expand_supports_interface(is, &gen_ref));787788 let calls = self.methods.iter().map(Method::expand_call_def);789 let consts = self.methods.iter().map(Method::expand_const);790 let interface_id = self.methods.iter().map(Method::expand_interface_id);791 let parsers = self.methods.iter().map(Method::expand_parse);792 let call_variants_this = self793 .methods794 .iter()795 .map(|m| Method::expand_variant_call(m, &call_name));796 let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);797 let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);798799 // TODO: Inline inline_is800 let solidity_is = self801 .info802 .is803 .0804 .iter()805 .chain(self.info.inline_is.0.iter())806 .map(|is| is.name.to_string());807 let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());808 let solidity_generators = self809 .info810 .is811 .0812 .iter()813 .chain(self.info.inline_is.0.iter())814 .map(|is| Is::expand_generator(is, &gen_ref));815 let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);816817 // let methods = self.methods.iter().map(Method::solidity_def);818819 quote! {820 #[derive(Debug)]821 pub enum #call_name #gen_ref {822 ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),823 #(824 #calls,825 )*826 #(827 #call_sub,828 )*829 }830 impl #gen_ref #call_name #gen_ref {831 #(832 #consts833 )*834 pub fn interface_id() -> ::evm_coder::types::bytes4 {835 let mut interface_id = 0;836 #(#interface_id)*837 #(#inline_interface_id)*838 u32::to_be_bytes(interface_id)839 }840 pub fn supports_interface(interface_id: ::evm_coder::types::bytes4) -> bool {841 interface_id != u32::to_be_bytes(0xffffff) && (842 interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||843 interface_id == Self::interface_id()844 #(845 || #supports_interface846 )*847 )848 }849 pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {850 use evm_coder::solidity::*;851 use core::fmt::Write;852 let interface = SolidityInterface {853 name: #solidity_name,854 selector: Self::interface_id(),855 is: &["Dummy", "ERC165", #(856 #solidity_is,857 )* #(858 #solidity_events_is,859 )* ],860 functions: (#(861 #solidity_functions,862 )*),863 };864 if is_impl {865 tc.collect("// 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());866 } else {867 tc.collect("// Common stubs holder\ninterface Dummy {\n}\ninterface ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool);\n}\n".into());868 }869 #(870 #solidity_generators871 )*872 #(873 #solidity_event_generators874 )*875876 let mut out = string::new();877 // In solidity interface usage (is) should be preceeded by interface definition878 // This comment helps to sort it in a set879 if #solidity_name.starts_with("Inline") {880 out.push_str("// Inline\n");881 }882 let _ = interface.format(is_impl, &mut out, tc);883 tc.collect(out);884 }885 }886 impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {887 fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {888 use ::evm_coder::abi::AbiRead;889 match method_id {890 ::evm_coder::ERC165Call::INTERFACE_ID => return Ok(891 ::evm_coder::ERC165Call::parse(method_id, reader)?892 .map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))893 ),894 #(895 #parsers,896 )*897 _ => {},898 }899 #(900 #call_parse901 )else*902 return Ok(None);903 }904 }905 impl #generics ::evm_coder::Weighted for #call_name #gen_ref {906 #[allow(unused_variables)]907 fn weight(&self) -> ::evm_coder::execution::DispatchInfo {908 match self {909 #(910 #weight_variants,911 )*912 // TODO: It should be very cheap, but not free913 Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => 100u64.into(),914 #(915 #weight_variants_this,916 )*917 }918 }919 }920 impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name {921 #[allow(unreachable_code)] // In case of no inner calls922 fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {923 use ::evm_coder::abi::AbiWrite;924 match c.call {925 #(926 #call_variants,927 )*928 #call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {929 let mut writer = ::evm_coder::abi::AbiWriter::default();930 writer.bool(&<#call_name #gen_ref>::supports_interface(interface_id));931 return Ok(writer.into());932 }933 _ => {},934 }935 let mut writer = ::evm_coder::abi::AbiWriter::default();936 match c.call {937 #(938 #call_variants_this,939 )*940 _ => unreachable!()941 }942 }943 }944 }945 }946}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)]1819use quote::quote;20use darling::{FromMeta, ToTokens};21use inflector::cases;22use std::fmt::Write;23use syn::{24 Expr, FnArg, GenericArgument, Generics, Ident, ImplItem, ImplItemMethod, ItemImpl, Lit, Meta,25 MetaNameValue, NestedMeta, PatType, Path, PathArguments, ReturnType, Type, spanned::Spanned,26 parse_str,27};2829use crate::{30 fn_selector_str, parse_ident_from_pat, parse_ident_from_path, parse_path, parse_path_segment,31 parse_result_ok, pascal_ident_to_call, pascal_ident_to_snake_call, snake_ident_to_pascal,32 snake_ident_to_screaming,33};3435struct Is {36 name: Ident,37 pascal_call_name: Ident,38 snake_call_name: Ident,39 via: Option<(Type, Ident)>,40}41impl Is {42 fn new_via(path: &Path, via: Option<(Type, Ident)>) -> syn::Result<Self> {43 let name = parse_ident_from_path(path, false)?.clone();44 Ok(Self {45 pascal_call_name: pascal_ident_to_call(&name),46 snake_call_name: pascal_ident_to_snake_call(&name),47 name,48 via,49 })50 }51 fn new(path: &Path) -> syn::Result<Self> {52 Self::new_via(path, None)53 }5455 fn expand_call_def(&self, gen_ref: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {56 let name = &self.name;57 let pascal_call_name = &self.pascal_call_name;58 quote! {59 #name(#pascal_call_name #gen_ref)60 }61 }6263 fn expand_interface_id(&self) -> proc_macro2::TokenStream {64 let pascal_call_name = &self.pascal_call_name;65 quote! {66 interface_id ^= u32::from_be_bytes(#pascal_call_name::interface_id());67 }68 }6970 fn expand_supports_interface(71 &self,72 generics: &proc_macro2::TokenStream,73 ) -> proc_macro2::TokenStream {74 let pascal_call_name = &self.pascal_call_name;75 quote! {76 <#pascal_call_name #generics>::supports_interface(interface_id)77 }78 }7980 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {81 let name = &self.name;82 quote! {83 Self::#name(call) => call.weight()84 }85 }8687 fn expand_variant_call(88 &self,89 call_name: &proc_macro2::Ident,90 generics: &proc_macro2::TokenStream,91 ) -> proc_macro2::TokenStream {92 let name = &self.name;93 let pascal_call_name = &self.pascal_call_name;94 let via_typ = self95 .via96 .as_ref()97 .map(|(t, _)| quote! {#t})98 .unwrap_or_else(|| quote! {Self});99 let via_map = self100 .via101 .as_ref()102 .map(|(_, i)| quote! {.#i()})103 .unwrap_or_default();104 quote! {105 #call_name::#name(call) => return <#via_typ as ::evm_coder::Callable<#pascal_call_name #generics>>::call(self #via_map, Msg {106 call,107 caller: c.caller,108 value: c.value,109 })110 }111 }112113 fn expand_parse(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {114 let name = &self.name;115 let pascal_call_name = &self.pascal_call_name;116 quote! {117 if let Some(parsed_call) = <#pascal_call_name #generics>::parse(method_id, reader)? {118 return Ok(Some(Self::#name(parsed_call)))119 }120 }121 }122123 fn expand_generator(&self, generics: &proc_macro2::TokenStream) -> proc_macro2::TokenStream {124 let pascal_call_name = &self.pascal_call_name;125 quote! {126 <#pascal_call_name #generics>::generate_solidity_interface(tc, is_impl);127 }128 }129130 fn expand_event_generator(&self) -> proc_macro2::TokenStream {131 let name = &self.name;132 quote! {133 #name::generate_solidity_interface(tc, is_impl);134 }135 }136}137138#[derive(Default)]139struct IsList(Vec<Is>);140impl FromMeta for IsList {141 fn from_list(items: &[NestedMeta]) -> darling::Result<Self> {142 let mut out = Vec::new();143 for item in items {144 match item {145 NestedMeta::Meta(Meta::Path(path)) => out.push(Is::new(path)?),146 // TODO: replace meta parsing with manual147 NestedMeta::Meta(Meta::List(list))148 if list.path.is_ident("via") && list.nested.len() == 3 =>149 {150 let mut data = list.nested.iter();151 let typ = match data.next().expect("len == 3") {152 NestedMeta::Lit(Lit::Str(s)) => {153 let v = s.value();154 let typ: Type = parse_str(&v)?;155 typ156 }157 _ => {158 return Err(syn::Error::new(159 item.span(),160 "via typ should be type in string",161 )162 .into())163 }164 };165 let via = match data.next().expect("len == 3") {166 NestedMeta::Meta(Meta::Path(path)) => path167 .get_ident()168 .ok_or_else(|| syn::Error::new(item.span(), "via should be ident"))?,169 _ => return Err(syn::Error::new(item.span(), "via should be ident").into()),170 };171 let path = match data.next().expect("len == 3") {172 NestedMeta::Meta(Meta::Path(path)) => path,173 _ => return Err(syn::Error::new(item.span(), "path should be path").into()),174 };175176 out.push(Is::new_via(path, Some((typ, via.clone())))?)177 }178 _ => {179 return Err(syn::Error::new(180 item.span(),181 "expected either Name or via(\"Type\", getter, Name)",182 )183 .into())184 }185 }186 }187 Ok(Self(out))188 }189}190191#[derive(FromMeta)]192pub struct InterfaceInfo {193 name: Ident,194 #[darling(default)]195 is: IsList,196 #[darling(default)]197 inline_is: IsList,198 #[darling(default)]199 events: IsList,200}201202#[derive(FromMeta)]203struct MethodInfo {204 #[darling(default)]205 rename_selector: Option<String>,206}207208enum AbiType {209 // type210 Plain(Ident),211 // (type1,type2)212 Tuple(Vec<AbiType>),213 // type[]214 Vec(Box<AbiType>),215 // type[20]216 Array(Box<AbiType>, usize),217}218impl AbiType {219 fn try_from(value: &Type) -> syn::Result<Self> {220 let value = Self::try_maybe_special_from(value)?;221 if value.is_special() {222 return Err(syn::Error::new(value.span(), "unexpected special type"));223 }224 Ok(value)225 }226 fn try_maybe_special_from(value: &Type) -> syn::Result<Self> {227 match value {228 Type::Array(arr) => {229 let wrapped = AbiType::try_from(&arr.elem)?;230 match &arr.len {231 Expr::Lit(l) => match &l.lit {232 Lit::Int(i) => {233 let num = i.base10_parse::<usize>()?;234 Ok(AbiType::Array(Box::new(wrapped), num as usize))235 }236 _ => Err(syn::Error::new(arr.len.span(), "should be int literal")),237 },238 _ => Err(syn::Error::new(arr.len.span(), "should be literal")),239 }240 }241 Type::Path(_) => {242 let path = parse_path(value)?;243 let segment = parse_path_segment(path)?;244 if segment.ident == "Vec" {245 let args = match &segment.arguments {246 PathArguments::AngleBracketed(e) => e,247 _ => {248 return Err(syn::Error::new(249 segment.arguments.span(),250 "missing Vec generic",251 ))252 }253 };254 let args = &args.args;255 if args.len() != 1 {256 return Err(syn::Error::new(257 args.span(),258 "expected only one generic for vec",259 ));260 }261 let arg = args.first().unwrap();262263 let ty = match arg {264 GenericArgument::Type(ty) => ty,265 _ => {266 return Err(syn::Error::new(267 arg.span(),268 "expected first generic to be type",269 ))270 }271 };272273 let wrapped = AbiType::try_from(ty)?;274 Ok(Self::Vec(Box::new(wrapped)))275 } else {276 if !segment.arguments.is_empty() {277 return Err(syn::Error::new(278 segment.arguments.span(),279 "unexpected generic arguments for non-vec type",280 ));281 }282 Ok(Self::Plain(segment.ident.clone()))283 }284 }285 Type::Tuple(t) => {286 let mut out = Vec::with_capacity(t.elems.len());287 for el in t.elems.iter() {288 out.push(AbiType::try_from(el)?)289 }290 Ok(Self::Tuple(out))291 }292 _ => Err(syn::Error::new(293 value.span(),294 "unexpected type, only arrays, plain types and tuples are supported",295 )),296 }297 }298 fn is_value(&self) -> bool {299 matches!(self, Self::Plain(v) if v == "value")300 }301 fn is_caller(&self) -> bool {302 matches!(self, Self::Plain(v) if v == "caller")303 }304 fn is_special(&self) -> bool {305 self.is_caller() || self.is_value()306 }307 fn selector_ty_buf(&self, buf: &mut String) -> std::fmt::Result {308 match self {309 AbiType::Plain(t) => {310 write!(buf, "{}", t)311 }312 AbiType::Tuple(t) => {313 write!(buf, "(")?;314 for (i, t) in t.iter().enumerate() {315 if i != 0 {316 write!(buf, ",")?;317 }318 t.selector_ty_buf(buf)?;319 }320 write!(buf, ")")321 }322 AbiType::Vec(v) => {323 v.selector_ty_buf(buf)?;324 write!(buf, "[]")325 }326 AbiType::Array(v, len) => {327 v.selector_ty_buf(buf)?;328 write!(buf, "[{}]", len)329 }330 }331 }332 fn selector_ty(&self) -> String {333 let mut out = String::new();334 self.selector_ty_buf(&mut out).expect("no fmt error");335 out336 }337}338impl ToTokens for AbiType {339 fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {340 match self {341 AbiType::Plain(t) => tokens.extend(quote! {#t}),342 AbiType::Tuple(t) => {343 tokens.extend(quote! {(344 #(#t),*345 )});346 }347 AbiType::Vec(v) => tokens.extend(quote! {Vec<#v>}),348 AbiType::Array(v, l) => tokens.extend(quote! {[#v; #l]}),349 }350 }351}352353struct MethodArg {354 name: Ident,355 camel_name: String,356 ty: AbiType,357}358impl MethodArg {359 fn try_from(value: &PatType) -> syn::Result<Self> {360 let name = parse_ident_from_pat(&value.pat)?.clone();361 Ok(Self {362 camel_name: cases::camelcase::to_camel_case(&name.to_string()),363 name,364 ty: AbiType::try_maybe_special_from(&value.ty)?,365 })366 }367 fn is_value(&self) -> bool {368 self.ty.is_value()369 }370 fn is_caller(&self) -> bool {371 self.ty.is_caller()372 }373 fn is_special(&self) -> bool {374 self.ty.is_special()375 }376 fn selector_ty(&self) -> String {377 assert!(!self.is_special());378 self.ty.selector_ty()379 }380381 fn expand_call_def(&self) -> proc_macro2::TokenStream {382 assert!(!self.is_special());383 let name = &self.name;384 let ty = &self.ty;385386 quote! {387 #name: #ty388 }389 }390391 fn expand_parse(&self) -> proc_macro2::TokenStream {392 assert!(!self.is_special());393 let name = &self.name;394 quote! {395 #name: reader.abi_read()?396 }397 }398399 fn expand_call_arg(&self) -> proc_macro2::TokenStream {400 if self.is_value() {401 quote! {402 c.value.clone()403 }404 } else if self.is_caller() {405 quote! {406 c.caller.clone()407 }408 } else {409 let name = &self.name;410 quote! {411 #name412 }413 }414 }415416 fn expand_solidity_argument(&self) -> proc_macro2::TokenStream {417 let camel_name = &self.camel_name.to_string();418 let ty = &self.ty;419 quote! {420 <NamedArgument<#ty>>::new(#camel_name)421 }422 }423}424425#[derive(PartialEq)]426enum Mutability {427 Mutable,428 View,429 Pure,430}431432pub struct WeightAttr(syn::Expr);433434mod keyword {435 syn::custom_keyword!(weight);436}437438impl syn::parse::Parse for WeightAttr {439 fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {440 input.parse::<syn::Token![#]>()?;441 let content;442 syn::bracketed!(content in input);443 content.parse::<keyword::weight>()?;444445 let weight_content;446 syn::parenthesized!(weight_content in content);447 Ok(WeightAttr(weight_content.parse::<syn::Expr>()?))448 }449}450451struct Method {452 name: Ident,453 camel_name: String,454 pascal_name: Ident,455 screaming_name: Ident,456 selector_str: String,457 selector: u32,458 args: Vec<MethodArg>,459 has_normal_args: bool,460 mutability: Mutability,461 result: Type,462 weight: Option<Expr>,463 docs: Vec<String>,464}465impl Method {466 fn try_from(value: &ImplItemMethod) -> syn::Result<Self> {467 let mut info = MethodInfo {468 rename_selector: None,469 };470 let mut docs = Vec::new();471 let mut weight = None;472 for attr in &value.attrs {473 let ident = parse_ident_from_path(&attr.path, false)?;474 if ident == "solidity" {475 let args = attr.parse_meta().unwrap();476 info = MethodInfo::from_meta(&args).unwrap();477 } else if ident == "doc" {478 let args = attr.parse_meta().unwrap();479 let value = match args {480 Meta::NameValue(MetaNameValue {481 lit: Lit::Str(str), ..482 }) => str.value(),483 _ => unreachable!(),484 };485 docs.push(value);486 } else if ident == "weight" {487 weight = Some(syn::parse2::<WeightAttr>(attr.to_token_stream())?.0);488 }489 }490 let ident = &value.sig.ident;491 let ident_str = ident.to_string();492 if !cases::snakecase::is_snake_case(&ident_str) {493 return Err(syn::Error::new(ident.span(), "method name should be snake_cased\nif alternative solidity name needs to be set - use #[solidity] attribute"));494 }495496 let mut mutability = Mutability::Pure;497498 if let Some(FnArg::Receiver(receiver)) = value499 .sig500 .inputs501 .iter()502 .find(|arg| matches!(arg, FnArg::Receiver(_)))503 {504 if receiver.reference.is_none() {505 return Err(syn::Error::new(506 receiver.span(),507 "receiver should be by ref",508 ));509 }510 if receiver.mutability.is_some() {511 mutability = Mutability::Mutable;512 } else {513 mutability = Mutability::View;514 }515 }516 let mut args = Vec::new();517 for typ in value518 .sig519 .inputs520 .iter()521 .filter(|arg| matches!(arg, FnArg::Typed(_)))522 {523 let typ = match typ {524 FnArg::Typed(typ) => typ,525 _ => unreachable!(),526 };527 args.push(MethodArg::try_from(typ)?);528 }529530 if mutability != Mutability::Mutable && args.iter().any(|arg| arg.is_value()) {531 return Err(syn::Error::new(532 args.iter().find(|arg| arg.is_value()).unwrap().ty.span(),533 "payable function should be mutable",534 ));535 }536537 let result = match &value.sig.output {538 ReturnType::Type(_, ty) => ty,539 _ => 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)")),540 };541 let result = parse_result_ok(result)?;542543 let camel_name = info544 .rename_selector545 .unwrap_or_else(|| cases::camelcase::to_camel_case(&ident.to_string()));546 let mut selector_str = camel_name.clone();547 selector_str.push('(');548 let mut has_normal_args = false;549 for (i, arg) in args.iter().filter(|arg| !arg.is_special()).enumerate() {550 if i != 0 {551 selector_str.push(',');552 }553 write!(selector_str, "{}", arg.selector_ty()).unwrap();554 has_normal_args = true;555 }556 selector_str.push(')');557 let selector = fn_selector_str(&selector_str);558559 Ok(Self {560 name: ident.clone(),561 camel_name,562 pascal_name: snake_ident_to_pascal(ident),563 screaming_name: snake_ident_to_screaming(ident),564 selector_str,565 selector,566 args,567 has_normal_args,568 mutability,569 result: result.clone(),570 weight,571 docs,572 })573 }574 fn expand_call_def(&self) -> proc_macro2::TokenStream {575 let defs = self576 .args577 .iter()578 .filter(|a| !a.is_special())579 .map(|a| a.expand_call_def());580 let pascal_name = &self.pascal_name;581582 if self.has_normal_args {583 quote! {584 #pascal_name {585 #(586 #defs,587 )*588 }589 }590 } else {591 quote! {#pascal_name}592 }593 }594595 fn expand_const(&self) -> proc_macro2::TokenStream {596 let screaming_name = &self.screaming_name;597 let selector = u32::to_be_bytes(self.selector);598 let selector_str = &self.selector_str;599 quote! {600 #[doc = #selector_str]601 const #screaming_name: ::evm_coder::types::bytes4 = [#(#selector,)*];602 }603 }604605 fn expand_interface_id(&self) -> proc_macro2::TokenStream {606 let screaming_name = &self.screaming_name;607 quote! {608 interface_id ^= u32::from_be_bytes(Self::#screaming_name);609 }610 }611612 fn expand_parse(&self) -> proc_macro2::TokenStream {613 let pascal_name = &self.pascal_name;614 let screaming_name = &self.screaming_name;615 if self.has_normal_args {616 let parsers = self617 .args618 .iter()619 .filter(|a| !a.is_special())620 .map(|a| a.expand_parse());621 quote! {622 Self::#screaming_name => return Ok(Some(Self::#pascal_name {623 #(624 #parsers,625 )*626 }))627 }628 } else {629 quote! { Self::#screaming_name => return Ok(Some(Self::#pascal_name)) }630 }631 }632633 fn expand_variant_call(&self, call_name: &proc_macro2::Ident) -> proc_macro2::TokenStream {634 let pascal_name = &self.pascal_name;635 let name = &self.name;636637 let matcher = if self.has_normal_args {638 let names = self639 .args640 .iter()641 .filter(|a| !a.is_special())642 .map(|a| &a.name);643644 quote! {{645 #(646 #names,647 )*648 }}649 } else {650 quote! {}651 };652653 let receiver = match self.mutability {654 Mutability::Mutable | Mutability::View => quote! {self.},655 Mutability::Pure => quote! {Self::},656 };657 let args = self.args.iter().map(|a| a.expand_call_arg());658659 quote! {660 #call_name::#pascal_name #matcher => {661 let result = #receiver #name(662 #(663 #args,664 )*665 )?;666 (&result).to_result()667 }668 }669 }670671 fn expand_variant_weight(&self) -> proc_macro2::TokenStream {672 let pascal_name = &self.pascal_name;673 if let Some(weight) = &self.weight {674 let matcher = if self.has_normal_args {675 let names = self676 .args677 .iter()678 .filter(|a| !a.is_special())679 .map(|a| &a.name);680681 quote! {{682 #(683 #names,684 )*685 }}686 } else {687 quote! {}688 };689 quote! {690 Self::#pascal_name #matcher => (#weight).into()691 }692 } else {693 let matcher = if self.has_normal_args {694 quote! {{..}}695 } else {696 quote! {}697 };698 quote! {699 Self::#pascal_name #matcher => ().into()700 }701 }702 }703704 fn expand_solidity_function(&self) -> proc_macro2::TokenStream {705 let camel_name = &self.camel_name;706 let mutability = match self.mutability {707 Mutability::Mutable => quote! {SolidityMutability::Mutable},708 Mutability::View => quote! { SolidityMutability::View },709 Mutability::Pure => quote! {SolidityMutability::Pure},710 };711 let result = &self.result;712713 let args = self714 .args715 .iter()716 .filter(|a| !a.is_special())717 .map(MethodArg::expand_solidity_argument);718 let docs = self.docs.iter();719 let selector = format!("{} {:0>8x}", self.selector_str, self.selector);720721 quote! {722 SolidityFunction {723 docs: &[#(#docs),*],724 selector: #selector,725 name: #camel_name,726 mutability: #mutability,727 args: (728 #(729 #args,730 )*731 ),732 result: <UnnamedArgument<#result>>::default(),733 }734 }735 }736}737738fn generics_list(gen: &Generics) -> proc_macro2::TokenStream {739 if gen.params.is_empty() {740 return quote! {};741 }742 let params = gen.params.iter().map(|p| match p {743 syn::GenericParam::Type(id) => {744 let v = &id.ident;745 quote! {#v}746 }747 syn::GenericParam::Lifetime(lt) => {748 let v = <.lifetime;749 quote! {#v}750 }751 syn::GenericParam::Const(c) => {752 let i = &c.ident;753 quote! {#i}754 }755 });756 quote! { #(#params),* }757}758fn generics_reference(gen: &Generics) -> proc_macro2::TokenStream {759 if gen.params.is_empty() {760 return quote! {};761 }762 let list = generics_list(gen);763 quote! { <#list> }764}765fn generics_data(gen: &Generics) -> proc_macro2::TokenStream {766 let list = generics_list(gen);767 if gen.params.len() == 1 {768 quote! {#list}769 } else {770 quote! { (#list) }771 }772}773774pub struct SolidityInterface {775 generics: Generics,776 name: Box<syn::Type>,777 info: InterfaceInfo,778 methods: Vec<Method>,779}780impl SolidityInterface {781 pub fn try_from(info: InterfaceInfo, value: &ItemImpl) -> syn::Result<Self> {782 let mut methods = Vec::new();783784 for item in &value.items {785 if let ImplItem::Method(method) = item {786 methods.push(Method::try_from(method)?)787 }788 }789 Ok(Self {790 generics: value.generics.clone(),791 name: value.self_ty.clone(),792 info,793 methods,794 })795 }796 pub fn expand(self) -> proc_macro2::TokenStream {797 let name = self.name;798799 let solidity_name = self.info.name.to_string();800 let call_name = pascal_ident_to_call(&self.info.name);801 let generics = self.generics;802 let gen_ref = generics_reference(&generics);803 let gen_data = generics_data(&generics);804805 let call_sub = self806 .info807 .inline_is808 .0809 .iter()810 .chain(self.info.is.0.iter())811 .map(|c| Is::expand_call_def(c, &gen_ref));812 let call_parse = self813 .info814 .inline_is815 .0816 .iter()817 .chain(self.info.is.0.iter())818 .map(|is| Is::expand_parse(is, &gen_ref));819 let call_variants = self820 .info821 .inline_is822 .0823 .iter()824 .chain(self.info.is.0.iter())825 .map(|c| Is::expand_variant_call(c, &call_name, &gen_ref));826 let weight_variants = self827 .info828 .inline_is829 .0830 .iter()831 .chain(self.info.is.0.iter())832 .map(Is::expand_variant_weight);833834 let inline_interface_id = self.info.inline_is.0.iter().map(Is::expand_interface_id);835 let supports_interface = self836 .info837 .is838 .0839 .iter()840 .map(|is| Is::expand_supports_interface(is, &gen_ref));841842 let calls = self.methods.iter().map(Method::expand_call_def);843 let consts = self.methods.iter().map(Method::expand_const);844 let interface_id = self.methods.iter().map(Method::expand_interface_id);845 let parsers = self.methods.iter().map(Method::expand_parse);846 let call_variants_this = self847 .methods848 .iter()849 .map(|m| Method::expand_variant_call(m, &call_name));850 let weight_variants_this = self.methods.iter().map(Method::expand_variant_weight);851 let solidity_functions = self.methods.iter().map(Method::expand_solidity_function);852853 // TODO: Inline inline_is854 let solidity_is = self855 .info856 .is857 .0858 .iter()859 .chain(self.info.inline_is.0.iter())860 .map(|is| is.name.to_string());861 let solidity_events_is = self.info.events.0.iter().map(|is| is.name.to_string());862 let solidity_generators = self863 .info864 .is865 .0866 .iter()867 .chain(self.info.inline_is.0.iter())868 .map(|is| Is::expand_generator(is, &gen_ref));869 let solidity_event_generators = self.info.events.0.iter().map(Is::expand_event_generator);870871 // let methods = self.methods.iter().map(Method::solidity_def);872873 quote! {874 #[derive(Debug)]875 pub enum #call_name #gen_ref {876 ERC165Call(::evm_coder::ERC165Call, ::core::marker::PhantomData<#gen_data>),877 #(878 #calls,879 )*880 #(881 #call_sub,882 )*883 }884 impl #gen_ref #call_name #gen_ref {885 #(886 #consts887 )*888 pub fn interface_id() -> ::evm_coder::types::bytes4 {889 let mut interface_id = 0;890 #(#interface_id)*891 #(#inline_interface_id)*892 u32::to_be_bytes(interface_id)893 }894 pub fn supports_interface(interface_id: ::evm_coder::types::bytes4) -> bool {895 interface_id != u32::to_be_bytes(0xffffff) && (896 interface_id == ::evm_coder::ERC165Call::INTERFACE_ID ||897 interface_id == Self::interface_id()898 #(899 || #supports_interface900 )*901 )902 }903 pub fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector, is_impl: bool) {904 use evm_coder::solidity::*;905 use core::fmt::Write;906 let interface = SolidityInterface {907 name: #solidity_name,908 selector: Self::interface_id(),909 is: &["Dummy", "ERC165", #(910 #solidity_is,911 )* #(912 #solidity_events_is,913 )* ],914 functions: (#(915 #solidity_functions,916 )*),917 };918 if is_impl {919 tc.collect("// 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());920 } else {921 tc.collect("// Common stubs holder\ninterface Dummy {\n}\ninterface ERC165 is Dummy {\n\tfunction supportsInterface(bytes4 interfaceID) external view returns (bool);\n}\n".into());922 }923 #(924 #solidity_generators925 )*926 #(927 #solidity_event_generators928 )*929930 let mut out = string::new();931 // In solidity interface usage (is) should be preceeded by interface definition932 // This comment helps to sort it in a set933 if #solidity_name.starts_with("Inline") {934 out.push_str("// Inline\n");935 }936 let _ = interface.format(is_impl, &mut out, tc);937 tc.collect(out);938 }939 }940 impl #gen_ref ::evm_coder::Call for #call_name #gen_ref {941 fn parse(method_id: ::evm_coder::types::bytes4, reader: &mut ::evm_coder::abi::AbiReader) -> ::evm_coder::execution::Result<Option<Self>> {942 use ::evm_coder::abi::AbiRead;943 match method_id {944 ::evm_coder::ERC165Call::INTERFACE_ID => return Ok(945 ::evm_coder::ERC165Call::parse(method_id, reader)?946 .map(|c| Self::ERC165Call(c, ::core::marker::PhantomData))947 ),948 #(949 #parsers,950 )*951 _ => {},952 }953 #(954 #call_parse955 )else*956 return Ok(None);957 }958 }959 impl #generics ::evm_coder::Weighted for #call_name #gen_ref {960 #[allow(unused_variables)]961 fn weight(&self) -> ::evm_coder::execution::DispatchInfo {962 match self {963 #(964 #weight_variants,965 )*966 // TODO: It should be very cheap, but not free967 Self::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {..}, _) => 100u64.into(),968 #(969 #weight_variants_this,970 )*971 }972 }973 }974 impl #generics ::evm_coder::Callable<#call_name #gen_ref> for #name {975 #[allow(unreachable_code)] // In case of no inner calls976 fn call(&mut self, c: Msg<#call_name #gen_ref>) -> ::evm_coder::execution::ResultWithPostInfo<::evm_coder::abi::AbiWriter> {977 use ::evm_coder::abi::AbiWrite;978 match c.call {979 #(980 #call_variants,981 )*982 #call_name::ERC165Call(::evm_coder::ERC165Call::SupportsInterface {interface_id}, _) => {983 let mut writer = ::evm_coder::abi::AbiWriter::default();984 writer.bool(&<#call_name #gen_ref>::supports_interface(interface_id));985 return Ok(writer.into());986 }987 _ => {},988 }989 let mut writer = ::evm_coder::abi::AbiWriter::default();990 match c.call {991 #(992 #call_variants_this,993 )*994 _ => unreachable!()995 }996 }997 }998 }999 }1000}pallets/common/src/erc.rsdiffbeforeafterboth--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -14,9 +14,14 @@
// You should have received a copy of the GNU General Public License
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
-pub use pallet_evm::PrecompileOutput;
-pub use pallet_evm::PrecompileResult;
+use evm_coder::{solidity_interface, types::*, execution::Result};
+pub use pallet_evm::{PrecompileOutput, PrecompileResult, account::CrossAccountId};
+use pallet_evm_coder_substrate::dispatch_to_evm;
use sp_core::{H160, U256};
+use sp_std::vec::Vec;
+use up_data_structs::Property;
+
+use crate::{Pallet, CollectionHandle, Config};
/// Does not always represent a full collection, for RFT it is either
/// collection (Implementing ERC721), or specific collection token (Implementing ERC20)
@@ -25,3 +30,27 @@
fn call(self, source: &H160, input: &[u8], value: U256) -> Option<PrecompileResult>;
}
+
+#[solidity_interface(name = "CollectionProperties")]
+impl<T: Config> CollectionHandle<T> {
+ fn set_property(&mut self, caller: caller, key: string, value: string) -> Result<()> {
+ <Pallet<T>>::set_collection_property(
+ self,
+ &T::CrossAccountId::from_eth(caller),
+ Property {
+ key: <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "key too large")?,
+ value: <Vec<u8>>::from(value)
+ .try_into()
+ .map_err(|_| "value too large")?,
+ },
+ )
+ .map_err(dispatch_to_evm::<T>)?;
+ Ok(())
+ }
+
+ fn delete_property(&mut self, caller: caller, key: string) -> Result<()> {
+ self.set_property(caller, key, string::new())
+ }
+}
pallets/common/src/lib.rsdiffbeforeafterboth--- a/pallets/common/src/lib.rs
+++ b/pallets/common/src/lib.rs
@@ -595,7 +595,7 @@
.iter()
.map(|(key, value)| Property {
key: key.clone(),
- value: value.clone()
+ value: value.clone(),
})
.collect();
@@ -680,19 +680,20 @@
};
let mut collection_properties = up_data_structs::CollectionProperties::get();
- collection_properties.try_set_from_iter(
- data.properties.into_iter()
- .map(|p| (p.key, p.value))
- ).map_err(|e| -> Error<T> { e.into() })?;
+ collection_properties
+ .try_set_from_iter(data.properties.into_iter().map(|p| (p.key, p.value)))
+ .map_err(|e| -> Error<T> { e.into() })?;
CollectionProperties::<T>::insert(id, collection_properties);
let mut token_props_permissions = PropertiesPermissionMap::new();
- token_props_permissions.try_set_from_iter(
- data.token_property_permissions
- .into_iter()
- .map(|property| (property.key, property.permission))
- ).map_err(|e| -> Error<T> { e.into() })?;
+ token_props_permissions
+ .try_set_from_iter(
+ data.token_property_permissions
+ .into_iter()
+ .map(|property| (property.key, property.permission)),
+ )
+ .map_err(|e| -> Error<T> { e.into() })?;
CollectionPropertyPermissions::<T>::insert(id, token_props_permissions);
@@ -806,7 +807,8 @@
CollectionProperties::<T>::try_mutate(collection.id, |properties| {
properties.remove(&property_key)
- }).map_err(|e| -> Error<T> { e.into() })?;
+ })
+ .map_err(|e| -> Error<T> { e.into() })?;
Self::deposit_event(Event::CollectionPropertyDeleted(
collection.id,
@@ -903,11 +905,10 @@
let properties = keys
.into_iter()
.filter_map(|key| {
- properties.get(&key)
- .map(|value| Property {
- key,
- value: value.clone(),
- })
+ properties.get(&key).map(|value| Property {
+ key,
+ value: value.clone(),
+ })
})
.collect();
pallets/fungible/src/erc.rsdiffbeforeafterboth--- a/pallets/fungible/src/erc.rs
+++ b/pallets/fungible/src/erc.rs
@@ -24,6 +24,7 @@
use pallet_evm::account::CrossAccountId;
use pallet_evm_coder_substrate::{call, dispatch_to_evm};
use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};
+use pallet_common::{CollectionHandle, erc::CollectionPropertiesCall};
use crate::{
Allowance, Balance, Config, FungibleHandle, Pallet, SelfWeightOf, TotalSupply,
@@ -144,7 +145,14 @@
}
}
-#[solidity_interface(name = "UniqueFungible", is(ERC20))]
+#[solidity_interface(
+ name = "UniqueFungible",
+ is(
+ ERC20,
+ ERC20UniqueExtensions,
+ via("CollectionHandle<T>", common_mut, CollectionProperties)
+ )
+)]
impl<T: Config> FungibleHandle<T> {}
generate_stubgen!(gen_impl, UniqueFungibleCall<()>, true);
pallets/fungible/src/lib.rsdiffbeforeafterboth--- a/pallets/fungible/src/lib.rs
+++ b/pallets/fungible/src/lib.rs
@@ -110,6 +110,9 @@
pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {
self.0
}
+ pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {
+ &mut self.0
+ }
}
impl<T: Config> WithRecorder<T> for FungibleHandle<T> {
fn recorder(&self) -> &pallet_evm_coder_substrate::SubstrateRecorder<T> {
pallets/nonfungible/src/common.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/common.rs
+++ b/pallets/nonfungible/src/common.rs
@@ -391,11 +391,10 @@
keys.into_iter()
.filter_map(|key| {
- properties.get(&key)
- .map(|value| Property {
- key,
- value: value.clone(),
- })
+ properties.get(&key).map(|value| Property {
+ key,
+ value: value.clone(),
+ })
})
.collect()
}
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -26,7 +26,8 @@
use sp_core::{H160, U256};
use sp_std::{vec::Vec, vec};
use pallet_common::{
- erc::{CommonEvmHandler, PrecompileResult},
+ erc::{CommonEvmHandler, PrecompileResult, CollectionPropertiesCall},
+ CollectionHandle,
};
use pallet_evm::account::CrossAccountId;
use pallet_evm_coder_substrate::call;
@@ -504,6 +505,7 @@
ERC721UniqueExtensions,
ERC721Mintable,
ERC721Burnable,
+ via("CollectionHandle<T>", common_mut, CollectionProperties)
)
)]
impl<T: Config> NonfungibleHandle<T> {}
pallets/nonfungible/src/lib.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/lib.rs
+++ b/pallets/nonfungible/src/lib.rs
@@ -142,6 +142,9 @@
pub fn into_inner(self) -> pallet_common::CollectionHandle<T> {
self.0
}
+ pub fn common_mut(&mut self) -> &mut pallet_common::CollectionHandle<T> {
+ &mut self.0
+ }
}
impl<T: Config> WithRecorder<T> for NonfungibleHandle<T> {
fn recorder(&self) -> &SubstrateRecorder<T> {
@@ -302,7 +305,8 @@
<TokenProperties<T>>::try_mutate((collection.id, token_id), |properties| {
properties.remove(&property_key)
- }).map_err(|e| -> CommonError<T> { e.into() })?;
+ })
+ .map_err(|e| -> CommonError<T> { e.into() })?;
<PalletCommon<T>>::deposit_event(CommonEvent::TokenPropertyDeleted(
collection.id,
primitives/data-structs/src/lib.rsdiffbeforeafterboth--- a/primitives/data-structs/src/lib.rs
+++ b/primitives/data-structs/src/lib.rs
@@ -699,7 +699,7 @@
fn try_set_from_iter<I>(&mut self, iter: I) -> Result<(), PropertiesError>
where
- I: Iterator<Item=(PropertyKey, Self::Value)>
+ I: Iterator<Item = (PropertyKey, Self::Value)>,
{
for (key, value) in iter {
self.try_set(key, value)?;
@@ -711,7 +711,9 @@
#[derive(Encode, Decode, TypeInfo, Derivative, Clone, PartialEq, MaxEncodedLen)]
#[derivative(Default(bound = ""))]
-pub struct PropertiesMap<Value>(BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>);
+pub struct PropertiesMap<Value>(
+ BoundedBTreeMap<PropertyKey, Value, ConstU32<MAX_PROPERTIES_PER_ITEM>>,
+);
impl<Value> PropertiesMap<Value> {
pub fn new() -> Self {