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.rsdiffbeforeafterboth--- a/crates/evm-coder/procedural/src/abi_derive/mod.rs
+++ b/crates/evm-coder/procedural/src/abi_derive/mod.rs
@@ -19,20 +19,18 @@
ast: &syn::DeriveInput,
) -> syn::Result<proc_macro2::TokenStream> {
let name = &ast.ident;
- let docs = extract_docs(&ast.attrs, false)?;
- let (is_named_fields, field_names, field_types, field_docs, params_count) = match ds.fields {
+ let docs = extract_docs(&ast.attrs)?;
+ let (is_named_fields, field_names, field_types, params_count) = match ds.fields {
syn::Fields::Named(ref fields) => Ok((
true,
fields.named.iter().enumerate().map(map_field_to_name),
fields.named.iter().map(map_field_to_type),
- fields.named.iter().map(map_field_to_doc),
fields.named.len(),
)),
syn::Fields::Unnamed(ref fields) => Ok((
false,
fields.unnamed.iter().enumerate().map(map_field_to_name),
fields.unnamed.iter().map(map_field_to_type),
- fields.unnamed.iter().map(map_field_to_doc),
fields.unnamed.len(),
)),
syn::Fields::Unit => Err(syn::Error::new(name.span(), "Unit structs not supported")),
@@ -52,11 +50,9 @@
let abi_type = impl_struct_abi_type(name, tuple_type.clone());
let abi_read = impl_struct_abi_read(name, tuple_type, tuple_names, struct_from_tuple);
let abi_write = impl_struct_abi_write(name, is_named_fields, tuple_ref_type, tuple_data);
- let solidity_type = impl_struct_solidity_type(name, field_types.clone(), params_count);
+ let solidity_type = impl_struct_solidity_type(name, docs, ds.fields.iter());
let solidity_type_name =
impl_struct_solidity_type_name(name, field_types.clone(), params_count);
- let solidity_struct_collect =
- impl_struct_solidity_struct_collect(name, field_names, field_types, field_docs, &docs)?;
Ok(quote! {
#can_be_plcaed_in_vec
@@ -65,7 +61,6 @@
#abi_write
#solidity_type
#solidity_type_name
- #solidity_struct_collect
})
}
@@ -75,26 +70,16 @@
) -> syn::Result<proc_macro2::TokenStream> {
let name = &ast.ident;
check_repr_u8(name, &ast.attrs)?;
- let docs = extract_docs(&ast.attrs, false)?;
- let option_count = check_and_count_options(de)?;
- let enum_options = de.variants.iter().map(|v| &v.ident);
- let enum_options_docs = de.variants.iter().map(|v| extract_docs(&v.attrs, true));
+ let docs = extract_docs(&ast.attrs)?;
+ let enum_options = de.variants.iter();
let from = impl_enum_from_u8(name, enum_options.clone());
- let solidity_option = impl_solidity_option(name, enum_options.clone());
+ let solidity_option = impl_solidity_option(docs, name, enum_options.clone());
let can_be_plcaed_in_vec = impl_can_be_placed_in_vec(name);
let abi_type = impl_enum_abi_type(name);
let abi_read = impl_enum_abi_read(name);
let abi_write = impl_enum_abi_write(name);
- let solidity_type = impl_enum_solidity_type(name);
let solidity_type_name = impl_enum_solidity_type_name(name);
- let solidity_struct_collect = impl_enum_solidity_struct_collect(
- name,
- enum_options,
- option_count,
- enum_options_docs,
- &docs,
- );
Ok(quote! {
#from
@@ -103,16 +88,11 @@
#abi_type
#abi_read
#abi_write
- #solidity_type
#solidity_type_name
- #solidity_struct_collect
})
}
-fn extract_docs(
- attrs: &[syn::Attribute],
- is_field_doc: bool,
-) -> syn::Result<Vec<proc_macro2::TokenStream>> {
+fn extract_docs(attrs: &[syn::Attribute]) -> syn::Result<Vec<String>> {
attrs
.iter()
.filter_map(|attr| {
@@ -132,16 +112,6 @@
}
}
None
- })
- .enumerate()
- .map(|(i, doc)| {
- let doc = doc?;
- let doc = doc.trim();
- let dev = if i == 0 { " @dev" } else { "" };
- let tab = if is_field_doc { "\t" } else { "" };
- Ok(quote! {
- writeln!(str, "{}///{} {}", #tab, #dev, #doc).unwrap();
- })
})
.collect()
}
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.soldiffbeforeafterboth1// SPDX-License-Identifier: OTHER2// This code is automatically generated34pragma solidity >=0.8.0 <0.9.0;56/// @dev common stubs holder7contract Dummy {8 uint8 dummy;9 string stub_error = "this contract is implemented in native";10}1112contract ERC165 is Dummy {13 function supportsInterface(bytes4 interfaceID) external view returns (bool) {14 require(false, stub_error);15 interfaceID;16 return true;17 }18}1920/// @title A contract that allows to set and delete token properties and change token property permissions.21/// @dev the ERC-165 identifier for this interface is 0xde0695c222contract TokenProperties is Dummy, ERC165 {23 // /// @notice Set permissions for token property.24 // /// @dev Throws error if `msg.sender` is not admin or owner of the collection.25 // /// @param key Property key.26 // /// @param isMutable Permission to mutate property.27 // /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.28 // /// @param tokenOwner Permission to mutate property by token owner if property is mutable.29 // /// @dev EVM selector for this function is: 0x222d97fa,30 // /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)31 // function setTokenPropertyPermission(string memory key, bool isMutable, bool collectionAdmin, bool tokenOwner) public {32 // require(false, stub_error);33 // key;34 // isMutable;35 // collectionAdmin;36 // tokenOwner;37 // dummy = 0;38 // }3940 /// @notice Set permissions for token property.41 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.42 /// @param permissions Permissions for keys.43 /// @dev EVM selector for this function is: 0xbd92983a,44 /// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])45 function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) public {46 require(false, stub_error);47 permissions;48 dummy = 0;49 }5051 /// @notice Get permissions for token properties.52 /// @dev EVM selector for this function is: 0xf23d7790,53 /// or in textual repr: tokenPropertyPermissions()54 function tokenPropertyPermissions() public view returns (TokenPropertyPermission[] memory) {55 require(false, stub_error);56 dummy;57 return new TokenPropertyPermission[](0);58 }5960 // /// @notice Set token property value.61 // /// @dev Throws error if `msg.sender` has no permission to edit the property.62 // /// @param tokenId ID of the token.63 // /// @param key Property key.64 // /// @param value Property value.65 // /// @dev EVM selector for this function is: 0x1752d67b,66 // /// or in textual repr: setProperty(uint256,string,bytes)67 // function setProperty(uint256 tokenId, string memory key, bytes memory value) public {68 // require(false, stub_error);69 // tokenId;70 // key;71 // value;72 // dummy = 0;73 // }7475 /// @notice Set token properties value.76 /// @dev Throws error if `msg.sender` has no permission to edit the property.77 /// @param tokenId ID of the token.78 /// @param properties settable properties79 /// @dev EVM selector for this function is: 0x14ed3a6e,80 /// or in textual repr: setProperties(uint256,(string,bytes)[])81 function setProperties(uint256 tokenId, Property[] memory properties) public {82 require(false, stub_error);83 tokenId;84 properties;85 dummy = 0;86 }8788 // /// @notice Delete token property value.89 // /// @dev Throws error if `msg.sender` has no permission to edit the property.90 // /// @param tokenId ID of the token.91 // /// @param key Property key.92 // /// @dev EVM selector for this function is: 0x066111d1,93 // /// or in textual repr: deleteProperty(uint256,string)94 // function deleteProperty(uint256 tokenId, string memory key) public {95 // require(false, stub_error);96 // tokenId;97 // key;98 // dummy = 0;99 // }100101 /// @notice Delete token properties value.102 /// @dev Throws error if `msg.sender` has no permission to edit the property.103 /// @param tokenId ID of the token.104 /// @param keys Properties key.105 /// @dev EVM selector for this function is: 0xc472d371,106 /// or in textual repr: deleteProperties(uint256,string[])107 function deleteProperties(uint256 tokenId, string[] memory keys) public {108 require(false, stub_error);109 tokenId;110 keys;111 dummy = 0;112 }113114 /// @notice Get token property value.115 /// @dev Throws error if key not found116 /// @param tokenId ID of the token.117 /// @param key Property key.118 /// @return Property value bytes119 /// @dev EVM selector for this function is: 0x7228c327,120 /// or in textual repr: property(uint256,string)121 function property(uint256 tokenId, string memory key) public view returns (bytes memory) {122 require(false, stub_error);123 tokenId;124 key;125 dummy;126 return hex"";127 }128}129130/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).131struct Property {132 string key;133 bytes value;134}135136/// @dev Ethereum representation of Token Property Permissions.137struct TokenPropertyPermission {138 /// @dev Token property key.139 string key;140 /// @dev Token property permissions.141 PropertyPermission[] permissions;142}143144/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.145struct PropertyPermission {146 /// @dev TokenPermission field.147 TokenPermissionField code;148 /// @dev TokenPermission value.149 bool value;150}151152/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.153enum TokenPermissionField {154 /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]155 Mutable,156 /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]157 TokenOwner,158 /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]159 CollectionAdmin160}161162/// @title A contract that allows you to work with collections.163/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1164contract Collection is Dummy, ERC165 {165 // /// Set collection property.166 // ///167 // /// @param key Property key.168 // /// @param value Propery value.169 // /// @dev EVM selector for this function is: 0x2f073f66,170 // /// or in textual repr: setCollectionProperty(string,bytes)171 // function setCollectionProperty(string memory key, bytes memory value) public {172 // require(false, stub_error);173 // key;174 // value;175 // dummy = 0;176 // }177178 /// Set collection properties.179 ///180 /// @param properties Vector of properties key/value pair.181 /// @dev EVM selector for this function is: 0x50b26b2a,182 /// or in textual repr: setCollectionProperties((string,bytes)[])183 function setCollectionProperties(Property[] memory properties) public {184 require(false, stub_error);185 properties;186 dummy = 0;187 }188189 // /// Delete collection property.190 // ///191 // /// @param key Property key.192 // /// @dev EVM selector for this function is: 0x7b7debce,193 // /// or in textual repr: deleteCollectionProperty(string)194 // function deleteCollectionProperty(string memory key) public {195 // require(false, stub_error);196 // key;197 // dummy = 0;198 // }199200 /// Delete collection properties.201 ///202 /// @param keys Properties keys.203 /// @dev EVM selector for this function is: 0xee206ee3,204 /// or in textual repr: deleteCollectionProperties(string[])205 function deleteCollectionProperties(string[] memory keys) public {206 require(false, stub_error);207 keys;208 dummy = 0;209 }210211 /// Get collection property.212 ///213 /// @dev Throws error if key not found.214 ///215 /// @param key Property key.216 /// @return bytes The property corresponding to the key.217 /// @dev EVM selector for this function is: 0xcf24fd6d,218 /// or in textual repr: collectionProperty(string)219 function collectionProperty(string memory key) public view returns (bytes memory) {220 require(false, stub_error);221 key;222 dummy;223 return hex"";224 }225226 /// Get collection properties.227 ///228 /// @param keys Properties keys. Empty keys for all propertyes.229 /// @return Vector of properties key/value pairs.230 /// @dev EVM selector for this function is: 0x285fb8e6,231 /// or in textual repr: collectionProperties(string[])232 function collectionProperties(string[] memory keys) public view returns (Property[] memory) {233 require(false, stub_error);234 keys;235 dummy;236 return new Property[](0);237 }238239 // /// Set the sponsor of the collection.240 // ///241 // /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.242 // ///243 // /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.244 // /// @dev EVM selector for this function is: 0x7623402e,245 // /// or in textual repr: setCollectionSponsor(address)246 // function setCollectionSponsor(address sponsor) public {247 // require(false, stub_error);248 // sponsor;249 // dummy = 0;250 // }251252 /// Set the sponsor of the collection.253 ///254 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.255 ///256 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.257 /// @dev EVM selector for this function is: 0x84a1d5a8,258 /// or in textual repr: setCollectionSponsorCross((address,uint256))259 function setCollectionSponsorCross(CrossAddress memory sponsor) public {260 require(false, stub_error);261 sponsor;262 dummy = 0;263 }264265 /// Whether there is a pending sponsor.266 /// @dev EVM selector for this function is: 0x058ac185,267 /// or in textual repr: hasCollectionPendingSponsor()268 function hasCollectionPendingSponsor() public view returns (bool) {269 require(false, stub_error);270 dummy;271 return false;272 }273274 /// Collection sponsorship confirmation.275 ///276 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.277 /// @dev EVM selector for this function is: 0x3c50e97a,278 /// or in textual repr: confirmCollectionSponsorship()279 function confirmCollectionSponsorship() public {280 require(false, stub_error);281 dummy = 0;282 }283284 /// Remove collection sponsor.285 /// @dev EVM selector for this function is: 0x6e0326a3,286 /// or in textual repr: removeCollectionSponsor()287 function removeCollectionSponsor() public {288 require(false, stub_error);289 dummy = 0;290 }291292 /// Get current sponsor.293 ///294 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.295 /// @dev EVM selector for this function is: 0x6ec0a9f1,296 /// or in textual repr: collectionSponsor()297 function collectionSponsor() public view returns (CrossAddress memory) {298 require(false, stub_error);299 dummy;300 return CrossAddress(0x0000000000000000000000000000000000000000, 0);301 }302303 /// Get current collection limits.304 ///305 /// @return Array of collection limits306 /// @dev EVM selector for this function is: 0xf63bc572,307 /// or in textual repr: collectionLimits()308 function collectionLimits() public view returns (CollectionLimit[] memory) {309 require(false, stub_error);310 dummy;311 return new CollectionLimit[](0);312 }313314 /// Set limits for the collection.315 /// @dev Throws error if limit not found.316 /// @param limit Some limit.317 /// @dev EVM selector for this function is: 0x2316ee74,318 /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))319 function setCollectionLimit(CollectionLimit memory limit) public {320 require(false, stub_error);321 limit;322 dummy = 0;323 }324325 /// Get contract address.326 /// @dev EVM selector for this function is: 0xf6b4dfb4,327 /// or in textual repr: contractAddress()328 function contractAddress() public view returns (address) {329 require(false, stub_error);330 dummy;331 return 0x0000000000000000000000000000000000000000;332 }333334 /// Add collection admin.335 /// @param newAdmin Cross account administrator address.336 /// @dev EVM selector for this function is: 0x859aa7d6,337 /// or in textual repr: addCollectionAdminCross((address,uint256))338 function addCollectionAdminCross(CrossAddress memory newAdmin) public {339 require(false, stub_error);340 newAdmin;341 dummy = 0;342 }343344 /// Remove collection admin.345 /// @param admin Cross account administrator address.346 /// @dev EVM selector for this function is: 0x6c0cd173,347 /// or in textual repr: removeCollectionAdminCross((address,uint256))348 function removeCollectionAdminCross(CrossAddress memory admin) public {349 require(false, stub_error);350 admin;351 dummy = 0;352 }353354 // /// Add collection admin.355 // /// @param newAdmin Address of the added administrator.356 // /// @dev EVM selector for this function is: 0x92e462c7,357 // /// or in textual repr: addCollectionAdmin(address)358 // function addCollectionAdmin(address newAdmin) public {359 // require(false, stub_error);360 // newAdmin;361 // dummy = 0;362 // }363364 // /// Remove collection admin.365 // ///366 // /// @param admin Address of the removed administrator.367 // /// @dev EVM selector for this function is: 0xfafd7b42,368 // /// or in textual repr: removeCollectionAdmin(address)369 // function removeCollectionAdmin(address admin) public {370 // require(false, stub_error);371 // admin;372 // dummy = 0;373 // }374375 /// Toggle accessibility of collection nesting.376 ///377 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'378 /// @dev EVM selector for this function is: 0x112d4586,379 /// or in textual repr: setCollectionNesting(bool)380 function setCollectionNesting(bool enable) public {381 require(false, stub_error);382 enable;383 dummy = 0;384 }385386 /// Toggle accessibility of collection nesting.387 ///388 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'389 /// @param collections Addresses of collections that will be available for nesting.390 /// @dev EVM selector for this function is: 0x64872396,391 /// or in textual repr: setCollectionNesting(bool,address[])392 function setCollectionNesting(bool enable, address[] memory collections) public {393 require(false, stub_error);394 enable;395 collections;396 dummy = 0;397 }398399 /// Returns nesting for a collection400 /// @dev EVM selector for this function is: 0x22d25bfe,401 /// or in textual repr: collectionNestingRestrictedCollectionIds()402 function collectionNestingRestrictedCollectionIds() public view returns (CollectionNesting memory) {403 require(false, stub_error);404 dummy;405 return CollectionNesting(false, new uint256[](0));406 }407408 /// Returns permissions for a collection409 /// @dev EVM selector for this function is: 0x5b2eaf4b,410 /// or in textual repr: collectionNestingPermissions()411 function collectionNestingPermissions() public view returns (CollectionNestingPermission[] memory) {412 require(false, stub_error);413 dummy;414 return new CollectionNestingPermission[](0);415 }416417 /// Set the collection access method.418 /// @param mode Access mode419 /// 0 for Normal420 /// 1 for AllowList421 /// @dev EVM selector for this function is: 0x41835d4c,422 /// or in textual repr: setCollectionAccess(uint8)423 function setCollectionAccess(uint8 mode) public {424 require(false, stub_error);425 mode;426 dummy = 0;427 }428429 /// Checks that user allowed to operate with collection.430 ///431 /// @param user User address to check.432 /// @dev EVM selector for this function is: 0x91b6df49,433 /// or in textual repr: allowlistedCross((address,uint256))434 function allowlistedCross(CrossAddress memory user) public view returns (bool) {435 require(false, stub_error);436 user;437 dummy;438 return false;439 }440441 // /// Add the user to the allowed list.442 // ///443 // /// @param user Address of a trusted user.444 // /// @dev EVM selector for this function is: 0x67844fe6,445 // /// or in textual repr: addToCollectionAllowList(address)446 // function addToCollectionAllowList(address user) public {447 // require(false, stub_error);448 // user;449 // dummy = 0;450 // }451452 /// Add user to allowed list.453 ///454 /// @param user User cross account address.455 /// @dev EVM selector for this function is: 0xa0184a3a,456 /// or in textual repr: addToCollectionAllowListCross((address,uint256))457 function addToCollectionAllowListCross(CrossAddress memory user) public {458 require(false, stub_error);459 user;460 dummy = 0;461 }462463 // /// Remove the user from the allowed list.464 // ///465 // /// @param user Address of a removed user.466 // /// @dev EVM selector for this function is: 0x85c51acb,467 // /// or in textual repr: removeFromCollectionAllowList(address)468 // function removeFromCollectionAllowList(address user) public {469 // require(false, stub_error);470 // user;471 // dummy = 0;472 // }473474 /// Remove user from allowed list.475 ///476 /// @param user User cross account address.477 /// @dev EVM selector for this function is: 0x09ba452a,478 /// or in textual repr: removeFromCollectionAllowListCross((address,uint256))479 function removeFromCollectionAllowListCross(CrossAddress memory user) public {480 require(false, stub_error);481 user;482 dummy = 0;483 }484485 /// Switch permission for minting.486 ///487 /// @param mode Enable if "true".488 /// @dev EVM selector for this function is: 0x00018e84,489 /// or in textual repr: setCollectionMintMode(bool)490 function setCollectionMintMode(bool mode) public {491 require(false, stub_error);492 mode;493 dummy = 0;494 }495496 // /// Check that account is the owner or admin of the collection497 // ///498 // /// @param user account to verify499 // /// @return "true" if account is the owner or admin500 // /// @dev EVM selector for this function is: 0x9811b0c7,501 // /// or in textual repr: isOwnerOrAdmin(address)502 // function isOwnerOrAdmin(address user) public view returns (bool) {503 // require(false, stub_error);504 // user;505 // dummy;506 // return false;507 // }508509 /// Check that account is the owner or admin of the collection510 ///511 /// @param user User cross account to verify512 /// @return "true" if account is the owner or admin513 /// @dev EVM selector for this function is: 0x3e75a905,514 /// or in textual repr: isOwnerOrAdminCross((address,uint256))515 function isOwnerOrAdminCross(CrossAddress memory user) public view returns (bool) {516 require(false, stub_error);517 user;518 dummy;519 return false;520 }521522 /// Returns collection type523 ///524 /// @return `Fungible` or `NFT` or `ReFungible`525 /// @dev EVM selector for this function is: 0xd34b55b8,526 /// or in textual repr: uniqueCollectionType()527 function uniqueCollectionType() public view returns (string memory) {528 require(false, stub_error);529 dummy;530 return "";531 }532533 /// Get collection owner.534 ///535 /// @return Tuble with sponsor address and his substrate mirror.536 /// If address is canonical then substrate mirror is zero and vice versa.537 /// @dev EVM selector for this function is: 0xdf727d3b,538 /// or in textual repr: collectionOwner()539 function collectionOwner() public view returns (CrossAddress memory) {540 require(false, stub_error);541 dummy;542 return CrossAddress(0x0000000000000000000000000000000000000000, 0);543 }544545 // /// Changes collection owner to another account546 // ///547 // /// @dev Owner can be changed only by current owner548 // /// @param newOwner new owner account549 // /// @dev EVM selector for this function is: 0x4f53e226,550 // /// or in textual repr: changeCollectionOwner(address)551 // function changeCollectionOwner(address newOwner) public {552 // require(false, stub_error);553 // newOwner;554 // dummy = 0;555 // }556557 /// Get collection administrators558 ///559 /// @return Vector of tuples with admins address and his substrate mirror.560 /// If address is canonical then substrate mirror is zero and vice versa.561 /// @dev EVM selector for this function is: 0x5813216b,562 /// or in textual repr: collectionAdmins()563 function collectionAdmins() public view returns (CrossAddress[] memory) {564 require(false, stub_error);565 dummy;566 return new CrossAddress[](0);567 }568569 /// Changes collection owner to another account570 ///571 /// @dev Owner can be changed only by current owner572 /// @param newOwner new owner cross account573 /// @dev EVM selector for this function is: 0x6496c497,574 /// or in textual repr: changeCollectionOwnerCross((address,uint256))575 function changeCollectionOwnerCross(CrossAddress memory newOwner) public {576 require(false, stub_error);577 newOwner;578 dummy = 0;579 }580}581582/// @dev Cross account struct583struct CrossAddress {584 address eth;585 uint256 sub;586}587588/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.589struct CollectionNestingPermission {590 CollectionPermissionField field;591 bool value;592}593594/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.595enum CollectionPermissionField {596 /// @dev Owner of token can nest tokens under it.597 TokenOwner,598 /// @dev Admin of token collection can nest tokens under token.599 CollectionAdmin600}601602/// @dev Nested collections.603struct CollectionNesting {604 bool token_owner;605 uint256[] ids;606}607608/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.609struct CollectionLimit {610 CollectionLimitField field;611 OptionUint value;612}613614/// @dev Ethereum representation of Optional value with uint256.615struct OptionUint {616 bool status;617 uint256 value;618}619620/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.621enum CollectionLimitField {622 /// @dev How many tokens can a user have on one account.623 AccountTokenOwnership,624 /// @dev How many bytes of data are available for sponsorship.625 SponsoredDataSize,626 /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]627 SponsoredDataRateLimit,628 /// @dev How many tokens can be mined into this collection.629 TokenLimit,630 /// @dev Timeouts for transfer sponsoring.631 SponsorTransferTimeout,632 /// @dev Timeout for sponsoring an approval in passed blocks.633 SponsorApproveTimeout,634 /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).635 OwnerCanTransfer,636 /// @dev Can the collection owner burn other people's tokens.637 OwnerCanDestroy,638 /// @dev Is it possible to send tokens from this collection between users.639 TransferEnabled640}641642/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension643/// @dev See https://eips.ethereum.org/EIPS/eip-721644/// @dev the ERC-165 identifier for this interface is 0x5b5e139f645contract ERC721Metadata is Dummy, ERC165 {646 // /// @notice A descriptive name for a collection of NFTs in this contract647 // /// @dev real implementation of this function lies in `ERC721UniqueExtensions`648 // /// @dev EVM selector for this function is: 0x06fdde03,649 // /// or in textual repr: name()650 // function name() public view returns (string memory) {651 // require(false, stub_error);652 // dummy;653 // return "";654 // }655656 // /// @notice An abbreviated name for NFTs in this contract657 // /// @dev real implementation of this function lies in `ERC721UniqueExtensions`658 // /// @dev EVM selector for this function is: 0x95d89b41,659 // /// or in textual repr: symbol()660 // function symbol() public view returns (string memory) {661 // require(false, stub_error);662 // dummy;663 // return "";664 // }665666 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.667 ///668 /// @dev If the token has a `url` property and it is not empty, it is returned.669 /// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.670 /// If the collection property `baseURI` is empty or absent, return "" (empty string)671 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix672 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).673 ///674 /// @return token's const_metadata675 /// @dev EVM selector for this function is: 0xc87b56dd,676 /// or in textual repr: tokenURI(uint256)677 function tokenURI(uint256 tokenId) public view returns (string memory) {678 require(false, stub_error);679 tokenId;680 dummy;681 return "";682 }683}684685/// @title ERC721 Token that can be irreversibly burned (destroyed).686/// @dev the ERC-165 identifier for this interface is 0x42966c68687contract ERC721Burnable is Dummy, ERC165 {688 /// @notice Burns a specific ERC721 token.689 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized690 /// operator of the current owner.691 /// @param tokenId The NFT to approve692 /// @dev EVM selector for this function is: 0x42966c68,693 /// or in textual repr: burn(uint256)694 function burn(uint256 tokenId) public {695 require(false, stub_error);696 tokenId;697 dummy = 0;698 }699}700701/// @dev inlined interface702contract ERC721UniqueMintableEvents {703 event MintingFinished();704}705706/// @title ERC721 minting logic.707/// @dev the ERC-165 identifier for this interface is 0x476ff149708contract ERC721UniqueMintable is Dummy, ERC165, ERC721UniqueMintableEvents {709 /// @dev EVM selector for this function is: 0x05d2035b,710 /// or in textual repr: mintingFinished()711 function mintingFinished() public view returns (bool) {712 require(false, stub_error);713 dummy;714 return false;715 }716717 /// @notice Function to mint a token.718 /// @param to The new owner719 /// @return uint256 The id of the newly minted token720 /// @dev EVM selector for this function is: 0x6a627842,721 /// or in textual repr: mint(address)722 function mint(address to) public returns (uint256) {723 require(false, stub_error);724 to;725 dummy = 0;726 return 0;727 }728729 // /// @notice Function to mint a token.730 // /// @dev `tokenId` should be obtained with `nextTokenId` method,731 // /// unlike standard, you can't specify it manually732 // /// @param to The new owner733 // /// @param tokenId ID of the minted NFT734 // /// @dev EVM selector for this function is: 0x40c10f19,735 // /// or in textual repr: mint(address,uint256)736 // function mint(address to, uint256 tokenId) public returns (bool) {737 // require(false, stub_error);738 // to;739 // tokenId;740 // dummy = 0;741 // return false;742 // }743744 /// @notice Function to mint token with the given tokenUri.745 /// @param to The new owner746 /// @param tokenUri Token URI that would be stored in the NFT properties747 /// @return uint256 The id of the newly minted token748 /// @dev EVM selector for this function is: 0x45c17782,749 /// or in textual repr: mintWithTokenURI(address,string)750 function mintWithTokenURI(address to, string memory tokenUri) public returns (uint256) {751 require(false, stub_error);752 to;753 tokenUri;754 dummy = 0;755 return 0;756 }757758 // /// @notice Function to mint token with the given tokenUri.759 // /// @dev `tokenId` should be obtained with `nextTokenId` method,760 // /// unlike standard, you can't specify it manually761 // /// @param to The new owner762 // /// @param tokenId ID of the minted NFT763 // /// @param tokenUri Token URI that would be stored in the NFT properties764 // /// @dev EVM selector for this function is: 0x50bb4e7f,765 // /// or in textual repr: mintWithTokenURI(address,uint256,string)766 // function mintWithTokenURI(address to, uint256 tokenId, string memory tokenUri) public returns (bool) {767 // require(false, stub_error);768 // to;769 // tokenId;770 // tokenUri;771 // dummy = 0;772 // return false;773 // }774775 /// @dev Not implemented776 /// @dev EVM selector for this function is: 0x7d64bcb4,777 /// or in textual repr: finishMinting()778 function finishMinting() public returns (bool) {779 require(false, stub_error);780 dummy = 0;781 return false;782 }783}784785/// @title Unique extensions for ERC721.786/// @dev the ERC-165 identifier for this interface is 0x0e48fdb4787contract ERC721UniqueExtensions is Dummy, ERC165 {788 /// @notice A descriptive name for a collection of NFTs in this contract789 /// @dev EVM selector for this function is: 0x06fdde03,790 /// or in textual repr: name()791 function name() public view returns (string memory) {792 require(false, stub_error);793 dummy;794 return "";795 }796797 /// @notice An abbreviated name for NFTs in this contract798 /// @dev EVM selector for this function is: 0x95d89b41,799 /// or in textual repr: symbol()800 function symbol() public view returns (string memory) {801 require(false, stub_error);802 dummy;803 return "";804 }805806 /// @notice A description for the collection.807 /// @dev EVM selector for this function is: 0x7284e416,808 /// or in textual repr: description()809 function description() public view returns (string memory) {810 require(false, stub_error);811 dummy;812 return "";813 }814815 /// Returns the owner (in cross format) of the token.816 ///817 /// @param tokenId Id for the token.818 /// @dev EVM selector for this function is: 0x2b29dace,819 /// or in textual repr: crossOwnerOf(uint256)820 function crossOwnerOf(uint256 tokenId) public view returns (CrossAddress memory) {821 require(false, stub_error);822 tokenId;823 dummy;824 return CrossAddress(0x0000000000000000000000000000000000000000, 0);825 }826827 /// Returns the token properties.828 ///829 /// @param tokenId Id for the token.830 /// @param keys Properties keys. Empty keys for all propertyes.831 /// @return Vector of properties key/value pairs.832 /// @dev EVM selector for this function is: 0xe07ede7e,833 /// or in textual repr: properties(uint256,string[])834 function properties(uint256 tokenId, string[] memory keys) public view returns (Property[] memory) {835 require(false, stub_error);836 tokenId;837 keys;838 dummy;839 return new Property[](0);840 }841842 /// @notice Set or reaffirm the approved address for an NFT843 /// @dev The zero address indicates there is no approved address.844 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized845 /// operator of the current owner.846 /// @param approved The new substrate address approved NFT controller847 /// @param tokenId The NFT to approve848 /// @dev EVM selector for this function is: 0x0ecd0ab0,849 /// or in textual repr: approveCross((address,uint256),uint256)850 function approveCross(CrossAddress memory approved, uint256 tokenId) public {851 require(false, stub_error);852 approved;853 tokenId;854 dummy = 0;855 }856857 /// @notice Transfer ownership of an NFT858 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`859 /// is the zero address. Throws if `tokenId` is not a valid NFT.860 /// @param to The new owner861 /// @param tokenId The NFT to transfer862 /// @dev EVM selector for this function is: 0xa9059cbb,863 /// or in textual repr: transfer(address,uint256)864 function transfer(address to, uint256 tokenId) public {865 require(false, stub_error);866 to;867 tokenId;868 dummy = 0;869 }870871 /// @notice Transfer ownership of an NFT872 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`873 /// is the zero address. Throws if `tokenId` is not a valid NFT.874 /// @param to The new owner875 /// @param tokenId The NFT to transfer876 /// @dev EVM selector for this function is: 0x2ada85ff,877 /// or in textual repr: transferCross((address,uint256),uint256)878 function transferCross(CrossAddress memory to, uint256 tokenId) public {879 require(false, stub_error);880 to;881 tokenId;882 dummy = 0;883 }884885 /// @notice Transfer ownership of an NFT from cross account address to cross account address886 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`887 /// is the zero address. Throws if `tokenId` is not a valid NFT.888 /// @param from Cross acccount address of current owner889 /// @param to Cross acccount address of new owner890 /// @param tokenId The NFT to transfer891 /// @dev EVM selector for this function is: 0xd5cf430b,892 /// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)893 function transferFromCross(894 CrossAddress memory from,895 CrossAddress memory to,896 uint256 tokenId897 ) public {898 require(false, stub_error);899 from;900 to;901 tokenId;902 dummy = 0;903 }904905 // /// @notice Burns a specific ERC721 token.906 // /// @dev Throws unless `msg.sender` is the current owner or an authorized907 // /// operator for this NFT. Throws if `from` is not the current owner. Throws908 // /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.909 // /// @param from The current owner of the NFT910 // /// @param tokenId The NFT to transfer911 // /// @dev EVM selector for this function is: 0x79cc6790,912 // /// or in textual repr: burnFrom(address,uint256)913 // function burnFrom(address from, uint256 tokenId) public {914 // require(false, stub_error);915 // from;916 // tokenId;917 // dummy = 0;918 // }919920 /// @notice Burns a specific ERC721 token.921 /// @dev Throws unless `msg.sender` is the current owner or an authorized922 /// operator for this NFT. Throws if `from` is not the current owner. Throws923 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.924 /// @param from The current owner of the NFT925 /// @param tokenId The NFT to transfer926 /// @dev EVM selector for this function is: 0xbb2f5a58,927 /// or in textual repr: burnFromCross((address,uint256),uint256)928 function burnFromCross(CrossAddress memory from, uint256 tokenId) public {929 require(false, stub_error);930 from;931 tokenId;932 dummy = 0;933 }934935 /// @notice Returns next free NFT ID.936 /// @dev EVM selector for this function is: 0x75794a3c,937 /// or in textual repr: nextTokenId()938 function nextTokenId() public view returns (uint256) {939 require(false, stub_error);940 dummy;941 return 0;942 }943944 // /// @notice Function to mint multiple tokens.945 // /// @dev `tokenIds` should be an array of consecutive numbers and first number946 // /// should be obtained with `nextTokenId` method947 // /// @param to The new owner948 // /// @param tokenIds IDs of the minted NFTs949 // /// @dev EVM selector for this function is: 0x44a9945e,950 // /// or in textual repr: mintBulk(address,uint256[])951 // function mintBulk(address to, uint256[] memory tokenIds) public returns (bool) {952 // require(false, stub_error);953 // to;954 // tokenIds;955 // dummy = 0;956 // return false;957 // }958959 // /// @notice Function to mint multiple tokens with the given tokenUris.960 // /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive961 // /// numbers and first number should be obtained with `nextTokenId` method962 // /// @param to The new owner963 // /// @param tokens array of pairs of token ID and token URI for minted tokens964 // /// @dev EVM selector for this function is: 0x36543006,965 // /// or in textual repr: mintBulkWithTokenURI(address,(uint256,string)[])966 // function mintBulkWithTokenURI(address to, Tuple15[] memory tokens) public returns (bool) {967 // require(false, stub_error);968 // to;969 // tokens;970 // dummy = 0;971 // return false;972 // }973974 /// @notice Function to mint a token.975 /// @param to The new owner crossAccountId976 /// @param properties Properties of minted token977 /// @return uint256 The id of the newly minted token978 /// @dev EVM selector for this function is: 0xb904db03,979 /// or in textual repr: mintCross((address,uint256),(string,bytes)[])980 function mintCross(CrossAddress memory to, Property[] memory properties) public returns (uint256) {981 require(false, stub_error);982 to;983 properties;984 dummy = 0;985 return 0;986 }987}988989/// @dev anonymous struct990struct Tuple15 {991 uint256 field_0;992 string field_1;993}994995/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension996/// @dev See https://eips.ethereum.org/EIPS/eip-721997/// @dev the ERC-165 identifier for this interface is 0x780e9d63998contract ERC721Enumerable is Dummy, ERC165 {999 /// @notice Enumerate valid NFTs1000 /// @param index A counter less than `totalSupply()`1001 /// @return The token identifier for the `index`th NFT,1002 /// (sort order not specified)1003 /// @dev EVM selector for this function is: 0x4f6ccce7,1004 /// or in textual repr: tokenByIndex(uint256)1005 function tokenByIndex(uint256 index) public view returns (uint256) {1006 require(false, stub_error);1007 index;1008 dummy;1009 return 0;1010 }10111012 /// @dev Not implemented1013 /// @dev EVM selector for this function is: 0x2f745c59,1014 /// or in textual repr: tokenOfOwnerByIndex(address,uint256)1015 function tokenOfOwnerByIndex(address owner, uint256 index) public view returns (uint256) {1016 require(false, stub_error);1017 owner;1018 index;1019 dummy;1020 return 0;1021 }10221023 /// @notice Count NFTs tracked by this contract1024 /// @return A count of valid NFTs tracked by this contract, where each one of1025 /// them has an assigned and queryable owner not equal to the zero address1026 /// @dev EVM selector for this function is: 0x18160ddd,1027 /// or in textual repr: totalSupply()1028 function totalSupply() public view returns (uint256) {1029 require(false, stub_error);1030 dummy;1031 return 0;1032 }1033}10341035/// @dev inlined interface1036contract ERC721Events {1037 event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);1038 event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);1039 event ApprovalForAll(address indexed owner, address indexed operator, bool approved);1040}10411042/// @title ERC-721 Non-Fungible Token Standard1043/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md1044/// @dev the ERC-165 identifier for this interface is 0x983a942b1045contract ERC721 is Dummy, ERC165, ERC721Events {1046 /// @notice Count all NFTs assigned to an owner1047 /// @dev NFTs assigned to the zero address are considered invalid, and this1048 /// function throws for queries about the zero address.1049 /// @param owner An address for whom to query the balance1050 /// @return The number of NFTs owned by `owner`, possibly zero1051 /// @dev EVM selector for this function is: 0x70a08231,1052 /// or in textual repr: balanceOf(address)1053 function balanceOf(address owner) public view returns (uint256) {1054 require(false, stub_error);1055 owner;1056 dummy;1057 return 0;1058 }10591060 /// @notice Find the owner of an NFT1061 /// @dev NFTs assigned to zero address are considered invalid, and queries1062 /// about them do throw.1063 /// @param tokenId The identifier for an NFT1064 /// @return The address of the owner of the NFT1065 /// @dev EVM selector for this function is: 0x6352211e,1066 /// or in textual repr: ownerOf(uint256)1067 function ownerOf(uint256 tokenId) public view returns (address) {1068 require(false, stub_error);1069 tokenId;1070 dummy;1071 return 0x0000000000000000000000000000000000000000;1072 }10731074 /// @dev Not implemented1075 /// @dev EVM selector for this function is: 0xb88d4fde,1076 /// or in textual repr: safeTransferFrom(address,address,uint256,bytes)1077 function safeTransferFrom(1078 address from,1079 address to,1080 uint256 tokenId,1081 bytes memory data1082 ) public {1083 require(false, stub_error);1084 from;1085 to;1086 tokenId;1087 data;1088 dummy = 0;1089 }10901091 /// @dev Not implemented1092 /// @dev EVM selector for this function is: 0x42842e0e,1093 /// or in textual repr: safeTransferFrom(address,address,uint256)1094 function safeTransferFrom(1095 address from,1096 address to,1097 uint256 tokenId1098 ) public {1099 require(false, stub_error);1100 from;1101 to;1102 tokenId;1103 dummy = 0;1104 }11051106 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE1107 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE1108 /// THEY MAY BE PERMANENTLY LOST1109 /// @dev Throws unless `msg.sender` is the current owner or an authorized1110 /// operator for this NFT. Throws if `from` is not the current owner. Throws1111 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.1112 /// @param from The current owner of the NFT1113 /// @param to The new owner1114 /// @param tokenId The NFT to transfer1115 /// @dev EVM selector for this function is: 0x23b872dd,1116 /// or in textual repr: transferFrom(address,address,uint256)1117 function transferFrom(1118 address from,1119 address to,1120 uint256 tokenId1121 ) public {1122 require(false, stub_error);1123 from;1124 to;1125 tokenId;1126 dummy = 0;1127 }11281129 /// @notice Set or reaffirm the approved address for an NFT1130 /// @dev The zero address indicates there is no approved address.1131 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized1132 /// operator of the current owner.1133 /// @param approved The new approved NFT controller1134 /// @param tokenId The NFT to approve1135 /// @dev EVM selector for this function is: 0x095ea7b3,1136 /// or in textual repr: approve(address,uint256)1137 function approve(address approved, uint256 tokenId) public {1138 require(false, stub_error);1139 approved;1140 tokenId;1141 dummy = 0;1142 }11431144 /// @notice Sets or unsets the approval of a given operator.1145 /// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1146 /// @param operator Operator1147 /// @param approved Should operator status be granted or revoked?1148 /// @dev EVM selector for this function is: 0xa22cb465,1149 /// or in textual repr: setApprovalForAll(address,bool)1150 function setApprovalForAll(address operator, bool approved) public {1151 require(false, stub_error);1152 operator;1153 approved;1154 dummy = 0;1155 }11561157 /// @dev Not implemented1158 /// @dev EVM selector for this function is: 0x081812fc,1159 /// or in textual repr: getApproved(uint256)1160 function getApproved(uint256 tokenId) public view returns (address) {1161 require(false, stub_error);1162 tokenId;1163 dummy;1164 return 0x0000000000000000000000000000000000000000;1165 }11661167 /// @notice Tells whether the given `owner` approves the `operator`.1168 /// @dev EVM selector for this function is: 0xe985e9c5,1169 /// or in textual repr: isApprovedForAll(address,address)1170 function isApprovedForAll(address owner, address operator) public view returns (bool) {1171 require(false, stub_error);1172 owner;1173 operator;1174 dummy;1175 return false;1176 }11771178 /// @notice Returns collection helper contract address1179 /// @dev EVM selector for this function is: 0x1896cce6,1180 /// or in textual repr: collectionHelperAddress()1181 function collectionHelperAddress() public view returns (address) {1182 require(false, stub_error);1183 dummy;1184 return 0x0000000000000000000000000000000000000000;1185 }1186}11871188contract UniqueNFT is1189 Dummy,1190 ERC165,1191 ERC721,1192 ERC721Enumerable,1193 ERC721UniqueExtensions,1194 ERC721UniqueMintable,1195 ERC721Burnable,1196 ERC721Metadata,1197 Collection,1198 TokenProperties1199{}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;