difftreelog
refactor reuse code generation patterns
in: master
22 files changed
crates/evm-coder/procedural/src/abi_derive/derive_enum.rsdiffbeforeafterboth--- a/crates/evm-coder/procedural/src/abi_derive/derive_enum.rs
+++ b/crates/evm-coder/procedural/src/abi_derive/derive_enum.rs
@@ -1,20 +1,52 @@
use quote::quote;
+use super::extract_docs;
+
pub fn impl_solidity_option<'a>(
+ docs: Vec<String>,
name: &proc_macro2::Ident,
- enum_options: impl Iterator<Item = &'a syn::Ident>,
+ enum_options: impl Iterator<Item = &'a syn::Variant> + Clone,
) -> proc_macro2::TokenStream {
- let enum_options = enum_options.map(|opt| {
+ let variant_names = enum_options.clone().map(|opt| {
+ let opt = &opt.ident;
let s = name.to_string() + "." + opt.to_string().as_str();
let as_string = proc_macro2::Literal::string(s.as_str());
quote!(#name::#opt => #as_string,)
});
+ let solidity_name = name.to_string();
+
+ let solidity_fields = enum_options.map(|v| {
+ let docs = extract_docs(&v.attrs).expect("TODO: handle bad docs");
+ let name = v.ident.to_string();
+ quote! {
+ SolidityEnumVariant {
+ docs: &[#(#docs),*],
+ name: #name,
+ }
+ }
+ });
+
quote!(
#[cfg(feature = "stubgen")]
- impl ::evm_coder::solidity::SolidityEnum for #name {
+ impl ::evm_coder::solidity::SolidityEnumTy for #name {
+ fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector) -> String {
+ use evm_coder::solidity::*;
+ use core::fmt::Write;
+ let interface = SolidityEnum {
+ docs: &[#(#docs),*],
+ name: #solidity_name,
+ fields: &[#(
+ #solidity_fields,
+ )*],
+ };
+ let mut out = String::new();
+ let _ = interface.format(&mut out, tc);
+ tc.collect(out);
+ #solidity_name.to_string()
+ }
fn solidity_option(&self) -> &str {
match self {
- #(#enum_options)*
+ #(#variant_names)*
}
}
}
@@ -23,11 +55,12 @@
pub fn impl_enum_from_u8<'a>(
name: &proc_macro2::Ident,
- enum_options: impl Iterator<Item = &'a syn::Ident>,
+ enum_options: impl Iterator<Item = &'a syn::Variant>,
) -> proc_macro2::TokenStream {
let error_str = format!("Value not convertible into enum \"{name}\"");
let error_str = proc_macro2::Literal::string(&error_str);
let enum_options = enum_options.enumerate().map(|(i, opt)| {
+ let opt = &opt.ident;
let n = proc_macro2::Literal::u8_suffixed(i as u8);
quote! {#n => Ok(#name::#opt),}
});
@@ -83,21 +116,6 @@
}
}
)
-}
-
-pub fn impl_enum_solidity_type<'a>(name: &syn::Ident) -> proc_macro2::TokenStream {
- quote! {
- #[cfg(feature = "stubgen")]
- impl ::evm_coder::solidity::SolidityType for #name {
- fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {
- Vec::new()
- }
-
- fn len() -> usize {
- 1
- }
- }
- }
}
pub fn impl_enum_solidity_type_name(name: &syn::Ident) -> proc_macro2::TokenStream {
@@ -108,7 +126,7 @@
writer: &mut impl ::core::fmt::Write,
tc: &::evm_coder::solidity::TypeCollector,
) -> ::core::fmt::Result {
- write!(writer, "{}", tc.collect_struct::<Self>())
+ write!(writer, "{}", tc.collect_enum::<Self>())
}
fn is_simple() -> bool {
@@ -119,49 +137,7 @@
writer: &mut impl ::core::fmt::Write,
tc: &::evm_coder::solidity::TypeCollector,
) -> ::core::fmt::Result {
- write!(writer, "{}", <#name as ::evm_coder::solidity::SolidityEnum>::solidity_option(&<#name>::default()))
- }
- }
- )
-}
-
-pub fn impl_enum_solidity_struct_collect<'a>(
- name: &syn::Ident,
- enum_options: impl Iterator<Item = &'a syn::Ident>,
- option_count: usize,
- enum_options_docs: impl Iterator<Item = syn::Result<Vec<proc_macro2::TokenStream>>>,
- docs: &[proc_macro2::TokenStream],
-) -> proc_macro2::TokenStream {
- let string_name = name.to_string();
- let enum_options = enum_options
- .zip(enum_options_docs)
- .enumerate()
- .map(|(i, (opt, doc))| {
- let opt = proc_macro2::Literal::string(opt.to_string().as_str());
- let doc = doc.expect("Doc parsing error");
- let comma = if i != option_count - 1 { "," } else { "" };
- quote! {
- #(#doc)*
- writeln!(str, "\t{}{}", #opt, #comma).expect("Enum format option");
- }
- });
-
- quote!(
- #[cfg(feature = "stubgen")]
- impl ::evm_coder::solidity::StructCollect for #name {
- fn name() -> String {
- #string_name.into()
- }
-
- fn declaration() -> String {
- use std::fmt::Write;
-
- let mut str = String::new();
- #(#docs)*
- writeln!(str, "enum {} {{", <Self as ::evm_coder::solidity::StructCollect>::name()).unwrap();
- #(#enum_options)*
- writeln!(str, "}}").unwrap();
- str
+ write!(writer, "{}", <#name as ::evm_coder::solidity::SolidityEnumTy>::solidity_option(&<#name>::default()))
}
}
)
crates/evm-coder/procedural/src/abi_derive/derive_struct.rsdiffbeforeafterboth--- a/crates/evm-coder/procedural/src/abi_derive/derive_struct.rs
+++ b/crates/evm-coder/procedural/src/abi_derive/derive_struct.rs
@@ -1,5 +1,6 @@
use super::extract_docs;
use quote::quote;
+use syn::Field;
pub fn tuple_type<'a>(
field_types: impl Iterator<Item = &'a syn::Type> + Clone,
@@ -87,10 +88,6 @@
&field.ty
}
-pub fn map_field_to_doc(field: &syn::Field) -> syn::Result<Vec<proc_macro2::TokenStream>> {
- extract_docs(&field.attrs, true)
-}
-
pub fn impl_can_be_placed_in_vec(ident: &syn::Ident) -> proc_macro2::TokenStream {
quote! {
impl ::evm_coder::sealed::CanBePlacedInVec for #ident {}
@@ -147,27 +144,44 @@
pub fn impl_struct_solidity_type<'a>(
name: &syn::Ident,
- field_types: impl Iterator<Item = &'a syn::Type> + Clone,
- params_count: usize,
+ docs: Vec<String>,
+ fields: impl Iterator<Item = &'a Field> + Clone,
) -> proc_macro2::TokenStream {
- let len = proc_macro2::Literal::usize_suffixed(params_count);
+ let solidity_name = name.to_string();
+ let solidity_fields = fields.enumerate().map(|(i, f)| {
+ let name = f
+ .ident
+ .as_ref()
+ .map(|i| i.to_string())
+ .unwrap_or_else(|| format!("field_{i}"));
+ let ty = &f.ty;
+ let docs = extract_docs(&f.attrs).expect("TODO: handle bad docs");
+ quote! {
+ SolidityStructField::<#ty> {
+ docs: &[#(#docs),*],
+ name: #name,
+ ty: ::core::marker::PhantomData,
+ }
+ }
+ });
quote! {
#[cfg(feature = "stubgen")]
- impl ::evm_coder::solidity::SolidityType for #name {
- fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {
- let mut collected =
- Vec::with_capacity(<Self as ::evm_coder::solidity::SolidityType>::len());
- #({
- let mut out = String::new();
- <#field_types as ::evm_coder::solidity::SolidityTypeName>::solidity_name(&mut out, tc)
- .expect("no fmt error");
- collected.push(out);
- })*
- collected
- }
-
- fn len() -> usize {
- #len
+ impl ::evm_coder::solidity::SolidityStructTy for #name {
+ /// Generate solidity definitions for methods described in this struct
+ fn generate_solidity_interface(tc: &evm_coder::solidity::TypeCollector) -> String {
+ use evm_coder::solidity::*;
+ use core::fmt::Write;
+ let interface = SolidityStruct {
+ docs: &[#(#docs),*],
+ name: #solidity_name,
+ fields: (#(
+ #solidity_fields,
+ )*),
+ };
+ let mut out = String::new();
+ let _ = interface.format(&mut out, tc);
+ tc.collect(out);
+ #solidity_name.to_string()
}
}
}
@@ -214,47 +228,4 @@
}
}
}
-}
-
-pub fn impl_struct_solidity_struct_collect<'a>(
- name: &syn::Ident,
- field_names: impl Iterator<Item = proc_macro2::Ident> + Clone,
- field_types: impl Iterator<Item = &'a syn::Type> + Clone,
- field_docs: impl Iterator<Item = syn::Result<Vec<proc_macro2::TokenStream>>> + Clone,
- docs: &[proc_macro2::TokenStream],
-) -> syn::Result<proc_macro2::TokenStream> {
- let string_name = name.to_string();
- let name_type = field_names
- .into_iter()
- .zip(field_types)
- .zip(field_docs)
- .map(|((name, ty), doc)| {
- let field_docs = doc.expect("Doc parse error");
- let name = format!("{}", name);
- quote!(
- #(#field_docs)*
- write!(str, "\t{} ", <#ty as ::evm_coder::solidity::StructCollect>::name()).unwrap();
- writeln!(str, "{};", #name).unwrap();
- )
- });
-
- Ok(quote! {
- #[cfg(feature = "stubgen")]
- impl ::evm_coder::solidity::StructCollect for #name {
- fn name() -> String {
- #string_name.into()
- }
-
- fn declaration() -> String {
- use std::fmt::Write;
-
- let mut str = String::new();
- #(#docs)*
- writeln!(str, "struct {} {{", Self::name()).unwrap();
- #(#name_type)*
- writeln!(str, "}}").unwrap();
- str
- }
- }
- })
}
crates/evm-coder/procedural/src/abi_derive/mod.rsdiffbeforeafterboth1mod derive_enum;2mod derive_struct;34use quote::quote;5use derive_struct::*;6use derive_enum::*;78pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {9 let name = &ast.ident;10 match &ast.data {11 syn::Data::Struct(ds) => expand_struct(ds, ast),12 syn::Data::Enum(de) => expand_enum(de, ast),13 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),14 }15}1617fn expand_struct(18 ds: &syn::DataStruct,19 ast: &syn::DeriveInput,20) -> syn::Result<proc_macro2::TokenStream> {21 let name = &ast.ident;22 let docs = extract_docs(&ast.attrs, false)?;23 let (is_named_fields, field_names, field_types, field_docs, params_count) = match ds.fields {24 syn::Fields::Named(ref fields) => Ok((25 true,26 fields.named.iter().enumerate().map(map_field_to_name),27 fields.named.iter().map(map_field_to_type),28 fields.named.iter().map(map_field_to_doc),29 fields.named.len(),30 )),31 syn::Fields::Unnamed(ref fields) => Ok((32 false,33 fields.unnamed.iter().enumerate().map(map_field_to_name),34 fields.unnamed.iter().map(map_field_to_type),35 fields.unnamed.iter().map(map_field_to_doc),36 fields.unnamed.len(),37 )),38 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),39 }?;4041 if params_count == 0 {42 return Err(syn::Error::new(name.span(), "Empty structs not supported"));43 };4445 let tuple_type = tuple_type(field_types.clone());46 let tuple_ref_type = tuple_ref_type(field_types.clone());47 let tuple_data = tuple_data_as_ref(is_named_fields, field_names.clone());48 let tuple_names = tuple_names(is_named_fields, field_names.clone());49 let struct_from_tuple = struct_from_tuple(name, is_named_fields, field_names.clone());5051 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);52 let abi_type = impl_struct_abi_type(name, tuple_type.clone());53 let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);54 let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);55 let solidity_type = impl_struct_solidity_type(name, field_types.clone(), params_count);56 let solidity_type_name =57 impl_struct_solidity_type_name(name, field_types.clone(), params_count);58 let solidity_struct_collect =59 impl_struct_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;6061 Ok(quote! {62 #can_be_plcaed_in_vec63 #abi_type64 #abi_read65 #abi_write66 #solidity_type67 #solidity_type_name68 #solidity_struct_collect69 })70}7172fn expand_enum(73 de: &syn::DataEnum,74 ast: &syn::DeriveInput,75) -> syn::Result<proc_macro2::TokenStream> {76 let name = &ast.ident;77 check_repr_u8(name, &ast.attrs)?;78 let docs = extract_docs(&ast.attrs, false)?;79 let option_count = check_and_count_options(de)?;80 let enum_options = de.variants.iter().map(|v| &v.ident);81 let enum_options_docs = de.variants.iter().map(|v| extract_docs(&v.attrs, true));8283 let from = impl_enum_from_u8(name, enum_options.clone());84 let solidity_option = impl_solidity_option(name, enum_options.clone());85 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);86 let abi_type = impl_enum_abi_type(name);87 let abi_read = impl_enum_abi_read(name);88 let abi_write = impl_enum_abi_write(name);89 let solidity_type = impl_enum_solidity_type(name);90 let solidity_type_name = impl_enum_solidity_type_name(name);91 let solidity_struct_collect = impl_enum_solidity_struct_collect(92 name,93 enum_options,94 option_count,95 enum_options_docs,96 &docs,97 );9899 Ok(quote! {100 #from101 #solidity_option102 #can_be_plcaed_in_vec103 #abi_type104 #abi_read105 #abi_write106 #solidity_type107 #solidity_type_name108 #solidity_struct_collect109 })110}111112fn extract_docs(113 attrs: &[syn::Attribute],114 is_field_doc: bool,115) -> syn::Result<Vec<proc_macro2::TokenStream>> {116 attrs117 .iter()118 .filter_map(|attr| {119 if let Some(ps) = attr.path.segments.first() {120 if ps.ident == "doc" {121 let meta = match attr.parse_meta() {122 Ok(meta) => meta,123 Err(e) => return Some(Err(e)),124 };125 match meta {126 syn::Meta::NameValue(mnv) => match &mnv.lit {127 syn::Lit::Str(ls) => return Some(Ok(ls.value())),128 _ => unreachable!(),129 },130 _ => unreachable!(),131 }132 }133 }134 None135 })136 .enumerate()137 .map(|(i, doc)| {138 let doc = doc?;139 let doc = doc.trim();140 let dev = if i == 0 { " @dev" } else { "" };141 let tab = if is_field_doc { "\t" } else { "" };142 Ok(quote! {143 writeln!(str, "{}///{} {}", #tab, #dev, #doc).unwrap();144 })145 })146 .collect()147}1mod derive_enum;2mod derive_struct;34use quote::quote;5use derive_struct::*;6use derive_enum::*;78pub(crate) fn impl_abi_macro(ast: &syn::DeriveInput) -> syn::Result<proc_macro2::TokenStream> {9 let name = &ast.ident;10 match &ast.data {11 syn::Data::Struct(ds) => expand_struct(ds, ast),12 syn::Data::Enum(de) => expand_enum(de, ast),13 syn::Data::Union(_) => Err(syn::Error::new(name.span(), "Unions not supported")),14 }15}1617fn expand_struct(18 ds: &syn::DataStruct,19 ast: &syn::DeriveInput,20) -> syn::Result<proc_macro2::TokenStream> {21 let name = &ast.ident;22 let docs = extract_docs(&ast.attrs)?;23 let (is_named_fields, field_names, field_types, params_count) = match ds.fields {24 syn::Fields::Named(ref fields) => Ok((25 true,26 fields.named.iter().enumerate().map(map_field_to_name),27 fields.named.iter().map(map_field_to_type),28 fields.named.len(),29 )),30 syn::Fields::Unnamed(ref fields) => Ok((31 false,32 fields.unnamed.iter().enumerate().map(map_field_to_name),33 fields.unnamed.iter().map(map_field_to_type),34 fields.unnamed.len(),35 )),36 syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),37 }?;3839 if params_count == 0 {40 return Err(syn::Error::new(name.span(), "Empty structs not supported"));41 };4243 let tuple_type = tuple_type(field_types.clone());44 let tuple_ref_type = tuple_ref_type(field_types.clone());45 let tuple_data = tuple_data_as_ref(is_named_fields, field_names.clone());46 let tuple_names = tuple_names(is_named_fields, field_names.clone());47 let struct_from_tuple = struct_from_tuple(name, is_named_fields, field_names.clone());4849 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);50 let abi_type = impl_struct_abi_type(name, tuple_type.clone());51 let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);52 let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);53 let solidity_type = impl_struct_solidity_type(name, docs, ds.fields.iter());54 let solidity_type_name =55 impl_struct_solidity_type_name(name, field_types.clone(), params_count);5657 Ok(quote! {58 #can_be_plcaed_in_vec59 #abi_type60 #abi_read61 #abi_write62 #solidity_type63 #solidity_type_name64 })65}6667fn expand_enum(68 de: &syn::DataEnum,69 ast: &syn::DeriveInput,70) -> syn::Result<proc_macro2::TokenStream> {71 let name = &ast.ident;72 check_repr_u8(name, &ast.attrs)?;73 let docs = extract_docs(&ast.attrs)?;74 let enum_options = de.variants.iter();7576 let from = impl_enum_from_u8(name, enum_options.clone());77 let solidity_option = impl_solidity_option(docs, name, enum_options.clone());78 let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);79 let abi_type = impl_enum_abi_type(name);80 let abi_read = impl_enum_abi_read(name);81 let abi_write = impl_enum_abi_write(name);82 let solidity_type_name = impl_enum_solidity_type_name(name);8384 Ok(quote! {85 #from86 #solidity_option87 #can_be_plcaed_in_vec88 #abi_type89 #abi_read90 #abi_write91 #solidity_type_name92 })93}9495fn extract_docs(attrs: &[syn::Attribute]) -> syn::Result<Vec<String>> {96 attrs97 .iter()98 .filter_map(|attr| {99 if let Some(ps) = attr.path.segments.first() {100 if ps.ident == "doc" {101 let meta = match attr.parse_meta() {102 Ok(meta) => meta,103 Err(e) => return Some(Err(e)),104 };105 match meta {106 syn::Meta::NameValue(mnv) => match &mnv.lit {107 syn::Lit::Str(ls) => return Some(Ok(ls.value())),108 _ => unreachable!(),109 },110 _ => unreachable!(),111 }112 }113 }114 None115 })116 .collect()117}crates/evm-coder/src/solidity/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity/impls.rs
+++ b/crates/evm-coder/src/solidity/impls.rs
@@ -1,4 +1,4 @@
-use super::{TypeCollector, SolidityTypeName, SolidityType, StructCollect};
+use super::{TypeCollector, SolidityTypeName, SolidityTupleTy};
use crate::{sealed, types::*};
use core::fmt;
use primitive_types::{U256, H160};
@@ -17,16 +17,6 @@
write!(writer, $default)
}
}
-
- impl StructCollect for $ty {
- fn name() -> String {
- $name.to_string()
- }
-
- fn declaration() -> String {
- String::default()
- }
- }
)*
};
}
@@ -71,17 +61,7 @@
write!(writer, "new ")?;
T::solidity_name(writer, tc)?;
write!(writer, "[](0)")
- }
-}
-
-impl<T: StructCollect + sealed::CanBePlacedInVec> StructCollect for Vec<T> {
- fn name() -> String {
- <T as StructCollect>::name() + "[]"
}
-
- fn declaration() -> String {
- unimplemented!("Vectors have not declarations.")
- }
}
macro_rules! count {
@@ -91,8 +71,8 @@
macro_rules! impl_tuples {
($($ident:ident)+) => {
- impl<$($ident: SolidityTypeName + 'static),+> SolidityType for ($($ident,)+) {
- fn names(tc: &TypeCollector) -> Vec<string> {
+ impl<$($ident: SolidityTypeName + 'static),+> SolidityTupleTy for ($($ident,)+) {
+ fn fields(tc: &TypeCollector) -> Vec<string> {
let mut collected = Vec::with_capacity(Self::len());
$({
let mut out = string::new();
crates/evm-coder/src/solidity/mod.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity/mod.rs
+++ b/crates/evm-coder/src/solidity/mod.rs
@@ -44,6 +44,7 @@
/// id ordering is required to perform topo-sort on the resulting data
structs: RefCell<BTreeMap<string, usize>>,
anonymous: RefCell<BTreeMap<Vec<string>, usize>>,
+ // generic: RefCell<BTreeMap<string, usize>>,
id: Cell<usize>,
}
impl TypeCollector {
@@ -59,8 +60,9 @@
self.id.set(v + 1);
v
}
- pub fn collect_tuple<T: SolidityType>(&self) -> String {
- let names = T::names(self);
+ /// Collect typle, deduplicating it by type, and returning generated name
+ pub fn collect_tuple<T: SolidityTupleTy>(&self) -> String {
+ let names = T::fields(self);
if let Some(id) = self.anonymous.borrow().get(&names).cloned() {
return format!("Tuple{}", id);
}
@@ -76,11 +78,12 @@
self.anonymous.borrow_mut().insert(names, id);
format!("Tuple{}", id)
}
- pub fn collect_struct<T: StructCollect + SolidityType>(&self) -> String {
- let _names = T::names(self);
- self.collect(<T as StructCollect>::declaration());
- <T as StructCollect>::name()
+ pub fn collect_struct<T: SolidityStructTy>(&self) -> String {
+ T::generate_solidity_interface(self)
}
+ pub fn collect_enum<T: SolidityEnumTy>(&self) -> String {
+ T::generate_solidity_interface(self)
+ }
pub fn finish(self) -> Vec<string> {
let mut data = self.structs.into_inner().into_iter().collect::<Vec<_>>();
data.sort_by_key(|(_, id)| Reverse(*id));
@@ -420,3 +423,93 @@
writeln!(writer, ");")
}
}
+
+#[impl_for_tuples(0, 48)]
+impl SolidityItems for Tuple {
+ for_tuples!( where #( Tuple: SolidityItems ),* );
+
+ fn solidity_name(&self, writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
+ for_tuples!( #(
+ Tuple.solidity_name(writer, tc)?;
+ )* );
+ Ok(())
+ }
+}
+
+pub struct SolidityStructField<T> {
+ pub docs: &'static [&'static str],
+ pub name: &'static str,
+ pub ty: PhantomData<*const T>,
+}
+
+impl<T> SolidityItems for SolidityStructField<T>
+where
+ T: SolidityTypeName,
+{
+ fn solidity_name(&self, out: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
+ for doc in self.docs {
+ writeln!(out, "///{}", doc)?;
+ }
+ write!(out, "\t")?;
+ T::solidity_name(out, tc)?;
+ writeln!(out, " {};", self.name)?;
+ Ok(())
+ }
+}
+pub struct SolidityStruct<F> {
+ pub docs: &'static [&'static str],
+ // pub generics:
+ pub name: &'static str,
+ pub fields: F,
+}
+impl<F> SolidityStruct<F>
+where
+ F: SolidityItems,
+{
+ pub fn format(&self, out: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
+ for doc in self.docs {
+ writeln!(out, "///{}", doc)?;
+ }
+ writeln!(out, "struct {} {{", self.name)?;
+ self.fields.solidity_name(out, tc)?;
+ writeln!(out, "}}")?;
+ Ok(())
+ }
+}
+
+pub struct SolidityEnumVariant {
+ pub docs: &'static [&'static str],
+ pub name: &'static str,
+}
+impl SolidityItems for SolidityEnumVariant {
+ fn solidity_name(&self, out: &mut impl fmt::Write, _tc: &TypeCollector) -> fmt::Result {
+ for doc in self.docs {
+ writeln!(out, "///{}", doc)?;
+ }
+ write!(out, "\t{}", self.name)?;
+ Ok(())
+ }
+}
+pub struct SolidityEnum {
+ pub docs: &'static [&'static str],
+ pub name: &'static str,
+ pub fields: &'static [SolidityEnumVariant],
+}
+impl SolidityEnum {
+ pub fn format(&self, out: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
+ for doc in self.docs {
+ writeln!(out, "///{}", doc)?;
+ }
+ write!(out, "enum {} {{", self.name)?;
+ for (i, field) in self.fields.iter().enumerate() {
+ if i != 0 {
+ write!(out, ",")?;
+ }
+ writeln!(out)?;
+ field.solidity_name(out, tc)?;
+ }
+ writeln!(out)?;
+ writeln!(out, "}}")?;
+ Ok(())
+ }
+}
crates/evm-coder/src/solidity/traits.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity/traits.rs
+++ b/crates/evm-coder/src/solidity/traits.rs
@@ -1,17 +1,6 @@
use super::TypeCollector;
use core::fmt;
-pub trait StructCollect: 'static {
- /// Structure name.
- fn name() -> String;
- /// Structure declaration.
- fn declaration() -> String;
-}
-
-pub trait SolidityEnum: 'static {
- fn solidity_option(&self) -> &str;
-}
-
pub trait SolidityTypeName: 'static {
fn solidity_name(writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result;
/// "simple" types are stored inline, no `memory` modifier should be used in solidity
@@ -23,10 +12,17 @@
}
}
-pub trait SolidityType {
- fn names(tc: &TypeCollector) -> Vec<String>;
+pub trait SolidityTupleTy: 'static {
+ fn fields(tc: &TypeCollector) -> Vec<String>;
fn len() -> usize;
}
+pub trait SolidityStructTy: 'static {
+ fn generate_solidity_interface(tc: &TypeCollector) -> String;
+}
+pub trait SolidityEnumTy: 'static {
+ fn generate_solidity_interface(tc: &TypeCollector) -> String;
+ fn solidity_option(&self) -> &str;
+}
pub trait SolidityArguments {
fn solidity_name(&self, writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result;
@@ -46,3 +42,9 @@
tc: &TypeCollector,
) -> fmt::Result;
}
+
+pub trait SolidityItems {
+ fn solidity_name(&self, writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result;
+ // For PhantomData fields
+ // fn is_void()
+}
crates/evm-coder/tests/abi_derive_generation.rsdiffbeforeafterboth--- a/crates/evm-coder/tests/abi_derive_generation.rs
+++ b/crates/evm-coder/tests/abi_derive_generation.rs
@@ -74,41 +74,6 @@
}
#[test]
- #[cfg(feature = "stubgen")]
- fn struct_collect_type_struct3_derived_mixed_param() {
- assert_eq!(
- <TypeStruct3DerivedMixedParam as ::evm_coder::solidity::StructCollect>::name(),
- "TypeStruct3DerivedMixedParam"
- );
- similar_asserts::assert_eq!(
- <TypeStruct3DerivedMixedParam as ::evm_coder::solidity::StructCollect>::declaration(),
- r#"/// @dev Some docs
-/// At multi
-/// line
-struct TypeStruct3DerivedMixedParam {
- /// @dev Docs for A
- /// multi
- /// line
- TypeStruct1SimpleParam _a;
- /// @dev Docs for B
- TypeStruct2DynamicParam _b;
- /// @dev Docs for C
- TypeStruct2MixedParam _c;
-}
-"#
- );
- }
-
- #[test]
- #[cfg(feature = "stubgen")]
- fn struct_collect_vec() {
- assert_eq!(
- <Vec<u8> as ::evm_coder::solidity::StructCollect>::name(),
- "uint8[]"
- );
- }
-
- #[test]
fn impl_abi_type_signature() {
assert_eq!(
<TypeStruct1SimpleParam as evm_coder::abi::AbiType>::SIGNATURE
@@ -303,31 +268,6 @@
);
#[test]
- #[cfg(feature = "stubgen")]
- fn struct_collect_tuple_struct3_derived_mixed_param() {
- assert_eq!(
- <TupleStruct3DerivedMixedParam as ::evm_coder::solidity::StructCollect>::name(),
- "TupleStruct3DerivedMixedParam"
- );
- similar_asserts::assert_eq!(
- <TupleStruct3DerivedMixedParam as ::evm_coder::solidity::StructCollect>::declaration(),
- r#"/// @dev Some docs
-/// At multi
-/// line
-struct TupleStruct3DerivedMixedParam {
- /// @dev Docs for A
- /// multi
- /// line
- TupleStruct1SimpleParam field0;
- TupleStruct2DynamicParam field1;
- /// @dev Docs for C
- TupleStruct2MixedParam field2;
-}
-"#
- );
- }
-
- #[test]
fn impl_abi_type_signature_same_for_structs() {
assert_eq!(
<TypeStruct1SimpleParam as evm_coder::abi::AbiType>::SIGNATURE
@@ -821,30 +761,5 @@
<Color as evm_coder::abi::AbiRead>::abi_read(&mut decoder).unwrap();
assert_eq!(restored_enum_data, Color::Green);
}
- }
-
- #[test]
- #[cfg(feature = "stubgen")]
- fn struct_collect_enum() {
- assert_eq!(
- <Color as ::evm_coder::solidity::StructCollect>::name(),
- "Color"
- );
- similar_asserts::assert_eq!(
- <Color as ::evm_coder::solidity::StructCollect>::declaration(),
- r#"/// @dev Some docs
-/// At multi
-/// line
-enum Color {
- /// @dev Docs for Red
- /// multi
- /// line
- Red,
- Green,
- /// @dev Docs for Blue
- Blue
-}
-"#
- );
}
}
pallets/evm-contract-helpers/src/stubs/ContractHelpers.rawdiffbeforeafterbothbinary blob — no preview
pallets/evm-contract-helpers/src/stubs/ContractHelpers.soldiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/stubs/ContractHelpers.sol
+++ b/pallets/evm-contract-helpers/src/stubs/ContractHelpers.sol
@@ -265,13 +265,13 @@
}
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of Optional value with CrossAddress.
+/// Ethereum representation of Optional value with CrossAddress.
struct OptionCrossAddress {
bool status;
CrossAddress value;
pallets/fungible/src/stubs/UniqueFungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/fungible/src/stubs/UniqueFungible.soldiffbeforeafterboth--- a/pallets/fungible/src/stubs/UniqueFungible.sol
+++ b/pallets/fungible/src/stubs/UniqueFungible.sol
@@ -437,67 +437,67 @@
}
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
pallets/nonfungible/src/stubs/UniqueNFT.rawdiffbeforeafterbothbinary blob — no preview
pallets/nonfungible/src/stubs/UniqueNFT.soldiffbeforeafterboth--- a/pallets/nonfungible/src/stubs/UniqueNFT.sol
+++ b/pallets/nonfungible/src/stubs/UniqueNFT.sol
@@ -127,35 +127,35 @@
}
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
}
-/// @dev Ethereum representation of Token Property Permissions.
+/// Ethereum representation of Token Property Permissions.
struct TokenPropertyPermission {
- /// @dev Token property key.
+ /// Token property key.
string key;
- /// @dev Token property permissions.
+ /// Token property permissions.
PropertyPermission[] permissions;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
struct PropertyPermission {
- /// @dev TokenPermission field.
+ /// TokenPermission field.
TokenPermissionField code;
- /// @dev TokenPermission value.
+ /// TokenPermission value.
bool value;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum TokenPermissionField {
- /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
- /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
@@ -579,63 +579,63 @@
}
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
pallets/refungible/src/stubs/UniqueRefungible.rawdiffbeforeafterbothbinary blob — no preview
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -127,35 +127,35 @@
}
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
}
-/// @dev Ethereum representation of Token Property Permissions.
+/// Ethereum representation of Token Property Permissions.
struct TokenPropertyPermission {
- /// @dev Token property key.
+ /// Token property key.
string key;
- /// @dev Token property permissions.
+ /// Token property permissions.
PropertyPermission[] permissions;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
struct PropertyPermission {
- /// @dev TokenPermission field.
+ /// TokenPermission field.
TokenPermissionField code;
- /// @dev TokenPermission value.
+ /// TokenPermission value.
bool value;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum TokenPermissionField {
- /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
- /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
@@ -579,63 +579,63 @@
}
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
pallets/refungible/src/stubs/UniqueRefungibleToken.rawdiffbeforeafterbothbinary blob — no preview
pallets/refungible/src/stubs/UniqueRefungibleToken.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungibleToken.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungibleToken.sol
@@ -128,7 +128,7 @@
}
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
tests/src/eth/api/ContractHelpers.soldiffbeforeafterboth--- a/tests/src/eth/api/ContractHelpers.sol
+++ b/tests/src/eth/api/ContractHelpers.sol
@@ -171,13 +171,13 @@
function toggleAllowlist(address contractAddress, bool enabled) external;
}
-/// @dev Ethereum representation of Optional value with CrossAddress.
+/// Ethereum representation of Optional value with CrossAddress.
struct OptionCrossAddress {
bool status;
CrossAddress value;
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -279,67 +279,67 @@
function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -80,35 +80,35 @@
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
}
-/// @dev Ethereum representation of Token Property Permissions.
+/// Ethereum representation of Token Property Permissions.
struct TokenPropertyPermission {
- /// @dev Token property key.
+ /// Token property key.
string key;
- /// @dev Token property permissions.
+ /// Token property permissions.
PropertyPermission[] permissions;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
struct PropertyPermission {
- /// @dev TokenPermission field.
+ /// TokenPermission field.
TokenPermissionField code;
- /// @dev TokenPermission value.
+ /// TokenPermission value.
bool value;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum TokenPermissionField {
- /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
- /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
@@ -379,63 +379,63 @@
function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -80,35 +80,35 @@
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
-/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
}
-/// @dev Ethereum representation of Token Property Permissions.
+/// Ethereum representation of Token Property Permissions.
struct TokenPropertyPermission {
- /// @dev Token property key.
+ /// Token property key.
string key;
- /// @dev Token property permissions.
+ /// Token property permissions.
PropertyPermission[] permissions;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
struct PropertyPermission {
- /// @dev TokenPermission field.
+ /// TokenPermission field.
TokenPermissionField code;
- /// @dev TokenPermission value.
+ /// TokenPermission value.
bool value;
}
-/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
enum TokenPermissionField {
- /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
Mutable,
- /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
}
@@ -379,63 +379,63 @@
function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
struct CollectionNestingPermission {
CollectionPermissionField field;
bool value;
}
-/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissionField {
- /// @dev Owner of token can nest tokens under it.
+ /// Owner of token can nest tokens under it.
TokenOwner,
- /// @dev Admin of token collection can nest tokens under token.
+ /// Admin of token collection can nest tokens under token.
CollectionAdmin
}
-/// @dev Nested collections.
+/// Nested collections.
struct CollectionNesting {
bool token_owner;
uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
struct CollectionLimit {
CollectionLimitField field;
OptionUint value;
}
-/// @dev Ethereum representation of Optional value with uint256.
+/// Ethereum representation of Optional value with uint256.
struct OptionUint {
bool status;
uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
enum CollectionLimitField {
- /// @dev How many tokens can a user have on one account.
+ /// How many tokens can a user have on one account.
AccountTokenOwnership,
- /// @dev How many bytes of data are available for sponsorship.
+ /// How many bytes of data are available for sponsorship.
SponsoredDataSize,
- /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
+ /// In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]
SponsoredDataRateLimit,
- /// @dev How many tokens can be mined into this collection.
+ /// How many tokens can be mined into this collection.
TokenLimit,
- /// @dev Timeouts for transfer sponsoring.
+ /// Timeouts for transfer sponsoring.
SponsorTransferTimeout,
- /// @dev Timeout for sponsoring an approval in passed blocks.
+ /// Timeout for sponsoring an approval in passed blocks.
SponsorApproveTimeout,
- /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).
+ /// Whether the collection owner of the collection can send tokens (which belong to other users).
OwnerCanTransfer,
- /// @dev Can the collection owner burn other people's tokens.
+ /// Can the collection owner burn other people's tokens.
OwnerCanDestroy,
- /// @dev Is it possible to send tokens from this collection between users.
+ /// Is it possible to send tokens from this collection between users.
TransferEnabled
}
tests/src/eth/api/UniqueRefungibleToken.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungibleToken.sol
+++ b/tests/src/eth/api/UniqueRefungibleToken.sol
@@ -79,7 +79,7 @@
) external returns (bool);
}
-/// @dev Cross account struct
+/// Cross account struct
struct CrossAddress {
address eth;
uint256 sub;