difftreelog
Merge branch 'develop' into tests/eth-helpers
in: master
60 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),}
});
@@ -93,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 {
@@ -104,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,25 +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_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,14 +89,10 @@
#abi_read
#abi_write
#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| {
@@ -130,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/abi/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/abi/impls.rs
+++ b/crates/evm-coder/src/abi/impls.rs
@@ -135,41 +135,6 @@
}
}
-impl sealed::CanBePlacedInVec for Property {}
-
-impl AbiType for Property {
- const SIGNATURE: SignatureUnit = make_signature!(new fixed("(string,bytes)"));
-
- fn is_dynamic() -> bool {
- string::is_dynamic() || bytes::is_dynamic()
- }
-
- fn size() -> usize {
- <string as AbiType>::size() + <bytes as AbiType>::size()
- }
-}
-
-impl AbiRead for Property {
- fn abi_read(reader: &mut AbiReader) -> Result<Property> {
- let size = if !Property::is_dynamic() {
- Some(<Property as AbiType>::size())
- } else {
- None
- };
- let mut subresult = reader.subresult(size)?;
- let key = <string>::abi_read(&mut subresult)?;
- let value = <bytes>::abi_read(&mut subresult)?;
-
- Ok(Property { key, value })
- }
-}
-
-impl AbiWrite for Property {
- fn abi_write(&self, writer: &mut AbiWriter) {
- (&self.key, &self.value).abi_write(writer);
- }
-}
-
impl<T: AbiWrite + AbiType> AbiWrite for Vec<T> {
fn abi_write(&self, writer: &mut AbiWriter) {
let is_dynamic = T::is_dynamic();
crates/evm-coder/src/lib.rsdiffbeforeafterboth--- a/crates/evm-coder/src/lib.rs
+++ b/crates/evm-coder/src/lib.rs
@@ -196,12 +196,6 @@
self.len() == 0
}
}
-
- #[derive(Debug, Default)]
- pub struct Property {
- pub key: string,
- pub value: bytes,
- }
}
/// Parseable EVM call, this trait should be implemented with [`solidity_interface`] macro
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()
- }
- }
)*
};
}
@@ -81,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();
@@ -131,60 +121,3 @@
impl_tuples! {A B C D E F G H}
impl_tuples! {A B C D E F G H I}
impl_tuples! {A B C D E F G H I J}
-
-impl StructCollect for Property {
- fn name() -> String {
- "Property".into()
- }
-
- fn declaration() -> String {
- use std::fmt::Write;
-
- let mut str = String::new();
- writeln!(str, "/// @dev Property struct").unwrap();
- writeln!(str, "struct {} {{", Self::name()).unwrap();
- writeln!(str, "\tstring key;").unwrap();
- writeln!(str, "\tbytes value;").unwrap();
- writeln!(str, "}}").unwrap();
- str
- }
-}
-
-impl SolidityTypeName for Property {
- fn solidity_name(writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
- write!(writer, "{}", tc.collect_struct::<Self>())
- }
-
- fn is_simple() -> bool {
- false
- }
-
- fn solidity_default(writer: &mut impl fmt::Write, tc: &TypeCollector) -> fmt::Result {
- write!(writer, "{}(", tc.collect_struct::<Self>())?;
- address::solidity_default(writer, tc)?;
- write!(writer, ",")?;
- uint256::solidity_default(writer, tc)?;
- write!(writer, ")")
- }
-}
-
-impl SolidityType for Property {
- fn names(tc: &TypeCollector) -> Vec<string> {
- let mut collected = Vec::with_capacity(Self::len());
- {
- let mut out = string::new();
- string::solidity_name(&mut out, tc).expect("no fmt error");
- collected.push(out);
- }
- {
- let mut out = string::new();
- bytes::solidity_name(&mut out, tc).expect("no fmt error");
- collected.push(out);
- }
- collected
- }
-
- fn len() -> usize {
- 2
- }
-}
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,9 +78,11 @@
self.anonymous.borrow_mut().insert(names, id);
format!("Tuple{}", id)
}
- pub fn collect_struct<T: StructCollect>(&self) -> String {
- 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<_>>();
@@ -419,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,32 +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]
fn impl_abi_type_signature() {
assert_eq!(
<TypeStruct1SimpleParam as evm_coder::abi::AbiType>::SIGNATURE
@@ -292,31 +266,6 @@
/// Docs for C
TupleStruct2MixedParam,
);
-
- #[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() {
@@ -812,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/common/src/erc.rsdiffbeforeafterboth--- a/pallets/common/src/erc.rs
+++ b/pallets/common/src/erc.rs
@@ -21,7 +21,6 @@
abi::AbiType,
solidity_interface, solidity, ToLog,
types::*,
- types::Property as PropertyStruct,
execution::{Result, Error},
weight,
};
@@ -31,15 +30,9 @@
AccessMode, CollectionMode, CollectionPermissions, OwnerRestrictedSet, Property,
SponsoringRateLimit, SponsorshipState,
};
-use alloc::format;
use crate::{
- Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf,
- eth::{
- EthCrossAccount, CollectionPermissions as EvmPermissions,
- CollectionLimits as EvmCollectionLimits,
- },
- weights::WeightInfo,
+ Pallet, CollectionHandle, Config, CollectionProperties, SelfWeightOf, eth, weights::WeightInfo,
};
/// Events for ethereum collection helper.
@@ -123,21 +116,13 @@
fn set_collection_properties(
&mut self,
caller: caller,
- properties: Vec<PropertyStruct>,
+ properties: Vec<eth::Property>,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
let properties = properties
.into_iter()
- .map(|PropertyStruct { key, value }| {
- let key = <Vec<u8>>::from(key)
- .try_into()
- .map_err(|_| "key too large")?;
-
- let value = value.0.try_into().map_err(|_| "value too large")?;
-
- Ok(Property { key, value })
- })
+ .map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?;
<Pallet<T>>::set_collection_properties(self, &caller, properties)
@@ -197,7 +182,7 @@
///
/// @param keys Properties keys. Empty keys for all propertyes.
/// @return Vector of properties key/value pairs.
- fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {
+ fn collection_properties(&self, keys: Vec<string>) -> Result<Vec<eth::Property>> {
let keys = keys
.into_iter()
.map(|key| {
@@ -215,12 +200,7 @@
let properties = properties
.into_iter()
- .map(|p| {
- let key =
- string::from_utf8(p.key.into()).map_err(|e| Error::Revert(format!("{}", e)))?;
- let value = bytes(p.value.to_vec());
- Ok(PropertyStruct { key, value })
- })
+ .map(Property::try_into)
.collect::<Result<Vec<_>>>()?;
Ok(properties)
}
@@ -249,7 +229,7 @@
fn set_collection_sponsor_cross(
&mut self,
caller: caller,
- sponsor: EthCrossAccount,
+ sponsor: eth::CrossAddress,
) -> Result<void> {
self.consume_store_reads_and_writes(1, 1)?;
@@ -289,103 +269,65 @@
/// Get current sponsor.
///
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
- fn collection_sponsor(&self) -> Result<EthCrossAccount> {
+ fn collection_sponsor(&self) -> Result<eth::CrossAddress> {
let sponsor = match self.collection.sponsorship.sponsor() {
Some(sponsor) => sponsor,
None => return Ok(Default::default()),
};
- Ok(EthCrossAccount::from_sub::<T>(&sponsor))
+ Ok(eth::CrossAddress::from_sub::<T>(&sponsor))
}
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
- fn collection_limits(&self) -> Result<Vec<(EvmCollectionLimits, bool, uint256)>> {
- let convert_value_limit = |limit: EvmCollectionLimits,
- value: Option<u32>|
- -> (EvmCollectionLimits, bool, uint256) {
- value
- .map(|v| (limit, true, v.into()))
- .unwrap_or((limit, false, Default::default()))
- };
-
- let convert_bool_limit = |limit: EvmCollectionLimits,
- value: Option<bool>|
- -> (EvmCollectionLimits, bool, uint256) {
- value
- .map(|v| {
- (
- limit,
- true,
- if v {
- uint256::from(1)
- } else {
- Default::default()
- },
- )
- })
- .unwrap_or((limit, false, Default::default()))
- };
-
+ /// @return Array of collection limits
+ fn collection_limits(&self) -> Result<Vec<eth::CollectionLimit>> {
let limits = &self.collection.limits;
Ok(vec![
- convert_value_limit(
- EvmCollectionLimits::AccountTokenOwnership,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::AccountTokenOwnership,
limits.account_token_ownership_limit,
),
- convert_value_limit(
- EvmCollectionLimits::SponsoredDataSize,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::SponsoredDataSize,
limits.sponsored_data_size,
),
limits
.sponsored_data_rate_limit
.and_then(|limit| {
if let SponsoringRateLimit::Blocks(blocks) = limit {
- Some((
- EvmCollectionLimits::SponsoredDataRateLimit,
- true,
- blocks.into(),
+ Some(eth::CollectionLimit::new::<u32>(
+ eth::CollectionLimitField::SponsoredDataRateLimit,
+ blocks,
))
} else {
None
}
})
- .unwrap_or((
- EvmCollectionLimits::SponsoredDataRateLimit,
- false,
+ .unwrap_or(eth::CollectionLimit::new::<u32>(
+ eth::CollectionLimitField::SponsoredDataRateLimit,
Default::default(),
)),
- convert_value_limit(EvmCollectionLimits::TokenLimit, limits.token_limit),
- convert_value_limit(
- EvmCollectionLimits::SponsorTransferTimeout,
+ eth::CollectionLimit::new(eth::CollectionLimitField::TokenLimit, limits.token_limit),
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::SponsorTransferTimeout,
limits.sponsor_transfer_timeout,
),
- convert_value_limit(
- EvmCollectionLimits::SponsorApproveTimeout,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::SponsorApproveTimeout,
limits.sponsor_approve_timeout,
),
- convert_bool_limit(
- EvmCollectionLimits::OwnerCanTransfer,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::OwnerCanTransfer,
limits.owner_can_transfer,
),
- convert_bool_limit(
- EvmCollectionLimits::OwnerCanDestroy,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::OwnerCanDestroy,
limits.owner_can_destroy,
),
- convert_bool_limit(
- EvmCollectionLimits::TransferEnabled,
+ eth::CollectionLimit::new(
+ eth::CollectionLimitField::TransferEnabled,
limits.transfers_enabled,
),
])
@@ -393,82 +335,21 @@
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
+ /// @param limit Some limit.
#[solidity(rename_selector = "setCollectionLimit")]
fn set_collection_limit(
&mut self,
caller: caller,
- limit: EvmCollectionLimits,
- status: bool,
- value: uint256,
+ limit: eth::CollectionLimit,
) -> Result<void> {
self.consume_store_reads_and_writes(1, 1)?;
- if !status {
+ if !limit.has_value() {
return Err(Error::Revert("user can't disable limits".into()));
- }
-
- let value = value
- .try_into()
- .map_err(|_| Error::Revert(format!("can't convert value to u32 \"{}\"", value)))?;
-
- let convert_value_to_bool = || match value {
- 0 => Ok(false),
- 1 => Ok(true),
- _ => {
- return Err(Error::Revert(format!(
- "can't convert value to boolean \"{}\"",
- value
- )))
- }
- };
-
- let mut limits = self.limits.clone();
-
- match limit {
- EvmCollectionLimits::AccountTokenOwnership => {
- limits.account_token_ownership_limit = Some(value);
- }
- EvmCollectionLimits::SponsoredDataSize => {
- limits.sponsored_data_size = Some(value);
- }
- EvmCollectionLimits::SponsoredDataRateLimit => {
- limits.sponsored_data_rate_limit = Some(SponsoringRateLimit::Blocks(value));
- }
- EvmCollectionLimits::TokenLimit => {
- limits.token_limit = Some(value);
- }
- EvmCollectionLimits::SponsorTransferTimeout => {
- limits.sponsor_transfer_timeout = Some(value);
- }
- EvmCollectionLimits::SponsorApproveTimeout => {
- limits.sponsor_approve_timeout = Some(value);
- }
- EvmCollectionLimits::OwnerCanTransfer => {
- limits.owner_can_transfer = Some(convert_value_to_bool()?);
- }
- EvmCollectionLimits::OwnerCanDestroy => {
- limits.owner_can_destroy = Some(convert_value_to_bool()?);
- }
- EvmCollectionLimits::TransferEnabled => {
- limits.transfers_enabled = Some(convert_value_to_bool()?);
- }
- _ => return Err(Error::Revert(format!("unknown limit \"{:?}\"", limit))),
}
let caller = T::CrossAccountId::from_eth(caller);
- <Pallet<T>>::update_limits(&caller, self, limits).map_err(dispatch_to_evm::<T>)
+ <Pallet<T>>::update_limits(&caller, self, limit.try_into()?).map_err(dispatch_to_evm::<T>)
}
/// Get contract address.
@@ -481,7 +362,7 @@
fn add_collection_admin_cross(
&mut self,
caller: caller,
- new_admin: EthCrossAccount,
+ new_admin: eth::CrossAddress,
) -> Result<void> {
self.consume_store_reads_and_writes(2, 2)?;
@@ -496,7 +377,7 @@
fn remove_collection_admin_cross(
&mut self,
caller: caller,
- admin: EthCrossAccount,
+ admin: eth::CrossAddress,
) -> Result<void> {
self.consume_store_reads_and_writes(2, 2)?;
@@ -595,10 +476,10 @@
/// Returns nesting for a collection
#[solidity(rename_selector = "collectionNestingRestrictedCollectionIds")]
- fn collection_nesting_restricted_ids(&self) -> Result<(bool, Vec<uint256>)> {
+ fn collection_nesting_restricted_ids(&self) -> Result<eth::CollectionNesting> {
let nesting = self.collection.permissions.nesting();
- Ok((
+ Ok(eth::CollectionNesting::new(
nesting.token_owner,
nesting
.restricted
@@ -609,11 +490,17 @@
}
/// Returns permissions for a collection
- fn collection_nesting_permissions(&self) -> Result<Vec<(EvmPermissions, bool)>> {
+ fn collection_nesting_permissions(&self) -> Result<Vec<eth::CollectionNestingPermission>> {
let nesting = self.collection.permissions.nesting();
Ok(vec![
- (EvmPermissions::CollectionAdmin, nesting.collection_admin),
- (EvmPermissions::TokenOwner, nesting.token_owner),
+ eth::CollectionNestingPermission::new(
+ eth::CollectionPermissionField::CollectionAdmin,
+ nesting.collection_admin,
+ ),
+ eth::CollectionNestingPermission::new(
+ eth::CollectionPermissionField::TokenOwner,
+ nesting.token_owner,
+ ),
])
}
/// Set the collection access method.
@@ -638,7 +525,7 @@
/// Checks that user allowed to operate with collection.
///
/// @param user User address to check.
- fn allowlisted_cross(&self, user: EthCrossAccount) -> Result<bool> {
+ fn allowlisted_cross(&self, user: eth::CrossAddress) -> Result<bool> {
let user = user.into_sub_cross_account::<T>()?;
Ok(Pallet::<T>::allowed(self.id, user))
}
@@ -662,7 +549,7 @@
fn add_to_collection_allow_list_cross(
&mut self,
caller: caller,
- user: EthCrossAccount,
+ user: eth::CrossAddress,
) -> Result<void> {
self.consume_store_writes(1)?;
@@ -691,7 +578,7 @@
fn remove_from_collection_allow_list_cross(
&mut self,
caller: caller,
- user: EthCrossAccount,
+ user: eth::CrossAddress,
) -> Result<void> {
self.consume_store_writes(1)?;
@@ -729,7 +616,7 @@
///
/// @param user User cross account to verify
/// @return "true" if account is the owner or admin
- fn is_owner_or_admin_cross(&self, user: EthCrossAccount) -> Result<bool> {
+ fn is_owner_or_admin_cross(&self, user: eth::CrossAddress) -> Result<bool> {
let user = user.into_sub_cross_account::<T>()?;
Ok(self.is_owner_or_admin(&user))
}
@@ -750,8 +637,8 @@
///
/// @return Tuble with sponsor address and his substrate mirror.
/// If address is canonical then substrate mirror is zero and vice versa.
- fn collection_owner(&self) -> Result<EthCrossAccount> {
- Ok(EthCrossAccount::from_sub_cross_account::<T>(
+ fn collection_owner(&self) -> Result<eth::CrossAddress> {
+ Ok(eth::CrossAddress::from_sub_cross_account::<T>(
&T::CrossAccountId::from_sub(self.owner.clone()),
))
}
@@ -774,9 +661,9 @@
///
/// @return Vector of tuples with admins address and his substrate mirror.
/// If address is canonical then substrate mirror is zero and vice versa.
- fn collection_admins(&self) -> Result<Vec<EthCrossAccount>> {
+ fn collection_admins(&self) -> Result<Vec<eth::CrossAddress>> {
let result = crate::IsAdmin::<T>::iter_prefix((self.id,))
- .map(|(admin, _)| EthCrossAccount::from_sub_cross_account::<T>(&admin))
+ .map(|(admin, _)| eth::CrossAddress::from_sub_cross_account::<T>(&admin))
.collect();
Ok(result)
}
@@ -788,7 +675,7 @@
fn change_collection_owner_cross(
&mut self,
caller: caller,
- new_owner: EthCrossAccount,
+ new_owner: eth::CrossAddress,
) -> Result<void> {
self.consume_store_writes(1)?;
@@ -797,29 +684,6 @@
self.change_owner(caller, new_owner)
.map_err(dispatch_to_evm::<T>)
}
-}
-
-/// ### Note
-/// Do not forget to add: `self.consume_store_reads(1)?;`
-fn check_is_owner_or_admin<T: Config>(
- caller: caller,
- collection: &CollectionHandle<T>,
-) -> Result<T::CrossAccountId> {
- let caller = T::CrossAccountId::from_eth(caller);
- collection
- .check_is_owner_or_admin(&caller)
- .map_err(dispatch_to_evm::<T>)?;
- Ok(caller)
-}
-
-/// ### Note
-/// Do not forget to add: `self.consume_store_writes(1)?;`
-fn save<T: Config>(collection: &CollectionHandle<T>) -> Result<void> {
- collection
- .check_is_internal()
- .map_err(dispatch_to_evm::<T>)?;
- collection.save().map_err(dispatch_to_evm::<T>)?;
- Ok(())
}
/// Contains static property keys and values.
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -16,6 +16,8 @@
//! The module contains a number of functions for converting and checking ethereum identifiers.
+use alloc::format;
+use sp_std::{vec, vec::Vec};
use evm_coder::{
AbiCoder,
types::{uint256, address},
@@ -64,15 +66,78 @@
T::CrossAccountId::from_sub(account_id)
}
+/// Ethereum representation of Optional value with uint256.
+#[derive(Debug, Default, AbiCoder)]
+pub struct OptionUint {
+ status: bool,
+ value: uint256,
+}
+
+impl From<u32> for OptionUint {
+ fn from(value: u32) -> Self {
+ Self {
+ status: true,
+ value: uint256::from(value),
+ }
+ }
+}
+
+impl From<Option<u32>> for OptionUint {
+ fn from(value: Option<u32>) -> Self {
+ match value {
+ Some(value) => Self {
+ status: true,
+ value: value.into(),
+ },
+ None => Self {
+ status: false,
+ value: Default::default(),
+ },
+ }
+ }
+}
+
+impl From<bool> for OptionUint {
+ fn from(value: bool) -> Self {
+ Self {
+ status: true,
+ value: if value {
+ uint256::from(1)
+ } else {
+ Default::default()
+ },
+ }
+ }
+}
+
+impl From<Option<bool>> for OptionUint {
+ fn from(value: Option<bool>) -> Self {
+ match value {
+ Some(value) => Self::from(value),
+ None => Self {
+ status: false,
+ value: Default::default(),
+ },
+ }
+ }
+}
+
+/// Ethereum representation of Optional value with CrossAddress.
+#[derive(Debug, Default, AbiCoder)]
+pub struct OptionCrossAddress {
+ pub status: bool,
+ pub value: CrossAddress,
+}
+
/// Cross account struct
#[derive(Debug, Default, AbiCoder)]
-pub struct EthCrossAccount {
+pub struct CrossAddress {
pub(crate) eth: address,
pub(crate) sub: uint256,
}
-impl EthCrossAccount {
- /// Converts `CrossAccountId` to `EthCrossAccountId`
+impl CrossAddress {
+ /// Converts `CrossAccountId` to [`CrossAddress`]
pub fn from_sub_cross_account<T>(cross_account_id: &T::CrossAccountId) -> Self
where
T: pallet_evm::Config,
@@ -87,7 +152,7 @@
}
}
}
- /// Creates `EthCrossAccount` from substrate account
+ /// Creates [`CrossAddress`] from substrate account
pub fn from_sub<T>(account_id: &T::AccountId) -> Self
where
T: pallet_evm::Config,
@@ -98,7 +163,7 @@
sub: uint256::from_big_endian(account_id.as_ref()),
}
}
- /// Converts `EthCrossAccount` to `CrossAccountId`
+ /// Converts [`CrossAddress`] to `CrossAccountId`
pub fn into_sub_cross_account<T>(&self) -> evm_coder::execution::Result<T::CrossAccountId>
where
T: pallet_evm::Config,
@@ -116,10 +181,42 @@
}
}
-/// [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
+#[derive(Debug, Default, AbiCoder)]
+pub struct Property {
+ key: evm_coder::types::string,
+ value: evm_coder::types::bytes,
+}
+
+impl TryFrom<up_data_structs::Property> for Property {
+ type Error = evm_coder::execution::Error;
+
+ fn try_from(from: up_data_structs::Property) -> Result<Self, Self::Error> {
+ let key = evm_coder::types::string::from_utf8(from.key.into())
+ .map_err(|e| Self::Error::Revert(format!("utf8 conversion error: {}", e)))?;
+ let value = evm_coder::types::bytes(from.value.to_vec());
+ Ok(Property { key, value })
+ }
+}
+
+impl TryInto<up_data_structs::Property> for Property {
+ type Error = evm_coder::execution::Error;
+
+ fn try_into(self) -> Result<up_data_structs::Property, Self::Error> {
+ let key = <Vec<u8>>::from(self.key)
+ .try_into()
+ .map_err(|_| "key too large")?;
+
+ let value = self.value.0.try_into().map_err(|_| "value too large")?;
+
+ Ok(up_data_structs::Property { key, value })
+ }
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
#[derive(Debug, Default, Clone, Copy, AbiCoder)]
#[repr(u8)]
-pub enum CollectionLimits {
+pub enum CollectionLimitField {
/// How many tokens can a user have on one account.
#[default]
AccountTokenOwnership,
@@ -148,10 +245,91 @@
/// Is it possible to send tokens from this collection between users.
TransferEnabled,
}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+#[derive(Debug, Default, AbiCoder)]
+pub struct CollectionLimit {
+ field: CollectionLimitField,
+ value: OptionUint,
+}
+
+impl CollectionLimit {
+ /// Create [`CollectionLimit`] from field and value.
+ pub fn new<T>(field: CollectionLimitField, value: T) -> Self
+ where
+ OptionUint: From<T>,
+ {
+ Self {
+ field,
+ value: value.into(),
+ }
+ }
+ /// Whether the field contains a value.
+ pub fn has_value(&self) -> bool {
+ self.value.status
+ }
+}
+
+impl TryInto<up_data_structs::CollectionLimits> for CollectionLimit {
+ type Error = evm_coder::execution::Error;
+
+ fn try_into(self) -> Result<up_data_structs::CollectionLimits, Self::Error> {
+ let value = self.value.value.try_into().map_err(|error| {
+ Self::Error::Revert(format!(
+ "can't convert value to u32 \"{}\" because: \"{error}\"",
+ self.value.value
+ ))
+ })?;
+
+ let convert_value_to_bool = || match value {
+ 0 => Ok(false),
+ 1 => Ok(true),
+ _ => {
+ return Err(Self::Error::Revert(format!(
+ "can't convert value to boolean \"{value}\""
+ )))
+ }
+ };
+
+ let mut limits = up_data_structs::CollectionLimits::default();
+ match self.field {
+ CollectionLimitField::AccountTokenOwnership => {
+ limits.account_token_ownership_limit = Some(value);
+ }
+ CollectionLimitField::SponsoredDataSize => {
+ limits.sponsored_data_size = Some(value);
+ }
+ CollectionLimitField::SponsoredDataRateLimit => {
+ limits.sponsored_data_rate_limit =
+ Some(up_data_structs::SponsoringRateLimit::Blocks(value));
+ }
+ CollectionLimitField::TokenLimit => {
+ limits.token_limit = Some(value);
+ }
+ CollectionLimitField::SponsorTransferTimeout => {
+ limits.sponsor_transfer_timeout = Some(value);
+ }
+ CollectionLimitField::SponsorApproveTimeout => {
+ limits.sponsor_approve_timeout = Some(value);
+ }
+ CollectionLimitField::OwnerCanTransfer => {
+ limits.owner_can_transfer = Some(convert_value_to_bool()?);
+ }
+ CollectionLimitField::OwnerCanDestroy => {
+ limits.owner_can_destroy = Some(convert_value_to_bool()?);
+ }
+ CollectionLimitField::TransferEnabled => {
+ limits.transfers_enabled = Some(convert_value_to_bool()?);
+ }
+ };
+ Ok(limits)
+ }
+}
+
/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
#[derive(Default, Debug, Clone, Copy, AbiCoder)]
#[repr(u8)]
-pub enum CollectionPermissions {
+pub enum CollectionPermissionField {
/// Owner of token can nest tokens under it.
#[default]
TokenOwner,
@@ -163,7 +341,7 @@
/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
#[derive(AbiCoder, Copy, Clone, Default, Debug)]
#[repr(u8)]
-pub enum EthTokenPermissions {
+pub enum TokenPermissionField {
/// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
#[default]
Mutable,
@@ -174,3 +352,122 @@
/// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin,
}
+
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+#[derive(Debug, Default, AbiCoder)]
+pub struct PropertyPermission {
+ /// TokenPermission field.
+ code: TokenPermissionField,
+ /// TokenPermission value.
+ value: bool,
+}
+
+impl PropertyPermission {
+ /// Make vector of [`PropertyPermission`] from [`up_data_structs::PropertyPermission`].
+ pub fn into_vec(pp: up_data_structs::PropertyPermission) -> Vec<Self> {
+ vec![
+ PropertyPermission {
+ code: TokenPermissionField::Mutable,
+ value: pp.mutable,
+ },
+ PropertyPermission {
+ code: TokenPermissionField::TokenOwner,
+ value: pp.token_owner,
+ },
+ PropertyPermission {
+ code: TokenPermissionField::CollectionAdmin,
+ value: pp.collection_admin,
+ },
+ ]
+ }
+
+ /// Make [`up_data_structs::PropertyPermission`] from vector of [`PropertyPermission`].
+ pub fn from_vec(permission: Vec<Self>) -> up_data_structs::PropertyPermission {
+ let mut token_permission = up_data_structs::PropertyPermission::default();
+
+ for PropertyPermission { code, value } in permission {
+ match code {
+ TokenPermissionField::Mutable => token_permission.mutable = value,
+ TokenPermissionField::TokenOwner => token_permission.token_owner = value,
+ TokenPermissionField::CollectionAdmin => token_permission.collection_admin = value,
+ }
+ }
+ token_permission
+ }
+}
+
+/// Ethereum representation of Token Property Permissions.
+#[derive(Debug, Default, AbiCoder)]
+pub struct TokenPropertyPermission {
+ /// Token property key.
+ key: evm_coder::types::string,
+ /// Token property permissions.
+ permissions: Vec<PropertyPermission>,
+}
+
+impl
+ From<(
+ up_data_structs::PropertyKey,
+ up_data_structs::PropertyPermission,
+ )> for TokenPropertyPermission
+{
+ fn from(
+ value: (
+ up_data_structs::PropertyKey,
+ up_data_structs::PropertyPermission,
+ ),
+ ) -> Self {
+ let (key, permission) = value;
+ let key = evm_coder::types::string::from_utf8(key.into_inner())
+ .expect("Stored key must be valid");
+ let permissions = PropertyPermission::into_vec(permission);
+ Self { key, permissions }
+ }
+}
+
+impl TokenPropertyPermission {
+ /// Convert vector of [`TokenPropertyPermission`] into vector of [`up_data_structs::PropertyKeyPermission`].
+ pub fn into_property_key_permissions(
+ permissions: Vec<TokenPropertyPermission>,
+ ) -> evm_coder::execution::Result<Vec<up_data_structs::PropertyKeyPermission>> {
+ let mut perms = Vec::new();
+
+ for TokenPropertyPermission { key, permissions } in permissions {
+ let token_permission = PropertyPermission::from_vec(permissions);
+
+ perms.push(up_data_structs::PropertyKeyPermission {
+ key: key.into_bytes().try_into().map_err(|_| "too long key")?,
+ permission: token_permission,
+ });
+ }
+ Ok(perms)
+ }
+}
+
+/// Nested collections.
+#[derive(Debug, Default, AbiCoder)]
+pub struct CollectionNesting {
+ token_owner: bool,
+ ids: Vec<uint256>,
+}
+
+impl CollectionNesting {
+ /// Create [`CollectionNesting`].
+ pub fn new(token_owner: bool, ids: Vec<uint256>) -> Self {
+ Self { token_owner, ids }
+ }
+}
+
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+#[derive(Debug, Default, AbiCoder)]
+pub struct CollectionNestingPermission {
+ field: CollectionPermissionField,
+ value: bool,
+}
+
+impl CollectionNestingPermission {
+ /// Create [`CollectionNestingPermission`].
+ pub fn new(field: CollectionPermissionField, value: bool) -> Self {
+ Self { field, value }
+ }
+}
pallets/evm-contract-helpers/src/eth.rsdiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/eth.rs
+++ b/pallets/evm-contract-helpers/src/eth.rs
@@ -23,9 +23,9 @@
execution::Result,
generate_stubgen, solidity_interface,
types::*,
- ToLog,
+ ToLog, AbiCoder,
};
-use pallet_common::eth::EthCrossAccount;
+use pallet_common::eth;
use pallet_evm::{
ExitRevert, OnCreate, OnMethodCall, PrecompileResult, PrecompileFailure, PrecompileHandle,
account::CrossAccountId,
@@ -175,10 +175,17 @@
///
/// @param contractAddress The contract for which a sponsor is requested.
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
- fn sponsor(&self, contract_address: address) -> Result<EthCrossAccount> {
- Ok(EthCrossAccount::from_sub_cross_account::<T>(
- &Pallet::<T>::get_sponsor(contract_address).ok_or("Contract has no sponsor")?,
- ))
+ fn sponsor(&self, contract_address: address) -> Result<eth::OptionCrossAddress> {
+ Ok(match Pallet::<T>::get_sponsor(contract_address) {
+ Some(ref value) => eth::OptionCrossAddress {
+ status: true,
+ value: eth::CrossAddress::from_sub_cross_account::<T>(value),
+ },
+ None => eth::OptionCrossAddress {
+ status: false,
+ value: Default::default(),
+ },
+ })
}
/// Check tat contract has confirmed sponsor.
@@ -208,14 +215,12 @@
&mut self,
caller: caller,
contract_address: address,
- // TODO: implement support for enums in evm-coder
- mode: uint8,
+ mode: SponsoringModeT,
) -> Result<void> {
self.recorder().consume_sload()?;
self.recorder().consume_sstore()?;
<Pallet<T>>::ensure_owner(contract_address, caller).map_err(dispatch_to_evm::<T>)?;
- let mode = SponsoringModeT::from_eth(mode).ok_or("unknown mode")?;
<Pallet<T>>::set_sponsoring_mode(contract_address, mode);
Ok(())
pallets/evm-contract-helpers/src/lib.rsdiffbeforeafterboth--- a/pallets/evm-contract-helpers/src/lib.rs
+++ b/pallets/evm-contract-helpers/src/lib.rs
@@ -19,6 +19,7 @@
#![warn(missing_docs)]
use codec::{Decode, Encode, MaxEncodedLen};
+use evm_coder::AbiCoder;
pub use pallet::*;
pub use eth::*;
use scale_info::TypeInfo;
@@ -407,7 +408,10 @@
}
/// Available contract sponsoring modes
-#[derive(Encode, Decode, PartialEq, TypeInfo, MaxEncodedLen, Default)]
+#[derive(
+ Encode, Decode, Debug, PartialEq, TypeInfo, MaxEncodedLen, Default, AbiCoder, Clone, Copy,
+)]
+#[repr(u8)]
pub enum SponsoringModeT {
/// Sponsoring is disabled
#[default]
@@ -416,23 +420,4 @@
Allowlisted,
/// All users will be sponsored
Generous,
-}
-
-impl SponsoringModeT {
- fn from_eth(v: u8) -> Option<Self> {
- Some(match v {
- 0 => Self::Disabled,
- 1 => Self::Allowlisted,
- 2 => Self::Generous,
- _ => return None,
- })
- }
- #[allow(dead_code)]
- fn to_eth(self) -> u8 {
- match self {
- SponsoringModeT::Disabled => 0,
- SponsoringModeT::Allowlisted => 1,
- SponsoringModeT::Generous => 2,
- }
- }
}
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
@@ -96,11 +96,11 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x766c4f37,
/// or in textual repr: sponsor(address)
- function sponsor(address contractAddress) public view returns (EthCrossAccount memory) {
+ function sponsor(address contractAddress) public view returns (OptionCrossAddress memory) {
require(false, stub_error);
contractAddress;
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return OptionCrossAddress(false, CrossAddress(0x0000000000000000000000000000000000000000, 0));
}
/// Check tat contract has confirmed sponsor.
@@ -140,7 +140,7 @@
/// @dev EVM selector for this function is: 0xfde8a560,
/// or in textual repr: setSponsoringMode(address,uint8)
- function setSponsoringMode(address contractAddress, uint8 mode) public {
+ function setSponsoringMode(address contractAddress, SponsoringModeT mode) public {
require(false, stub_error);
contractAddress;
mode;
@@ -265,8 +265,24 @@
}
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Available contract sponsoring modes
+enum SponsoringModeT {
+ /// Sponsoring is disabled
+ Disabled,
+ /// Only users from allowlist will be sponsored
+ Allowlisted,
+ /// All users will be sponsored
+ Generous
+}
+
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
+
+/// Ethereum representation of Optional value with CrossAddress.
+struct OptionCrossAddress {
+ bool status;
+ CrossAddress value;
+}
pallets/foreign-assets/src/lib.rsdiffbeforeafterboth--- a/pallets/foreign-assets/src/lib.rs
+++ b/pallets/foreign-assets/src/lib.rs
@@ -161,9 +161,7 @@
fn get_currency_id(multi_location: MultiLocation) -> Option<CurrencyId> {
log::trace!(target: "fassets::get_currency_id", "call");
- Some(AssetIds::ForeignAssetId(
- Pallet::<T>::location_to_currency_ids(multi_location).unwrap_or(0),
- ))
+ Pallet::<T>::location_to_currency_ids(multi_location).map(|id| AssetIds::ForeignAssetId(id))
}
}
pallets/fungible/src/erc.rsdiffbeforeafterboth--- a/pallets/fungible/src/erc.rs
+++ b/pallets/fungible/src/erc.rs
@@ -27,7 +27,6 @@
use pallet_common::{
CollectionHandle,
erc::{CommonEvmHandler, PrecompileResult, CollectionCall},
- eth::EthCrossAccount,
};
use sp_std::vec::Vec;
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
@@ -175,7 +174,12 @@
}
#[weight(<SelfWeightOf<T>>::create_item())]
- fn mint_cross(&mut self, caller: caller, to: EthCrossAccount, amount: uint256) -> Result<bool> {
+ fn mint_cross(
+ &mut self,
+ caller: caller,
+ to: pallet_common::eth::CrossAddress,
+ amount: uint256,
+ ) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
let to = to.into_sub_cross_account::<T>()?;
let amount = amount.try_into().map_err(|_| "amount overflow")?;
@@ -191,7 +195,7 @@
fn approve_cross(
&mut self,
caller: caller,
- spender: EthCrossAccount,
+ spender: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -232,7 +236,7 @@
fn burn_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
+ from: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -274,7 +278,7 @@
fn transfer_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
+ to: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -292,8 +296,8 @@
fn transfer_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
- to: EthCrossAccount,
+ from: pallet_common::eth::CrossAddress,
+ to: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
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
@@ -18,7 +18,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -114,7 +114,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) public {
+ function setCollectionSponsorCross(CrossAddress memory sponsor) public {
require(false, stub_error);
sponsor;
dummy = 0;
@@ -152,58 +152,31 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() public view returns (EthCrossAccount memory) {
+ function collectionSponsor() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() public view returns (Tuple23[] memory) {
+ function collectionLimits() public view returns (CollectionLimit[] memory) {
require(false, stub_error);
dummy;
- return new Tuple23[](0);
+ return new CollectionLimit[](0);
}
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) public {
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) public {
require(false, stub_error);
limit;
- status;
- value;
dummy = 0;
}
@@ -220,7 +193,7 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) public {
+ function addCollectionAdminCross(CrossAddress memory newAdmin) public {
require(false, stub_error);
newAdmin;
dummy = 0;
@@ -230,7 +203,7 @@
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) public {
+ function removeCollectionAdminCross(CrossAddress memory admin) public {
require(false, stub_error);
admin;
dummy = 0;
@@ -284,19 +257,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple29 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (CollectionNesting memory) {
require(false, stub_error);
dummy;
- return Tuple29(false, new uint256[](0));
+ return CollectionNesting(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple32[] memory) {
+ function collectionNestingPermissions() public view returns (CollectionNestingPermission[] memory) {
require(false, stub_error);
dummy;
- return new Tuple32[](0);
+ return new CollectionNestingPermission[](0);
}
/// Set the collection access method.
@@ -316,7 +289,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) public view returns (bool) {
+ function allowlistedCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -339,7 +312,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) public {
+ function addToCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -361,7 +334,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) public {
+ function removeFromCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -397,7 +370,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) public view returns (bool) {
+ function isOwnerOrAdminCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -421,10 +394,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() public view returns (EthCrossAccount memory) {
+ function collectionOwner() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
// /// Changes collection owner to another account
@@ -445,10 +418,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() public view returns (EthCrossAccount[] memory) {
+ function collectionAdmins() public view returns (CrossAddress[] memory) {
require(false, stub_error);
dummy;
- return new EthCrossAccount[](0);
+ return new CrossAddress[](0);
}
/// Changes collection owner to another account
@@ -457,66 +430,74 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) public {
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) public {
require(false, stub_error);
newOwner;
dummy = 0;
}
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple32 {
- CollectionPermissions field_0;
- bool field_1;
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple29 {
- bool field_0;
- uint256[] field_1;
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
+}
+
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple23 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
-}
-
-/// @dev Property struct
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
@@ -535,7 +516,7 @@
/// @dev EVM selector for this function is: 0x269e6158,
/// or in textual repr: mintCross((address,uint256),uint256)
- function mintCross(EthCrossAccount memory to, uint256 amount) public returns (bool) {
+ function mintCross(CrossAddress memory to, uint256 amount) public returns (bool) {
require(false, stub_error);
to;
amount;
@@ -545,7 +526,7 @@
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory spender, uint256 amount) public returns (bool) {
+ function approveCross(CrossAddress memory spender, uint256 amount) public returns (bool) {
require(false, stub_error);
spender;
amount;
@@ -575,7 +556,7 @@
/// @param amount The amount that will be burnt.
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 amount) public returns (bool) {
+ function burnFromCross(CrossAddress memory from, uint256 amount) public returns (bool) {
require(false, stub_error);
from;
amount;
@@ -596,7 +577,7 @@
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 amount) public returns (bool) {
+ function transferCross(CrossAddress memory to, uint256 amount) public returns (bool) {
require(false, stub_error);
to;
amount;
@@ -607,8 +588,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 amount
) public returns (bool) {
require(false, stub_error);
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -26,7 +26,7 @@
};
use evm_coder::{
abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,
- types::Property as PropertyStruct, weight,
+ weight,
};
use frame_support::BoundedVec;
use up_data_structs::{
@@ -38,7 +38,7 @@
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},
- eth::{EthCrossAccount, EthTokenPermissions},
+ eth,
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::call;
@@ -94,63 +94,21 @@
fn set_token_property_permissions(
&mut self,
caller: caller,
- permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
+ permissions: Vec<eth::TokenPropertyPermission>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
- const PERMISSIONS_FIELDS_COUNT: usize = 3;
-
- let mut perms = Vec::new();
-
- for (key, pp) in permissions {
- if pp.len() > PERMISSIONS_FIELDS_COUNT {
- return Err(alloc::format!(
- "Actual number of fields {} for {}, which exceeds the maximum value of {}",
- pp.len(),
- stringify!(EthTokenPermissions),
- PERMISSIONS_FIELDS_COUNT
- )
- .as_str()
- .into());
- }
-
- let mut token_permission = PropertyPermission::default();
-
- for (perm, value) in pp {
- match perm {
- EthTokenPermissions::Mutable => token_permission.mutable = value,
- EthTokenPermissions::TokenOwner => token_permission.token_owner = value,
- EthTokenPermissions::CollectionAdmin => {
- token_permission.collection_admin = value
- }
- }
- }
-
- perms.push(PropertyKeyPermission {
- key: key.into_bytes().try_into().map_err(|_| "too long key")?,
- permission: token_permission,
- });
- }
+ let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;
<Pallet<T>>::set_token_property_permissions(self, &caller, perms)
.map_err(dispatch_to_evm::<T>)
}
/// @notice Get permissions for token properties.
- fn token_property_permissions(
- &self,
- ) -> Result<Vec<(string, Vec<(EthTokenPermissions, bool)>)>> {
+ fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {
let perms = <Pallet<T>>::token_property_permission(self.id);
Ok(perms
.into_iter()
- .map(|(key, pp)| {
- let key = string::from_utf8(key.into_inner()).expect("Stored key must be valid");
- let pp = vec![
- (EthTokenPermissions::Mutable, pp.mutable),
- (EthTokenPermissions::TokenOwner, pp.token_owner),
- (EthTokenPermissions::CollectionAdmin, pp.collection_admin),
- ];
- (key, pp)
- })
+ .map(eth::TokenPropertyPermission::from)
.collect())
}
@@ -198,7 +156,7 @@
&mut self,
caller: caller,
token_id: uint256,
- properties: Vec<PropertyStruct>,
+ properties: Vec<eth::Property>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
@@ -209,15 +167,7 @@
let properties = properties
.into_iter()
- .map(|PropertyStruct { key, value }| {
- let key = <Vec<u8>>::from(key)
- .try_into()
- .map_err(|_| "key too large")?;
-
- let value = value.0.try_into().map_err(|_| "value too large")?;
-
- Ok(Property { key, value })
- })
+ .map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?;
<Pallet<T>>::set_token_properties(
@@ -800,9 +750,9 @@
/// Returns the owner (in cross format) of the token.
///
/// @param tokenId Id for the token.
- fn cross_owner_of(&self, token_id: uint256) -> Result<EthCrossAccount> {
+ fn cross_owner_of(&self, token_id: uint256) -> Result<eth::CrossAddress> {
Self::token_owner(&self, token_id.try_into()?)
- .map(|o| EthCrossAccount::from_sub_cross_account::<T>(&o))
+ .map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))
.ok_or(Error::Revert("key too large".into()))
}
@@ -811,7 +761,7 @@
/// @param tokenId Id for the token.
/// @param keys Properties keys. Empty keys for all propertyes.
/// @return Vector of properties key/value pairs.
- fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {
+ fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<eth::Property>> {
let keys = keys
.into_iter()
.map(|key| {
@@ -827,12 +777,7 @@
if keys.is_empty() { None } else { Some(keys) },
)
.into_iter()
- .map(|p| {
- let key = string::from_utf8(p.key.to_vec())
- .map_err(|e| Error::Revert(alloc::format!("{}", e)))?;
- let value = bytes(p.value.to_vec());
- Ok(PropertyStruct { key, value })
- })
+ .map(eth::Property::try_from)
.collect::<Result<Vec<_>>>()
}
@@ -846,7 +791,7 @@
fn approve_cross(
&mut self,
caller: caller,
- approved: EthCrossAccount,
+ approved: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -885,7 +830,7 @@
fn transfer_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
+ to: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -909,8 +854,8 @@
fn transfer_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
- to: EthCrossAccount,
+ from: eth::CrossAddress,
+ to: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -956,7 +901,7 @@
fn burn_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
+ from: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -1078,8 +1023,8 @@
fn mint_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
- properties: Vec<PropertyStruct>,
+ to: eth::CrossAddress,
+ properties: Vec<eth::Property>,
) -> Result<uint256> {
let token_id = <TokensMinted<T>>::get(self.id)
.checked_add(1)
@@ -1089,15 +1034,7 @@
let properties = properties
.into_iter()
- .map(|PropertyStruct { key, value }| {
- let key = <Vec<u8>>::from(key)
- .try_into()
- .map_err(|_| "key too large")?;
-
- let value = value.0.try_into().map_err(|_| "value too large")?;
-
- Ok(Property { key, value })
- })
+ .map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?
.try_into()
.map_err(|_| Error::Revert(alloc::format!("too many properties")))?;
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
@@ -42,7 +42,7 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple61[] memory permissions) public {
+ function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) public {
require(false, stub_error);
permissions;
dummy = 0;
@@ -51,10 +51,10 @@
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() public view returns (Tuple61[] memory) {
+ function tokenPropertyPermissions() public view returns (TokenPropertyPermission[] memory) {
require(false, stub_error);
dummy;
- return new Tuple61[](0);
+ return new TokenPropertyPermission[](0);
}
// /// @notice Set token property value.
@@ -127,36 +127,40 @@
}
}
-/// @dev Property struct
+/// 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 TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
-enum EthTokenPermissions {
- /// @dev 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`]
- TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
- CollectionAdmin
+/// Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// Token property key.
+ string key;
+ /// Token property permissions.
+ PropertyPermission[] permissions;
}
-/// @dev anonymous struct
-struct Tuple61 {
- string field_0;
- Tuple59[] field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// TokenPermission field.
+ TokenPermissionField code;
+ /// TokenPermission value.
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple59 {
- EthTokenPermissions field_0;
- bool field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+enum TokenPermissionField {
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ Mutable,
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ TokenOwner,
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ CollectionAdmin
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -252,7 +256,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) public {
+ function setCollectionSponsorCross(CrossAddress memory sponsor) public {
require(false, stub_error);
sponsor;
dummy = 0;
@@ -290,58 +294,31 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() public view returns (EthCrossAccount memory) {
+ function collectionSponsor() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() public view returns (Tuple35[] memory) {
+ function collectionLimits() public view returns (CollectionLimit[] memory) {
require(false, stub_error);
dummy;
- return new Tuple35[](0);
+ return new CollectionLimit[](0);
}
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) public {
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) public {
require(false, stub_error);
limit;
- status;
- value;
dummy = 0;
}
@@ -358,7 +335,7 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) public {
+ function addCollectionAdminCross(CrossAddress memory newAdmin) public {
require(false, stub_error);
newAdmin;
dummy = 0;
@@ -368,7 +345,7 @@
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) public {
+ function removeCollectionAdminCross(CrossAddress memory admin) public {
require(false, stub_error);
admin;
dummy = 0;
@@ -422,19 +399,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple41 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (CollectionNesting memory) {
require(false, stub_error);
dummy;
- return Tuple41(false, new uint256[](0));
+ return CollectionNesting(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple44[] memory) {
+ function collectionNestingPermissions() public view returns (CollectionNestingPermission[] memory) {
require(false, stub_error);
dummy;
- return new Tuple44[](0);
+ return new CollectionNestingPermission[](0);
}
/// Set the collection access method.
@@ -454,7 +431,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) public view returns (bool) {
+ function allowlistedCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -477,7 +454,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) public {
+ function addToCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -499,7 +476,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) public {
+ function removeFromCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -535,7 +512,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) public view returns (bool) {
+ function isOwnerOrAdminCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -559,10 +536,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() public view returns (EthCrossAccount memory) {
+ function collectionOwner() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
// /// Changes collection owner to another account
@@ -583,10 +560,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() public view returns (EthCrossAccount[] memory) {
+ function collectionAdmins() public view returns (CrossAddress[] memory) {
require(false, stub_error);
dummy;
- return new EthCrossAccount[](0);
+ return new CrossAddress[](0);
}
/// Changes collection owner to another account
@@ -595,65 +572,73 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) public {
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) public {
require(false, stub_error);
newOwner;
dummy = 0;
}
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
+}
+
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
+}
+
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
}
-/// @dev anonymous struct
-struct Tuple44 {
- CollectionPermissions field_0;
- bool field_1;
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
}
-/// @dev anonymous struct
-struct Tuple41 {
- bool field_0;
- uint256[] field_1;
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple35 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
-}
-
/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension
/// @dev See https://eips.ethereum.org/EIPS/eip-721
/// @dev the ERC-165 identifier for this interface is 0x5b5e139f
@@ -832,11 +817,11 @@
/// @param tokenId Id for the token.
/// @dev EVM selector for this function is: 0x2b29dace,
/// or in textual repr: crossOwnerOf(uint256)
- function crossOwnerOf(uint256 tokenId) public view returns (EthCrossAccount memory) {
+ function crossOwnerOf(uint256 tokenId) public view returns (CrossAddress memory) {
require(false, stub_error);
tokenId;
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
/// Returns the token properties.
@@ -862,7 +847,7 @@
/// @param tokenId The NFT to approve
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory approved, uint256 tokenId) public {
+ function approveCross(CrossAddress memory approved, uint256 tokenId) public {
require(false, stub_error);
approved;
tokenId;
@@ -890,7 +875,7 @@
/// @param tokenId The NFT to transfer
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 tokenId) public {
+ function transferCross(CrossAddress memory to, uint256 tokenId) public {
require(false, stub_error);
to;
tokenId;
@@ -906,8 +891,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 tokenId
) public {
require(false, stub_error);
@@ -940,7 +925,7 @@
/// @param tokenId The NFT to transfer
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 tokenId) public {
+ function burnFromCross(CrossAddress memory from, uint256 tokenId) public {
require(false, stub_error);
from;
tokenId;
@@ -992,7 +977,7 @@
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0xb904db03,
/// or in textual repr: mintCross((address,uint256),(string,bytes)[])
- function mintCross(EthCrossAccount memory to, Property[] memory properties) public returns (uint256) {
+ function mintCross(CrossAddress memory to, Property[] memory properties) public returns (uint256) {
require(false, stub_error);
to;
properties;
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -27,14 +27,14 @@
};
use evm_coder::{
abi::AbiType, ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*,
- types::Property as PropertyStruct, weight,
+ weight,
};
use frame_support::{BoundedBTreeMap, BoundedVec};
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
- erc::{CommonEvmHandler, CollectionCall, static_property::key},
- eth::{EthCrossAccount, EthTokenPermissions},
Error as CommonError,
+ erc::{CommonEvmHandler, CollectionCall, static_property::key},
+ eth,
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::{call, dispatch_to_evm};
@@ -97,67 +97,21 @@
fn set_token_property_permissions(
&mut self,
caller: caller,
- permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
+ permissions: Vec<eth::TokenPropertyPermission>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
- const PERMISSIONS_FIELDS_COUNT: usize = 3;
-
- let mut perms = Vec::new();
-
- for (key, pp) in permissions {
- if pp.len() > PERMISSIONS_FIELDS_COUNT {
- return Err(alloc::format!(
- "Actual number of fields {} for {}, which exceeds the maximum value of {}",
- pp.len(),
- stringify!(EthTokenPermissions),
- PERMISSIONS_FIELDS_COUNT
- )
- .as_str()
- .into());
- }
-
- let mut token_permission = PropertyPermission {
- mutable: false,
- collection_admin: false,
- token_owner: false,
- };
-
- for (perm, value) in pp {
- match perm {
- EthTokenPermissions::Mutable => token_permission.mutable = value,
- EthTokenPermissions::TokenOwner => token_permission.token_owner = value,
- EthTokenPermissions::CollectionAdmin => {
- token_permission.collection_admin = value
- }
- }
- }
+ let perms = eth::TokenPropertyPermission::into_property_key_permissions(permissions)?;
- perms.push(PropertyKeyPermission {
- key: key.into_bytes().try_into().map_err(|_| "too long key")?,
- permission: token_permission,
- });
- }
-
<Pallet<T>>::set_token_property_permissions(self, &caller, perms)
.map_err(dispatch_to_evm::<T>)
}
/// @notice Get permissions for token properties.
- fn token_property_permissions(
- &self,
- ) -> Result<Vec<(string, Vec<(EthTokenPermissions, bool)>)>> {
+ fn token_property_permissions(&self) -> Result<Vec<eth::TokenPropertyPermission>> {
let perms = <Pallet<T>>::token_property_permission(self.id);
Ok(perms
.into_iter()
- .map(|(key, pp)| {
- let key = string::from_utf8(key.into_inner()).expect("Stored key must be valid");
- let pp = vec![
- (EthTokenPermissions::Mutable, pp.mutable),
- (EthTokenPermissions::TokenOwner, pp.token_owner),
- (EthTokenPermissions::CollectionAdmin, pp.collection_admin),
- ];
- (key, pp)
- })
+ .map(eth::TokenPropertyPermission::from)
.collect())
}
@@ -205,7 +159,7 @@
&mut self,
caller: caller,
token_id: uint256,
- properties: Vec<PropertyStruct>,
+ properties: Vec<eth::Property>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
@@ -216,15 +170,7 @@
let properties = properties
.into_iter()
- .map(|PropertyStruct { key, value }| {
- let key = <Vec<u8>>::from(key)
- .try_into()
- .map_err(|_| "key too large")?;
-
- let value = value.0.try_into().map_err(|_| "value too large")?;
-
- Ok(Property { key, value })
- })
+ .map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?;
<Pallet<T>>::set_token_properties(
@@ -839,9 +785,9 @@
/// Returns the owner (in cross format) of the token.
///
/// @param tokenId Id for the token.
- fn cross_owner_of(&self, token_id: uint256) -> Result<EthCrossAccount> {
+ fn cross_owner_of(&self, token_id: uint256) -> Result<eth::CrossAddress> {
Self::token_owner(&self, token_id.try_into()?)
- .map(|o| EthCrossAccount::from_sub_cross_account::<T>(&o))
+ .map(|o| eth::CrossAddress::from_sub_cross_account::<T>(&o))
.ok_or(Error::Revert("key too large".into()))
}
@@ -850,7 +796,7 @@
/// @param tokenId Id for the token.
/// @param keys Properties keys. Empty keys for all propertyes.
/// @return Vector of properties key/value pairs.
- fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<PropertyStruct>> {
+ fn properties(&self, token_id: uint256, keys: Vec<string>) -> Result<Vec<eth::Property>> {
let keys = keys
.into_iter()
.map(|key| {
@@ -866,12 +812,7 @@
if keys.is_empty() { None } else { Some(keys) },
)
.into_iter()
- .map(|p| {
- let key = string::from_utf8(p.key.to_vec())
- .map_err(|e| Error::Revert(alloc::format!("{}", e)))?;
- let value = bytes(p.value.to_vec());
- Ok(PropertyStruct { key, value })
- })
+ .map(eth::Property::try_from)
.collect::<Result<Vec<_>>>()
}
/// @notice Transfer ownership of an RFT
@@ -907,7 +848,7 @@
fn transfer_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
+ to: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -935,8 +876,8 @@
fn transfer_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
- to: EthCrossAccount,
+ from: eth::CrossAddress,
+ to: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -991,7 +932,7 @@
fn burn_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
+ from: eth::CrossAddress,
token_id: uint256,
) -> Result<void> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -1128,8 +1069,8 @@
fn mint_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
- properties: Vec<PropertyStruct>,
+ to: eth::CrossAddress,
+ properties: Vec<eth::Property>,
) -> Result<uint256> {
let token_id = <TokensMinted<T>>::get(self.id)
.checked_add(1)
@@ -1139,15 +1080,7 @@
let properties = properties
.into_iter()
- .map(|PropertyStruct { key, value }| {
- let key = <Vec<u8>>::from(key)
- .try_into()
- .map_err(|_| "key too large")?;
-
- let value = value.0.try_into().map_err(|_| "value too large")?;
-
- Ok(Property { key, value })
- })
+ .map(eth::Property::try_into)
.collect::<Result<Vec<_>>>()?
.try_into()
.map_err(|_| Error::Revert(alloc::format!("too many properties")))?;
pallets/refungible/src/erc_token.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc_token.rs
+++ b/pallets/refungible/src/erc_token.rs
@@ -30,7 +30,7 @@
use pallet_common::{
CommonWeightInfo,
erc::{CommonEvmHandler, PrecompileResult},
- eth::{collection_id_to_address, EthCrossAccount},
+ eth::collection_id_to_address,
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::{call, dispatch_to_evm, WithRecorder};
@@ -224,7 +224,7 @@
fn burn_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
+ from: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -250,7 +250,7 @@
fn approve_cross(
&mut self,
caller: caller,
- spender: EthCrossAccount,
+ spender: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -280,7 +280,7 @@
fn transfer_cross(
&mut self,
caller: caller,
- to: EthCrossAccount,
+ to: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
@@ -303,8 +303,8 @@
fn transfer_from_cross(
&mut self,
caller: caller,
- from: EthCrossAccount,
- to: EthCrossAccount,
+ from: pallet_common::eth::CrossAddress,
+ to: pallet_common::eth::CrossAddress,
amount: uint256,
) -> Result<bool> {
let caller = T::CrossAccountId::from_eth(caller);
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -92,12 +92,8 @@
use codec::{Encode, Decode, MaxEncodedLen};
use core::ops::Deref;
-use derivative::Derivative;
use evm_coder::ToLog;
-use frame_support::{
- BoundedBTreeMap, BoundedVec, ensure, fail, storage::with_transaction, transactional,
- pallet_prelude::ConstU32,
-};
+use frame_support::{BoundedVec, ensure, fail, storage::with_transaction, transactional};
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
@@ -110,11 +106,10 @@
use sp_runtime::{ArithmeticError, DispatchError, DispatchResult, TransactionOutcome};
use sp_std::{vec::Vec, vec, collections::btree_map::BTreeMap};
use up_data_structs::{
- AccessMode, budget::Budget, CollectionId, CollectionFlags, CollectionPropertiesVec,
- CreateCollectionData, CustomDataLimit, mapping::TokenAddressMapping, MAX_ITEMS_PER_BATCH,
- MAX_REFUNGIBLE_PIECES, Property, PropertyKey, PropertyKeyPermission, PropertyPermission,
- PropertyScope, PropertyValue, TokenId, TrySetProperty, PropertiesPermissionMap,
- CreateRefungibleExMultipleOwners,
+ AccessMode, budget::Budget, CollectionId, CollectionFlags, CreateCollectionData,
+ CustomDataLimit, mapping::TokenAddressMapping, MAX_REFUNGIBLE_PIECES, Property, PropertyKey,
+ PropertyKeyPermission, PropertyPermission, PropertyScope, PropertyValue, TokenId,
+ TrySetProperty, PropertiesPermissionMap, CreateRefungibleExMultipleOwners,
};
pub use pallet::*;
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
@@ -42,7 +42,7 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple60[] memory permissions) public {
+ function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) public {
require(false, stub_error);
permissions;
dummy = 0;
@@ -51,10 +51,10 @@
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() public view returns (Tuple60[] memory) {
+ function tokenPropertyPermissions() public view returns (TokenPropertyPermission[] memory) {
require(false, stub_error);
dummy;
- return new Tuple60[](0);
+ return new TokenPropertyPermission[](0);
}
// /// @notice Set token property value.
@@ -127,36 +127,40 @@
}
}
-/// @dev Property struct
+/// 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 TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
-enum EthTokenPermissions {
- /// @dev 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`]
- TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
- CollectionAdmin
+/// Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// Token property key.
+ string key;
+ /// Token property permissions.
+ PropertyPermission[] permissions;
}
-/// @dev anonymous struct
-struct Tuple60 {
- string field_0;
- Tuple58[] field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// TokenPermission field.
+ TokenPermissionField code;
+ /// TokenPermission value.
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple58 {
- EthTokenPermissions field_0;
- bool field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+enum TokenPermissionField {
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ Mutable,
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ TokenOwner,
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ CollectionAdmin
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
contract Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -252,7 +256,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) public {
+ function setCollectionSponsorCross(CrossAddress memory sponsor) public {
require(false, stub_error);
sponsor;
dummy = 0;
@@ -290,58 +294,31 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() public view returns (EthCrossAccount memory) {
+ function collectionSponsor() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() public view returns (Tuple34[] memory) {
+ function collectionLimits() public view returns (CollectionLimit[] memory) {
require(false, stub_error);
dummy;
- return new Tuple34[](0);
+ return new CollectionLimit[](0);
}
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) public {
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) public {
require(false, stub_error);
limit;
- status;
- value;
dummy = 0;
}
@@ -358,7 +335,7 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) public {
+ function addCollectionAdminCross(CrossAddress memory newAdmin) public {
require(false, stub_error);
newAdmin;
dummy = 0;
@@ -368,7 +345,7 @@
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) public {
+ function removeCollectionAdminCross(CrossAddress memory admin) public {
require(false, stub_error);
admin;
dummy = 0;
@@ -422,19 +399,19 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() public view returns (Tuple40 memory) {
+ function collectionNestingRestrictedCollectionIds() public view returns (CollectionNesting memory) {
require(false, stub_error);
dummy;
- return Tuple40(false, new uint256[](0));
+ return CollectionNesting(false, new uint256[](0));
}
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() public view returns (Tuple43[] memory) {
+ function collectionNestingPermissions() public view returns (CollectionNestingPermission[] memory) {
require(false, stub_error);
dummy;
- return new Tuple43[](0);
+ return new CollectionNestingPermission[](0);
}
/// Set the collection access method.
@@ -454,7 +431,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) public view returns (bool) {
+ function allowlistedCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -477,7 +454,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) public {
+ function addToCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -499,7 +476,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) public {
+ function removeFromCollectionAllowListCross(CrossAddress memory user) public {
require(false, stub_error);
user;
dummy = 0;
@@ -535,7 +512,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) public view returns (bool) {
+ function isOwnerOrAdminCross(CrossAddress memory user) public view returns (bool) {
require(false, stub_error);
user;
dummy;
@@ -559,10 +536,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() public view returns (EthCrossAccount memory) {
+ function collectionOwner() public view returns (CrossAddress memory) {
require(false, stub_error);
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
// /// Changes collection owner to another account
@@ -583,10 +560,10 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() public view returns (EthCrossAccount[] memory) {
+ function collectionAdmins() public view returns (CrossAddress[] memory) {
require(false, stub_error);
dummy;
- return new EthCrossAccount[](0);
+ return new CrossAddress[](0);
}
/// Changes collection owner to another account
@@ -595,65 +572,73 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) public {
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) public {
require(false, stub_error);
newOwner;
dummy = 0;
}
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple43 {
- CollectionPermissions field_0;
- bool field_1;
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple40 {
- bool field_0;
- uint256[] field_1;
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
+}
+
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple34 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
-}
-
/// @dev the ERC-165 identifier for this interface is 0x5b5e139f
contract ERC721Metadata is Dummy, ERC165 {
// /// @notice A descriptive name for a collection of NFTs in this contract
@@ -830,11 +815,11 @@
/// @param tokenId Id for the token.
/// @dev EVM selector for this function is: 0x2b29dace,
/// or in textual repr: crossOwnerOf(uint256)
- function crossOwnerOf(uint256 tokenId) public view returns (EthCrossAccount memory) {
+ function crossOwnerOf(uint256 tokenId) public view returns (CrossAddress memory) {
require(false, stub_error);
tokenId;
dummy;
- return EthCrossAccount(0x0000000000000000000000000000000000000000, 0);
+ return CrossAddress(0x0000000000000000000000000000000000000000, 0);
}
/// Returns the token properties.
@@ -875,7 +860,7 @@
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 tokenId) public {
+ function transferCross(CrossAddress memory to, uint256 tokenId) public {
require(false, stub_error);
to;
tokenId;
@@ -891,8 +876,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 tokenId
) public {
require(false, stub_error);
@@ -927,7 +912,7 @@
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 tokenId) public {
+ function burnFromCross(CrossAddress memory from, uint256 tokenId) public {
require(false, stub_error);
from;
tokenId;
@@ -979,7 +964,7 @@
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0xb904db03,
/// or in textual repr: mintCross((address,uint256),(string,bytes)[])
- function mintCross(EthCrossAccount memory to, Property[] memory properties) public returns (uint256) {
+ function mintCross(CrossAddress memory to, Property[] memory properties) public returns (uint256) {
require(false, stub_error);
to;
properties;
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
@@ -58,7 +58,7 @@
/// @param amount The amount that will be burnt.
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 amount) public returns (bool) {
+ function burnFromCross(CrossAddress memory from, uint256 amount) public returns (bool) {
require(false, stub_error);
from;
amount;
@@ -75,7 +75,7 @@
/// @param amount The amount of tokens to be spent.
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory spender, uint256 amount) public returns (bool) {
+ function approveCross(CrossAddress memory spender, uint256 amount) public returns (bool) {
require(false, stub_error);
spender;
amount;
@@ -100,7 +100,7 @@
/// @param amount The amount to be transferred.
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 amount) public returns (bool) {
+ function transferCross(CrossAddress memory to, uint256 amount) public returns (bool) {
require(false, stub_error);
to;
amount;
@@ -115,8 +115,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 amount
) public returns (bool) {
require(false, stub_error);
@@ -128,8 +128,8 @@
}
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
pallets/unique/src/eth/stubs/CollectionHelpers.rawdiffbeforeafterbothbinary blob — no preview
pallets/unique/src/lib.rsdiffbeforeafterboth--- a/pallets/unique/src/lib.rs
+++ b/pallets/unique/src/lib.rs
@@ -74,7 +74,7 @@
extern crate alloc;
use frame_support::{
- decl_module, decl_storage, decl_error, decl_event,
+ decl_module, decl_storage, decl_error,
dispatch::DispatchResult,
ensure, fail,
weights::{Weight},
runtime/common/config/xcm/foreignassets.rsdiffbeforeafterboth--- a/runtime/common/config/xcm/foreignassets.rs
+++ b/runtime/common/config/xcm/foreignassets.rs
@@ -18,7 +18,7 @@
traits::{Contains, Get, fungibles},
parameter_types,
};
-use sp_runtime::traits::{Zero, Convert};
+use sp_runtime::traits::Convert;
use xcm::v1::{Junction::*, MultiLocation, Junctions::*};
use xcm::latest::MultiAsset;
use xcm_builder::{FungiblesAdapter, ConvertedConcreteAssetId};
@@ -38,16 +38,16 @@
pub CheckingAccount: AccountId = PolkadotXcm::check_account();
}
-/// Allow checking in assets that have issuance > 0.
-pub struct NonZeroIssuance<AccountId, ForeignAssets>(PhantomData<(AccountId, ForeignAssets)>);
+/// No teleports are allowed
+pub struct NoTeleports<AccountId, ForeignAssets>(PhantomData<(AccountId, ForeignAssets)>);
impl<AccountId, ForeignAssets> Contains<<ForeignAssets as fungibles::Inspect<AccountId>>::AssetId>
- for NonZeroIssuance<AccountId, ForeignAssets>
+ for NoTeleports<AccountId, ForeignAssets>
where
ForeignAssets: fungibles::Inspect<AccountId>,
{
- fn contains(id: &<ForeignAssets as fungibles::Inspect<AccountId>>::AssetId) -> bool {
- !ForeignAssets::total_issuance(*id).is_zero()
+ fn contains(_id: &<ForeignAssets as fungibles::Inspect<AccountId>>::AssetId) -> bool {
+ false
}
}
@@ -84,7 +84,7 @@
Some(AssetIds::ForeignAssetId(foreign_asset_id)) => {
ConvertAssetId::convert_ref(AssetIds::ForeignAssetId(foreign_asset_id))
}
- _ => ConvertAssetId::convert_ref(AssetIds::ForeignAssetId(0)),
+ _ => Err(()),
}
}
@@ -132,9 +132,8 @@
LocationToAccountId,
// Our chain's account ID type (we can't get away without mentioning it explicitly):
AccountId,
- // We only want to allow teleports of known assets. We use non-zero issuance as an indication
- // that this asset is known.
- NonZeroIssuance<AccountId, ForeignAssets>,
+ // No teleports are allowed
+ NoTeleports<AccountId, ForeignAssets>,
// The account to use for tracking teleports.
CheckingAccount,
>;
runtime/common/config/xcm/mod.rsdiffbeforeafterboth--- a/runtime/common/config/xcm/mod.rs
+++ b/runtime/common/config/xcm/mod.rs
@@ -186,6 +186,9 @@
TransferReserveAsset { dest: dst, .. } => {
allowed |= allowed_locations.contains(dst);
}
+ InitiateReserveWithdraw { reserve: dst, .. } => {
+ allowed |= allowed_locations.contains(dst);
+ }
_ => {}
});
tests/src/config.tsdiffbeforeafterboth--- a/tests/src/config.ts
+++ b/tests/src/config.ts
@@ -25,6 +25,8 @@
moonbeamUrl: process.env.moonbeamUrl || 'ws://127.0.0.1:9947',
moonriverUrl: process.env.moonbeamUrl || 'ws://127.0.0.1:9947',
westmintUrl: process.env.westmintUrl || 'ws://127.0.0.1:9948',
+ statemineUrl: process.env.statemineUrl || 'ws://127.0.0.1:9948',
+ statemintUrl: process.env.statemintUrl || 'ws://127.0.0.1:9948',
};
export default config;
tests/src/eth/abi/contractHelpers.jsondiffbeforeafterboth--- a/tests/src/eth/abi/contractHelpers.json
+++ b/tests/src/eth/abi/contractHelpers.json
@@ -190,7 +190,11 @@
"name": "contractAddress",
"type": "address"
},
- { "internalType": "uint8", "name": "mode", "type": "uint8" }
+ {
+ "internalType": "enum SponsoringModeT",
+ "name": "mode",
+ "type": "uint8"
+ }
],
"name": "setSponsoringMode",
"outputs": [],
@@ -223,10 +227,18 @@
"outputs": [
{
"components": [
- { "internalType": "address", "name": "eth", "type": "address" },
- { "internalType": "uint256", "name": "sub", "type": "uint256" }
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ {
+ "components": [
+ { "internalType": "address", "name": "eth", "type": "address" },
+ { "internalType": "uint256", "name": "sub", "type": "uint256" }
+ ],
+ "internalType": "struct CrossAddress",
+ "name": "value",
+ "type": "tuple"
+ }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct OptionCrossAddress",
"name": "",
"type": "tuple"
}
tests/src/eth/abi/fungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/fungible.json
+++ b/tests/src/eth/abi/fungible.json
@@ -56,7 +56,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newAdmin",
"type": "tuple"
}
@@ -73,7 +73,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -100,7 +100,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -127,7 +127,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "spender",
"type": "tuple"
},
@@ -154,7 +154,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -172,7 +172,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newOwner",
"type": "tuple"
}
@@ -191,7 +191,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount[]",
+ "internalType": "struct CrossAddress[]",
"name": "",
"type": "tuple[]"
}
@@ -213,14 +213,21 @@
{
"components": [
{
- "internalType": "enum CollectionLimits",
- "name": "field_0",
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" },
- { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
],
- "internalType": "struct Tuple23[]",
+ "internalType": "struct CollectionLimit[]",
"name": "",
"type": "tuple[]"
}
@@ -235,13 +242,13 @@
{
"components": [
{
- "internalType": "enum CollectionPermissions",
- "name": "field_0",
+ "internalType": "enum CollectionPermissionField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple32[]",
+ "internalType": "struct CollectionNestingPermission[]",
"name": "",
"type": "tuple[]"
}
@@ -255,14 +262,10 @@
"outputs": [
{
"components": [
- { "internalType": "bool", "name": "field_0", "type": "bool" },
- {
- "internalType": "uint256[]",
- "name": "field_1",
- "type": "uint256[]"
- }
+ { "internalType": "bool", "name": "token_owner", "type": "bool" },
+ { "internalType": "uint256[]", "name": "ids", "type": "uint256[]" }
],
- "internalType": "struct Tuple29",
+ "internalType": "struct CollectionNesting",
"name": "",
"type": "tuple"
}
@@ -279,7 +282,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -322,7 +325,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -381,7 +384,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -425,7 +428,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -450,7 +453,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "admin",
"type": "tuple"
}
@@ -474,7 +477,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -494,12 +497,26 @@
{
"inputs": [
{
- "internalType": "enum CollectionLimits",
+ "components": [
+ {
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
+ "type": "uint8"
+ },
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
+ ],
+ "internalType": "struct CollectionLimit",
"name": "limit",
- "type": "uint8"
- },
- { "internalType": "bool", "name": "status", "type": "bool" },
- { "internalType": "uint256", "name": "value", "type": "uint256" }
+ "type": "tuple"
+ }
],
"name": "setCollectionLimit",
"outputs": [],
@@ -558,7 +575,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "sponsor",
"type": "tuple"
}
@@ -608,7 +625,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -637,7 +654,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -646,7 +663,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -87,7 +87,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newAdmin",
"type": "tuple"
}
@@ -104,7 +104,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -121,7 +121,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -148,7 +148,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "approved",
"type": "tuple"
},
@@ -184,7 +184,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -202,7 +202,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newOwner",
"type": "tuple"
}
@@ -221,7 +221,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount[]",
+ "internalType": "struct CrossAddress[]",
"name": "",
"type": "tuple[]"
}
@@ -243,14 +243,21 @@
{
"components": [
{
- "internalType": "enum CollectionLimits",
- "name": "field_0",
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" },
- { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
],
- "internalType": "struct Tuple35[]",
+ "internalType": "struct CollectionLimit[]",
"name": "",
"type": "tuple[]"
}
@@ -265,13 +272,13 @@
{
"components": [
{
- "internalType": "enum CollectionPermissions",
- "name": "field_0",
+ "internalType": "enum CollectionPermissionField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple44[]",
+ "internalType": "struct CollectionNestingPermission[]",
"name": "",
"type": "tuple[]"
}
@@ -285,14 +292,10 @@
"outputs": [
{
"components": [
- { "internalType": "bool", "name": "field_0", "type": "bool" },
- {
- "internalType": "uint256[]",
- "name": "field_1",
- "type": "uint256[]"
- }
+ { "internalType": "bool", "name": "token_owner", "type": "bool" },
+ { "internalType": "uint256[]", "name": "ids", "type": "uint256[]" }
],
- "internalType": "struct Tuple41",
+ "internalType": "struct CollectionNesting",
"name": "",
"type": "tuple"
}
@@ -309,7 +312,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -352,7 +355,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -385,7 +388,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -459,7 +462,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -483,7 +486,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -579,7 +582,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "admin",
"type": "tuple"
}
@@ -603,7 +606,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -656,12 +659,26 @@
{
"inputs": [
{
- "internalType": "enum CollectionLimits",
+ "components": [
+ {
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
+ "type": "uint8"
+ },
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
+ ],
+ "internalType": "struct CollectionLimit",
"name": "limit",
- "type": "uint8"
- },
- { "internalType": "bool", "name": "status", "type": "bool" },
- { "internalType": "uint256", "name": "value", "type": "uint256" }
+ "type": "tuple"
+ }
],
"name": "setCollectionLimit",
"outputs": [],
@@ -720,7 +737,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "sponsor",
"type": "tuple"
}
@@ -752,22 +769,22 @@
"inputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
- "internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "internalType": "enum TokenPermissionField",
+ "name": "code",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple59[]",
- "name": "field_1",
+ "internalType": "struct PropertyPermission[]",
+ "name": "permissions",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple61[]",
+ "internalType": "struct TokenPropertyPermission[]",
"name": "permissions",
"type": "tuple[]"
}
@@ -818,22 +835,22 @@
"outputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
- "internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "internalType": "enum TokenPermissionField",
+ "name": "code",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple59[]",
- "name": "field_1",
+ "internalType": "struct PropertyPermission[]",
+ "name": "permissions",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple61[]",
+ "internalType": "struct TokenPropertyPermission[]",
"name": "",
"type": "tuple[]"
}
@@ -874,7 +891,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -903,7 +920,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -912,7 +929,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -87,7 +87,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newAdmin",
"type": "tuple"
}
@@ -104,7 +104,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -121,7 +121,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -166,7 +166,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -184,7 +184,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "newOwner",
"type": "tuple"
}
@@ -203,7 +203,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount[]",
+ "internalType": "struct CrossAddress[]",
"name": "",
"type": "tuple[]"
}
@@ -225,14 +225,21 @@
{
"components": [
{
- "internalType": "enum CollectionLimits",
- "name": "field_0",
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" },
- { "internalType": "uint256", "name": "field_2", "type": "uint256" }
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
],
- "internalType": "struct Tuple34[]",
+ "internalType": "struct CollectionLimit[]",
"name": "",
"type": "tuple[]"
}
@@ -247,13 +254,13 @@
{
"components": [
{
- "internalType": "enum CollectionPermissions",
- "name": "field_0",
+ "internalType": "enum CollectionPermissionField",
+ "name": "field",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple43[]",
+ "internalType": "struct CollectionNestingPermission[]",
"name": "",
"type": "tuple[]"
}
@@ -267,14 +274,10 @@
"outputs": [
{
"components": [
- { "internalType": "bool", "name": "field_0", "type": "bool" },
- {
- "internalType": "uint256[]",
- "name": "field_1",
- "type": "uint256[]"
- }
+ { "internalType": "bool", "name": "token_owner", "type": "bool" },
+ { "internalType": "uint256[]", "name": "ids", "type": "uint256[]" }
],
- "internalType": "struct Tuple40",
+ "internalType": "struct CollectionNesting",
"name": "",
"type": "tuple"
}
@@ -291,7 +294,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -334,7 +337,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -367,7 +370,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "",
"type": "tuple"
}
@@ -441,7 +444,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -465,7 +468,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -561,7 +564,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "admin",
"type": "tuple"
}
@@ -585,7 +588,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "user",
"type": "tuple"
}
@@ -638,12 +641,26 @@
{
"inputs": [
{
- "internalType": "enum CollectionLimits",
+ "components": [
+ {
+ "internalType": "enum CollectionLimitField",
+ "name": "field",
+ "type": "uint8"
+ },
+ {
+ "components": [
+ { "internalType": "bool", "name": "status", "type": "bool" },
+ { "internalType": "uint256", "name": "value", "type": "uint256" }
+ ],
+ "internalType": "struct OptionUint",
+ "name": "value",
+ "type": "tuple"
+ }
+ ],
+ "internalType": "struct CollectionLimit",
"name": "limit",
- "type": "uint8"
- },
- { "internalType": "bool", "name": "status", "type": "bool" },
- { "internalType": "uint256", "name": "value", "type": "uint256" }
+ "type": "tuple"
+ }
],
"name": "setCollectionLimit",
"outputs": [],
@@ -702,7 +719,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "sponsor",
"type": "tuple"
}
@@ -734,22 +751,22 @@
"inputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
- "internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "internalType": "enum TokenPermissionField",
+ "name": "code",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple58[]",
- "name": "field_1",
+ "internalType": "struct PropertyPermission[]",
+ "name": "permissions",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple60[]",
+ "internalType": "struct TokenPropertyPermission[]",
"name": "permissions",
"type": "tuple[]"
}
@@ -809,22 +826,22 @@
"outputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
- "internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "internalType": "enum TokenPermissionField",
+ "name": "code",
"type": "uint8"
},
- { "internalType": "bool", "name": "field_1", "type": "bool" }
+ { "internalType": "bool", "name": "value", "type": "bool" }
],
- "internalType": "struct Tuple58[]",
- "name": "field_1",
+ "internalType": "struct PropertyPermission[]",
+ "name": "permissions",
"type": "tuple[]"
}
],
- "internalType": "struct Tuple60[]",
+ "internalType": "struct TokenPropertyPermission[]",
"name": "",
"type": "tuple[]"
}
@@ -865,7 +882,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -894,7 +911,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -903,7 +920,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
tests/src/eth/abi/reFungibleToken.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungibleToken.json
+++ b/tests/src/eth/abi/reFungibleToken.json
@@ -76,7 +76,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "spender",
"type": "tuple"
},
@@ -113,7 +113,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -201,7 +201,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
@@ -230,7 +230,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "from",
"type": "tuple"
},
@@ -239,7 +239,7 @@
{ "internalType": "address", "name": "eth", "type": "address" },
{ "internalType": "uint256", "name": "sub", "type": "uint256" }
],
- "internalType": "struct EthCrossAccount",
+ "internalType": "struct CrossAddress",
"name": "to",
"type": "tuple"
},
tests/src/eth/api/ContractHelpers.soldiffbeforeafterboth--- a/tests/src/eth/api/ContractHelpers.sol
+++ b/tests/src/eth/api/ContractHelpers.sol
@@ -69,7 +69,7 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x766c4f37,
/// or in textual repr: sponsor(address)
- function sponsor(address contractAddress) external view returns (EthCrossAccount memory);
+ function sponsor(address contractAddress) external view returns (OptionCrossAddress memory);
/// Check tat contract has confirmed sponsor.
///
@@ -93,7 +93,7 @@
/// @dev EVM selector for this function is: 0xfde8a560,
/// or in textual repr: setSponsoringMode(address,uint8)
- function setSponsoringMode(address contractAddress, uint8 mode) external;
+ function setSponsoringMode(address contractAddress, SponsoringModeT mode) external;
/// Get current contract sponsoring rate limit
/// @param contractAddress Contract to get sponsoring rate limit of
@@ -171,8 +171,24 @@
function toggleAllowlist(address contractAddress, bool enabled) external;
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Available contract sponsoring modes
+enum SponsoringModeT {
+ /// Sponsoring is disabled
+ Disabled,
+ /// Only users from allowlist will be sponsored
+ Allowlisted,
+ /// All users will be sponsored
+ Generous
+}
+
+/// Ethereum representation of Optional value with CrossAddress.
+struct OptionCrossAddress {
+ bool status;
+ CrossAddress value;
+}
+
+/// 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
@@ -13,7 +13,7 @@
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -78,7 +78,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) external;
+ function setCollectionSponsorCross(CrossAddress memory sponsor) external;
/// Whether there is a pending sponsor.
/// @dev EVM selector for this function is: 0x058ac185,
@@ -102,46 +102,21 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() external view returns (EthCrossAccount memory);
+ function collectionSponsor() external view returns (CrossAddress memory);
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() external view returns (Tuple21[] memory);
+ function collectionLimits() external view returns (CollectionLimit[] memory);
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) external;
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -152,13 +127,13 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) external;
+ function addCollectionAdminCross(CrossAddress memory newAdmin) external;
/// Remove collection admin.
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) external;
+ function removeCollectionAdminCross(CrossAddress memory admin) external;
// /// Add collection admin.
// /// @param newAdmin Address of the added administrator.
@@ -191,12 +166,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple26 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (CollectionNesting memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple29[] memory);
+ function collectionNestingPermissions() external view returns (CollectionNestingPermission[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -211,7 +186,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) external view returns (bool);
+ function allowlistedCross(CrossAddress memory user) external view returns (bool);
// /// Add the user to the allowed list.
// ///
@@ -225,7 +200,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) external;
+ function addToCollectionAllowListCross(CrossAddress memory user) external;
// /// Remove the user from the allowed list.
// ///
@@ -239,7 +214,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) external;
+ function removeFromCollectionAllowListCross(CrossAddress memory user) external;
/// Switch permission for minting.
///
@@ -262,7 +237,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) external view returns (bool);
+ function isOwnerOrAdminCross(CrossAddress memory user) external view returns (bool);
/// Returns collection type
///
@@ -277,7 +252,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() external view returns (EthCrossAccount memory);
+ function collectionOwner() external view returns (CrossAddress memory);
// /// Changes collection owner to another account
// ///
@@ -293,7 +268,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() external view returns (EthCrossAccount[] memory);
+ function collectionAdmins() external view returns (CrossAddress[] memory);
/// Changes collection owner to another account
///
@@ -301,62 +276,70 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) external;
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev anonymous struct
-struct Tuple29 {
- CollectionPermissions field_0;
- bool field_1;
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple26 {
- bool field_0;
- uint256[] field_1;
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
+}
+
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple21 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
-}
-
-/// @dev Property struct
+/// Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
string key;
bytes value;
@@ -371,11 +354,11 @@
/// @dev EVM selector for this function is: 0x269e6158,
/// or in textual repr: mintCross((address,uint256),uint256)
- function mintCross(EthCrossAccount memory to, uint256 amount) external returns (bool);
+ function mintCross(CrossAddress memory to, uint256 amount) external returns (bool);
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory spender, uint256 amount) external returns (bool);
+ function approveCross(CrossAddress memory spender, uint256 amount) external returns (bool);
// /// Burn tokens from account
// /// @dev Function that burns an `amount` of the tokens of a given account,
@@ -393,7 +376,7 @@
/// @param amount The amount that will be burnt.
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 amount) external returns (bool);
+ function burnFromCross(CrossAddress memory from, uint256 amount) external returns (bool);
/// Mint tokens for multiple accounts.
/// @param amounts array of pairs of account address and amount
@@ -403,13 +386,13 @@
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 amount) external returns (bool);
+ function transferCross(CrossAddress memory to, uint256 amount) external returns (bool);
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 amount
) external returns (bool);
}
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueNFT.sol
+++ b/tests/src/eth/api/UniqueNFT.sol
@@ -30,12 +30,12 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple53[] memory permissions) external;
+ function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) external;
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() external view returns (Tuple53[] memory);
+ function tokenPropertyPermissions() external view returns (TokenPropertyPermission[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
@@ -80,36 +80,40 @@
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
-/// @dev Property struct
+/// 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 TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
-enum EthTokenPermissions {
- /// @dev 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`]
- TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
- CollectionAdmin
+/// Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// Token property key.
+ string key;
+ /// Token property permissions.
+ PropertyPermission[] permissions;
}
-/// @dev anonymous struct
-struct Tuple53 {
- string field_0;
- Tuple51[] field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// TokenPermission field.
+ TokenPermissionField code;
+ /// TokenPermission value.
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple51 {
- EthTokenPermissions field_0;
- bool field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+enum TokenPermissionField {
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ Mutable,
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ TokenOwner,
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ CollectionAdmin
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -174,7 +178,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) external;
+ function setCollectionSponsorCross(CrossAddress memory sponsor) external;
/// Whether there is a pending sponsor.
/// @dev EVM selector for this function is: 0x058ac185,
@@ -198,46 +202,21 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() external view returns (EthCrossAccount memory);
+ function collectionSponsor() external view returns (CrossAddress memory);
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() external view returns (Tuple31[] memory);
+ function collectionLimits() external view returns (CollectionLimit[] memory);
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) external;
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -248,13 +227,13 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) external;
+ function addCollectionAdminCross(CrossAddress memory newAdmin) external;
/// Remove collection admin.
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) external;
+ function removeCollectionAdminCross(CrossAddress memory admin) external;
// /// Add collection admin.
// /// @param newAdmin Address of the added administrator.
@@ -287,12 +266,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple36 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (CollectionNesting memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple39[] memory);
+ function collectionNestingPermissions() external view returns (CollectionNestingPermission[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -307,7 +286,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) external view returns (bool);
+ function allowlistedCross(CrossAddress memory user) external view returns (bool);
// /// Add the user to the allowed list.
// ///
@@ -321,7 +300,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) external;
+ function addToCollectionAllowListCross(CrossAddress memory user) external;
// /// Remove the user from the allowed list.
// ///
@@ -335,7 +314,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) external;
+ function removeFromCollectionAllowListCross(CrossAddress memory user) external;
/// Switch permission for minting.
///
@@ -358,7 +337,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) external view returns (bool);
+ function isOwnerOrAdminCross(CrossAddress memory user) external view returns (bool);
/// Returns collection type
///
@@ -373,7 +352,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() external view returns (EthCrossAccount memory);
+ function collectionOwner() external view returns (CrossAddress memory);
// /// Changes collection owner to another account
// ///
@@ -389,7 +368,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() external view returns (EthCrossAccount[] memory);
+ function collectionAdmins() external view returns (CrossAddress[] memory);
/// Changes collection owner to another account
///
@@ -397,59 +376,67 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) external;
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev anonymous struct
-struct Tuple39 {
- CollectionPermissions field_0;
- bool field_1;
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple36 {
- bool field_0;
- uint256[] field_1;
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
+}
+
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple31 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
}
/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension
@@ -569,7 +556,7 @@
/// @param tokenId Id for the token.
/// @dev EVM selector for this function is: 0x2b29dace,
/// or in textual repr: crossOwnerOf(uint256)
- function crossOwnerOf(uint256 tokenId) external view returns (EthCrossAccount memory);
+ function crossOwnerOf(uint256 tokenId) external view returns (CrossAddress memory);
/// Returns the token properties.
///
@@ -588,7 +575,7 @@
/// @param tokenId The NFT to approve
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory approved, uint256 tokenId) external;
+ function approveCross(CrossAddress memory approved, uint256 tokenId) external;
/// @notice Transfer ownership of an NFT
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
@@ -606,7 +593,7 @@
/// @param tokenId The NFT to transfer
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 tokenId) external;
+ function transferCross(CrossAddress memory to, uint256 tokenId) external;
/// @notice Transfer ownership of an NFT from cross account address to cross account address
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
@@ -617,8 +604,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 tokenId
) external;
@@ -640,7 +627,7 @@
/// @param tokenId The NFT to transfer
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 tokenId) external;
+ function burnFromCross(CrossAddress memory from, uint256 tokenId) external;
/// @notice Returns next free NFT ID.
/// @dev EVM selector for this function is: 0x75794a3c,
@@ -671,7 +658,7 @@
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0xb904db03,
/// or in textual repr: mintCross((address,uint256),(string,bytes)[])
- function mintCross(EthCrossAccount memory to, Property[] memory properties) external returns (uint256);
+ function mintCross(CrossAddress memory to, Property[] memory properties) external returns (uint256);
}
/// @dev anonymous struct
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -30,12 +30,12 @@
/// @param permissions Permissions for keys.
/// @dev EVM selector for this function is: 0xbd92983a,
/// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])
- function setTokenPropertyPermissions(Tuple52[] memory permissions) external;
+ function setTokenPropertyPermissions(TokenPropertyPermission[] memory permissions) external;
/// @notice Get permissions for token properties.
/// @dev EVM selector for this function is: 0xf23d7790,
/// or in textual repr: tokenPropertyPermissions()
- function tokenPropertyPermissions() external view returns (Tuple52[] memory);
+ function tokenPropertyPermissions() external view returns (TokenPropertyPermission[] memory);
// /// @notice Set token property value.
// /// @dev Throws error if `msg.sender` has no permission to edit the property.
@@ -80,36 +80,40 @@
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
-/// @dev Property struct
+/// 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 TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
-enum EthTokenPermissions {
- /// @dev 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`]
- TokenOwner,
- /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
- CollectionAdmin
+/// Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// Token property key.
+ string key;
+ /// Token property permissions.
+ PropertyPermission[] permissions;
}
-/// @dev anonymous struct
-struct Tuple52 {
- string field_0;
- Tuple50[] field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// TokenPermission field.
+ TokenPermissionField code;
+ /// TokenPermission value.
+ bool value;
}
-/// @dev anonymous struct
-struct Tuple50 {
- EthTokenPermissions field_0;
- bool field_1;
+/// Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.
+enum TokenPermissionField {
+ /// Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]
+ Mutable,
+ /// Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]
+ TokenOwner,
+ /// Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
+ CollectionAdmin
}
/// @title A contract that allows you to work with collections.
-/// @dev the ERC-165 identifier for this interface is 0x81172a75
+/// @dev the ERC-165 identifier for this interface is 0x2a14cfd1
interface Collection is Dummy, ERC165 {
// /// Set collection property.
// ///
@@ -174,7 +178,7 @@
/// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.
/// @dev EVM selector for this function is: 0x84a1d5a8,
/// or in textual repr: setCollectionSponsorCross((address,uint256))
- function setCollectionSponsorCross(EthCrossAccount memory sponsor) external;
+ function setCollectionSponsorCross(CrossAddress memory sponsor) external;
/// Whether there is a pending sponsor.
/// @dev EVM selector for this function is: 0x058ac185,
@@ -198,46 +202,21 @@
/// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.
/// @dev EVM selector for this function is: 0x6ec0a9f1,
/// or in textual repr: collectionSponsor()
- function collectionSponsor() external view returns (EthCrossAccount memory);
+ function collectionSponsor() external view returns (CrossAddress memory);
/// Get current collection limits.
///
- /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// Return `false` if a limit not set.
+ /// @return Array of collection limits
/// @dev EVM selector for this function is: 0xf63bc572,
/// or in textual repr: collectionLimits()
- function collectionLimits() external view returns (Tuple30[] memory);
+ function collectionLimits() external view returns (CollectionLimit[] memory);
/// Set limits for the collection.
/// @dev Throws error if limit not found.
- /// @param limit Name of the limit. Valid names:
- /// "accountTokenOwnershipLimit",
- /// "sponsoredDataSize",
- /// "sponsoredDataRateLimit",
- /// "tokenLimit",
- /// "sponsorTransferTimeout",
- /// "sponsorApproveTimeout"
- /// "ownerCanTransfer",
- /// "ownerCanDestroy",
- /// "transfersEnabled"
- /// @param status enable\disable limit. Works only with `true`.
- /// @param value Value of the limit.
- /// @dev EVM selector for this function is: 0x88150bd0,
- /// or in textual repr: setCollectionLimit(uint8,bool,uint256)
- function setCollectionLimit(
- CollectionLimits limit,
- bool status,
- uint256 value
- ) external;
+ /// @param limit Some limit.
+ /// @dev EVM selector for this function is: 0x2316ee74,
+ /// or in textual repr: setCollectionLimit((uint8,(bool,uint256)))
+ function setCollectionLimit(CollectionLimit memory limit) external;
/// Get contract address.
/// @dev EVM selector for this function is: 0xf6b4dfb4,
@@ -248,13 +227,13 @@
/// @param newAdmin Cross account administrator address.
/// @dev EVM selector for this function is: 0x859aa7d6,
/// or in textual repr: addCollectionAdminCross((address,uint256))
- function addCollectionAdminCross(EthCrossAccount memory newAdmin) external;
+ function addCollectionAdminCross(CrossAddress memory newAdmin) external;
/// Remove collection admin.
/// @param admin Cross account administrator address.
/// @dev EVM selector for this function is: 0x6c0cd173,
/// or in textual repr: removeCollectionAdminCross((address,uint256))
- function removeCollectionAdminCross(EthCrossAccount memory admin) external;
+ function removeCollectionAdminCross(CrossAddress memory admin) external;
// /// Add collection admin.
// /// @param newAdmin Address of the added administrator.
@@ -287,12 +266,12 @@
/// Returns nesting for a collection
/// @dev EVM selector for this function is: 0x22d25bfe,
/// or in textual repr: collectionNestingRestrictedCollectionIds()
- function collectionNestingRestrictedCollectionIds() external view returns (Tuple35 memory);
+ function collectionNestingRestrictedCollectionIds() external view returns (CollectionNesting memory);
/// Returns permissions for a collection
/// @dev EVM selector for this function is: 0x5b2eaf4b,
/// or in textual repr: collectionNestingPermissions()
- function collectionNestingPermissions() external view returns (Tuple38[] memory);
+ function collectionNestingPermissions() external view returns (CollectionNestingPermission[] memory);
/// Set the collection access method.
/// @param mode Access mode
@@ -307,7 +286,7 @@
/// @param user User address to check.
/// @dev EVM selector for this function is: 0x91b6df49,
/// or in textual repr: allowlistedCross((address,uint256))
- function allowlistedCross(EthCrossAccount memory user) external view returns (bool);
+ function allowlistedCross(CrossAddress memory user) external view returns (bool);
// /// Add the user to the allowed list.
// ///
@@ -321,7 +300,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0xa0184a3a,
/// or in textual repr: addToCollectionAllowListCross((address,uint256))
- function addToCollectionAllowListCross(EthCrossAccount memory user) external;
+ function addToCollectionAllowListCross(CrossAddress memory user) external;
// /// Remove the user from the allowed list.
// ///
@@ -335,7 +314,7 @@
/// @param user User cross account address.
/// @dev EVM selector for this function is: 0x09ba452a,
/// or in textual repr: removeFromCollectionAllowListCross((address,uint256))
- function removeFromCollectionAllowListCross(EthCrossAccount memory user) external;
+ function removeFromCollectionAllowListCross(CrossAddress memory user) external;
/// Switch permission for minting.
///
@@ -358,7 +337,7 @@
/// @return "true" if account is the owner or admin
/// @dev EVM selector for this function is: 0x3e75a905,
/// or in textual repr: isOwnerOrAdminCross((address,uint256))
- function isOwnerOrAdminCross(EthCrossAccount memory user) external view returns (bool);
+ function isOwnerOrAdminCross(CrossAddress memory user) external view returns (bool);
/// Returns collection type
///
@@ -373,7 +352,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0xdf727d3b,
/// or in textual repr: collectionOwner()
- function collectionOwner() external view returns (EthCrossAccount memory);
+ function collectionOwner() external view returns (CrossAddress memory);
// /// Changes collection owner to another account
// ///
@@ -389,7 +368,7 @@
/// If address is canonical then substrate mirror is zero and vice versa.
/// @dev EVM selector for this function is: 0x5813216b,
/// or in textual repr: collectionAdmins()
- function collectionAdmins() external view returns (EthCrossAccount[] memory);
+ function collectionAdmins() external view returns (CrossAddress[] memory);
/// Changes collection owner to another account
///
@@ -397,59 +376,67 @@
/// @param newOwner new owner cross account
/// @dev EVM selector for this function is: 0x6496c497,
/// or in textual repr: changeCollectionOwnerCross((address,uint256))
- function changeCollectionOwnerCross(EthCrossAccount memory newOwner) external;
+ function changeCollectionOwnerCross(CrossAddress memory newOwner) external;
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
-/// @dev anonymous struct
-struct Tuple38 {
- CollectionPermissions field_0;
- bool field_1;
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) field.
+struct CollectionNestingPermission {
+ CollectionPermissionField field;
+ bool value;
}
-enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+/// Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
+enum CollectionPermissionField {
+ /// Owner of token can nest tokens under it.
+ TokenOwner,
+ /// Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple35 {
- bool field_0;
- uint256[] field_1;
+/// Nested collections.
+struct CollectionNesting {
+ bool token_owner;
+ uint256[] ids;
+}
+
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) field representation for EVM.
+struct CollectionLimit {
+ CollectionLimitField field;
+ OptionUint value;
+}
+
+/// Ethereum representation of Optional value with uint256.
+struct OptionUint {
+ bool status;
+ uint256 value;
}
-/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.
-enum CollectionLimits {
- /// @dev How many tokens can a user have on one account.
+/// [`CollectionLimits`](up_data_structs::CollectionLimits) fields representation for EVM.
+enum CollectionLimitField {
+ /// 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 anonymous struct
-struct Tuple30 {
- CollectionLimits field_0;
- bool field_1;
- uint256 field_2;
}
/// @dev the ERC-165 identifier for this interface is 0x5b5e139f
@@ -567,7 +554,7 @@
/// @param tokenId Id for the token.
/// @dev EVM selector for this function is: 0x2b29dace,
/// or in textual repr: crossOwnerOf(uint256)
- function crossOwnerOf(uint256 tokenId) external view returns (EthCrossAccount memory);
+ function crossOwnerOf(uint256 tokenId) external view returns (CrossAddress memory);
/// Returns the token properties.
///
@@ -596,7 +583,7 @@
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 tokenId) external;
+ function transferCross(CrossAddress memory to, uint256 tokenId) external;
/// @notice Transfer ownership of an RFT
/// @dev Throws unless `msg.sender` is the current owner. Throws if `to`
@@ -607,8 +594,8 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 tokenId
) external;
@@ -632,7 +619,7 @@
/// @param tokenId The RFT to transfer
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 tokenId) external;
+ function burnFromCross(CrossAddress memory from, uint256 tokenId) external;
/// @notice Returns next free RFT ID.
/// @dev EVM selector for this function is: 0x75794a3c,
@@ -663,7 +650,7 @@
/// @return uint256 The id of the newly minted token
/// @dev EVM selector for this function is: 0xb904db03,
/// or in textual repr: mintCross((address,uint256),(string,bytes)[])
- function mintCross(EthCrossAccount memory to, Property[] memory properties) external returns (uint256);
+ function mintCross(CrossAddress memory to, Property[] memory properties) external returns (uint256);
/// Returns EVM address for refungible token
///
tests/src/eth/api/UniqueRefungibleToken.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungibleToken.sol
+++ b/tests/src/eth/api/UniqueRefungibleToken.sol
@@ -39,7 +39,7 @@
/// @param amount The amount that will be burnt.
/// @dev EVM selector for this function is: 0xbb2f5a58,
/// or in textual repr: burnFromCross((address,uint256),uint256)
- function burnFromCross(EthCrossAccount memory from, uint256 amount) external returns (bool);
+ function burnFromCross(CrossAddress memory from, uint256 amount) external returns (bool);
/// @dev Approve the passed address to spend the specified amount of tokens on behalf of `msg.sender`.
/// Beware that changing an allowance with this method brings the risk that someone may use both the old
@@ -50,7 +50,7 @@
/// @param amount The amount of tokens to be spent.
/// @dev EVM selector for this function is: 0x0ecd0ab0,
/// or in textual repr: approveCross((address,uint256),uint256)
- function approveCross(EthCrossAccount memory spender, uint256 amount) external returns (bool);
+ function approveCross(CrossAddress memory spender, uint256 amount) external returns (bool);
/// @dev Function that changes total amount of the tokens.
/// Throws if `msg.sender` doesn't owns all of the tokens.
@@ -64,7 +64,7 @@
/// @param amount The amount to be transferred.
/// @dev EVM selector for this function is: 0x2ada85ff,
/// or in textual repr: transferCross((address,uint256),uint256)
- function transferCross(EthCrossAccount memory to, uint256 amount) external returns (bool);
+ function transferCross(CrossAddress memory to, uint256 amount) external returns (bool);
/// @dev Transfer tokens from one address to another
/// @param from The address which you want to send tokens from
@@ -73,14 +73,14 @@
/// @dev EVM selector for this function is: 0xd5cf430b,
/// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)
function transferFromCross(
- EthCrossAccount memory from,
- EthCrossAccount memory to,
+ CrossAddress memory from,
+ CrossAddress memory to,
uint256 amount
) external returns (bool);
}
-/// @dev Cross account struct
-struct EthCrossAccount {
+/// Cross account struct
+struct CrossAddress {
address eth;
uint256 sub;
}
tests/src/eth/collectionLimits.test.tsdiffbeforeafterboth--- a/tests/src/eth/collectionLimits.test.ts
+++ b/tests/src/eth/collectionLimits.test.ts
@@ -1,7 +1,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
-import {CollectionLimits} from './util/playgrounds/types';
+import {CollectionLimitField} from './util/playgrounds/types';
describe('Can set collection limits', () => {
@@ -46,15 +46,15 @@
};
const collectionEvm = await helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, limits.accountTokenOwnershipLimit).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsoredDataSize, true, limits.sponsoredDataSize).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsoredDataRateLimit, true, limits.sponsoredDataRateLimit).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.TokenLimit, true, limits.tokenLimit).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsorTransferTimeout, true, limits.sponsorTransferTimeout).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.SponsorApproveTimeout, true, limits.sponsorApproveTimeout).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, limits.ownerCanTransfer).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.OwnerCanDestroy, true, limits.ownerCanDestroy).send();
- await collectionEvm.methods.setCollectionLimit(CollectionLimits.TransferEnabled, true, limits.transfersEnabled).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: limits.accountTokenOwnershipLimit}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsoredDataSize, value: {status: true, value: limits.sponsoredDataSize}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsoredDataRateLimit, value: {status: true, value: limits.sponsoredDataRateLimit}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.TokenLimit, value: {status: true, value: limits.tokenLimit}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsorTransferTimeout, value: {status: true, value: limits.sponsorTransferTimeout}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.SponsorApproveTimeout, value: {status: true, value: limits.sponsorApproveTimeout}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.OwnerCanTransfer, value: {status: true, value: limits.ownerCanTransfer}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.OwnerCanDestroy, value: {status: true, value: limits.ownerCanDestroy}}).send();
+ await collectionEvm.methods.setCollectionLimit({field: CollectionLimitField.TransferEnabled, value: {status: true, value: limits.transfersEnabled}}).send();
// Check limits from sub:
const data = (await helper.rft.getData(collectionId))!;
@@ -63,15 +63,15 @@
// Check limits from eth:
const limitsEvm = await collectionEvm.methods.collectionLimits().call({from: owner});
expect(limitsEvm).to.have.length(9);
- expect(limitsEvm[0]).to.deep.eq([CollectionLimits.AccountTokenOwnership.toString(), true, limits.accountTokenOwnershipLimit.toString()]);
- expect(limitsEvm[1]).to.deep.eq([CollectionLimits.SponsoredDataSize.toString(), true, limits.sponsoredDataSize.toString()]);
- expect(limitsEvm[2]).to.deep.eq([CollectionLimits.SponsoredDataRateLimit.toString(), true, limits.sponsoredDataRateLimit.toString()]);
- expect(limitsEvm[3]).to.deep.eq([CollectionLimits.TokenLimit.toString(), true, limits.tokenLimit.toString()]);
- expect(limitsEvm[4]).to.deep.eq([CollectionLimits.SponsorTransferTimeout.toString(), true, limits.sponsorTransferTimeout.toString()]);
- expect(limitsEvm[5]).to.deep.eq([CollectionLimits.SponsorApproveTimeout.toString(), true, limits.sponsorApproveTimeout.toString()]);
- expect(limitsEvm[6]).to.deep.eq([CollectionLimits.OwnerCanTransfer.toString(), true, limits.ownerCanTransfer.toString()]);
- expect(limitsEvm[7]).to.deep.eq([CollectionLimits.OwnerCanDestroy.toString(), true, limits.ownerCanDestroy.toString()]);
- expect(limitsEvm[8]).to.deep.eq([CollectionLimits.TransferEnabled.toString(), true, limits.transfersEnabled.toString()]);
+ expect(limitsEvm[0]).to.deep.eq([CollectionLimitField.AccountTokenOwnership.toString(), [true, limits.accountTokenOwnershipLimit.toString()]]);
+ expect(limitsEvm[1]).to.deep.eq([CollectionLimitField.SponsoredDataSize.toString(), [true, limits.sponsoredDataSize.toString()]]);
+ expect(limitsEvm[2]).to.deep.eq([CollectionLimitField.SponsoredDataRateLimit.toString(), [true, limits.sponsoredDataRateLimit.toString()]]);
+ expect(limitsEvm[3]).to.deep.eq([CollectionLimitField.TokenLimit.toString(), [true, limits.tokenLimit.toString()]]);
+ expect(limitsEvm[4]).to.deep.eq([CollectionLimitField.SponsorTransferTimeout.toString(), [true, limits.sponsorTransferTimeout.toString()]]);
+ expect(limitsEvm[5]).to.deep.eq([CollectionLimitField.SponsorApproveTimeout.toString(), [true, limits.sponsorApproveTimeout.toString()]]);
+ expect(limitsEvm[6]).to.deep.eq([CollectionLimitField.OwnerCanTransfer.toString(), [true, limits.ownerCanTransfer.toString()]]);
+ expect(limitsEvm[7]).to.deep.eq([CollectionLimitField.OwnerCanDestroy.toString(), [true, limits.ownerCanDestroy.toString()]]);
+ expect(limitsEvm[8]).to.deep.eq([CollectionLimitField.TransferEnabled.toString(), [true, limits.transfersEnabled.toString()]]);
}));
});
@@ -101,24 +101,24 @@
// Cannot set non-existing limit
await expect(collectionEvm.methods
- .setCollectionLimit(9, true, 1)
- .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert Value not convertible into enum "CollectionLimits"');
+ .setCollectionLimit({field: 9, value: {status: true, value: 1}})
+ .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert Value not convertible into enum "CollectionLimitField"');
// Cannot disable limits
await expect(collectionEvm.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, false, 200)
- .call()).to.be.rejectedWith('Returned error: VM Exception while processing transaction: revert user can\'t disable limits');
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: false, value: 200}})
+ .call()).to.be.rejectedWith('user can\'t disable limits');
await expect(collectionEvm.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, invalidLimits.accountTokenOwnershipLimit)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: invalidLimits.accountTokenOwnershipLimit}})
.call()).to.be.rejectedWith(`can't convert value to u32 "${invalidLimits.accountTokenOwnershipLimit}"`);
await expect(collectionEvm.methods
- .setCollectionLimit(CollectionLimits.TransferEnabled, true, 3)
+ .setCollectionLimit({field: CollectionLimitField.TransferEnabled, value: {status: true, value: 3}})
.call()).to.be.rejectedWith(`can't convert value to boolean "${invalidLimits.transfersEnabled}"`);
expect(() => collectionEvm.methods
- .setCollectionLimit(CollectionLimits.SponsoredDataSize, true, -1).send()).to.throw('value out-of-bounds');
+ .setCollectionLimit({field: CollectionLimitField.SponsoredDataSize, value: {status: true, value: -1}}).send()).to.throw('value out-of-bounds');
}));
[
@@ -133,12 +133,12 @@
const collectionEvm = await helper.ethNativeContract.collection(collectionAddress, testCase.case, owner);
await expect(collectionEvm.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call({from: nonOwner}))
.to.be.rejectedWith('NoPermission');
await expect(collectionEvm.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.send({from: nonOwner}))
.to.be.rejected;
}));
tests/src/eth/contractSponsoring.test.tsdiffbeforeafterboth--- a/tests/src/eth/contractSponsoring.test.ts
+++ b/tests/src/eth/contractSponsoring.test.ts
@@ -42,7 +42,9 @@
expect(await helpers.methods.hasSponsor(flipper.options.address).call()).to.be.true;
// 1.1 Can get sponsor using methods.sponsor:
- const actualSponsor = await helpers.methods.sponsor(flipper.options.address).call();
+ const actualSponsorOpt = await helpers.methods.sponsor(flipper.options.address).call();
+ expect(actualSponsorOpt.status).to.be.true;
+ const actualSponsor = actualSponsorOpt.value;
expect(actualSponsor.eth).to.eq(flipper.options.address);
expect(actualSponsor.sub).to.eq('0');
@@ -151,7 +153,9 @@
expect(await helpers.methods.hasSponsor(flipper.options.address).call()).to.be.true;
// 1.1 Can get sponsor using methods.sponsor:
- const actualSponsor = await helpers.methods.sponsor(flipper.options.address).call();
+ const actualSponsorOpt = await helpers.methods.sponsor(flipper.options.address).call();
+ expect(actualSponsorOpt.status).to.be.true;
+ const actualSponsor = actualSponsorOpt.value;
expect(actualSponsor.eth).to.eq(sponsor);
expect(actualSponsor.sub).to.eq('0');
tests/src/eth/createFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createFTCollection.test.ts
+++ b/tests/src/eth/createFTCollection.test.ts
@@ -18,7 +18,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {Pallets, requirePalletsOrSkip} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
-import {CollectionLimits} from './util/playgrounds/types';
+import {CollectionLimitField} from './util/playgrounds/types';
const DECIMALS = 18;
@@ -205,7 +205,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -230,7 +230,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/createNFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createNFTCollection.test.ts
+++ b/tests/src/eth/createNFTCollection.test.ts
@@ -17,7 +17,7 @@
import {evmToAddress} from '@polkadot/util-crypto';
import {IKeyringPair} from '@polkadot/types/types';
import {expect, itEth, usingEthPlaygrounds} from './util';
-import {CollectionLimits} from './util/playgrounds/types';
+import {CollectionLimitField} from './util/playgrounds/types';
describe('Create NFT collection from EVM', () => {
@@ -215,7 +215,7 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -240,7 +240,7 @@
}
{
await expect(malfeasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/createRFTCollection.test.tsdiffbeforeafterboth--- a/tests/src/eth/createRFTCollection.test.ts
+++ b/tests/src/eth/createRFTCollection.test.ts
@@ -18,7 +18,7 @@
import {IKeyringPair} from '@polkadot/types/types';
import {Pallets, requirePalletsOrSkip} from '../util';
import {expect, itEth, usingEthPlaygrounds} from './util';
-import {CollectionLimits} from './util/playgrounds/types';
+import {CollectionLimitField} from './util/playgrounds/types';
describe('Create RFT collection from EVM', () => {
@@ -226,7 +226,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
@@ -251,7 +251,7 @@
}
{
await expect(peasantCollection.methods
- .setCollectionLimit(CollectionLimits.AccountTokenOwnership, true, 1000)
+ .setCollectionLimit({field: CollectionLimitField.AccountTokenOwnership, value: {status: true, value: 1000}})
.call()).to.be.rejectedWith(EXPECTED_ERROR);
}
});
tests/src/eth/events.test.tsdiffbeforeafterboth--- a/tests/src/eth/events.test.ts
+++ b/tests/src/eth/events.test.ts
@@ -19,7 +19,7 @@
import {EthUniqueHelper, itEth, usingEthPlaygrounds} from './util';
import {IEvent, TCollectionMode} from '../util/playgrounds/types';
import {Pallets, requirePalletsOrSkip} from '../util';
-import {CollectionLimits, EthTokenPermissions, NormalizedEvent} from './util/playgrounds/types';
+import {CollectionLimitField, TokenPermissionField, NormalizedEvent} from './util/playgrounds/types';
let donor: IKeyringPair;
@@ -121,9 +121,9 @@
const {unsubscribe, collectedEvents: subEvents} = await helper.subscribeEvents([{section: 'common', names: ['PropertyPermissionSet']}]);
await collection.methods.setTokenPropertyPermissions([
['A', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
]).send({from: owner});
await helper.wait.newBlocks(1);
@@ -233,7 +233,7 @@
});
const {unsubscribe, collectedEvents: subEvents} = await helper.subscribeEvents([{section: 'common', names: ['CollectionLimitSet']}]);
{
- await collection.methods.setCollectionLimit(CollectionLimits.OwnerCanTransfer, true, 0).send({from: owner});
+ await collection.methods.setCollectionLimit({field: CollectionLimitField.OwnerCanTransfer, value: {status: true, value: 0}}).send({from: owner});
await helper.wait.newBlocks(1);
expect(ethEvents).to.containSubset([
{
@@ -379,9 +379,9 @@
const tokenId = result.events.Transfer.returnValues.tokenId;
await collection.methods.setTokenPropertyPermissions([
['A', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
]).send({from: owner});
tests/src/eth/fractionalizer/Fractionalizer.soldiffbeforeafterboth--- a/tests/src/eth/fractionalizer/Fractionalizer.sol
+++ b/tests/src/eth/fractionalizer/Fractionalizer.sol
@@ -3,7 +3,7 @@
import {CollectionHelpers} from "../api/CollectionHelpers.sol";
import {ContractHelpers} from "../api/ContractHelpers.sol";
import {UniqueRefungibleToken} from "../api/UniqueRefungibleToken.sol";
-import {UniqueRefungible, EthCrossAccount} from "../api/UniqueRefungible.sol";
+import {UniqueRefungible, CrossAddress} from "../api/UniqueRefungible.sol";
import {UniqueNFT} from "../api/UniqueNFT.sol";
/// @dev Fractionalization contract. It stores mappings between NFT and RFT tokens,
@@ -63,7 +63,7 @@
"Wrong collection type. Collection is not refungible."
);
require(
- refungibleContract.isOwnerOrAdminCross(EthCrossAccount({eth: address(this), sub: uint256(0)})),
+ refungibleContract.isOwnerOrAdminCross(CrossAddress({eth: address(this), sub: uint256(0)})),
"Fractionalizer contract should be an admin of the collection"
);
rftCollection = _collection;
@@ -128,7 +128,7 @@
address rftTokenAddress;
UniqueRefungibleToken rftTokenContract;
if (nft2rftMapping[_collection][_token] == 0) {
- rftTokenId = rftCollectionContract.mint(address(this));
+ rftTokenId = rftCollectionContract.mint(address(this));
rftTokenAddress = rftCollectionContract.tokenContractAddress(rftTokenId);
nft2rftMapping[_collection][_token] = rftTokenId;
rft2nftMapping[rftTokenAddress] = Token(_collection, _token);
tests/src/eth/tokenProperties.test.tsdiffbeforeafterboth--- a/tests/src/eth/tokenProperties.test.ts
+++ b/tests/src/eth/tokenProperties.test.ts
@@ -20,7 +20,7 @@
import {ITokenPropertyPermission} from '../util/playgrounds/types';
import {Pallets} from '../util';
import {UniqueNFTCollection, UniqueNFToken, UniqueRFTCollection} from '../util/playgrounds/unique';
-import {EthTokenPermissions} from './util/playgrounds/types';
+import {TokenPermissionField} from './util/playgrounds/types';
describe('EVM token properties', () => {
let donor: IKeyringPair;
@@ -47,9 +47,9 @@
await collection.methods.setTokenPropertyPermissions([
['testKey', [
- [EthTokenPermissions.Mutable, mutable],
- [EthTokenPermissions.TokenOwner, tokenOwner],
- [EthTokenPermissions.CollectionAdmin, collectionAdmin]],
+ [TokenPermissionField.Mutable, mutable],
+ [TokenPermissionField.TokenOwner, tokenOwner],
+ [TokenPermissionField.CollectionAdmin, collectionAdmin]],
],
]).send({from: caller.eth});
@@ -60,9 +60,9 @@
expect(await collection.methods.tokenPropertyPermissions().call({from: caller.eth})).to.be.like([
['testKey', [
- [EthTokenPermissions.Mutable.toString(), mutable],
- [EthTokenPermissions.TokenOwner.toString(), tokenOwner],
- [EthTokenPermissions.CollectionAdmin.toString(), collectionAdmin]],
+ [TokenPermissionField.Mutable.toString(), mutable],
+ [TokenPermissionField.TokenOwner.toString(), tokenOwner],
+ [TokenPermissionField.CollectionAdmin.toString(), collectionAdmin]],
],
]);
}
@@ -80,19 +80,19 @@
await collection.methods.setTokenPropertyPermissions([
['testKey_0', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
['testKey_1', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, false],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, false],
+ [TokenPermissionField.CollectionAdmin, true]],
],
['testKey_2', [
- [EthTokenPermissions.Mutable, false],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, false]],
+ [TokenPermissionField.Mutable, false],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, false]],
],
]).send({from: owner});
@@ -113,19 +113,19 @@
expect(await collection.methods.tokenPropertyPermissions().call({from: owner})).to.be.like([
['testKey_0', [
- [EthTokenPermissions.Mutable.toString(), true],
- [EthTokenPermissions.TokenOwner.toString(), true],
- [EthTokenPermissions.CollectionAdmin.toString(), true]],
+ [TokenPermissionField.Mutable.toString(), true],
+ [TokenPermissionField.TokenOwner.toString(), true],
+ [TokenPermissionField.CollectionAdmin.toString(), true]],
],
['testKey_1', [
- [EthTokenPermissions.Mutable.toString(), true],
- [EthTokenPermissions.TokenOwner.toString(), false],
- [EthTokenPermissions.CollectionAdmin.toString(), true]],
+ [TokenPermissionField.Mutable.toString(), true],
+ [TokenPermissionField.TokenOwner.toString(), false],
+ [TokenPermissionField.CollectionAdmin.toString(), true]],
],
['testKey_2', [
- [EthTokenPermissions.Mutable.toString(), false],
- [EthTokenPermissions.TokenOwner.toString(), true],
- [EthTokenPermissions.CollectionAdmin.toString(), false]],
+ [TokenPermissionField.Mutable.toString(), false],
+ [TokenPermissionField.TokenOwner.toString(), true],
+ [TokenPermissionField.CollectionAdmin.toString(), false]],
],
]);
}));
@@ -144,19 +144,19 @@
await collection.methods.setTokenPropertyPermissions([
['testKey_0', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
['testKey_1', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, false],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, false],
+ [TokenPermissionField.CollectionAdmin, true]],
],
['testKey_2', [
- [EthTokenPermissions.Mutable, false],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, false]],
+ [TokenPermissionField.Mutable, false],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, false]],
],
]).send({from: caller.eth});
@@ -177,19 +177,19 @@
expect(await collection.methods.tokenPropertyPermissions().call({from: caller.eth})).to.be.like([
['testKey_0', [
- [EthTokenPermissions.Mutable.toString(), true],
- [EthTokenPermissions.TokenOwner.toString(), true],
- [EthTokenPermissions.CollectionAdmin.toString(), true]],
+ [TokenPermissionField.Mutable.toString(), true],
+ [TokenPermissionField.TokenOwner.toString(), true],
+ [TokenPermissionField.CollectionAdmin.toString(), true]],
],
['testKey_1', [
- [EthTokenPermissions.Mutable.toString(), true],
- [EthTokenPermissions.TokenOwner.toString(), false],
- [EthTokenPermissions.CollectionAdmin.toString(), true]],
+ [TokenPermissionField.Mutable.toString(), true],
+ [TokenPermissionField.TokenOwner.toString(), false],
+ [TokenPermissionField.CollectionAdmin.toString(), true]],
],
['testKey_2', [
- [EthTokenPermissions.Mutable.toString(), false],
- [EthTokenPermissions.TokenOwner.toString(), true],
- [EthTokenPermissions.CollectionAdmin.toString(), false]],
+ [TokenPermissionField.Mutable.toString(), false],
+ [TokenPermissionField.TokenOwner.toString(), true],
+ [TokenPermissionField.CollectionAdmin.toString(), false]],
],
]);
@@ -460,9 +460,9 @@
await expect(collection.methods.setTokenPropertyPermissions([
['testKey_0', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
]).call({from: caller})).to.be.rejectedWith('NoPermission');
}));
@@ -480,9 +480,9 @@
await expect(collection.methods.setTokenPropertyPermissions([
// "Space" is invalid character
['testKey 0', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
]).call({from: owner})).to.be.rejectedWith('InvalidCharacterInPropertyKey');
}));
@@ -500,9 +500,9 @@
// 1. Owner sets strict property-permissions:
await collection.methods.setTokenPropertyPermissions([
['testKey', [
- [EthTokenPermissions.Mutable, true],
- [EthTokenPermissions.TokenOwner, true],
- [EthTokenPermissions.CollectionAdmin, true]],
+ [TokenPermissionField.Mutable, true],
+ [TokenPermissionField.TokenOwner, true],
+ [TokenPermissionField.CollectionAdmin, true]],
],
]).send({from: owner});
@@ -510,9 +510,9 @@
for(const values of [[true, true, false], [true, false, false], [false, false, false]]) {
await collection.methods.setTokenPropertyPermissions([
['testKey', [
- [EthTokenPermissions.Mutable, values[0]],
- [EthTokenPermissions.TokenOwner, values[1]],
- [EthTokenPermissions.CollectionAdmin, values[2]]],
+ [TokenPermissionField.Mutable, values[0]],
+ [TokenPermissionField.TokenOwner, values[1]],
+ [TokenPermissionField.CollectionAdmin, values[2]]],
],
]).send({from: owner});
}
@@ -536,9 +536,9 @@
// 1. Owner sets strict property-permissions:
await collection.methods.setTokenPropertyPermissions([
['testKey', [
- [EthTokenPermissions.Mutable, false],
- [EthTokenPermissions.TokenOwner, false],
- [EthTokenPermissions.CollectionAdmin, false]],
+ [TokenPermissionField.Mutable, false],
+ [TokenPermissionField.TokenOwner, false],
+ [TokenPermissionField.CollectionAdmin, false]],
],
]).send({from: owner});
@@ -546,9 +546,9 @@
for(const values of [[true, false, false], [false, true, false], [false, false, true]]) {
await expect(collection.methods.setTokenPropertyPermissions([
['testKey', [
- [EthTokenPermissions.Mutable, values[0]],
- [EthTokenPermissions.TokenOwner, values[1]],
- [EthTokenPermissions.CollectionAdmin, values[2]]],
+ [TokenPermissionField.Mutable, values[0]],
+ [TokenPermissionField.TokenOwner, values[1]],
+ [TokenPermissionField.CollectionAdmin, values[2]]],
],
]).call({from: owner})).to.be.rejectedWith('NoPermission');
}
tests/src/eth/util/playgrounds/types.tsdiffbeforeafterboth--- a/tests/src/eth/util/playgrounds/types.ts
+++ b/tests/src/eth/util/playgrounds/types.ts
@@ -13,19 +13,26 @@
event: string,
args: { [key: string]: string }
};
-export interface TEthCrossAccount {
+
+export interface OptionUint {
+ status: boolean,
+ value: bigint,
+}
+
+export interface CrossAddress {
readonly eth: string,
readonly sub: string | Uint8Array,
}
export type EthProperty = string[];
-export enum EthTokenPermissions {
+export enum TokenPermissionField {
Mutable,
TokenOwner,
CollectionAdmin
}
-export enum CollectionLimits {
+
+export enum CollectionLimitField {
AccountTokenOwnership,
SponsoredDataSize,
SponsoredDataRateLimit,
@@ -36,3 +43,8 @@
OwnerCanDestroy,
TransferEnabled
}
+
+export interface CollectionLimit {
+ field: CollectionLimitField,
+ value: OptionUint,
+}
tests/src/eth/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/eth/util/playgrounds/unique.dev.ts
+++ b/tests/src/eth/util/playgrounds/unique.dev.ts
@@ -18,7 +18,7 @@
import {DevUniqueHelper} from '../../../util/playgrounds/unique.dev';
-import {ContractImports, CompiledContract, TEthCrossAccount, NormalizedEvent, EthProperty} from './types';
+import {ContractImports, CompiledContract, CrossAddress, NormalizedEvent, EthProperty} from './types';
// Native contracts ABI
import collectionHelpersAbi from '../../abi/collectionHelpers.json';
@@ -435,7 +435,7 @@
export type EthUniqueHelperConstructor = new (...args: any[]) => EthUniqueHelper;
export class EthCrossAccountGroup extends EthGroupBase {
- createAccount(): TEthCrossAccount {
+ createAccount(): CrossAddress {
return this.fromAddress(this.helper.eth.createAccount());
}
@@ -443,14 +443,14 @@
return this.fromAddress(await this.helper.eth.createAccountWithBalance(donor, amount));
}
- fromAddress(address: TEthereumAccount): TEthCrossAccount {
+ fromAddress(address: TEthereumAccount): CrossAddress {
return {
eth: address,
sub: '0',
};
}
- fromKeyringPair(keyring: IKeyringPair): TEthCrossAccount {
+ fromKeyringPair(keyring: IKeyringPair): CrossAddress {
return {
eth: '0x0000000000000000000000000000000000000000',
sub: keyring.addressRaw,
tests/src/util/index.tsdiffbeforeafterboth--- a/tests/src/util/index.ts
+++ b/tests/src/util/index.ts
@@ -11,7 +11,7 @@
import config from '../config';
import {ChainHelperBase} from './playgrounds/unique';
import {ILogger} from './playgrounds/types';
-import {DevUniqueHelper, SilentLogger, SilentConsole, DevMoonbeamHelper, DevMoonriverHelper, DevAcalaHelper, DevKaruraHelper, DevRelayHelper, DevWestmintHelper} from './playgrounds/unique.dev';
+import {DevUniqueHelper, SilentLogger, SilentConsole, DevMoonbeamHelper, DevMoonriverHelper, DevAcalaHelper, DevKaruraHelper, DevRelayHelper, DevWestmintHelper, DevStatemineHelper, DevStatemintHelper} from './playgrounds/unique.dev';
chai.use(chaiAsPromised);
chai.use(chaiSubset);
@@ -65,6 +65,14 @@
return usingPlaygroundsGeneral<DevWestmintHelper>(DevWestmintHelper, url, code);
};
+export const usingStateminePlaygrounds = (url: string, code: (helper: DevWestmintHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {
+ return usingPlaygroundsGeneral<DevStatemineHelper>(DevWestmintHelper, url, code);
+};
+
+export const usingStatemintPlaygrounds = (url: string, code: (helper: DevWestmintHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {
+ return usingPlaygroundsGeneral<DevStatemintHelper>(DevWestmintHelper, url, code);
+};
+
export const usingRelayPlaygrounds = (url: string, code: (helper: DevRelayHelper, privateKey: (seed: string) => Promise<IKeyringPair>) => Promise<void>) => {
return usingPlaygroundsGeneral<DevRelayHelper>(DevRelayHelper, url, code);
};
tests/src/util/playgrounds/unique.dev.tsdiffbeforeafterboth--- a/tests/src/util/playgrounds/unique.dev.ts
+++ b/tests/src/util/playgrounds/unique.dev.ts
@@ -118,7 +118,16 @@
}
}
-export class DevRelayHelper extends RelayHelper {}
+export class DevRelayHelper extends RelayHelper {
+ wait: WaitGroup;
+
+ constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {
+ options.helperBase = options.helperBase ?? DevRelayHelper;
+
+ super(logger, options);
+ this.wait = new WaitGroup(this);
+ }
+}
export class DevWestmintHelper extends WestmintHelper {
wait: WaitGroup;
@@ -131,12 +140,17 @@
}
}
+export class DevStatemineHelper extends DevWestmintHelper {}
+
+export class DevStatemintHelper extends DevWestmintHelper {}
+
export class DevMoonbeamHelper extends MoonbeamHelper {
account: MoonbeamAccountGroup;
wait: WaitGroup;
constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {
options.helperBase = options.helperBase ?? DevMoonbeamHelper;
+ options.notePreimagePallet = options.notePreimagePallet ?? 'democracy';
super(logger, options);
this.account = new MoonbeamAccountGroup(this);
@@ -144,7 +158,12 @@
}
}
-export class DevMoonriverHelper extends DevMoonbeamHelper {}
+export class DevMoonriverHelper extends DevMoonbeamHelper {
+ constructor(logger: { log: (msg: any, level: any) => void, level: any }, options: {[key: string]: any} = {}) {
+ options.notePreimagePallet = options.notePreimagePallet ?? 'preimage';
+ super(logger, options);
+ }
+}
export class DevAcalaHelper extends AcalaHelper {
wait: WaitGroup;
tests/src/util/playgrounds/unique.tsdiffbeforeafterboth1// Copyright 2019-2022 Unique Network (Gibraltar) Ltd.2// SPDX-License-Identifier: Apache-2.034/* eslint-disable @typescript-eslint/no-var-requires */5/* eslint-disable function-call-argument-newline */6/* eslint-disable no-prototype-builtins */78import {ApiPromise, WsProvider, Keyring} from '@polkadot/api';9import {ApiInterfaceEvents, SignerOptions} from '@polkadot/api/types';10import {encodeAddress, decodeAddress, keccakAsHex, evmToAddress, addressToEvm, base58Encode, blake2AsU8a} from '@polkadot/util-crypto';11import {IKeyringPair} from '@polkadot/types/types';12import {hexToU8a} from '@polkadot/util/hex';13import {u8aConcat} from '@polkadot/util/u8a';14import {15 IApiListeners,16 IBlock,17 IEvent,18 IChainProperties,19 ICollectionCreationOptions,20 ICollectionLimits,21 ICollectionPermissions,22 ICrossAccountId,23 ICrossAccountIdLower,24 ILogger,25 INestingPermissions,26 IProperty,27 IStakingInfo,28 ISchedulerOptions,29 ISubstrateBalance,30 IToken,31 ITokenPropertyPermission,32 ITransactionResult,33 IUniqueHelperLog,34 TApiAllowedListeners,35 TEthereumAccount,36 TSigner,37 TSubstrateAccount,38 TNetworks,39 IForeignAssetMetadata,40 AcalaAssetMetadata,41 MoonbeamAssetInfo,42 DemocracyStandardAccountVote,43 IEthCrossAccountId,44} from './types';45import {RuntimeDispatchInfo} from '@polkadot/types/interfaces';46import type {Vec} from '@polkadot/types-codec';47import {FrameSystemEventRecord} from '@polkadot/types/lookup';4849export class CrossAccountId implements ICrossAccountId {50 Substrate?: TSubstrateAccount;51 Ethereum?: TEthereumAccount;5253 constructor(account: ICrossAccountId) {54 if (account.Substrate) this.Substrate = account.Substrate;55 if (account.Ethereum) this.Ethereum = account.Ethereum;56 }5758 static fromKeyring(account: IKeyringPair, domain: 'Substrate' | 'Ethereum' = 'Substrate') {59 switch (domain) {60 case 'Substrate': return new CrossAccountId({Substrate: account.address});61 case 'Ethereum': return new CrossAccountId({Substrate: account.address}).toEthereum();62 }63 }6465 static fromLowerCaseKeys(address: ICrossAccountIdLower): CrossAccountId {66 return new CrossAccountId({Substrate: address.substrate, Ethereum: address.ethereum});67 }6869 static normalizeSubstrateAddress(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {70 return encodeAddress(decodeAddress(address), ss58Format);71 }7273 static withNormalizedSubstrate(address: TSubstrateAccount, ss58Format = 42): CrossAccountId {74 return new CrossAccountId({Substrate: CrossAccountId.normalizeSubstrateAddress(address, ss58Format)});75 }7677 withNormalizedSubstrate(ss58Format = 42): CrossAccountId {78 if (this.Substrate) return CrossAccountId.withNormalizedSubstrate(this.Substrate, ss58Format);79 return this;80 }8182 static translateSubToEth(address: TSubstrateAccount): TEthereumAccount {83 return nesting.toChecksumAddress('0x' + Array.from(addressToEvm(address), i => i.toString(16).padStart(2, '0')).join(''));84 }8586 toEthereum(): CrossAccountId {87 if (this.Substrate) return new CrossAccountId({Ethereum: CrossAccountId.translateSubToEth(this.Substrate)});88 return this;89 }9091 static translateEthToSub(address: TEthereumAccount, ss58Format?: number): TSubstrateAccount {92 return evmToAddress(address, ss58Format);93 }9495 toSubstrate(ss58Format?: number): CrossAccountId {96 if (this.Ethereum) return new CrossAccountId({Substrate: CrossAccountId.translateEthToSub(this.Ethereum, ss58Format)});97 return this;98 }99100 toLowerCase(): CrossAccountId {101 if (this.Substrate) this.Substrate = this.Substrate.toLowerCase();102 if (this.Ethereum) this.Ethereum = this.Ethereum.toLowerCase();103 return this;104 }105}106107const nesting = {108 toChecksumAddress(address: string): string {109 if (typeof address === 'undefined') return '';110111 if(!/^(0x)?[0-9a-f]{40}$/i.test(address)) throw new Error(`Given address "${address}" is not a valid Ethereum address.`);112113 address = address.toLowerCase().replace(/^0x/i,'');114 const addressHash = keccakAsHex(address).replace(/^0x/i,'');115 const checksumAddress = ['0x'];116117 for (let i = 0; i < address.length; i++) {118 // If ith character is 8 to f then make it uppercase119 if (parseInt(addressHash[i], 16) > 7) {120 checksumAddress.push(address[i].toUpperCase());121 } else {122 checksumAddress.push(address[i]);123 }124 }125 return checksumAddress.join('');126 },127 tokenIdToAddress(collectionId: number, tokenId: number) {128 return this.toChecksumAddress(`0xf8238ccfff8ed887463fd5e0${collectionId.toString(16).padStart(8,'0')}${tokenId.toString(16).padStart(8,'0')}`);129 },130};131132class UniqueUtil {133 static transactionStatus = {134 NOT_READY: 'NotReady',135 FAIL: 'Fail',136 SUCCESS: 'Success',137 };138139 static chainLogType = {140 EXTRINSIC: 'extrinsic',141 RPC: 'rpc',142 };143144 static getTokenAccount(token: IToken): CrossAccountId {145 return new CrossAccountId({Ethereum: this.getTokenAddress(token)});146 }147148 static getTokenAddress(token: IToken): string {149 return nesting.tokenIdToAddress(token.collectionId, token.tokenId);150 }151152 static getDefaultLogger(): ILogger {153 return {154 log(msg: any, level = 'INFO') {155 console[level.toLocaleLowerCase() === 'error' ? 'error' : 'log'](...(Array.isArray(msg) ? msg : [msg]));156 },157 level: {158 ERROR: 'ERROR',159 WARNING: 'WARNING',160 INFO: 'INFO',161 },162 };163 }164165 static vec2str(arr: string[] | number[]) {166 return arr.map(x => String.fromCharCode(parseInt(x.toString()))).join('');167 }168169 static str2vec(string: string) {170 if (typeof string !== 'string') return string;171 return Array.from(string).map(x => x.charCodeAt(0));172 }173174 static fromSeed(seed: string, ss58Format = 42) {175 const keyring = new Keyring({type: 'sr25519', ss58Format});176 return keyring.addFromUri(seed);177 }178179 static extractCollectionIdFromCreationResult(creationResult: ITransactionResult): number {180 if (creationResult.status !== this.transactionStatus.SUCCESS) {181 throw Error('Unable to create collection!');182 }183184 let collectionId = null;185 creationResult.result.events.forEach(({event: {data, method, section}}) => {186 if ((section === 'common') && (method === 'CollectionCreated')) {187 collectionId = parseInt(data[0].toString(), 10);188 }189 });190191 if (collectionId === null) {192 throw Error('No CollectionCreated event was found!');193 }194195 return collectionId;196 }197198 static extractTokensFromCreationResult(creationResult: ITransactionResult): {199 success: boolean,200 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],201 } {202 if (creationResult.status !== this.transactionStatus.SUCCESS) {203 throw Error('Unable to create tokens!');204 }205 let success = false;206 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];207 creationResult.result.events.forEach(({event: {data, method, section}}) => {208 if (method === 'ExtrinsicSuccess') {209 success = true;210 } else if ((section === 'common') && (method === 'ItemCreated')) {211 tokens.push({212 collectionId: parseInt(data[0].toString(), 10),213 tokenId: parseInt(data[1].toString(), 10),214 owner: data[2].toHuman(),215 amount: data[3].toBigInt(),216 });217 }218 });219 return {success, tokens};220 }221222 static extractTokensFromBurnResult(burnResult: ITransactionResult): {223 success: boolean,224 tokens: {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[],225 } {226 if (burnResult.status !== this.transactionStatus.SUCCESS) {227 throw Error('Unable to burn tokens!');228 }229 let success = false;230 const tokens = [] as {collectionId: number, tokenId: number, owner: CrossAccountId, amount: bigint}[];231 burnResult.result.events.forEach(({event: {data, method, section}}) => {232 if (method === 'ExtrinsicSuccess') {233 success = true;234 } else if ((section === 'common') && (method === 'ItemDestroyed')) {235 tokens.push({236 collectionId: parseInt(data[0].toString(), 10),237 tokenId: parseInt(data[1].toString(), 10),238 owner: data[2].toHuman(),239 amount: data[3].toBigInt(),240 });241 }242 });243 return {success, tokens};244 }245246 static findCollectionInEvents(events: {event: IEvent}[], collectionId: number, expectedSection: string, expectedMethod: string): boolean {247 let eventId = null;248 events.forEach(({event: {data, method, section}}) => {249 if ((section === expectedSection) && (method === expectedMethod)) {250 eventId = parseInt(data[0].toString(), 10);251 }252 });253254 if (eventId === null) {255 throw Error(`No ${expectedMethod} event was found!`);256 }257 return eventId === collectionId;258 }259260 static isTokenTransferSuccess(events: {event: IEvent}[], collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {261 const normalizeAddress = (address: string | ICrossAccountId) => {262 if(typeof address === 'string') return address;263 const obj = {} as any;264 Object.keys(address).forEach(k => {265 obj[k.toLocaleLowerCase()] = address[k as 'Substrate' | 'Ethereum'];266 });267 if(obj.substrate) return CrossAccountId.withNormalizedSubstrate(obj.substrate);268 if(obj.ethereum) return CrossAccountId.fromLowerCaseKeys(obj).toLowerCase();269 return address;270 };271 let transfer = {collectionId: null, tokenId: null, from: null, to: null, amount: 1} as any;272 events.forEach(({event: {data, method, section}}) => {273 if ((section === 'common') && (method === 'Transfer')) {274 const hData = (data as any).toJSON();275 transfer = {276 collectionId: hData[0],277 tokenId: hData[1],278 from: normalizeAddress(hData[2]),279 to: normalizeAddress(hData[3]),280 amount: BigInt(hData[4]),281 };282 }283 });284 let isSuccess = parseInt(collectionId.toString()) === transfer.collectionId && parseInt(tokenId.toString()) === transfer.tokenId;285 isSuccess = isSuccess && JSON.stringify(normalizeAddress(fromAddressObj)) === JSON.stringify(transfer.from);286 isSuccess = isSuccess && JSON.stringify(normalizeAddress(toAddressObj)) === JSON.stringify(transfer.to);287 isSuccess = isSuccess && amount === transfer.amount;288 return isSuccess;289 }290291 static bigIntToDecimals(number: bigint, decimals = 18) {292 const numberStr = number.toString();293 const dotPos = numberStr.length - decimals;294295 if (dotPos <= 0) {296 return '0.' + '0'.repeat(Math.abs(dotPos)) + numberStr;297 } else {298 const intPart = numberStr.substring(0, dotPos);299 const fractPart = numberStr.substring(dotPos);300 return intPart + '.' + fractPart;301 }302 }303}304305class UniqueEventHelper {306 private static extractIndex(index: any): [number, number] | string {307 if(index.toRawType() === '[u8;2]') return [index[0], index[1]];308 return index.toJSON();309 }310311 private static extractSub(data: any, subTypes: any): {[key: string]: any} {312 let obj: any = {};313 let index = 0;314315 if (data.entries) {316 for(const [key, value] of data.entries()) {317 obj[key] = this.extractData(value, subTypes[index]);318 index++;319 }320 } else obj = data.toJSON();321322 return obj;323 }324325 private static toHuman(data: any) {326 return data && data.toHuman ? data.toHuman() : `${data}`;327 }328329 private static extractData(data: any, type: any): any {330 if(!type) return this.toHuman(data);331 if (['u16', 'u32'].indexOf(type.type) > -1) return data.toNumber();332 if (['u64', 'u128', 'u256'].indexOf(type.type) > -1) return data.toBigInt();333 if(type.hasOwnProperty('sub')) return this.extractSub(data, type.sub);334 return this.toHuman(data);335 }336337 public static extractEvents(events: {event: any, phase: any}[]): IEvent[] {338 const parsedEvents: IEvent[] = [];339340 events.forEach((record) => {341 const {event, phase} = record;342 const types = event.typeDef;343344 const eventData: IEvent = {345 section: event.section.toString(),346 method: event.method.toString(),347 index: this.extractIndex(event.index),348 data: [],349 phase: phase.toJSON(),350 };351352 event.data.forEach((val: any, index: number) => {353 eventData.data.push(this.extractData(val, types[index]));354 });355356 parsedEvents.push(eventData);357 });358359 return parsedEvents;360 }361}362363export class ChainHelperBase {364 helperBase: any;365366 transactionStatus = UniqueUtil.transactionStatus;367 chainLogType = UniqueUtil.chainLogType;368 util: typeof UniqueUtil;369 eventHelper: typeof UniqueEventHelper;370 logger: ILogger;371 api: ApiPromise | null;372 forcedNetwork: TNetworks | null;373 network: TNetworks | null;374 chainLog: IUniqueHelperLog[];375 children: ChainHelperBase[];376 address: AddressGroup;377 chain: ChainGroup;378379 constructor(logger?: ILogger, helperBase?: any) {380 this.helperBase = helperBase;381382 this.util = UniqueUtil;383 this.eventHelper = UniqueEventHelper;384 if (typeof logger == 'undefined') logger = this.util.getDefaultLogger();385 this.logger = logger;386 this.api = null;387 this.forcedNetwork = null;388 this.network = null;389 this.chainLog = [];390 this.children = [];391 this.address = new AddressGroup(this);392 this.chain = new ChainGroup(this);393 }394395 clone(helperCls: ChainHelperBaseConstructor, options: {[key: string]: any} = {}) {396 Object.setPrototypeOf(helperCls.prototype, this);397 const newHelper = new helperCls(this.logger, options);398399 newHelper.api = this.api;400 newHelper.network = this.network;401 newHelper.forceNetwork = this.forceNetwork;402403 this.children.push(newHelper);404405 return newHelper;406 }407408 getApi(): ApiPromise {409 if(this.api === null) throw Error('API not initialized');410 return this.api;411 }412413 async subscribeEvents(expectedEvents: {section: string, names: string[]}[]) {414 const collectedEvents: IEvent[] = [];415 const unsubscribe = await this.getApi().query.system.events((events: Vec<FrameSystemEventRecord>) => {416 const ievents = this.eventHelper.extractEvents(events);417 ievents.forEach((event) => {418 expectedEvents.forEach((e => {419 if (event.section === e.section && e.names.includes(event.method)) {420 collectedEvents.push(event);421 }422 }));423 });424 });425 return {unsubscribe: unsubscribe as any, collectedEvents};426 }427428 clearChainLog(): void {429 this.chainLog = [];430 }431432 forceNetwork(value: TNetworks): void {433 this.forcedNetwork = value;434 }435436 async connect(wsEndpoint: string, listeners?: IApiListeners) {437 if (this.api !== null) throw Error('Already connected');438 const {api, network} = await ChainHelperBase.createConnection(wsEndpoint, listeners, this.forcedNetwork);439 this.api = api;440 this.network = network;441 }442443 async disconnect() {444 for (const child of this.children) {445 child.clearApi();446 }447448 if (this.api === null) return;449 await this.api.disconnect();450 this.clearApi();451 }452453 clearApi() {454 this.api = null;455 this.network = null;456 }457458 static async detectNetwork(api: ApiPromise): Promise<TNetworks> {459 const spec = (await api.query.system.lastRuntimeUpgrade()).toJSON() as any;460 const xcmChains = ['rococo', 'westend', 'westmint', 'acala', 'karura', 'moonbeam', 'moonriver'];461462 if(xcmChains.indexOf(spec.specName) > -1) return spec.specName;463464 if(['quartz', 'unique'].indexOf(spec.specName) > -1) return spec.specName;465 return 'opal';466 }467468 static async detectNetworkByWsEndpoint(wsEndpoint: string): Promise<TNetworks> {469 const api = new ApiPromise({provider: new WsProvider(wsEndpoint)});470 await api.isReady;471472 const network = await this.detectNetwork(api);473474 await api.disconnect();475476 return network;477 }478479 static async createConnection(wsEndpoint: string, listeners?: IApiListeners, network?: TNetworks | null): Promise<{480 api: ApiPromise;481 network: TNetworks;482 }> {483 if(typeof network === 'undefined' || network === null) network = 'opal';484 const supportedRPC = {485 opal: {486 unique: require('@unique-nft/opal-testnet-types/definitions').unique.rpc,487 },488 quartz: {489 unique: require('@unique-nft/quartz-mainnet-types/definitions').unique.rpc,490 },491 unique: {492 unique: require('@unique-nft/unique-mainnet-types/definitions').unique.rpc,493 },494 rococo: {},495 westend: {},496 moonbeam: {},497 moonriver: {},498 acala: {},499 karura: {},500 westmint: {},501 };502 if(!supportedRPC.hasOwnProperty(network)) network = await this.detectNetworkByWsEndpoint(wsEndpoint);503 const rpc = supportedRPC[network];504505 // TODO: investigate how to replace rpc in runtime506 // api._rpcCore.addUserInterfaces(rpc);507508 const api = new ApiPromise({provider: new WsProvider(wsEndpoint), rpc});509510 await api.isReadyOrError;511512 if (typeof listeners === 'undefined') listeners = {};513 for (const event of ['connected', 'disconnected', 'error', 'ready', 'decorated']) {514 if (!listeners.hasOwnProperty(event) || typeof listeners[event as TApiAllowedListeners] === 'undefined') continue;515 api.on(event as ApiInterfaceEvents, listeners[event as TApiAllowedListeners] as (...args: any[]) => any);516 }517518 return {api, network};519 }520521 getTransactionStatus(data: {events: {event: IEvent}[], status: any}) {522 const {events, status} = data;523 if (status.isReady) {524 return this.transactionStatus.NOT_READY;525 }526 if (status.isBroadcast) {527 return this.transactionStatus.NOT_READY;528 }529 if (status.isInBlock || status.isFinalized) {530 const errors = events.filter(e => e.event.method === 'ExtrinsicFailed');531 if (errors.length > 0) {532 return this.transactionStatus.FAIL;533 }534 if (events.filter(e => e.event.method === 'ExtrinsicSuccess').length > 0) {535 return this.transactionStatus.SUCCESS;536 }537 }538539 return this.transactionStatus.FAIL;540 }541542 signTransaction(sender: TSigner, transaction: any, options: Partial<SignerOptions> | null = null, label = 'transaction') {543 const sign = (callback: any) => {544 if(options !== null) return transaction.signAndSend(sender, options, callback);545 return transaction.signAndSend(sender, callback);546 };547 // eslint-disable-next-line no-async-promise-executor548 return new Promise(async (resolve, reject) => {549 try {550 const unsub = await sign((result: any) => {551 const status = this.getTransactionStatus(result);552553 if (status === this.transactionStatus.SUCCESS) {554 this.logger.log(`${label} successful`);555 unsub();556 resolve({result, status});557 } else if (status === this.transactionStatus.FAIL) {558 let moduleError = null;559560 if (result.hasOwnProperty('dispatchError')) {561 const dispatchError = result['dispatchError'];562563 if (dispatchError) {564 if (dispatchError.isModule) {565 const modErr = dispatchError.asModule;566 const errorMeta = dispatchError.registry.findMetaError(modErr);567568 moduleError = `${errorMeta.section}.${errorMeta.name}`;569 } else {570 moduleError = dispatchError.toHuman();571 }572 } else {573 this.logger.log(result, this.logger.level.ERROR);574 }575 }576577 this.logger.log(`Something went wrong with ${label}. Status: ${status}`, this.logger.level.ERROR);578 unsub();579 reject({status, moduleError, result});580 }581 });582 } catch (e) {583 this.logger.log(e, this.logger.level.ERROR);584 reject(e);585 }586 });587 }588589 async getPaymentInfo(signer: TSigner, tx: any, len: number | null) {590 const api = this.getApi();591 const signingInfo = await api.derive.tx.signingInfo(signer.address);592593 // We need to sign the tx because594 // unsigned transactions does not have an inclusion fee595 tx.sign(signer, {596 blockHash: api.genesisHash,597 genesisHash: api.genesisHash,598 runtimeVersion: api.runtimeVersion,599 nonce: signingInfo.nonce,600 });601602 if (len === null) {603 return (await this.callRpc('api.rpc.payment.queryInfo', [tx.toHex()])) as RuntimeDispatchInfo;604 } else {605 return (await api.call.transactionPaymentApi.queryInfo(tx, len)) as RuntimeDispatchInfo;606 }607 }608609 constructApiCall(apiCall: string, params: any[]) {610 if(!apiCall.startsWith('api.')) throw Error(`Invalid api call: ${apiCall}`);611 let call = this.getApi() as any;612 for(const part of apiCall.slice(4).split('.')) {613 call = call[part];614 }615 return call(...params);616 }617618 async executeExtrinsic(sender: TSigner, extrinsic: string, params: any[], expectSuccess=true, options: Partial<SignerOptions>|null = null/*, failureMessage='expected success'*/) {619 if(this.api === null) throw Error('API not initialized');620 if(!extrinsic.startsWith('api.tx.')) throw Error(`${extrinsic} is not transaction`);621622 const startTime = (new Date()).getTime();623 let result: ITransactionResult;624 let events: IEvent[] = [];625 try {626 result = await this.signTransaction(sender, this.constructApiCall(extrinsic, params), options, extrinsic) as ITransactionResult;627 events = this.eventHelper.extractEvents(result.result.events);628 }629 catch(e) {630 if(!(e as object).hasOwnProperty('status')) throw e;631 result = e as ITransactionResult;632 }633634 const endTime = (new Date()).getTime();635636 const log = {637 executedAt: endTime,638 executionTime: endTime - startTime,639 type: this.chainLogType.EXTRINSIC,640 status: result.status,641 call: extrinsic,642 signer: this.getSignerAddress(sender),643 params,644 } as IUniqueHelperLog;645646 if(result.status !== this.transactionStatus.SUCCESS) {647 if (result.moduleError) log.moduleError = result.moduleError;648 else if (result.result.dispatchError) log.dispatchError = result.result.dispatchError;649 }650 if(events.length > 0) log.events = events;651652 this.chainLog.push(log);653654 if(expectSuccess && result.status !== this.transactionStatus.SUCCESS) {655 if (result.moduleError) throw Error(`${result.moduleError}`);656 else if (result.result.dispatchError) throw Error(JSON.stringify(result.result.dispatchError));657 }658 return result;659 }660661 async callRpc(rpc: string, params?: any[]) {662 if(typeof params === 'undefined') params = [];663 if(this.api === null) throw Error('API not initialized');664 if(!rpc.startsWith('api.rpc.') && !rpc.startsWith('api.query.')) throw Error(`${rpc} is not RPC call`);665666 const startTime = (new Date()).getTime();667 let result;668 let error = null;669 const log = {670 type: this.chainLogType.RPC,671 call: rpc,672 params,673 } as IUniqueHelperLog;674675 try {676 result = await this.constructApiCall(rpc, params);677 }678 catch(e) {679 error = e;680 }681682 const endTime = (new Date()).getTime();683684 log.executedAt = endTime;685 log.status = (error === null ? this.transactionStatus.SUCCESS : this.transactionStatus.FAIL) as 'Fail' | 'Success';686 log.executionTime = endTime - startTime;687688 this.chainLog.push(log);689690 if(error !== null) throw error;691692 return result;693 }694695 getSignerAddress(signer: IKeyringPair | string): string {696 if(typeof signer === 'string') return signer;697 return signer.address;698 }699700 fetchAllPalletNames(): string[] {701 if(this.api === null) throw Error('API not initialized');702 return this.api.runtimeMetadata.asLatest.pallets.map(m => m.name.toString().toLowerCase());703 }704705 fetchMissingPalletNames(requiredPallets: string[]): string[] {706 const palletNames = this.fetchAllPalletNames();707 return requiredPallets.filter(p => !palletNames.includes(p));708 }709}710711712class HelperGroup<T extends ChainHelperBase> {713 helper: T;714715 constructor(uniqueHelper: T) {716 this.helper = uniqueHelper;717 }718}719720721class CollectionGroup extends HelperGroup<UniqueHelper> {722 /**723 * Get number of blocks when sponsored transaction is available.724 *725 * @param collectionId ID of collection726 * @param tokenId ID of token727 * @param addressObj address for which the sponsorship is checked728 * @example await getTokenNextSponsored(1, 2, {Substrate: '5DfhbVfww7ThF8q6f3...'});729 * @returns number of blocks or null if sponsorship hasn't been set730 */731 async getTokenNextSponsored(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<number | null> {732 return (await this.helper.callRpc('api.rpc.unique.nextSponsored', [collectionId, addressObj, tokenId])).toJSON();733 }734735 /**736 * Get the number of created collections.737 *738 * @returns number of created collections739 */740 async getTotalCount(): Promise<number> {741 return (await this.helper.callRpc('api.rpc.unique.collectionStats')).created.toNumber();742 }743744 /**745 * Get information about the collection with additional data,746 * including the number of tokens it contains, its administrators,747 * the normalized address of the collection's owner, and decoded name and description.748 *749 * @param collectionId ID of collection750 * @example await getData(2)751 * @returns collection information object752 */753 async getData(collectionId: number): Promise<{754 id: number;755 name: string;756 description: string;757 tokensCount: number;758 admins: CrossAccountId[];759 normalizedOwner: TSubstrateAccount;760 raw: any761 } | null> {762 const collection = await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId]);763 const humanCollection = collection.toHuman(), collectionData = {764 id: collectionId, name: null, description: null, tokensCount: 0, admins: [],765 raw: humanCollection,766 } as any, jsonCollection = collection.toJSON();767 if (humanCollection === null) return null;768 collectionData.raw.limits = jsonCollection.limits;769 collectionData.raw.permissions = jsonCollection.permissions;770 collectionData.normalizedOwner = this.helper.address.normalizeSubstrate(collectionData.raw.owner);771 for (const key of ['name', 'description']) {772 collectionData[key] = this.helper.util.vec2str(humanCollection[key]);773 }774775 collectionData.tokensCount = (['RFT', 'NFT'].includes(humanCollection.mode))776 ? await this.helper[humanCollection.mode.toLocaleLowerCase() as 'nft' | 'rft'].getLastTokenId(collectionId)777 : 0;778 collectionData.admins = await this.getAdmins(collectionId);779780 return collectionData;781 }782783 /**784 * Get the addresses of the collection's administrators, optionally normalized.785 *786 * @param collectionId ID of collection787 * @param normalize whether to normalize the addresses to the default ss58 format788 * @example await getAdmins(1)789 * @returns array of administrators790 */791 async getAdmins(collectionId: number, normalize = false): Promise<CrossAccountId[]> {792 const admins = (await this.helper.callRpc('api.rpc.unique.adminlist', [collectionId])).toHuman();793794 return normalize795 ? admins.map((address: CrossAccountId) => address.withNormalizedSubstrate())796 : admins;797 }798799 /**800 * Get the addresses added to the collection allow-list, optionally normalized.801 * @param collectionId ID of collection802 * @param normalize whether to normalize the addresses to the default ss58 format803 * @example await getAllowList(1)804 * @returns array of allow-listed addresses805 */806 async getAllowList(collectionId: number, normalize = false): Promise<CrossAccountId[]> {807 const allowListed = (await this.helper.callRpc('api.rpc.unique.allowlist', [collectionId])).toHuman();808 return normalize809 ? allowListed.map((address: CrossAccountId) => address.withNormalizedSubstrate())810 : allowListed;811 }812813 /**814 * Get the effective limits of the collection instead of null for default values815 *816 * @param collectionId ID of collection817 * @example await getEffectiveLimits(2)818 * @returns object of collection limits819 */820 async getEffectiveLimits(collectionId: number): Promise<ICollectionLimits> {821 return (await this.helper.callRpc('api.rpc.unique.effectiveCollectionLimits', [collectionId])).toJSON();822 }823824 /**825 * Burns the collection if the signer has sufficient permissions and collection is empty.826 *827 * @param signer keyring of signer828 * @param collectionId ID of collection829 * @example await helper.collection.burn(aliceKeyring, 3);830 * @returns ```true``` if extrinsic success, otherwise ```false```831 */832 async burn(signer: TSigner, collectionId: number): Promise<boolean> {833 const result = await this.helper.executeExtrinsic(834 signer,835 'api.tx.unique.destroyCollection', [collectionId],836 true,837 );838839 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionDestroyed');840 }841842 /**843 * Sets the sponsor for the collection (Requires the Substrate address). Needs confirmation by the sponsor.844 *845 * @param signer keyring of signer846 * @param collectionId ID of collection847 * @param sponsorAddress Sponsor substrate address848 * @example setSponsor(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")849 * @returns ```true``` if extrinsic success, otherwise ```false```850 */851 async setSponsor(signer: TSigner, collectionId: number, sponsorAddress: TSubstrateAccount): Promise<boolean> {852 const result = await this.helper.executeExtrinsic(853 signer,854 'api.tx.unique.setCollectionSponsor', [collectionId, sponsorAddress],855 true,856 );857858 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorSet');859 }860861 /**862 * Confirms consent to sponsor the collection on behalf of the signer.863 *864 * @param signer keyring of signer865 * @param collectionId ID of collection866 * @example confirmSponsorship(aliceKeyring, 10)867 * @returns ```true``` if extrinsic success, otherwise ```false```868 */869 async confirmSponsorship(signer: TSigner, collectionId: number): Promise<boolean> {870 const result = await this.helper.executeExtrinsic(871 signer,872 'api.tx.unique.confirmSponsorship', [collectionId],873 true,874 );875876 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'SponsorshipConfirmed');877 }878879 /**880 * Removes the sponsor of a collection, regardless if it consented or not.881 *882 * @param signer keyring of signer883 * @param collectionId ID of collection884 * @example removeSponsor(aliceKeyring, 10)885 * @returns ```true``` if extrinsic success, otherwise ```false```886 */887 async removeSponsor(signer: TSigner, collectionId: number): Promise<boolean> {888 const result = await this.helper.executeExtrinsic(889 signer,890 'api.tx.unique.removeCollectionSponsor', [collectionId],891 true,892 );893894 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionSponsorRemoved');895 }896897 /**898 * Sets the limits of the collection. At least one limit must be specified for a correct call.899 *900 * @param signer keyring of signer901 * @param collectionId ID of collection902 * @param limits collection limits object903 * @example904 * await setLimits(905 * aliceKeyring,906 * 10,907 * {908 * sponsorTransferTimeout: 0,909 * ownerCanDestroy: false910 * }911 * )912 * @returns ```true``` if extrinsic success, otherwise ```false```913 */914 async setLimits(signer: TSigner, collectionId: number, limits: ICollectionLimits): Promise<boolean> {915 const result = await this.helper.executeExtrinsic(916 signer,917 'api.tx.unique.setCollectionLimits', [collectionId, limits],918 true,919 );920921 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionLimitSet');922 }923924 /**925 * Changes the owner of the collection to the new Substrate address.926 *927 * @param signer keyring of signer928 * @param collectionId ID of collection929 * @param ownerAddress substrate address of new owner930 * @example changeOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...")931 * @returns ```true``` if extrinsic success, otherwise ```false```932 */933 async changeOwner(signer: TSigner, collectionId: number, ownerAddress: TSubstrateAccount): Promise<boolean> {934 const result = await this.helper.executeExtrinsic(935 signer,936 'api.tx.unique.changeCollectionOwner', [collectionId, ownerAddress],937 true,938 );939940 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionOwnerChanged');941 }942943 /**944 * Adds a collection administrator.945 *946 * @param signer keyring of signer947 * @param collectionId ID of collection948 * @param adminAddressObj Administrator address (substrate or ethereum)949 * @example addAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})950 * @returns ```true``` if extrinsic success, otherwise ```false```951 */952 async addAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {953 const result = await this.helper.executeExtrinsic(954 signer,955 'api.tx.unique.addCollectionAdmin', [collectionId, adminAddressObj],956 true,957 );958959 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminAdded');960 }961962 /**963 * Removes a collection administrator.964 *965 * @param signer keyring of signer966 * @param collectionId ID of collection967 * @param adminAddressObj Administrator address (substrate or ethereum)968 * @example removeAdmin(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."})969 * @returns ```true``` if extrinsic success, otherwise ```false```970 */971 async removeAdmin(signer: TSigner, collectionId: number, adminAddressObj: ICrossAccountId): Promise<boolean> {972 const result = await this.helper.executeExtrinsic(973 signer,974 'api.tx.unique.removeCollectionAdmin', [collectionId, adminAddressObj],975 true,976 );977978 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionAdminRemoved');979 }980981 /**982 * Check if user is in allow list.983 *984 * @param collectionId ID of collection985 * @param user Account to check986 * @example await getAdmins(1)987 * @returns is user in allow list988 */989 async allowed(collectionId: number, user: ICrossAccountId): Promise<boolean> {990 return (await this.helper.callRpc('api.rpc.unique.allowed', [collectionId, user])).toJSON();991 }992993 /**994 * Adds an address to allow list995 * @param signer keyring of signer996 * @param collectionId ID of collection997 * @param addressObj address to add to the allow list998 * @returns ```true``` if extrinsic success, otherwise ```false```999 */1000 async addToAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1001 const result = await this.helper.executeExtrinsic(1002 signer,1003 'api.tx.unique.addToAllowList', [collectionId, addressObj],1004 true,1005 );10061007 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressAdded');1008 }10091010 /**1011 * Removes an address from allow list1012 *1013 * @param signer keyring of signer1014 * @param collectionId ID of collection1015 * @param addressObj address to remove from the allow list1016 * @returns ```true``` if extrinsic success, otherwise ```false```1017 */1018 async removeFromAllowList(signer: TSigner, collectionId: number, addressObj: ICrossAccountId): Promise<boolean> {1019 const result = await this.helper.executeExtrinsic(1020 signer,1021 'api.tx.unique.removeFromAllowList', [collectionId, addressObj],1022 true,1023 );10241025 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'AllowListAddressRemoved');1026 }10271028 /**1029 * Sets onchain permissions for selected collection.1030 *1031 * @param signer keyring of signer1032 * @param collectionId ID of collection1033 * @param permissions collection permissions object1034 * @example setPermissions(aliceKeyring, 10, {access:'AllowList', mintMode: true, nesting: {collectionAdmin: true, tokenOwner: true}});1035 * @returns ```true``` if extrinsic success, otherwise ```false```1036 */1037 async setPermissions(signer: TSigner, collectionId: number, permissions: ICollectionPermissions): Promise<boolean> {1038 const result = await this.helper.executeExtrinsic(1039 signer,1040 'api.tx.unique.setCollectionPermissions', [collectionId, permissions],1041 true,1042 );10431044 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPermissionSet');1045 }10461047 /**1048 * Enables nesting for selected collection. If `restricted` set, you can nest only tokens from specified collections.1049 *1050 * @param signer keyring of signer1051 * @param collectionId ID of collection1052 * @param permissions nesting permissions object1053 * @example enableNesting(aliceKeyring, 10, {collectionAdmin: true, tokenOwner: true});1054 * @returns ```true``` if extrinsic success, otherwise ```false```1055 */1056 async enableNesting(signer: TSigner, collectionId: number, permissions: INestingPermissions): Promise<boolean> {1057 return await this.setPermissions(signer, collectionId, {nesting: permissions});1058 }10591060 /**1061 * Disables nesting for selected collection.1062 *1063 * @param signer keyring of signer1064 * @param collectionId ID of collection1065 * @example disableNesting(aliceKeyring, 10);1066 * @returns ```true``` if extrinsic success, otherwise ```false```1067 */1068 async disableNesting(signer: TSigner, collectionId: number): Promise<boolean> {1069 return await this.setPermissions(signer, collectionId, {nesting: {tokenOwner: false, collectionAdmin: false}});1070 }10711072 /**1073 * Sets onchain properties to the collection.1074 *1075 * @param signer keyring of signer1076 * @param collectionId ID of collection1077 * @param properties array of property objects1078 * @example setProperties(aliceKeyring, 10, [{key: "gender", value: "male"}]);1079 * @returns ```true``` if extrinsic success, otherwise ```false```1080 */1081 async setProperties(signer: TSigner, collectionId: number, properties: IProperty[]): Promise<boolean> {1082 const result = await this.helper.executeExtrinsic(1083 signer,1084 'api.tx.unique.setCollectionProperties', [collectionId, properties],1085 true,1086 );10871088 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertySet');1089 }10901091 /**1092 * Get collection properties.1093 *1094 * @param collectionId ID of collection1095 * @param propertyKeys optionally filter the returned properties to only these keys1096 * @example getProperties(1219, ['location', 'date', 'time', 'isParadise']);1097 * @returns array of key-value pairs1098 */1099 async getProperties(collectionId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1100 return (await this.helper.callRpc('api.rpc.unique.collectionProperties', [collectionId, propertyKeys])).toHuman();1101 }11021103 async getPropertiesConsumedSpace(collectionId: number): Promise<number> {1104 const api = this.helper.getApi();1105 const props = (await api.query.common.collectionProperties(collectionId)).toJSON();11061107 return (props! as any).consumedSpace;1108 }11091110 async getCollectionOptions(collectionId: number) {1111 return (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1112 }11131114 /**1115 * Deletes onchain properties from the collection.1116 *1117 * @param signer keyring of signer1118 * @param collectionId ID of collection1119 * @param propertyKeys array of property keys to delete1120 * @example deleteProperties(aliceKeyring, 10, ["gender", "age"]);1121 * @returns ```true``` if extrinsic success, otherwise ```false```1122 */1123 async deleteProperties(signer: TSigner, collectionId: number, propertyKeys: string[]): Promise<boolean> {1124 const result = await this.helper.executeExtrinsic(1125 signer,1126 'api.tx.unique.deleteCollectionProperties', [collectionId, propertyKeys],1127 true,1128 );11291130 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'CollectionPropertyDeleted');1131 }11321133 /**1134 * Changes the owner of the token.1135 *1136 * @param signer keyring of signer1137 * @param collectionId ID of collection1138 * @param tokenId ID of token1139 * @param addressObj address of a new owner1140 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1141 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1142 * @returns true if the token success, otherwise false1143 */1144 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1145 const result = await this.helper.executeExtrinsic(1146 signer,1147 'api.tx.unique.transfer', [addressObj, collectionId, tokenId, amount],1148 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1149 );11501151 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, {Substrate: typeof signer === 'string' ? signer : signer.address}, addressObj, amount);1152 }11531154 /**1155 *1156 * Change ownership of a token(s) on behalf of the owner.1157 *1158 * @param signer keyring of signer1159 * @param collectionId ID of collection1160 * @param tokenId ID of token1161 * @param fromAddressObj address on behalf of which the token will be sent1162 * @param toAddressObj new token owner1163 * @param amount amount of tokens to be transfered. For NFT must be set to 1n1164 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg"}, {Ethereum: "0x9F0583DbB85..."})1165 * @returns true if the token success, otherwise false1166 */1167 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1168 const result = await this.helper.executeExtrinsic(1169 signer,1170 'api.tx.unique.transferFrom', [fromAddressObj, toAddressObj, collectionId, tokenId, amount],1171 true, // `Unable to transfer token #${tokenId} from collection #${collectionId}`,1172 );1173 return this.helper.util.isTokenTransferSuccess(result.result.events, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1174 }11751176 /**1177 *1178 * Destroys a concrete instance of NFT/RFT or burns a specified amount of fungible tokens.1179 *1180 * @param signer keyring of signer1181 * @param collectionId ID of collection1182 * @param tokenId ID of token1183 * @param amount amount of tokens to be burned. For NFT must be set to 1n1184 * @example burnToken(aliceKeyring, 10, 5);1185 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1186 */1187 async burnToken(signer: TSigner, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1188 const burnResult = await this.helper.executeExtrinsic(1189 signer,1190 'api.tx.unique.burnItem', [collectionId, tokenId, amount],1191 true, // `Unable to burn token for ${label}`,1192 );1193 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1194 if (burnedTokens.tokens.length > 1) throw Error('Burned multiple tokens');1195 return burnedTokens.success;1196 }11971198 /**1199 * Destroys a concrete instance of NFT on behalf of the owner1200 *1201 * @param signer keyring of signer1202 * @param collectionId ID of collection1203 * @param tokenId ID of token1204 * @param fromAddressObj address on behalf of which the token will be burnt1205 * @param amount amount of tokens to be burned. For NFT must be set to 1n1206 * @example burnTokenFrom(aliceKeyring, 10, {Substrate: "5DyN4Y92vZCjv38fg..."}, 5, {Ethereum: "0x9F0583DbB85..."})1207 * @returns ```true``` if extrinsic success, otherwise ```false```1208 */1209 async burnTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1210 const burnResult = await this.helper.executeExtrinsic(1211 signer,1212 'api.tx.unique.burnFrom', [collectionId, fromAddressObj, tokenId, amount],1213 true, // `Unable to burn token from for ${label}`,1214 );1215 const burnedTokens = this.helper.util.extractTokensFromBurnResult(burnResult);1216 return burnedTokens.success && burnedTokens.tokens.length > 0;1217 }12181219 /**1220 * Set, change, or remove approved address to transfer the ownership of the NFT.1221 *1222 * @param signer keyring of signer1223 * @param collectionId ID of collection1224 * @param tokenId ID of token1225 * @param toAddressObj Substrate or Ethereum address which gets approved use of the signer's tokens1226 * @param amount amount of token to be approved. For NFT must be set to 1n1227 * @returns ```true``` if extrinsic success, otherwise ```false```1228 */1229 async approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1230 const approveResult = await this.helper.executeExtrinsic(1231 signer,1232 'api.tx.unique.approve', [toAddressObj, collectionId, tokenId, amount],1233 true, // `Unable to approve token for ${label}`,1234 );12351236 return this.helper.util.findCollectionInEvents(approveResult.result.events, collectionId, 'common', 'Approved');1237 }12381239 /**1240 * Get the amount of token pieces approved to transfer or burn. Normally 0.1241 *1242 * @param collectionId ID of collection1243 * @param tokenId ID of token1244 * @param toAccountObj address which is approved to use token pieces1245 * @param fromAccountObj address which may have allowed the use of its owned tokens1246 * @example getTokenApprovedPieces(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5ERZNF88Mm7UGfPP3mdG..."})1247 * @returns number of approved to transfer pieces1248 */1249 async getTokenApprovedPieces(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId, fromAccountObj: ICrossAccountId): Promise<bigint> {1250 return (await this.helper.callRpc('api.rpc.unique.allowance', [collectionId, fromAccountObj, toAccountObj, tokenId])).toBigInt();1251 }12521253 /**1254 * Get the last created token ID in a collection1255 *1256 * @param collectionId ID of collection1257 * @example getLastTokenId(10);1258 * @returns id of the last created token1259 */1260 async getLastTokenId(collectionId: number): Promise<number> {1261 return (await this.helper.callRpc('api.rpc.unique.lastTokenId', [collectionId])).toNumber();1262 }12631264 /**1265 * Check if token exists1266 *1267 * @param collectionId ID of collection1268 * @param tokenId ID of token1269 * @example doesTokenExist(10, 20);1270 * @returns true if the token exists, otherwise false1271 */1272 async doesTokenExist(collectionId: number, tokenId: number): Promise<boolean> {1273 return (await this.helper.callRpc('api.rpc.unique.tokenExists', [collectionId, tokenId])).toJSON();1274 }1275}12761277class NFTnRFT extends CollectionGroup {1278 /**1279 * Get tokens owned by account1280 *1281 * @param collectionId ID of collection1282 * @param addressObj tokens owner1283 * @example getTokensByAddress(10, {Substrate: "5DyN4Y92vZCjv38fg..."})1284 * @returns array of token ids owned by account1285 */1286 async getTokensByAddress(collectionId: number, addressObj: ICrossAccountId): Promise<number[]> {1287 return (await this.helper.callRpc('api.rpc.unique.accountTokens', [collectionId, addressObj])).toJSON();1288 }12891290 /**1291 * Get token data1292 *1293 * @param collectionId ID of collection1294 * @param tokenId ID of token1295 * @param propertyKeys optionally filter the token properties to only these keys1296 * @param blockHashAt optionally query the data at some block with this hash1297 * @example getToken(10, 5);1298 * @returns human readable token data1299 */1300 async getToken(collectionId: number, tokenId: number, propertyKeys: string[] = [], blockHashAt?: string): Promise<{1301 properties: IProperty[];1302 owner: CrossAccountId;1303 normalizedOwner: CrossAccountId;1304 }| null> {1305 let tokenData;1306 if(typeof blockHashAt === 'undefined') {1307 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId]);1308 }1309 else {1310 if(propertyKeys.length == 0) {1311 const collection = (await this.helper.callRpc('api.rpc.unique.collectionById', [collectionId])).toHuman();1312 if(!collection) return null;1313 propertyKeys = collection.tokenPropertyPermissions.map((x: ITokenPropertyPermission) => x.key);1314 }1315 tokenData = await this.helper.callRpc('api.rpc.unique.tokenData', [collectionId, tokenId, propertyKeys, blockHashAt]);1316 }1317 tokenData = tokenData.toHuman();1318 if (tokenData === null || tokenData.owner === null) return null;1319 const owner = {} as any;1320 for (const key of Object.keys(tokenData.owner)) {1321 owner[key.toLocaleLowerCase()] = key.toLocaleLowerCase() == 'substrate'1322 ? CrossAccountId.normalizeSubstrateAddress(tokenData.owner[key])1323 : tokenData.owner[key];1324 }1325 tokenData.normalizedOwner = CrossAccountId.fromLowerCaseKeys(owner);1326 return tokenData;1327 }13281329 /**1330 * Set permissions to change token properties1331 *1332 * @param signer keyring of signer1333 * @param collectionId ID of collection1334 * @param permissions permissions to change a property by the collection admin or token owner1335 * @example setTokenPropertyPermissions(1336 * aliceKeyring, 10, [{key: "gender", permission: {tokenOwner: true, mutable: true, collectionAdmin: true}}]1337 * )1338 * @returns true if extrinsic success otherwise false1339 */1340 async setTokenPropertyPermissions(signer: TSigner, collectionId: number, permissions: ITokenPropertyPermission[]): Promise<boolean> {1341 const result = await this.helper.executeExtrinsic(1342 signer,1343 'api.tx.unique.setTokenPropertyPermissions', [collectionId, permissions],1344 true,1345 );13461347 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'PropertyPermissionSet');1348 }13491350 /**1351 * Get token property permissions.1352 *1353 * @param collectionId ID of collection1354 * @param propertyKeys optionally filter the returned property permissions to only these keys1355 * @example getPropertyPermissions(1219, ['location', 'date', 'time', 'isParadise']);1356 * @returns array of key-permission pairs1357 */1358 async getPropertyPermissions(collectionId: number, propertyKeys: string[] | null = null): Promise<ITokenPropertyPermission[]> {1359 return (await this.helper.callRpc('api.rpc.unique.propertyPermissions', [collectionId, ...(propertyKeys === null ? [] : [propertyKeys])])).toHuman();1360 }13611362 /**1363 * Set token properties1364 *1365 * @param signer keyring of signer1366 * @param collectionId ID of collection1367 * @param tokenId ID of token1368 * @param properties key-value pairs of metadata which to add to a token. Keys must be permitted in the collection1369 * @example setTokenProperties(aliceKeyring, 10, 5, [{key: "gender", value: "female"}, {key: "age", value: "23"}])1370 * @returns ```true``` if extrinsic success, otherwise ```false```1371 */1372 async setTokenProperties(signer: TSigner, collectionId: number, tokenId: number, properties: IProperty[]): Promise<boolean> {1373 const result = await this.helper.executeExtrinsic(1374 signer,1375 'api.tx.unique.setTokenProperties', [collectionId, tokenId, properties],1376 true,1377 );13781379 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertySet');1380 }13811382 /**1383 * Get properties, metadata assigned to a token.1384 *1385 * @param collectionId ID of collection1386 * @param tokenId ID of token1387 * @param propertyKeys optionally filter the returned properties to only these keys1388 * @example getTokenProperties(1219, ['location', 'date', 'time', 'isParadise']);1389 * @returns array of key-value pairs1390 */1391 async getTokenProperties(collectionId: number, tokenId: number, propertyKeys?: string[] | null): Promise<IProperty[]> {1392 return (await this.helper.callRpc('api.rpc.unique.tokenProperties', [collectionId, tokenId, propertyKeys])).toHuman();1393 }13941395 /**1396 * Delete the provided properties of a token1397 * @param signer keyring of signer1398 * @param collectionId ID of collection1399 * @param tokenId ID of token1400 * @param propertyKeys property keys to be deleted1401 * @example deleteTokenProperties(aliceKeyring, 10, 5, ["gender", "age"])1402 * @returns ```true``` if extrinsic success, otherwise ```false```1403 */1404 async deleteTokenProperties(signer: TSigner, collectionId: number, tokenId: number, propertyKeys: string[]): Promise<boolean> {1405 const result = await this.helper.executeExtrinsic(1406 signer,1407 'api.tx.unique.deleteTokenProperties', [collectionId, tokenId, propertyKeys],1408 true,1409 );14101411 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'TokenPropertyDeleted');1412 }14131414 /**1415 * Mint new collection1416 *1417 * @param signer keyring of signer1418 * @param collectionOptions basic collection options and properties1419 * @param mode NFT or RFT type of a collection1420 * @example mintCollection(aliceKeyring, {name: 'New', description: "New collection", tokenPrefix: "NEW"}, "NFT")1421 * @returns object of the created collection1422 */1423 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions, mode: 'NFT' | 'RFT'): Promise<UniqueBaseCollection> {1424 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1425 collectionOptions.mode = (mode === 'NFT') ? {nft: null} : {refungible: null};1426 for (const key of ['name', 'description', 'tokenPrefix']) {1427 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1428 }1429 const creationResult = await this.helper.executeExtrinsic(1430 signer,1431 'api.tx.unique.createCollectionEx', [collectionOptions],1432 true, // errorLabel,1433 );1434 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));1435 }14361437 getCollectionObject(_collectionId: number): any {1438 return null;1439 }14401441 getTokenObject(_collectionId: number, _tokenId: number): any {1442 return null;1443 }14441445 /**1446 * Tells whether the given `owner` approves the `operator`.1447 * @param collectionId ID of collection1448 * @param owner owner address1449 * @param operator operator addrees1450 * @returns true if operator is enabled1451 */1452 async allowanceForAll(collectionId: number, owner: ICrossAccountId, operator: ICrossAccountId): Promise<boolean> {1453 return (await this.helper.callRpc('api.rpc.unique.allowanceForAll', [collectionId, owner, operator])).toJSON();1454 }14551456 /** Sets or unsets the approval of a given operator.1457 * The `operator` is allowed to transfer all tokens of the `caller` on their behalf.1458 * @param operator Operator1459 * @param approved Should operator status be granted or revoked?1460 * @returns ```true``` if extrinsic success, otherwise ```false```1461 */1462 async setAllowanceForAll(signer: TSigner, collectionId: number, operator: ICrossAccountId, approved: boolean): Promise<boolean> {1463 const result = await this.helper.executeExtrinsic(1464 signer,1465 'api.tx.unique.setAllowanceForAll', [collectionId, operator, approved],1466 true,1467 );1468 return this.helper.util.findCollectionInEvents(result.result.events, collectionId, 'common', 'ApprovedForAll');1469 }1470}147114721473class NFTGroup extends NFTnRFT {1474 /**1475 * Get collection object1476 * @param collectionId ID of collection1477 * @example getCollectionObject(2);1478 * @returns instance of UniqueNFTCollection1479 */1480 getCollectionObject(collectionId: number): UniqueNFTCollection {1481 return new UniqueNFTCollection(collectionId, this.helper);1482 }14831484 /**1485 * Get token object1486 * @param collectionId ID of collection1487 * @param tokenId ID of token1488 * @example getTokenObject(10, 5);1489 * @returns instance of UniqueNFTToken1490 */1491 getTokenObject(collectionId: number, tokenId: number): UniqueNFToken {1492 return new UniqueNFToken(tokenId, this.getCollectionObject(collectionId));1493 }14941495 /**1496 * Get token's owner1497 * @param collectionId ID of collection1498 * @param tokenId ID of token1499 * @param blockHashAt optionally query the data at the block with this hash1500 * @example getTokenOwner(10, 5);1501 * @returns Address in CrossAccountId format, e.g. {Substrate: "5DnSF6RRjwteE3BrCj..."}1502 */1503 async getTokenOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId> {1504 let owner;1505 if (typeof blockHashAt === 'undefined') {1506 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId]);1507 } else {1508 owner = await this.helper.callRpc('api.rpc.unique.tokenOwner', [collectionId, tokenId, blockHashAt]);1509 }1510 return CrossAccountId.fromLowerCaseKeys(owner.toJSON());1511 }15121513 /**1514 * Is token approved to transfer1515 * @param collectionId ID of collection1516 * @param tokenId ID of token1517 * @param toAccountObj address to be approved1518 * @returns ```true``` if extrinsic success, otherwise ```false```1519 */1520 async isTokenApproved(collectionId: number, tokenId: number, toAccountObj: ICrossAccountId): Promise<boolean> {1521 return (await this.getTokenApprovedPieces(collectionId, tokenId, toAccountObj, await this.getTokenOwner(collectionId, tokenId))) === 1n;1522 }15231524 /**1525 * Changes the owner of the token.1526 *1527 * @param signer keyring of signer1528 * @param collectionId ID of collection1529 * @param tokenId ID of token1530 * @param addressObj address of a new owner1531 * @example transferToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1532 * @returns ```true``` if extrinsic success, otherwise ```false```1533 */1534 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<boolean> {1535 return await super.transferToken(signer, collectionId, tokenId, addressObj, 1n);1536 }15371538 /**1539 *1540 * Change ownership of a NFT on behalf of the owner.1541 *1542 * @param signer keyring of signer1543 * @param collectionId ID of collection1544 * @param tokenId ID of token1545 * @param fromAddressObj address on behalf of which the token will be sent1546 * @param toAddressObj new token owner1547 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Ethereum: "0x9F0583DbB85..."})1548 * @returns ```true``` if extrinsic success, otherwise ```false```1549 */1550 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId): Promise<boolean> {1551 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, 1n);1552 }15531554 /**1555 * Recursively find the address that owns the token1556 * @param collectionId ID of collection1557 * @param tokenId ID of token1558 * @param blockHashAt1559 * @example getTokenTopmostOwner(10, 5);1560 * @returns address in CrossAccountId format, e.g. {Substrate: "5DyN4Y92vZCjv38fg..."}1561 */1562 async getTokenTopmostOwner(collectionId: number, tokenId: number, blockHashAt?: string): Promise<CrossAccountId | null> {1563 let owner;1564 if (typeof blockHashAt === 'undefined') {1565 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId]);1566 } else {1567 owner = await this.helper.callRpc('api.rpc.unique.topmostTokenOwner', [collectionId, tokenId, blockHashAt]);1568 }15691570 if (owner === null) return null;15711572 return owner.toHuman();1573 }15741575 /**1576 * Get tokens nested in the provided token1577 * @param collectionId ID of collection1578 * @param tokenId ID of token1579 * @param blockHashAt optionally query the data at the block with this hash1580 * @example getTokenChildren(10, 5);1581 * @returns tokens whose depth of nesting is <= 51582 */1583 async getTokenChildren(collectionId: number, tokenId: number, blockHashAt?: string): Promise<IToken[]> {1584 let children;1585 if(typeof blockHashAt === 'undefined') {1586 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId]);1587 } else {1588 children = await this.helper.callRpc('api.rpc.unique.tokenChildren', [collectionId, tokenId, blockHashAt]);1589 }15901591 return children.toJSON().map((x: any) => {1592 return {collectionId: x.collection, tokenId: x.token};1593 });1594 }15951596 /**1597 * Nest one token into another1598 * @param signer keyring of signer1599 * @param tokenObj token to be nested1600 * @param rootTokenObj token to be parent1601 * @example nestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4});1602 * @returns ```true``` if extrinsic success, otherwise ```false```1603 */1604 async nestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken): Promise<boolean> {1605 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1606 const result = await this.transferToken(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress);1607 if(!result) {1608 throw Error('Unable to nest token!');1609 }1610 return result;1611 }16121613 /**1614 * Remove token from nested state1615 * @param signer keyring of signer1616 * @param tokenObj token to unnest1617 * @param rootTokenObj parent of a token1618 * @param toAddressObj address of a new token owner1619 * @example unnestToken(aliceKeyring, {collectionId: 10, tokenId: 5}, {collectionId: 10, tokenId: 4}, {Substrate: "5DyN4Y92vZCjv38fg..."});1620 * @returns ```true``` if extrinsic success, otherwise ```false```1621 */1622 async unnestToken(signer: TSigner, tokenObj: IToken, rootTokenObj: IToken, toAddressObj: ICrossAccountId): Promise<boolean> {1623 const rootTokenAddress = this.helper.util.getTokenAccount(rootTokenObj);1624 const result = await this.transferTokenFrom(signer, tokenObj.collectionId, tokenObj.tokenId, rootTokenAddress, toAddressObj);1625 if(!result) {1626 throw Error('Unable to unnest token!');1627 }1628 return result;1629 }16301631 /**1632 * Mint new collection1633 * @param signer keyring of signer1634 * @param collectionOptions Collection options1635 * @example1636 * mintCollection(aliceKeyring, {1637 * name: 'New',1638 * description: 'New collection',1639 * tokenPrefix: 'NEW',1640 * })1641 * @returns object of the created collection1642 */1643 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueNFTCollection> {1644 return await super.mintCollection(signer, collectionOptions, 'NFT') as UniqueNFTCollection;1645 }16461647 /**1648 * Mint new token1649 * @param signer keyring of signer1650 * @param data token data1651 * @returns created token object1652 */1653 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; properties?: IProperty[]; }): Promise<UniqueNFToken> {1654 const creationResult = await this.helper.executeExtrinsic(1655 signer,1656 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1657 nft: {1658 properties: data.properties,1659 },1660 }],1661 true,1662 );1663 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1664 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1665 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1666 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1667 }16681669 /**1670 * Mint multiple NFT tokens1671 * @param signer keyring of signer1672 * @param collectionId ID of collection1673 * @param tokens array of tokens with owner and properties1674 * @example1675 * mintMultipleTokens(aliceKeyring, 10, [{1676 * owner: {Substrate: "5DyN4Y92vZCjv38fg..."},1677 * properties: [{key: "gender", value: "male"},{key: "age", value: "45"}],1678 * },{1679 * owner: {Ethereum: "0x9F0583DbB855d..."},1680 * properties: [{key: "gender", value: "female"},{key: "age", value: "22"}],1681 * }]);1682 * @returns ```true``` if extrinsic success, otherwise ```false```1683 */1684 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1685 const creationResult = await this.helper.executeExtrinsic(1686 signer,1687 'api.tx.unique.createMultipleItemsEx', [collectionId, {NFT: tokens}],1688 true,1689 );1690 const collection = this.getCollectionObject(collectionId);1691 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1692 }16931694 /**1695 * Mint multiple NFT tokens with one owner1696 * @param signer keyring of signer1697 * @param collectionId ID of collection1698 * @param owner tokens owner1699 * @param tokens array of tokens with owner and properties1700 * @example1701 * mintMultipleTokensWithOneOwner(aliceKeyring, 10, "5DyN4Y92vZCjv38fg...", [{1702 * properties: [{1703 * key: "gender",1704 * value: "female",1705 * },{1706 * key: "age",1707 * value: "33",1708 * }],1709 * }]);1710 * @returns array of newly created tokens1711 */1712 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {properties?: IProperty[]}[]): Promise<UniqueNFToken[]> {1713 const rawTokens = [];1714 for (const token of tokens) {1715 const raw = {NFT: {properties: token.properties}};1716 rawTokens.push(raw);1717 }1718 const creationResult = await this.helper.executeExtrinsic(1719 signer,1720 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1721 true,1722 );1723 const collection = this.getCollectionObject(collectionId);1724 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1725 }17261727 /**1728 * Set, change, or remove approved address to transfer the ownership of the NFT.1729 *1730 * @param signer keyring of signer1731 * @param collectionId ID of collection1732 * @param tokenId ID of token1733 * @param toAddressObj address to approve1734 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."})1735 * @returns ```true``` if extrinsic success, otherwise ```false```1736 */1737 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId) {1738 return super.approveToken(signer, collectionId, tokenId, toAddressObj, 1n);1739 }1740}174117421743class RFTGroup extends NFTnRFT {1744 /**1745 * Get collection object1746 * @param collectionId ID of collection1747 * @example getCollectionObject(2);1748 * @returns instance of UniqueRFTCollection1749 */1750 getCollectionObject(collectionId: number): UniqueRFTCollection {1751 return new UniqueRFTCollection(collectionId, this.helper);1752 }17531754 /**1755 * Get token object1756 * @param collectionId ID of collection1757 * @param tokenId ID of token1758 * @example getTokenObject(10, 5);1759 * @returns instance of UniqueNFTToken1760 */1761 getTokenObject(collectionId: number, tokenId: number): UniqueRFToken {1762 return new UniqueRFToken(tokenId, this.getCollectionObject(collectionId));1763 }17641765 /**1766 * Get top 10 token owners with the largest number of pieces1767 * @param collectionId ID of collection1768 * @param tokenId ID of token1769 * @example getTokenTop10Owners(10, 5);1770 * @returns array of top 10 owners1771 */1772 async getTokenTop10Owners(collectionId: number, tokenId: number): Promise<CrossAccountId[]> {1773 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, tokenId])).toJSON().map(CrossAccountId.fromLowerCaseKeys);1774 }17751776 /**1777 * Get number of pieces owned by address1778 * @param collectionId ID of collection1779 * @param tokenId ID of token1780 * @param addressObj address token owner1781 * @example getTokenBalance(10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."});1782 * @returns number of pieces ownerd by address1783 */1784 async getTokenBalance(collectionId: number, tokenId: number, addressObj: ICrossAccountId): Promise<bigint> {1785 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, tokenId])).toBigInt();1786 }17871788 /**1789 * Transfer pieces of token to another address1790 * @param signer keyring of signer1791 * @param collectionId ID of collection1792 * @param tokenId ID of token1793 * @param addressObj address of a new owner1794 * @param amount number of pieces to be transfered1795 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2000n)1796 * @returns ```true``` if extrinsic success, otherwise ```false```1797 */1798 async transferToken(signer: TSigner, collectionId: number, tokenId: number, addressObj: ICrossAccountId, amount=1n): Promise<boolean> {1799 return await super.transferToken(signer, collectionId, tokenId, addressObj, amount);1800 }18011802 /**1803 * Change ownership of some pieces of RFT on behalf of the owner.1804 * @param signer keyring of signer1805 * @param collectionId ID of collection1806 * @param tokenId ID of token1807 * @param fromAddressObj address on behalf of which the token will be sent1808 * @param toAddressObj new token owner1809 * @param amount number of pieces to be transfered1810 * @example transferTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, {Substrate: "5DfhbVfww7ThF8q6f3i..."}, 2000n)1811 * @returns ```true``` if extrinsic success, otherwise ```false```1812 */1813 async transferTokenFrom(signer: TSigner, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1814 return await super.transferTokenFrom(signer, collectionId, tokenId, fromAddressObj, toAddressObj, amount);1815 }18161817 /**1818 * Mint new collection1819 * @param signer keyring of signer1820 * @param collectionOptions Collection options1821 * @example1822 * mintCollection(aliceKeyring, {1823 * name: 'New',1824 * description: 'New collection',1825 * tokenPrefix: 'NEW',1826 * })1827 * @returns object of the created collection1828 */1829 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}): Promise<UniqueRFTCollection> {1830 return await super.mintCollection(signer, collectionOptions, 'RFT') as UniqueRFTCollection;1831 }18321833 /**1834 * Mint new token1835 * @param signer keyring of signer1836 * @param data token data1837 * @example mintToken(aliceKeyring, {collectionId: 10, owner: {Substrate: '5GHoZe9c73RYbVzq...'}, pieces: 10000n});1838 * @returns created token object1839 */1840 async mintToken(signer: TSigner, data: { collectionId: number; owner: ICrossAccountId | string; pieces: bigint; properties?: IProperty[]; }): Promise<UniqueRFToken> {1841 const creationResult = await this.helper.executeExtrinsic(1842 signer,1843 'api.tx.unique.createItem', [data.collectionId, (typeof data.owner === 'string') ? {Substrate: data.owner} : data.owner, {1844 refungible: {1845 pieces: data.pieces,1846 properties: data.properties,1847 },1848 }],1849 true,1850 );1851 const createdTokens = this.helper.util.extractTokensFromCreationResult(creationResult);1852 if (createdTokens.tokens.length > 1) throw Error('Minted multiple tokens');1853 if (createdTokens.tokens.length < 1) throw Error('No tokens minted');1854 return this.getTokenObject(data.collectionId, createdTokens.tokens[0].tokenId);1855 }18561857 async mintMultipleTokens(signer: TSigner, collectionId: number, tokens: {owner: ICrossAccountId, pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1858 throw Error('Not implemented');1859 const creationResult = await this.helper.executeExtrinsic(1860 signer,1861 'api.tx.unique.createMultipleItemsEx', [collectionId, {RefungibleMultipleOwners: tokens}],1862 true, // `Unable to mint RFT tokens for ${label}`,1863 );1864 const collection = this.getCollectionObject(collectionId);1865 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1866 }18671868 /**1869 * Mint multiple RFT tokens with one owner1870 * @param signer keyring of signer1871 * @param collectionId ID of collection1872 * @param owner tokens owner1873 * @param tokens array of tokens with properties and pieces1874 * @example mintMultipleTokensWithOneOwner(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, [{pieces: 100000n, properties: [{key: "gender", value: "male"}]}]);1875 * @returns array of newly created RFT tokens1876 */1877 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, owner: ICrossAccountId, tokens: {pieces: bigint, properties?: IProperty[]}[]): Promise<UniqueRFToken[]> {1878 const rawTokens = [];1879 for (const token of tokens) {1880 const raw = {ReFungible: {pieces: token.pieces, properties: token.properties}};1881 rawTokens.push(raw);1882 }1883 const creationResult = await this.helper.executeExtrinsic(1884 signer,1885 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],1886 true,1887 );1888 const collection = this.getCollectionObject(collectionId);1889 return this.helper.util.extractTokensFromCreationResult(creationResult).tokens.map((x: IToken) => collection.getTokenObject(x.tokenId));1890 }18911892 /**1893 * Destroys a concrete instance of RFT.1894 * @param signer keyring of signer1895 * @param collectionId ID of collection1896 * @param tokenId ID of token1897 * @param amount number of pieces to be burnt1898 * @example burnToken(aliceKeyring, 10, 5);1899 * @returns ```true``` if the extrinsic is successful, otherwise ```false```1900 */1901 async burnToken(signer: IKeyringPair, collectionId: number, tokenId: number, amount=1n): Promise<boolean> {1902 return await super.burnToken(signer, collectionId, tokenId, amount);1903 }19041905 /**1906 * Destroys a concrete instance of RFT on behalf of the owner.1907 * @param signer keyring of signer1908 * @param collectionId ID of collection1909 * @param tokenId ID of token1910 * @param fromAddressObj address on behalf of which the token will be burnt1911 * @param amount number of pieces to be burnt1912 * @example burnTokenFrom(aliceKeyring, 10, 5, {Substrate: "5DyN4Y92vZCjv38fg..."}, 2n)1913 * @returns ```true``` if extrinsic success, otherwise ```false```1914 */1915 async burnTokenFrom(signer: IKeyringPair, collectionId: number, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {1916 return await super.burnTokenFrom(signer, collectionId, tokenId, fromAddressObj, amount);1917 }19181919 /**1920 * Set, change, or remove approved address to transfer the ownership of the RFT.1921 *1922 * @param signer keyring of signer1923 * @param collectionId ID of collection1924 * @param tokenId ID of token1925 * @param toAddressObj address to approve1926 * @param amount number of pieces to be approved1927 * @example approveToken(aliceKeyring, 10, 5, {Substrate: "5GHoZe9c73RYbVzq..."}, "", 10000n);1928 * @returns true if the token success, otherwise false1929 */1930 approveToken(signer: IKeyringPair, collectionId: number, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {1931 return super.approveToken(signer, collectionId, tokenId, toAddressObj, amount);1932 }19331934 /**1935 * Get total number of pieces1936 * @param collectionId ID of collection1937 * @param tokenId ID of token1938 * @example getTokenTotalPieces(10, 5);1939 * @returns number of pieces1940 */1941 async getTokenTotalPieces(collectionId: number, tokenId: number): Promise<bigint> {1942 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, tokenId])).unwrap().toBigInt();1943 }19441945 /**1946 * Change number of token pieces. Signer must be the owner of all token pieces.1947 * @param signer keyring of signer1948 * @param collectionId ID of collection1949 * @param tokenId ID of token1950 * @param amount new number of pieces1951 * @example repartitionToken(aliceKeyring, 10, 5, 12345n);1952 * @returns true if the repartion was success, otherwise false1953 */1954 async repartitionToken(signer: TSigner, collectionId: number, tokenId: number, amount: bigint): Promise<boolean> {1955 const currentAmount = await this.getTokenTotalPieces(collectionId, tokenId);1956 const repartitionResult = await this.helper.executeExtrinsic(1957 signer,1958 'api.tx.unique.repartition', [collectionId, tokenId, amount],1959 true,1960 );1961 if(currentAmount < amount) return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemCreated');1962 return this.helper.util.findCollectionInEvents(repartitionResult.result.events, collectionId, 'common', 'ItemDestroyed');1963 }1964}196519661967class FTGroup extends CollectionGroup {1968 /**1969 * Get collection object1970 * @param collectionId ID of collection1971 * @example getCollectionObject(2);1972 * @returns instance of UniqueFTCollection1973 */1974 getCollectionObject(collectionId: number): UniqueFTCollection {1975 return new UniqueFTCollection(collectionId, this.helper);1976 }19771978 /**1979 * Mint new fungible collection1980 * @param signer keyring of signer1981 * @param collectionOptions Collection options1982 * @param decimalPoints number of token decimals1983 * @example1984 * mintCollection(aliceKeyring, {1985 * name: 'New',1986 * description: 'New collection',1987 * tokenPrefix: 'NEW',1988 * }, 18)1989 * @returns newly created fungible collection1990 */1991 async mintCollection(signer: TSigner, collectionOptions: ICollectionCreationOptions = {}, decimalPoints = 0): Promise<UniqueFTCollection> {1992 collectionOptions = JSON.parse(JSON.stringify(collectionOptions)) as ICollectionCreationOptions; // Clone object1993 if(collectionOptions.tokenPropertyPermissions) throw Error('Fungible collections has no tokenPropertyPermissions');1994 collectionOptions.mode = {fungible: decimalPoints};1995 for (const key of ['name', 'description', 'tokenPrefix']) {1996 if (typeof collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] === 'string') collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] = this.helper.util.str2vec(collectionOptions[key as 'name' | 'description' | 'tokenPrefix'] as string);1997 }1998 const creationResult = await this.helper.executeExtrinsic(1999 signer,2000 'api.tx.unique.createCollectionEx', [collectionOptions],2001 true,2002 );2003 return this.getCollectionObject(this.helper.util.extractCollectionIdFromCreationResult(creationResult));2004 }20052006 /**2007 * Mint tokens2008 * @param signer keyring of signer2009 * @param collectionId ID of collection2010 * @param owner address owner of new tokens2011 * @param amount amount of tokens to be meanted2012 * @example mintTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq"}, 1000n);2013 * @returns ```true``` if extrinsic success, otherwise ```false```2014 */2015 async mintTokens(signer: TSigner, collectionId: number, amount: bigint, owner: ICrossAccountId | string): Promise<boolean> {2016 const creationResult = await this.helper.executeExtrinsic(2017 signer,2018 'api.tx.unique.createItem', [collectionId, (typeof owner === 'string') ? {Substrate: owner} : owner, {2019 fungible: {2020 value: amount,2021 },2022 }],2023 true, // `Unable to mint fungible tokens for ${label}`,2024 );2025 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2026 }20272028 /**2029 * Mint multiple Fungible tokens with one owner2030 * @param signer keyring of signer2031 * @param collectionId ID of collection2032 * @param owner tokens owner2033 * @param tokens array of tokens with properties and pieces2034 * @returns ```true``` if extrinsic success, otherwise ```false```2035 */2036 async mintMultipleTokensWithOneOwner(signer: TSigner, collectionId: number, tokens: {value: bigint}[], owner: ICrossAccountId): Promise<boolean> {2037 const rawTokens = [];2038 for (const token of tokens) {2039 const raw = {Fungible: {Value: token.value}};2040 rawTokens.push(raw);2041 }2042 const creationResult = await this.helper.executeExtrinsic(2043 signer,2044 'api.tx.unique.createMultipleItems', [collectionId, owner, rawTokens],2045 true,2046 );2047 return this.helper.util.findCollectionInEvents(creationResult.result.events, collectionId, 'common', 'ItemCreated');2048 }20492050 /**2051 * Get the top 10 owners with the largest balance for the Fungible collection2052 * @param collectionId ID of collection2053 * @example getTop10Owners(10);2054 * @returns array of ```ICrossAccountId```2055 */2056 async getTop10Owners(collectionId: number): Promise<CrossAccountId[]> {2057 return (await this.helper.callRpc('api.rpc.unique.tokenOwners', [collectionId, 0])).toJSON().map(CrossAccountId.fromLowerCaseKeys);2058 }20592060 /**2061 * Get account balance2062 * @param collectionId ID of collection2063 * @param addressObj address of owner2064 * @example getBalance(10, {Substrate: "5GHoZe9c73RYbVzq..."})2065 * @returns amount of fungible tokens owned by address2066 */2067 async getBalance(collectionId: number, addressObj: ICrossAccountId): Promise<bigint> {2068 return (await this.helper.callRpc('api.rpc.unique.balance', [collectionId, addressObj, 0])).toBigInt();2069 }20702071 /**2072 * Transfer tokens to address2073 * @param signer keyring of signer2074 * @param collectionId ID of collection2075 * @param toAddressObj address recipient2076 * @param amount amount of tokens to be sent2077 * @example transfer(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2078 * @returns ```true``` if extrinsic success, otherwise ```false```2079 */2080 async transfer(signer: TSigner, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2081 return await super.transferToken(signer, collectionId, 0, toAddressObj, amount);2082 }20832084 /**2085 * Transfer some tokens on behalf of the owner.2086 * @param signer keyring of signer2087 * @param collectionId ID of collection2088 * @param fromAddressObj address on behalf of which tokens will be sent2089 * @param toAddressObj address where token to be sent2090 * @param amount number of tokens to be sent2091 * @example transferFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, {Substrate: "5DfhbVfww7ThF8q6f3ij..."}, 10000n);2092 * @returns ```true``` if extrinsic success, otherwise ```false```2093 */2094 async transferFrom(signer: TSigner, collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {2095 return await super.transferTokenFrom(signer, collectionId, 0, fromAddressObj, toAddressObj, amount);2096 }20972098 /**2099 * Destroy some amount of tokens2100 * @param signer keyring of signer2101 * @param collectionId ID of collection2102 * @param amount amount of tokens to be destroyed2103 * @example burnTokens(aliceKeyring, 10, 1000n);2104 * @returns ```true``` if extrinsic success, otherwise ```false```2105 */2106 async burnTokens(signer: IKeyringPair, collectionId: number, amount=1n): Promise<boolean> {2107 return await super.burnToken(signer, collectionId, 0, amount);2108 }21092110 /**2111 * Burn some tokens on behalf of the owner.2112 * @param signer keyring of signer2113 * @param collectionId ID of collection2114 * @param fromAddressObj address on behalf of which tokens will be burnt2115 * @param amount amount of tokens to be burnt2116 * @example burnTokensFrom(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n);2117 * @returns ```true``` if extrinsic success, otherwise ```false```2118 */2119 async burnTokensFrom(signer: IKeyringPair, collectionId: number, fromAddressObj: ICrossAccountId, amount=1n): Promise<boolean> {2120 return await super.burnTokenFrom(signer, collectionId, 0, fromAddressObj, amount);2121 }21222123 /**2124 * Get total collection supply2125 * @param collectionId2126 * @returns2127 */2128 async getTotalPieces(collectionId: number): Promise<bigint> {2129 return (await this.helper.callRpc('api.rpc.unique.totalPieces', [collectionId, 0])).unwrap().toBigInt();2130 }21312132 /**2133 * Set, change, or remove approved address to transfer tokens.2134 *2135 * @param signer keyring of signer2136 * @param collectionId ID of collection2137 * @param toAddressObj address to be approved2138 * @param amount amount of tokens to be approved2139 * @example approveTokens(aliceKeyring, 10, {Substrate: "5GHoZe9c73RYbVzq..."}, 1000n)2140 * @returns ```true``` if extrinsic success, otherwise ```false```2141 */2142 approveTokens(signer: IKeyringPair, collectionId: number, toAddressObj: ICrossAccountId, amount=1n) {2143 return super.approveToken(signer, collectionId, 0, toAddressObj, amount);2144 }21452146 /**2147 * Get amount of fungible tokens approved to transfer2148 * @param collectionId ID of collection2149 * @param fromAddressObj owner of tokens2150 * @param toAddressObj the address approved for the transfer of tokens on behalf of the owner2151 * @returns number of tokens approved for the transfer2152 */2153 getApprovedTokens(collectionId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {2154 return super.getTokenApprovedPieces(collectionId, 0, toAddressObj, fromAddressObj);2155 }2156}215721582159class ChainGroup extends HelperGroup<ChainHelperBase> {2160 /**2161 * Get system properties of a chain2162 * @example getChainProperties();2163 * @returns ss58Format, token decimals, and token symbol2164 */2165 getChainProperties(): IChainProperties {2166 const properties = (this.helper.getApi() as any).registry.getChainProperties().toJSON();2167 return {2168 ss58Format: properties.ss58Format.toJSON(),2169 tokenDecimals: properties.tokenDecimals.toJSON(),2170 tokenSymbol: properties.tokenSymbol.toJSON(),2171 };2172 }21732174 /**2175 * Get chain header2176 * @example getLatestBlockNumber();2177 * @returns the number of the last block2178 */2179 async getLatestBlockNumber(): Promise<number> {2180 return (await this.helper.callRpc('api.rpc.chain.getHeader')).number.toNumber();2181 }21822183 /**2184 * Get block hash by block number2185 * @param blockNumber number of block2186 * @example getBlockHashByNumber(12345);2187 * @returns hash of a block2188 */2189 async getBlockHashByNumber(blockNumber: number): Promise<string | null> {2190 const blockHash = (await this.helper.callRpc('api.rpc.chain.getBlockHash', [blockNumber])).toJSON();2191 if(blockHash === '0x0000000000000000000000000000000000000000000000000000000000000000') return null;2192 return blockHash;2193 }21942195 // TODO add docs2196 async getBlock(blockHashOrNumber: string | number): Promise<IBlock | null> {2197 const blockHash = typeof blockHashOrNumber === 'string' ? blockHashOrNumber : await this.getBlockHashByNumber(blockHashOrNumber);2198 if (!blockHash) return null;2199 return (await this.helper.callRpc('api.rpc.chain.getBlock', [blockHash])).toHuman().block;2200 }22012202 /**2203 * Get latest relay block2204 * @returns {number} relay block2205 */2206 async getRelayBlockNumber(): Promise<bigint> {2207 const blockNumber = (await this.helper.callRpc('api.query.parachainSystem.validationData')).toJSON().relayParentNumber;2208 return BigInt(blockNumber);2209 }22102211 /**2212 * Get account nonce2213 * @param address substrate address2214 * @example getNonce("5GrwvaEF5zXb26Fz...");2215 * @returns number, account's nonce2216 */2217 async getNonce(address: TSubstrateAccount): Promise<number> {2218 return (await this.helper.callRpc('api.query.system.account', [address])).nonce.toNumber();2219 }2220}22212222class SubstrateBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2223 /**2224 * Get substrate address balance2225 * @param address substrate address2226 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2227 * @returns amount of tokens on address2228 */2229 async getSubstrate(address: TSubstrateAccount): Promise<bigint> {2230 return (await this.helper.callRpc('api.query.system.account', [address])).data.free.toBigInt();2231 }22322233 /**2234 * Transfer tokens to substrate address2235 * @param signer keyring of signer2236 * @param address substrate address of a recipient2237 * @param amount amount of tokens to be transfered2238 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2239 * @returns ```true``` if extrinsic success, otherwise ```false```2240 */2241 async transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2242 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true/*, `Unable to transfer balance from ${this.helper.getSignerAddress(signer)} to ${address}`*/);22432244 let transfer = {from: null, to: null, amount: 0n} as any;2245 result.result.events.forEach(({event: {data, method, section}}) => {2246 if ((section === 'balances') && (method === 'Transfer')) {2247 transfer = {2248 from: this.helper.address.normalizeSubstrate(data[0]),2249 to: this.helper.address.normalizeSubstrate(data[1]),2250 amount: BigInt(data[2]),2251 };2252 }2253 });2254 const isSuccess = this.helper.address.normalizeSubstrate(typeof signer === 'string' ? signer : signer.address) === transfer.from2255 && this.helper.address.normalizeSubstrate(address) === transfer.to2256 && BigInt(amount) === transfer.amount;2257 return isSuccess;2258 }22592260 /**2261 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2262 * @param address substrate address2263 * @returns2264 */2265 async getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2266 const accountInfo = (await this.helper.callRpc('api.query.system.account', [address])).data;2267 return {free: accountInfo.free.toBigInt(), miscFrozen: accountInfo.miscFrozen.toBigInt(), feeFrozen: accountInfo.feeFrozen.toBigInt(), reserved: accountInfo.reserved.toBigInt()};2268 }22692270 async getLocked(address: TSubstrateAccount): Promise<[{id: string, amount: bigint, reason: string}]> {2271 const locks = (await this.helper.callRpc('api.query.balances.locks', [address])).toHuman();2272 return locks.map((lock: any) => {return {id: lock.id, amount: BigInt(lock.amount.replace(/,/g, '')), reasons: lock.reasons};});2273 }2274}22752276class EthereumBalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2277 /**2278 * Get ethereum address balance2279 * @param address ethereum address2280 * @example getEthereum("0x9F0583DbB855d...")2281 * @returns amount of tokens on address2282 */2283 async getEthereum(address: TEthereumAccount): Promise<bigint> {2284 return (await this.helper.callRpc('api.rpc.eth.getBalance', [address])).toBigInt();2285 }22862287 /**2288 * Transfer tokens to address2289 * @param signer keyring of signer2290 * @param address Ethereum address of a recipient2291 * @param amount amount of tokens to be transfered2292 * @example transferToEthereum(alithKeyring, "0x9F0583DbB855d...", 100_000_000_000n);2293 * @returns ```true``` if extrinsic success, otherwise ```false```2294 */2295 async transferToEthereum(signer: TSigner, address: TEthereumAccount, amount: bigint | string): Promise<boolean> {2296 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.transfer', [address, amount], true);22972298 let transfer = {from: null, to: null, amount: 0n} as any;2299 result.result.events.forEach(({event: {data, method, section}}) => {2300 if ((section === 'balances') && (method === 'Transfer')) {2301 transfer = {2302 from: data[0].toString(),2303 to: data[1].toString(),2304 amount: BigInt(data[2]),2305 };2306 }2307 });2308 const isSuccess = (typeof signer === 'string' ? signer : signer.address) === transfer.from2309 && address === transfer.to2310 && BigInt(amount) === transfer.amount;2311 return isSuccess;2312 }2313}23142315class BalanceGroup<T extends ChainHelperBase> extends HelperGroup<T> {2316 subBalanceGroup: SubstrateBalanceGroup<T>;2317 ethBalanceGroup: EthereumBalanceGroup<T>;23182319 constructor(helper: T) {2320 super(helper);2321 this.subBalanceGroup = new SubstrateBalanceGroup(helper);2322 this.ethBalanceGroup = new EthereumBalanceGroup(helper);2323 }23242325 getCollectionCreationPrice(): bigint {2326 return 2n * this.getOneTokenNominal();2327 }2328 /**2329 * Representation of the native token in the smallest unit - one OPAL (OPL), QUARTZ (QTZ), or UNIQUE (UNQ).2330 * @example getOneTokenNominal()2331 * @returns ```BigInt``` representation of the native token in the smallest unit, e.g. ```1_000_000_000_000_000_000n``` for QTZ.2332 */2333 getOneTokenNominal(): bigint {2334 const chainProperties = this.helper.chain.getChainProperties();2335 return 10n ** BigInt((chainProperties.tokenDecimals || [18])[0]);2336 }23372338 /**2339 * Get substrate address balance2340 * @param address substrate address2341 * @example getSubstrate("5GrwvaEF5zXb26Fz...")2342 * @returns amount of tokens on address2343 */2344 getSubstrate(address: TSubstrateAccount): Promise<bigint> {2345 return this.subBalanceGroup.getSubstrate(address);2346 }23472348 /**2349 * Get full substrate balance including free, miscFrozen, feeFrozen, and reserved2350 * @param address substrate address2351 * @returns2352 */2353 getSubstrateFull(address: TSubstrateAccount): Promise<ISubstrateBalance> {2354 return this.subBalanceGroup.getSubstrateFull(address);2355 }23562357 /**2358 * Get locked balances2359 * @param address substrate address2360 * @returns locked balances with reason via api.query.balances.locks2361 */2362 getLocked(address: TSubstrateAccount) {2363 return this.subBalanceGroup.getLocked(address);2364 }23652366 /**2367 * Get ethereum address balance2368 * @param address ethereum address2369 * @example getEthereum("0x9F0583DbB855d...")2370 * @returns amount of tokens on address2371 */2372 getEthereum(address: TEthereumAccount): Promise<bigint> {2373 return this.ethBalanceGroup.getEthereum(address);2374 }23752376 /**2377 * Transfer tokens to substrate address2378 * @param signer keyring of signer2379 * @param address substrate address of a recipient2380 * @param amount amount of tokens to be transfered2381 * @example transferToSubstrate(aliceKeyring, "5GrwvaEF5zXb26Fz...", 100_000_000_000n);2382 * @returns ```true``` if extrinsic success, otherwise ```false```2383 */2384 transferToSubstrate(signer: TSigner, address: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2385 return this.subBalanceGroup.transferToSubstrate(signer, address, amount);2386 }23872388 async forceTransferToSubstrate(signer: TSigner, from: TSubstrateAccount, to: TSubstrateAccount, amount: bigint | string): Promise<boolean> {2389 const result = await this.helper.executeExtrinsic(signer, 'api.tx.balances.forceTransfer', [from, to, amount], true);23902391 let transfer = {from: null, to: null, amount: 0n} as any;2392 result.result.events.forEach(({event: {data, method, section}}) => {2393 if ((section === 'balances') && (method === 'Transfer')) {2394 transfer = {2395 from: this.helper.address.normalizeSubstrate(data[0]),2396 to: this.helper.address.normalizeSubstrate(data[1]),2397 amount: BigInt(data[2]),2398 };2399 }2400 });2401 let isSuccess = this.helper.address.normalizeSubstrate(from) === transfer.from;2402 isSuccess = isSuccess && this.helper.address.normalizeSubstrate(to) === transfer.to;2403 isSuccess = isSuccess && BigInt(amount) === transfer.amount;2404 return isSuccess;2405 }24062407 /**2408 * Transfer tokens with the unlock period2409 * @param signer signers Keyring2410 * @param address Substrate address of recipient2411 * @param schedule Schedule params2412 * @example vestedTransfer(signer, recepient.address, 20000, 100, 10, 50 * nominal); // total amount of vested tokens will be 100 * 50 = 50002413 */2414 async vestedTransfer(signer: TSigner, address: TSubstrateAccount, schedule: {start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}): Promise<void> {2415 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.vestedTransfer', [address, schedule]);2416 const event = result.result.events2417 .find(e => e.event.section === 'vesting' &&2418 e.event.method === 'VestingScheduleAdded' &&2419 e.event.data[0].toHuman() === signer.address);2420 if (!event) throw Error('Cannot find transfer in events');2421 }24222423 /**2424 * Get schedule for recepient of vested transfer2425 * @param address Substrate address of recipient2426 * @returns2427 */2428 async getVestingSchedules(address: TSubstrateAccount): Promise<{start: bigint, period: bigint, periodCount: bigint, perPeriod: bigint}[]> {2429 const schedule = (await this.helper.callRpc('api.query.vesting.vestingSchedules', [address])).toJSON();2430 return schedule.map((schedule: any) => {2431 return {2432 start: BigInt(schedule.start),2433 period: BigInt(schedule.period),2434 periodCount: BigInt(schedule.periodCount),2435 perPeriod: BigInt(schedule.perPeriod),2436 };2437 });2438 }24392440 /**2441 * Claim vested tokens2442 * @param signer signers Keyring2443 */2444 async claim(signer: TSigner) {2445 const result = await this.helper.executeExtrinsic(signer, 'api.tx.vesting.claim', []);2446 const event = result.result.events2447 .find(e => e.event.section === 'vesting' &&2448 e.event.method === 'Claimed' &&2449 e.event.data[0].toHuman() === signer.address);2450 if (!event) throw Error('Cannot find claim in events');2451 }2452}24532454class AddressGroup extends HelperGroup<ChainHelperBase> {2455 /**2456 * Normalizes the address to the specified ss58 format, by default ```42```.2457 * @param address substrate address2458 * @param ss58Format format for address conversion, by default ```42```2459 * @example normalizeSubstrate("unjKJQJrRd238pkUZZvzDQrfKuM39zBSnQ5zjAGAGcdRhaJTx") // returns 5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY2460 * @returns substrate address converted to normalized (i.e., starting with 5) or specified explicitly representation2461 */2462 normalizeSubstrate(address: TSubstrateAccount, ss58Format = 42): TSubstrateAccount {2463 return CrossAccountId.normalizeSubstrateAddress(address, ss58Format);2464 }24652466 /**2467 * Get address in the connected chain format2468 * @param address substrate address2469 * @example normalizeSubstrateToChainFormat("5GrwvaEF5zXb26Fz...") // returns unjKJQJrRd238pkUZZ... for Unique Network2470 * @returns address in chain format2471 */2472 normalizeSubstrateToChainFormat(address: TSubstrateAccount): TSubstrateAccount {2473 return this.normalizeSubstrate(address, this.helper.chain.getChainProperties().ss58Format);2474 }24752476 /**2477 * Get substrate mirror of an ethereum address2478 * @param ethAddress ethereum address2479 * @param toChainFormat false for normalized account2480 * @example ethToSubstrate('0x9F0583DbB855d...')2481 * @returns substrate mirror of a provided ethereum address2482 */2483 ethToSubstrate(ethAddress: TEthereumAccount, toChainFormat=false): TSubstrateAccount {2484 return CrossAccountId.translateEthToSub(ethAddress, toChainFormat ? this.helper.chain.getChainProperties().ss58Format : undefined);2485 }24862487 /**2488 * Get ethereum mirror of a substrate address2489 * @param subAddress substrate account2490 * @example substrateToEth("5DnSF6RRjwteE3BrC...")2491 * @returns ethereum mirror of a provided substrate address2492 */2493 substrateToEth(subAddress: TSubstrateAccount): TEthereumAccount {2494 return CrossAccountId.translateSubToEth(subAddress);2495 }24962497 /**2498 * Encode key to substrate address2499 * @param key key for encoding address2500 * @param ss58Format prefix for encoding to the address of the corresponding network2501 * @returns encoded substrate address2502 */2503 encodeSubstrateAddress (key: Uint8Array | string | bigint, ss58Format = 42): string {2504 const u8a :Uint8Array = typeof key === 'string'2505 ? hexToU8a(key)2506 : typeof key === 'bigint'2507 ? hexToU8a(key.toString(16))2508 : key;25092510 if (ss58Format < 0 || ss58Format > 16383 || [46, 47].includes(ss58Format)) {2511 throw new Error(`ss58Format is not valid, received ${typeofss58Format} "${ss58Format}"`);2512 }25132514 const allowedDecodedLengths = [1, 2, 4, 8, 32, 33];2515 if (!allowedDecodedLengths.includes(u8a.length)) {2516 throw new Error(`key length is not valid, received ${u8a.length}, valid values are ${allowedDecodedLengths.join(', ')}`);2517 }25182519 const u8aPrefix = ss58Format < 642520 ? new Uint8Array([ss58Format])2521 : new Uint8Array([2522 ((ss58Format & 0xfc) >> 2) | 0x40,2523 (ss58Format >> 8) | ((ss58Format & 0x03) << 6),2524 ]);25252526 const input = u8aConcat(u8aPrefix, u8a);25272528 return base58Encode(u8aConcat(2529 input,2530 blake2AsU8a(input).subarray(0, [32, 33].includes(u8a.length) ? 2 : 1),2531 ));2532 }25332534 /**2535 * Restore substrate address from bigint representation2536 * @param number decimal representation of substrate address2537 * @returns substrate address2538 */2539 restoreCrossAccountFromBigInt(number: bigint): TSubstrateAccount {2540 if (this.helper.api === null) {2541 throw 'Not connected';2542 }2543 const res = this.helper.api.registry.createType('AccountId', '0x' + number.toString(16).padStart(64, '0')).toJSON();2544 if (res === undefined || res === null) {2545 throw 'Restore address error';2546 }2547 return res.toString();2548 }25492550 /**2551 * Convert etherium cross account id to substrate cross account id2552 * @param ethCrossAccount etherium cross account2553 * @returns substrate cross account id2554 */2555 convertCrossAccountFromEthCrossAccount(ethCrossAccount: IEthCrossAccountId): ICrossAccountId {2556 if (ethCrossAccount.sub === '0') {2557 return {Ethereum: ethCrossAccount.eth.toLocaleLowerCase()};2558 }25592560 const ss58 = this.restoreCrossAccountFromBigInt(BigInt(ethCrossAccount.sub));2561 return {Substrate: ss58};2562 }25632564 paraSiblingSovereignAccount(paraid: number) {2565 // We are getting a *sibling* parachain sovereign account,2566 // so we need a sibling prefix: encoded(b"sibl") == 0x7369626c2567 const siblingPrefix = '0x7369626c';25682569 const encodedParaId = this.helper.getApi().createType('u32', paraid).toHex(true).substring(2);2570 const suffix = '000000000000000000000000000000000000000000000000';25712572 return siblingPrefix + encodedParaId + suffix;2573 }2574}25752576class StakingGroup extends HelperGroup<UniqueHelper> {2577 /**2578 * Stake tokens for App Promotion2579 * @param signer keyring of signer2580 * @param amountToStake amount of tokens to stake2581 * @param label extra label for log2582 * @returns2583 */2584 async stake(signer: TSigner, amountToStake: bigint, label?: string): Promise<boolean> {2585 if(typeof label === 'undefined') label = `${signer.address} amount: ${amountToStake}`;2586 const _stakeResult = await this.helper.executeExtrinsic(2587 signer, 'api.tx.appPromotion.stake',2588 [amountToStake], true,2589 );2590 // TODO extract info from stakeResult2591 return true;2592 }25932594 /**2595 * Unstake tokens for App Promotion2596 * @param signer keyring of signer2597 * @param amountToUnstake amount of tokens to unstake2598 * @param label extra label for log2599 * @returns block number where balances will be unlocked2600 */2601 async unstake(signer: TSigner, label?: string): Promise<number> {2602 if(typeof label === 'undefined') label = `${signer.address}`;2603 const _unstakeResult = await this.helper.executeExtrinsic(2604 signer, 'api.tx.appPromotion.unstake',2605 [], true,2606 );2607 // TODO extract block number fron events2608 return 1;2609 }26102611 /**2612 * Get total staked amount for address2613 * @param address substrate or ethereum address2614 * @returns total staked amount2615 */2616 async getTotalStaked(address?: ICrossAccountId): Promise<bigint> {2617 if (address) return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked', [address])).toBigInt();2618 return (await this.helper.callRpc('api.rpc.appPromotion.totalStaked')).toBigInt();2619 }26202621 /**2622 * Get total staked per block2623 * @param address substrate or ethereum address2624 * @returns array of stakes. `block` – the number of the block in which the stake was made. `amount` - the number of tokens staked in the block2625 */2626 async getTotalStakedPerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2627 const rawTotalStakerdPerBlock = await this.helper.callRpc('api.rpc.appPromotion.totalStakedPerBlock', [address]);2628 return rawTotalStakerdPerBlock.map(([block, amount]: any[]) => {2629 return {2630 block: block.toBigInt(),2631 amount: amount.toBigInt(),2632 };2633 });2634 }26352636 /**2637 * Get total pending unstake amount for address2638 * @param address substrate or ethereum address2639 * @returns total pending unstake amount2640 */2641 async getPendingUnstake(address: ICrossAccountId): Promise<bigint> {2642 return (await this.helper.callRpc('api.rpc.appPromotion.pendingUnstake', [address])).toBigInt();2643 }26442645 /**2646 * Get pending unstake amount per block for address2647 * @param address substrate or ethereum address2648 * @returns array of pending stakes. `block` – the number of the block in which the unstake was made. `amount` - the number of tokens unstaked in the block2649 */2650 async getPendingUnstakePerBlock(address: ICrossAccountId): Promise<IStakingInfo[]> {2651 const rawUnstakedPerBlock = await this.helper.callRpc('api.rpc.appPromotion.pendingUnstakePerBlock', [address]);2652 const result = rawUnstakedPerBlock.map(([block, amount]: any[]) => {2653 return {2654 block: block.toBigInt(),2655 amount: amount.toBigInt(),2656 };2657 });2658 return result;2659 }2660}26612662class SchedulerGroup extends HelperGroup<UniqueHelper> {2663 constructor(helper: UniqueHelper) {2664 super(helper);2665 }26662667 cancelScheduled(signer: TSigner, scheduledId: string) {2668 return this.helper.executeExtrinsic(2669 signer,2670 'api.tx.scheduler.cancelNamed',2671 [scheduledId],2672 true,2673 );2674 }26752676 changePriority(signer: TSigner, scheduledId: string, priority: number) {2677 return this.helper.executeExtrinsic(2678 signer,2679 'api.tx.scheduler.changeNamedPriority',2680 [scheduledId, priority],2681 true,2682 );2683 }26842685 scheduleAt<T extends UniqueHelper>(2686 executionBlockNumber: number,2687 options: ISchedulerOptions = {},2688 ) {2689 return this.schedule<T>('schedule', executionBlockNumber, options);2690 }26912692 scheduleAfter<T extends UniqueHelper>(2693 blocksBeforeExecution: number,2694 options: ISchedulerOptions = {},2695 ) {2696 return this.schedule<T>('scheduleAfter', blocksBeforeExecution, options);2697 }26982699 schedule<T extends UniqueHelper>(2700 scheduleFn: 'schedule' | 'scheduleAfter',2701 blocksNum: number,2702 options: ISchedulerOptions = {},2703 ) {2704 // eslint-disable-next-line @typescript-eslint/naming-convention2705 const ScheduledHelperType = ScheduledUniqueHelper(this.helper.helperBase);2706 return this.helper.clone(ScheduledHelperType, {2707 scheduleFn,2708 blocksNum,2709 options,2710 }) as T;2711 }2712}27132714class ForeignAssetsGroup extends HelperGroup<UniqueHelper> {2715 async register(signer: TSigner, ownerAddress: TSubstrateAccount, location: any, metadata: IForeignAssetMetadata) {2716 await this.helper.executeExtrinsic(2717 signer,2718 'api.tx.foreignAssets.registerForeignAsset',2719 [ownerAddress, location, metadata],2720 true,2721 );2722 }27232724 async update(signer: TSigner, foreignAssetId: number, location: any, metadata: IForeignAssetMetadata) {2725 await this.helper.executeExtrinsic(2726 signer,2727 'api.tx.foreignAssets.updateForeignAsset',2728 [foreignAssetId, location, metadata],2729 true,2730 );2731 }2732}27332734class XcmGroup<T extends ChainHelperBase> extends HelperGroup<T> {2735 palletName: string;27362737 constructor(helper: T, palletName: string) {2738 super(helper);27392740 this.palletName = palletName;2741 }27422743 async limitedReserveTransferAssets(signer: TSigner, destination: any, beneficiary: any, assets: any, feeAssetItem: number, weightLimit: number) {2744 await this.helper.executeExtrinsic(signer, `api.tx.${this.palletName}.limitedReserveTransferAssets`, [destination, beneficiary, assets, feeAssetItem, {Limited: weightLimit}], true);2745 }2746}27472748class XTokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2749 async transfer(signer: TSigner, currencyId: any, amount: bigint, destination: any, destWeight: number) {2750 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transfer', [currencyId, amount, destination, destWeight], true);2751 }27522753 async transferMultiasset(signer: TSigner, asset: any, destination: any, destWeight: number) {2754 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMultiasset', [asset, destination, destWeight], true);2755 }27562757 async transferMulticurrencies(signer: TSigner, currencies: any[], feeItem: number, destLocation: any, destWeight: number) {2758 await this.helper.executeExtrinsic(signer, 'api.tx.xTokens.transferMulticurrencies', [currencies, feeItem, destLocation, destWeight], true);2759 }2760}27612762class TokensGroup<T extends ChainHelperBase> extends HelperGroup<T> {2763 async accounts(address: string, currencyId: any) {2764 const {free} = (await this.helper.callRpc('api.query.tokens.accounts', [address, currencyId])).toJSON() as any;2765 return BigInt(free);2766 }2767}27682769class AssetsGroup<T extends ChainHelperBase> extends HelperGroup<T> {2770 async create(signer: TSigner, assetId: number, admin: string, minimalBalance: bigint) {2771 await this.helper.executeExtrinsic(signer, 'api.tx.assets.create', [assetId, admin, minimalBalance], true);2772 }27732774 async setMetadata(signer: TSigner, assetId: number, name: string, symbol: string, decimals: number) {2775 await this.helper.executeExtrinsic(signer, 'api.tx.assets.setMetadata', [assetId, name, symbol, decimals], true);2776 }27772778 async mint(signer: TSigner, assetId: number, beneficiary: string, amount: bigint) {2779 await this.helper.executeExtrinsic(signer, 'api.tx.assets.mint', [assetId, beneficiary, amount], true);2780 }27812782 async account(assetId: string | number, address: string) {2783 const accountAsset = (2784 await this.helper.callRpc('api.query.assets.account', [assetId, address])2785 ).toJSON()! as any;27862787 if (accountAsset !== null) {2788 return BigInt(accountAsset['balance']);2789 } else {2790 return null;2791 }2792 }2793}27942795class AcalaAssetRegistryGroup extends HelperGroup<AcalaHelper> {2796 async registerForeignAsset(signer: TSigner, destination: any, metadata: AcalaAssetMetadata) {2797 await this.helper.executeExtrinsic(signer, 'api.tx.assetRegistry.registerForeignAsset', [destination, metadata], true);2798 }2799}28002801class MoonbeamAssetManagerGroup extends HelperGroup<MoonbeamHelper> {2802 makeRegisterForeignAssetProposal(assetInfo: MoonbeamAssetInfo) {2803 const apiPrefix = 'api.tx.assetManager.';28042805 const registerTx = this.helper.constructApiCall(2806 apiPrefix + 'registerForeignAsset',2807 [assetInfo.location, assetInfo.metadata, assetInfo.existentialDeposit, assetInfo.isSufficient],2808 );28092810 const setUnitsTx = this.helper.constructApiCall(2811 apiPrefix + 'setAssetUnitsPerSecond',2812 [assetInfo.location, assetInfo.unitsPerSecond, assetInfo.numAssetsWeightHint],2813 );28142815 const batchCall = this.helper.getApi().tx.utility.batchAll([registerTx, setUnitsTx]);2816 const encodedProposal = batchCall?.method.toHex() || '';2817 return encodedProposal;2818 }28192820 async assetTypeId(location: any) {2821 return await this.helper.callRpc('api.query.assetManager.assetTypeId', [location]);2822 }2823}28242825class MoonbeamDemocracyGroup extends HelperGroup<MoonbeamHelper> {2826 async notePreimage(signer: TSigner, encodedProposal: string) {2827 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.notePreimage', [encodedProposal], true);2828 }28292830 externalProposeMajority(proposalHash: string) {2831 return this.helper.constructApiCall('api.tx.democracy.externalProposeMajority', [proposalHash]);2832 }28332834 fastTrack(proposalHash: string, votingPeriod: number, delayPeriod: number) {2835 return this.helper.constructApiCall('api.tx.democracy.fastTrack', [proposalHash, votingPeriod, delayPeriod]);2836 }28372838 async referendumVote(signer: TSigner, referendumIndex: number, accountVote: DemocracyStandardAccountVote) {2839 await this.helper.executeExtrinsic(signer, 'api.tx.democracy.vote', [referendumIndex, {Standard: accountVote}], true);2840 }2841}28422843class MoonbeamCollectiveGroup extends HelperGroup<MoonbeamHelper> {2844 collective: string;28452846 constructor(helper: MoonbeamHelper, collective: string) {2847 super(helper);28482849 this.collective = collective;2850 }28512852 async propose(signer: TSigner, threshold: number, proposalHash: string, lengthBound: number) {2853 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.propose`, [threshold, proposalHash, lengthBound], true);2854 }28552856 async vote(signer: TSigner, proposalHash: string, proposalIndex: number, approve: boolean) {2857 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.vote`, [proposalHash, proposalIndex, approve], true);2858 }28592860 async close(signer: TSigner, proposalHash: string, proposalIndex: number, weightBound: number, lengthBound: number) {2861 await this.helper.executeExtrinsic(signer, `api.tx.${this.collective}.close`, [proposalHash, proposalIndex, weightBound, lengthBound], true);2862 }28632864 async proposalCount() {2865 return Number(await this.helper.callRpc(`api.query.${this.collective}.proposalCount`, []));2866 }2867}28682869export type ChainHelperBaseConstructor = new(...args: any[]) => ChainHelperBase;2870export type UniqueHelperConstructor = new(...args: any[]) => UniqueHelper;28712872export class UniqueHelper extends ChainHelperBase {2873 balance: BalanceGroup<UniqueHelper>;2874 collection: CollectionGroup;2875 nft: NFTGroup;2876 rft: RFTGroup;2877 ft: FTGroup;2878 staking: StakingGroup;2879 scheduler: SchedulerGroup;2880 foreignAssets: ForeignAssetsGroup;2881 xcm: XcmGroup<UniqueHelper>;2882 xTokens: XTokensGroup<UniqueHelper>;2883 tokens: TokensGroup<UniqueHelper>;28842885 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2886 super(logger, options.helperBase ?? UniqueHelper);28872888 this.balance = new BalanceGroup(this);2889 this.collection = new CollectionGroup(this);2890 this.nft = new NFTGroup(this);2891 this.rft = new RFTGroup(this);2892 this.ft = new FTGroup(this);2893 this.staking = new StakingGroup(this);2894 this.scheduler = new SchedulerGroup(this);2895 this.foreignAssets = new ForeignAssetsGroup(this);2896 this.xcm = new XcmGroup(this, 'polkadotXcm');2897 this.xTokens = new XTokensGroup(this);2898 this.tokens = new TokensGroup(this);2899 }29002901 getSudo<T extends UniqueHelper>() {2902 // eslint-disable-next-line @typescript-eslint/naming-convention2903 const SudoHelperType = SudoHelper(this.helperBase);2904 return this.clone(SudoHelperType) as T;2905 }2906}29072908export class XcmChainHelper extends ChainHelperBase {2909 async connect(wsEndpoint: string, _listeners?: any): Promise<void> {2910 const wsProvider = new WsProvider(wsEndpoint);2911 this.api = new ApiPromise({2912 provider: wsProvider,2913 });2914 await this.api.isReadyOrError;2915 this.network = await UniqueHelper.detectNetwork(this.api);2916 }2917}29182919export class RelayHelper extends XcmChainHelper {2920 xcm: XcmGroup<RelayHelper>;29212922 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2923 super(logger, options.helperBase ?? RelayHelper);29242925 this.xcm = new XcmGroup(this, 'xcmPallet');2926 }2927}29282929export class WestmintHelper extends XcmChainHelper {2930 balance: SubstrateBalanceGroup<WestmintHelper>;2931 xcm: XcmGroup<WestmintHelper>;2932 assets: AssetsGroup<WestmintHelper>;2933 xTokens: XTokensGroup<WestmintHelper>;29342935 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2936 super(logger, options.helperBase ?? WestmintHelper);29372938 this.balance = new SubstrateBalanceGroup(this);2939 this.xcm = new XcmGroup(this, 'polkadotXcm');2940 this.assets = new AssetsGroup(this);2941 this.xTokens = new XTokensGroup(this);2942 }2943}29442945export class MoonbeamHelper extends XcmChainHelper {2946 balance: EthereumBalanceGroup<MoonbeamHelper>;2947 assetManager: MoonbeamAssetManagerGroup;2948 assets: AssetsGroup<MoonbeamHelper>;2949 xTokens: XTokensGroup<MoonbeamHelper>;2950 democracy: MoonbeamDemocracyGroup;2951 collective: {2952 council: MoonbeamCollectiveGroup,2953 techCommittee: MoonbeamCollectiveGroup,2954 };29552956 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2957 super(logger, options.helperBase ?? MoonbeamHelper);29582959 this.balance = new EthereumBalanceGroup(this);2960 this.assetManager = new MoonbeamAssetManagerGroup(this);2961 this.assets = new AssetsGroup(this);2962 this.xTokens = new XTokensGroup(this);2963 this.democracy = new MoonbeamDemocracyGroup(this);2964 this.collective = {2965 council: new MoonbeamCollectiveGroup(this, 'councilCollective'),2966 techCommittee: new MoonbeamCollectiveGroup(this, 'techCommitteeCollective'),2967 };2968 }2969}29702971export class AcalaHelper extends XcmChainHelper {2972 balance: SubstrateBalanceGroup<AcalaHelper>;2973 assetRegistry: AcalaAssetRegistryGroup;2974 xTokens: XTokensGroup<AcalaHelper>;2975 tokens: TokensGroup<AcalaHelper>;29762977 constructor(logger?: ILogger, options: {[key: string]: any} = {}) {2978 super(logger, options.helperBase ?? AcalaHelper);29792980 this.balance = new SubstrateBalanceGroup(this);2981 this.assetRegistry = new AcalaAssetRegistryGroup(this);2982 this.xTokens = new XTokensGroup(this);2983 this.tokens = new TokensGroup(this);2984 }29852986 getSudo<T extends AcalaHelper>() {2987 // eslint-disable-next-line @typescript-eslint/naming-convention2988 const SudoHelperType = SudoHelper(this.helperBase);2989 return this.clone(SudoHelperType) as T;2990 }2991}29922993// eslint-disable-next-line @typescript-eslint/naming-convention2994function ScheduledUniqueHelper<T extends UniqueHelperConstructor>(Base: T) {2995 return class extends Base {2996 scheduleFn: 'schedule' | 'scheduleAfter';2997 blocksNum: number;2998 options: ISchedulerOptions;29993000 constructor(...args: any[]) {3001 const logger = args[0] as ILogger;3002 const options = args[1] as {3003 scheduleFn: 'schedule' | 'scheduleAfter',3004 blocksNum: number,3005 options: ISchedulerOptions3006 };30073008 super(logger);30093010 this.scheduleFn = options.scheduleFn;3011 this.blocksNum = options.blocksNum;3012 this.options = options.options;3013 }30143015 executeExtrinsic(sender: IKeyringPair, scheduledExtrinsic: string, scheduledParams: any[], expectSuccess?: boolean): Promise<ITransactionResult> {3016 const scheduledTx = this.constructApiCall(scheduledExtrinsic, scheduledParams);30173018 const mandatorySchedArgs = [3019 this.blocksNum,3020 this.options.periodic ? [this.options.periodic.period, this.options.periodic.repetitions] : null,3021 this.options.priority ?? null,3022 scheduledTx,3023 ];30243025 let schedArgs;3026 let scheduleFn;30273028 if (this.options.scheduledId) {3029 schedArgs = [this.options.scheduledId!, ...mandatorySchedArgs];30303031 if (this.scheduleFn == 'schedule') {3032 scheduleFn = 'scheduleNamed';3033 } else if (this.scheduleFn == 'scheduleAfter') {3034 scheduleFn = 'scheduleNamedAfter';3035 }3036 } else {3037 schedArgs = mandatorySchedArgs;3038 scheduleFn = this.scheduleFn;3039 }30403041 const extrinsic = 'api.tx.scheduler.' + scheduleFn;30423043 return super.executeExtrinsic(3044 sender,3045 extrinsic,3046 schedArgs,3047 expectSuccess,3048 );3049 }3050 };3051}30523053// eslint-disable-next-line @typescript-eslint/naming-convention3054function SudoHelper<T extends ChainHelperBaseConstructor>(Base: T) {3055 return class extends Base {3056 constructor(...args: any[]) {3057 super(...args);3058 }30593060 executeExtrinsic (3061 sender: IKeyringPair,3062 extrinsic: string,3063 params: any[],3064 expectSuccess?: boolean,3065 ): Promise<ITransactionResult> {3066 const call = this.constructApiCall(extrinsic, params);3067 return super.executeExtrinsic(3068 sender,3069 'api.tx.sudo.sudo',3070 [call],3071 expectSuccess,3072 );3073 }3074 };3075}30763077export class UniqueBaseCollection {3078 helper: UniqueHelper;3079 collectionId: number;30803081 constructor(collectionId: number, uniqueHelper: UniqueHelper) {3082 this.collectionId = collectionId;3083 this.helper = uniqueHelper;3084 }30853086 async getData() {3087 return await this.helper.collection.getData(this.collectionId);3088 }30893090 async getLastTokenId() {3091 return await this.helper.collection.getLastTokenId(this.collectionId);3092 }30933094 async doesTokenExist(tokenId: number) {3095 return await this.helper.collection.doesTokenExist(this.collectionId, tokenId);3096 }30973098 async getAdmins() {3099 return await this.helper.collection.getAdmins(this.collectionId);3100 }31013102 async getAllowList() {3103 return await this.helper.collection.getAllowList(this.collectionId);3104 }31053106 async getEffectiveLimits() {3107 return await this.helper.collection.getEffectiveLimits(this.collectionId);3108 }31093110 async getProperties(propertyKeys?: string[] | null) {3111 return await this.helper.collection.getProperties(this.collectionId, propertyKeys);3112 }31133114 async getPropertiesConsumedSpace() {3115 return await this.helper.collection.getPropertiesConsumedSpace(this.collectionId);3116 }31173118 async getTokenNextSponsored(tokenId: number, addressObj: ICrossAccountId) {3119 return await this.helper.collection.getTokenNextSponsored(this.collectionId, tokenId, addressObj);3120 }31213122 async getOptions() {3123 return await this.helper.collection.getCollectionOptions(this.collectionId);3124 }31253126 async setSponsor(signer: TSigner, sponsorAddress: TSubstrateAccount) {3127 return await this.helper.collection.setSponsor(signer, this.collectionId, sponsorAddress);3128 }31293130 async confirmSponsorship(signer: TSigner) {3131 return await this.helper.collection.confirmSponsorship(signer, this.collectionId);3132 }31333134 async removeSponsor(signer: TSigner) {3135 return await this.helper.collection.removeSponsor(signer, this.collectionId);3136 }31373138 async setLimits(signer: TSigner, limits: ICollectionLimits) {3139 return await this.helper.collection.setLimits(signer, this.collectionId, limits);3140 }31413142 async changeOwner(signer: TSigner, ownerAddress: TSubstrateAccount) {3143 return await this.helper.collection.changeOwner(signer, this.collectionId, ownerAddress);3144 }31453146 async addAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3147 return await this.helper.collection.addAdmin(signer, this.collectionId, adminAddressObj);3148 }31493150 async addToAllowList(signer: TSigner, addressObj: ICrossAccountId) {3151 return await this.helper.collection.addToAllowList(signer, this.collectionId, addressObj);3152 }31533154 async removeFromAllowList(signer: TSigner, addressObj: ICrossAccountId) {3155 return await this.helper.collection.removeFromAllowList(signer, this.collectionId, addressObj);3156 }31573158 async removeAdmin(signer: TSigner, adminAddressObj: ICrossAccountId) {3159 return await this.helper.collection.removeAdmin(signer, this.collectionId, adminAddressObj);3160 }31613162 async setProperties(signer: TSigner, properties: IProperty[]) {3163 return await this.helper.collection.setProperties(signer, this.collectionId, properties);3164 }31653166 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3167 return await this.helper.collection.deleteProperties(signer, this.collectionId, propertyKeys);3168 }31693170 async setPermissions(signer: TSigner, permissions: ICollectionPermissions) {3171 return await this.helper.collection.setPermissions(signer, this.collectionId, permissions);3172 }31733174 async enableNesting(signer: TSigner, permissions: INestingPermissions) {3175 return await this.helper.collection.enableNesting(signer, this.collectionId, permissions);3176 }31773178 async disableNesting(signer: TSigner) {3179 return await this.helper.collection.disableNesting(signer, this.collectionId);3180 }31813182 async burn(signer: TSigner) {3183 return await this.helper.collection.burn(signer, this.collectionId);3184 }31853186 scheduleAt<T extends UniqueHelper>(3187 executionBlockNumber: number,3188 options: ISchedulerOptions = {},3189 ) {3190 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3191 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3192 }31933194 scheduleAfter<T extends UniqueHelper>(3195 blocksBeforeExecution: number,3196 options: ISchedulerOptions = {},3197 ) {3198 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3199 return new UniqueBaseCollection(this.collectionId, scheduledHelper);3200 }32013202 getSudo<T extends UniqueHelper>() {3203 return new UniqueBaseCollection(this.collectionId, this.helper.getSudo<T>());3204 }3205}320632073208export class UniqueNFTCollection extends UniqueBaseCollection {3209 getTokenObject(tokenId: number) {3210 return new UniqueNFToken(tokenId, this);3211 }32123213 async getTokensByAddress(addressObj: ICrossAccountId) {3214 return await this.helper.nft.getTokensByAddress(this.collectionId, addressObj);3215 }32163217 async getToken(tokenId: number, blockHashAt?: string) {3218 return await this.helper.nft.getToken(this.collectionId, tokenId, [], blockHashAt);3219 }32203221 async getTokenOwner(tokenId: number, blockHashAt?: string) {3222 return await this.helper.nft.getTokenOwner(this.collectionId, tokenId, blockHashAt);3223 }32243225 async getTokenTopmostOwner(tokenId: number, blockHashAt?: string) {3226 return await this.helper.nft.getTokenTopmostOwner(this.collectionId, tokenId, blockHashAt);3227 }32283229 async getTokenChildren(tokenId: number, blockHashAt?: string) {3230 return await this.helper.nft.getTokenChildren(this.collectionId, tokenId, blockHashAt);3231 }32323233 async getPropertyPermissions(propertyKeys: string[] | null = null) {3234 return await this.helper.nft.getPropertyPermissions(this.collectionId, propertyKeys);3235 }32363237 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3238 return await this.helper.nft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3239 }32403241 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3242 const api = this.helper.getApi();3243 const props = (await api.query.nonfungible.tokenProperties(this.collectionId, tokenId)).toJSON();32443245 return (props! as any).consumedSpace;3246 }32473248 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId) {3249 return await this.helper.nft.transferToken(signer, this.collectionId, tokenId, addressObj);3250 }32513252 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3253 return await this.helper.nft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj);3254 }32553256 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId) {3257 return await this.helper.nft.approveToken(signer, this.collectionId, tokenId, toAddressObj);3258 }32593260 async isTokenApproved(tokenId: number, toAddressObj: ICrossAccountId) {3261 return await this.helper.nft.isTokenApproved(this.collectionId, tokenId, toAddressObj);3262 }32633264 async mintToken(signer: TSigner, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3265 return await this.helper.nft.mintToken(signer, {collectionId: this.collectionId, owner, properties});3266 }32673268 async mintMultipleTokens(signer: TSigner, tokens: {owner: ICrossAccountId, properties?: IProperty[]}[]) {3269 return await this.helper.nft.mintMultipleTokens(signer, this.collectionId, tokens);3270 }32713272 async burnToken(signer: TSigner, tokenId: number) {3273 return await this.helper.nft.burnToken(signer, this.collectionId, tokenId);3274 }32753276 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId) {3277 return await this.helper.nft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj);3278 }32793280 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3281 return await this.helper.nft.setTokenProperties(signer, this.collectionId, tokenId, properties);3282 }32833284 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3285 return await this.helper.nft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3286 }32873288 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3289 return await this.helper.nft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3290 }32913292 async nestToken(signer: TSigner, tokenId: number, toTokenObj: IToken) {3293 return await this.helper.nft.nestToken(signer, {collectionId: this.collectionId, tokenId}, toTokenObj);3294 }32953296 async unnestToken(signer: TSigner, tokenId: number, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3297 return await this.helper.nft.unnestToken(signer, {collectionId: this.collectionId, tokenId}, fromTokenObj, toAddressObj);3298 }32993300 scheduleAt<T extends UniqueHelper>(3301 executionBlockNumber: number,3302 options: ISchedulerOptions = {},3303 ) {3304 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3305 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3306 }33073308 scheduleAfter<T extends UniqueHelper>(3309 blocksBeforeExecution: number,3310 options: ISchedulerOptions = {},3311 ) {3312 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3313 return new UniqueNFTCollection(this.collectionId, scheduledHelper);3314 }33153316 getSudo<T extends UniqueHelper>() {3317 return new UniqueNFTCollection(this.collectionId, this.helper.getSudo<T>());3318 }3319}332033213322export class UniqueRFTCollection extends UniqueBaseCollection {3323 getTokenObject(tokenId: number) {3324 return new UniqueRFToken(tokenId, this);3325 }33263327 async getToken(tokenId: number, blockHashAt?: string) {3328 return await this.helper.rft.getToken(this.collectionId, tokenId, [], blockHashAt);3329 }33303331 async getTokensByAddress(addressObj: ICrossAccountId) {3332 return await this.helper.rft.getTokensByAddress(this.collectionId, addressObj);3333 }33343335 async getTop10TokenOwners(tokenId: number) {3336 return await this.helper.rft.getTokenTop10Owners(this.collectionId, tokenId);3337 }33383339 async getTokenBalance(tokenId: number, addressObj: ICrossAccountId) {3340 return await this.helper.rft.getTokenBalance(this.collectionId, tokenId, addressObj);3341 }33423343 async getTokenTotalPieces(tokenId: number) {3344 return await this.helper.rft.getTokenTotalPieces(this.collectionId, tokenId);3345 }33463347 async getTokenApprovedPieces(tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3348 return await this.helper.rft.getTokenApprovedPieces(this.collectionId, tokenId, toAddressObj, fromAddressObj);3349 }33503351 async getPropertyPermissions(propertyKeys: string[] | null = null) {3352 return await this.helper.rft.getPropertyPermissions(this.collectionId, propertyKeys);3353 }33543355 async getTokenProperties(tokenId: number, propertyKeys?: string[] | null) {3356 return await this.helper.rft.getTokenProperties(this.collectionId, tokenId, propertyKeys);3357 }33583359 async getTokenPropertiesConsumedSpace(tokenId: number): Promise<number> {3360 const api = this.helper.getApi();3361 const props = (await api.query.refungible.tokenProperties(this.collectionId, tokenId)).toJSON();33623363 return (props! as any).consumedSpace;3364 }33653366 async transferToken(signer: TSigner, tokenId: number, addressObj: ICrossAccountId, amount=1n) {3367 return await this.helper.rft.transferToken(signer, this.collectionId, tokenId, addressObj, amount);3368 }33693370 async transferTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3371 return await this.helper.rft.transferTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, toAddressObj, amount);3372 }33733374 async approveToken(signer: TSigner, tokenId: number, toAddressObj: ICrossAccountId, amount=1n) {3375 return await this.helper.rft.approveToken(signer, this.collectionId, tokenId, toAddressObj, amount);3376 }33773378 async repartitionToken(signer: TSigner, tokenId: number, amount: bigint) {3379 return await this.helper.rft.repartitionToken(signer, this.collectionId, tokenId, amount);3380 }33813382 async mintToken(signer: TSigner, pieces=1n, owner: ICrossAccountId = {Substrate: signer.address}, properties?: IProperty[]) {3383 return await this.helper.rft.mintToken(signer, {collectionId: this.collectionId, owner, pieces, properties});3384 }33853386 async mintMultipleTokens(signer: TSigner, tokens: {pieces: bigint, owner: ICrossAccountId, properties?: IProperty[]}[]) {3387 return await this.helper.rft.mintMultipleTokens(signer, this.collectionId, tokens);3388 }33893390 async burnToken(signer: TSigner, tokenId: number, amount=1n) {3391 return await this.helper.rft.burnToken(signer, this.collectionId, tokenId, amount);3392 }33933394 async burnTokenFrom(signer: TSigner, tokenId: number, fromAddressObj: ICrossAccountId, amount=1n) {3395 return await this.helper.rft.burnTokenFrom(signer, this.collectionId, tokenId, fromAddressObj, amount);3396 }33973398 async setTokenProperties(signer: TSigner, tokenId: number, properties: IProperty[]) {3399 return await this.helper.rft.setTokenProperties(signer, this.collectionId, tokenId, properties);3400 }34013402 async deleteTokenProperties(signer: TSigner, tokenId: number, propertyKeys: string[]) {3403 return await this.helper.rft.deleteTokenProperties(signer, this.collectionId, tokenId, propertyKeys);3404 }34053406 async setTokenPropertyPermissions(signer: TSigner, permissions: ITokenPropertyPermission[]) {3407 return await this.helper.rft.setTokenPropertyPermissions(signer, this.collectionId, permissions);3408 }34093410 scheduleAt<T extends UniqueHelper>(3411 executionBlockNumber: number,3412 options: ISchedulerOptions = {},3413 ) {3414 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3415 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3416 }34173418 scheduleAfter<T extends UniqueHelper>(3419 blocksBeforeExecution: number,3420 options: ISchedulerOptions = {},3421 ) {3422 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3423 return new UniqueRFTCollection(this.collectionId, scheduledHelper);3424 }34253426 getSudo<T extends UniqueHelper>() {3427 return new UniqueRFTCollection(this.collectionId, this.helper.getSudo<T>());3428 }3429}343034313432export class UniqueFTCollection extends UniqueBaseCollection {3433 async getBalance(addressObj: ICrossAccountId) {3434 return await this.helper.ft.getBalance(this.collectionId, addressObj);3435 }34363437 async getTotalPieces() {3438 return await this.helper.ft.getTotalPieces(this.collectionId);3439 }34403441 async getApprovedTokens(fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3442 return await this.helper.ft.getApprovedTokens(this.collectionId, fromAddressObj, toAddressObj);3443 }34443445 async getTop10Owners() {3446 return await this.helper.ft.getTop10Owners(this.collectionId);3447 }34483449 async mint(signer: TSigner, amount=1n, owner: ICrossAccountId = {Substrate: signer.address}) {3450 return await this.helper.ft.mintTokens(signer, this.collectionId, amount, owner);3451 }34523453 async mintWithOneOwner(signer: TSigner, tokens: {value: bigint}[], owner: ICrossAccountId = {Substrate: signer.address}) {3454 return await this.helper.ft.mintMultipleTokensWithOneOwner(signer, this.collectionId, tokens, owner);3455 }34563457 async transfer(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3458 return await this.helper.ft.transfer(signer, this.collectionId, toAddressObj, amount);3459 }34603461 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3462 return await this.helper.ft.transferFrom(signer, this.collectionId, fromAddressObj, toAddressObj, amount);3463 }34643465 async burnTokens(signer: TSigner, amount=1n) {3466 return await this.helper.ft.burnTokens(signer, this.collectionId, amount);3467 }34683469 async burnTokensFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3470 return await this.helper.ft.burnTokensFrom(signer, this.collectionId, fromAddressObj, amount);3471 }34723473 async approveTokens(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3474 return await this.helper.ft.approveTokens(signer, this.collectionId, toAddressObj, amount);3475 }34763477 scheduleAt<T extends UniqueHelper>(3478 executionBlockNumber: number,3479 options: ISchedulerOptions = {},3480 ) {3481 const scheduledHelper = this.helper.scheduler.scheduleAt<T>(executionBlockNumber, options);3482 return new UniqueFTCollection(this.collectionId, scheduledHelper);3483 }34843485 scheduleAfter<T extends UniqueHelper>(3486 blocksBeforeExecution: number,3487 options: ISchedulerOptions = {},3488 ) {3489 const scheduledHelper = this.helper.scheduler.scheduleAfter<T>(blocksBeforeExecution, options);3490 return new UniqueFTCollection(this.collectionId, scheduledHelper);3491 }34923493 getSudo<T extends UniqueHelper>() {3494 return new UniqueFTCollection(this.collectionId, this.helper.getSudo<T>());3495 }3496}349734983499export class UniqueBaseToken {3500 collection: UniqueNFTCollection | UniqueRFTCollection;3501 collectionId: number;3502 tokenId: number;35033504 constructor(tokenId: number, collection: UniqueNFTCollection | UniqueRFTCollection) {3505 this.collection = collection;3506 this.collectionId = collection.collectionId;3507 this.tokenId = tokenId;3508 }35093510 async getNextSponsored(addressObj: ICrossAccountId) {3511 return await this.collection.getTokenNextSponsored(this.tokenId, addressObj);3512 }35133514 async getProperties(propertyKeys?: string[] | null) {3515 return await this.collection.getTokenProperties(this.tokenId, propertyKeys);3516 }35173518 async getTokenPropertiesConsumedSpace() {3519 return await this.collection.getTokenPropertiesConsumedSpace(this.tokenId);3520 }35213522 async setProperties(signer: TSigner, properties: IProperty[]) {3523 return await this.collection.setTokenProperties(signer, this.tokenId, properties);3524 }35253526 async deleteProperties(signer: TSigner, propertyKeys: string[]) {3527 return await this.collection.deleteTokenProperties(signer, this.tokenId, propertyKeys);3528 }35293530 async doesExist() {3531 return await this.collection.doesTokenExist(this.tokenId);3532 }35333534 nestingAccount() {3535 return this.collection.helper.util.getTokenAccount(this);3536 }35373538 scheduleAt<T extends UniqueHelper>(3539 executionBlockNumber: number,3540 options: ISchedulerOptions = {},3541 ) {3542 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3543 return new UniqueBaseToken(this.tokenId, scheduledCollection);3544 }35453546 scheduleAfter<T extends UniqueHelper>(3547 blocksBeforeExecution: number,3548 options: ISchedulerOptions = {},3549 ) {3550 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3551 return new UniqueBaseToken(this.tokenId, scheduledCollection);3552 }35533554 getSudo<T extends UniqueHelper>() {3555 return new UniqueBaseToken(this.tokenId, this.collection.getSudo<T>());3556 }3557}355835593560export class UniqueNFToken extends UniqueBaseToken {3561 collection: UniqueNFTCollection;35623563 constructor(tokenId: number, collection: UniqueNFTCollection) {3564 super(tokenId, collection);3565 this.collection = collection;3566 }35673568 async getData(blockHashAt?: string) {3569 return await this.collection.getToken(this.tokenId, blockHashAt);3570 }35713572 async getOwner(blockHashAt?: string) {3573 return await this.collection.getTokenOwner(this.tokenId, blockHashAt);3574 }35753576 async getTopmostOwner(blockHashAt?: string) {3577 return await this.collection.getTokenTopmostOwner(this.tokenId, blockHashAt);3578 }35793580 async getChildren(blockHashAt?: string) {3581 return await this.collection.getTokenChildren(this.tokenId, blockHashAt);3582 }35833584 async nest(signer: TSigner, toTokenObj: IToken) {3585 return await this.collection.nestToken(signer, this.tokenId, toTokenObj);3586 }35873588 async unnest(signer: TSigner, fromTokenObj: IToken, toAddressObj: ICrossAccountId) {3589 return await this.collection.unnestToken(signer, this.tokenId, fromTokenObj, toAddressObj);3590 }35913592 async transfer(signer: TSigner, addressObj: ICrossAccountId) {3593 return await this.collection.transferToken(signer, this.tokenId, addressObj);3594 }35953596 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId) {3597 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj);3598 }35993600 async approve(signer: TSigner, toAddressObj: ICrossAccountId) {3601 return await this.collection.approveToken(signer, this.tokenId, toAddressObj);3602 }36033604 async isApproved(toAddressObj: ICrossAccountId) {3605 return await this.collection.isTokenApproved(this.tokenId, toAddressObj);3606 }36073608 async burn(signer: TSigner) {3609 return await this.collection.burnToken(signer, this.tokenId);3610 }36113612 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId) {3613 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj);3614 }36153616 scheduleAt<T extends UniqueHelper>(3617 executionBlockNumber: number,3618 options: ISchedulerOptions = {},3619 ) {3620 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3621 return new UniqueNFToken(this.tokenId, scheduledCollection);3622 }36233624 scheduleAfter<T extends UniqueHelper>(3625 blocksBeforeExecution: number,3626 options: ISchedulerOptions = {},3627 ) {3628 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3629 return new UniqueNFToken(this.tokenId, scheduledCollection);3630 }36313632 getSudo<T extends UniqueHelper>() {3633 return new UniqueNFToken(this.tokenId, this.collection.getSudo<T>());3634 }3635}36363637export class UniqueRFToken extends UniqueBaseToken {3638 collection: UniqueRFTCollection;36393640 constructor(tokenId: number, collection: UniqueRFTCollection) {3641 super(tokenId, collection);3642 this.collection = collection;3643 }36443645 async getData(blockHashAt?: string) {3646 return await this.collection.getToken(this.tokenId, blockHashAt);3647 }36483649 async getTop10Owners() {3650 return await this.collection.getTop10TokenOwners(this.tokenId);3651 }36523653 async getBalance(addressObj: ICrossAccountId) {3654 return await this.collection.getTokenBalance(this.tokenId, addressObj);3655 }36563657 async getTotalPieces() {3658 return await this.collection.getTokenTotalPieces(this.tokenId);3659 }36603661 async getApprovedPieces(fromAddressObj: ICrossAccountId, toAccountObj: ICrossAccountId) {3662 return await this.collection.getTokenApprovedPieces(this.tokenId, fromAddressObj, toAccountObj);3663 }36643665 async transfer(signer: TSigner, addressObj: ICrossAccountId, amount=1n) {3666 return await this.collection.transferToken(signer, this.tokenId, addressObj, amount);3667 }36683669 async transferFrom(signer: TSigner, fromAddressObj: ICrossAccountId, toAddressObj: ICrossAccountId, amount=1n) {3670 return await this.collection.transferTokenFrom(signer, this.tokenId, fromAddressObj, toAddressObj, amount);3671 }36723673 async approve(signer: TSigner, toAddressObj: ICrossAccountId, amount=1n) {3674 return await this.collection.approveToken(signer, this.tokenId, toAddressObj, amount);3675 }36763677 async repartition(signer: TSigner, amount: bigint) {3678 return await this.collection.repartitionToken(signer, this.tokenId, amount);3679 }36803681 async burn(signer: TSigner, amount=1n) {3682 return await this.collection.burnToken(signer, this.tokenId, amount);3683 }36843685 async burnFrom(signer: TSigner, fromAddressObj: ICrossAccountId, amount=1n) {3686 return await this.collection.burnTokenFrom(signer, this.tokenId, fromAddressObj, amount);3687 }36883689 scheduleAt<T extends UniqueHelper>(3690 executionBlockNumber: number,3691 options: ISchedulerOptions = {},3692 ) {3693 const scheduledCollection = this.collection.scheduleAt<T>(executionBlockNumber, options);3694 return new UniqueRFToken(this.tokenId, scheduledCollection);3695 }36963697 scheduleAfter<T extends UniqueHelper>(3698 blocksBeforeExecution: number,3699 options: ISchedulerOptions = {},3700 ) {3701 const scheduledCollection = this.collection.scheduleAfter<T>(blocksBeforeExecution, options);3702 return new UniqueRFToken(this.tokenId, scheduledCollection);3703 }37043705 getSudo<T extends UniqueHelper>() {3706 return new UniqueRFToken(this.tokenId, this.collection.getSudo<T>());3707 }3708}tests/src/xcm/xcmOpal.test.tsdiffbeforeafterboth--- a/tests/src/xcm/xcmOpal.test.ts
+++ b/tests/src/xcm/xcmOpal.test.ts
@@ -31,6 +31,7 @@
const ASSET_METADATA_DESCRIPTION = 'USDT';
const ASSET_METADATA_MINIMAL_BALANCE = 1n;
+const RELAY_DECIMALS = 12;
const WESTMINT_DECIMALS = 12;
const TRANSFER_AMOUNT = 1_000_000_000_000_000_000n;
@@ -147,9 +148,8 @@
};
const feeAssetItem = 0;
- const weightLimit = 5_000_000_000;
- await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, weightLimit);
+ await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
});
});
@@ -202,16 +202,15 @@
};
const feeAssetItem = 0;
- const weightLimit = 5000000000;
balanceStmnBefore = await helper.balance.getSubstrate(alice.address);
- await helper.xcm.limitedReserveTransferAssets(alice, dest, beneficiary, assets, feeAssetItem, weightLimit);
+ await helper.xcm.limitedReserveTransferAssets(alice, dest, beneficiary, assets, feeAssetItem, 'Unlimited');
balanceStmnAfter = await helper.balance.getSubstrate(alice.address);
// common good parachain take commission in it native token
console.log(
- 'Opal to Westmint transaction fees on Westmint: %s WND',
+ '[Westmint -> Opal] transaction fees on Westmint: %s WND',
helper.util.bigIntToDecimals(balanceStmnBefore - balanceStmnAfter, WESTMINT_DECIMALS),
);
expect(balanceStmnBefore > balanceStmnAfter).to.be.true;
@@ -227,18 +226,19 @@
balanceOpalAfter = await helper.balance.getSubstrate(alice.address);
- // commission has not paid in USDT token
- expect(free == TRANSFER_AMOUNT).to.be.true;
console.log(
- 'Opal to Westmint transaction fees on Opal: %s USDT',
- helper.util.bigIntToDecimals(TRANSFER_AMOUNT - free),
+ '[Westmint -> Opal] transaction fees on Opal: %s USDT',
+ helper.util.bigIntToDecimals(TRANSFER_AMOUNT - free, ASSET_METADATA_DECIMALS),
);
- // ... and parachain native token
- expect(balanceOpalAfter == balanceOpalBefore).to.be.true;
console.log(
- 'Opal to Westmint transaction fees on Opal: %s WND',
- helper.util.bigIntToDecimals(balanceOpalAfter - balanceOpalBefore, WESTMINT_DECIMALS),
+ '[Westmint -> Opal] transaction fees on Opal: %s OPL',
+ helper.util.bigIntToDecimals(balanceOpalAfter - balanceOpalBefore),
);
+
+ // commission has not paid in USDT token
+ expect(free == TRANSFER_AMOUNT).to.be.true;
+ // ... and parachain native token
+ expect(balanceOpalAfter == balanceOpalBefore).to.be.true;
});
itSub('Should connect and send USDT from Unique to Statemine back', async ({helper}) => {
@@ -276,9 +276,8 @@
];
const feeItem = 1;
- const destWeight = 500000000000;
- await helper.xTokens.transferMulticurrencies(alice, currencies, feeItem, destination, destWeight);
+ await helper.xTokens.transferMulticurrencies(alice, currencies, feeItem, destination, 'Unlimited');
// the commission has been paid in parachain native token
balanceOpalFinal = await helper.balance.getSubstrate(alice.address);
@@ -339,9 +338,8 @@
};
const feeAssetItem = 0;
- const weightLimit = 5_000_000_000;
- await helper.xcm.limitedReserveTransferAssets(bob, destination, beneficiary, assets, feeAssetItem, weightLimit);
+ await helper.xcm.limitedReserveTransferAssets(bob, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
});
await helper.wait.newBlocks(3);
@@ -363,20 +361,23 @@
});
itSub('Should connect and send Relay token back', async ({helper}) => {
+ let relayTokenBalanceBefore: bigint;
+ let relayTokenBalanceAfter: bigint;
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ relayTokenBalanceBefore = await helper.balance.getSubstrate(bob.address);
+ });
+
const destination = {
V1: {
parents: 1,
- interior: {X2: [
- {
- Parachain: STATEMINE_CHAIN,
- },
- {
+ interior: {
+ X1:{
AccountId32: {
network: 'Any',
id: bob.addressRaw,
},
},
- ]},
+ },
},
};
@@ -390,11 +391,19 @@
];
const feeItem = 0;
- const destWeight = 500000000000;
- await helper.xTokens.transferMulticurrencies(bob, currencies, feeItem, destination, destWeight);
+ await helper.xTokens.transferMulticurrencies(bob, currencies, feeItem, destination, 'Unlimited');
balanceBobFinal = await helper.balance.getSubstrate(bob.address);
- console.log('Relay (Westend) to Opal transaction fees: %s OPL', balanceBobAfter - balanceBobFinal);
+ console.log('[Opal -> Relay (Westend)] transaction fees: %s OPL', helper.util.bigIntToDecimals(balanceBobAfter - balanceBobFinal));
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ await helper.wait.newBlocks(10);
+ relayTokenBalanceAfter = await helper.balance.getSubstrate(bob.address);
+
+ const diff = relayTokenBalanceAfter - relayTokenBalanceBefore;
+ console.log('[Opal -> Relay (Westend)] actually delivered: %s WND', helper.util.bigIntToDecimals(diff, RELAY_DECIMALS));
+ expect(diff > 0, 'Relay tokens was not delivered back').to.be.true;
+ });
});
});
tests/src/xcm/xcmQuartz.test.tsdiffbeforeafterboth--- a/tests/src/xcm/xcmQuartz.test.ts
+++ b/tests/src/xcm/xcmQuartz.test.ts
@@ -17,21 +17,430 @@
import {IKeyringPair} from '@polkadot/types/types';
import {blake2AsHex} from '@polkadot/util-crypto';
import config from '../config';
-import {XcmV2TraitsOutcome, XcmV2TraitsError} from '../interfaces';
-import {itSub, expect, describeXCM, usingPlaygrounds, usingKaruraPlaygrounds, usingRelayPlaygrounds, usingMoonriverPlaygrounds} from '../util';
+import {XcmV2TraitsError} from '../interfaces';
+import {itSub, expect, describeXCM, usingPlaygrounds, usingKaruraPlaygrounds, usingRelayPlaygrounds, usingMoonriverPlaygrounds, usingStateminePlaygrounds} from '../util';
const QUARTZ_CHAIN = 2095;
+const STATEMINE_CHAIN = 1000;
const KARURA_CHAIN = 2000;
const MOONRIVER_CHAIN = 2023;
+const STATEMINE_PALLET_INSTANCE = 50;
+
const relayUrl = config.relayUrl;
+const statemineUrl = config.statemineUrl;
const karuraUrl = config.karuraUrl;
const moonriverUrl = config.moonriverUrl;
+const RELAY_DECIMALS = 12;
+const STATEMINE_DECIMALS = 12;
const KARURA_DECIMALS = 12;
const TRANSFER_AMOUNT = 2000000000000000000000000n;
+const FUNDING_AMOUNT = 3_500_000_0000_000_000n;
+
+const TRANSFER_AMOUNT_RELAY = 50_000_000_000_000_000n;
+
+const USDT_ASSET_ID = 100;
+const USDT_ASSET_METADATA_DECIMALS = 18;
+const USDT_ASSET_METADATA_NAME = 'USDT';
+const USDT_ASSET_METADATA_DESCRIPTION = 'USDT';
+const USDT_ASSET_METADATA_MINIMAL_BALANCE = 1n;
+const USDT_ASSET_AMOUNT = 10_000_000_000_000_000_000_000_000n;
+
+describeXCM('[XCM] Integration test: Exchanging USDT with Statemine', () => {
+ let alice: IKeyringPair;
+ let bob: IKeyringPair;
+
+ let balanceStmnBefore: bigint;
+ let balanceStmnAfter: bigint;
+
+ let balanceQuartzBefore: bigint;
+ let balanceQuartzAfter: bigint;
+ let balanceQuartzFinal: bigint;
+
+ let balanceBobBefore: bigint;
+ let balanceBobAfter: bigint;
+ let balanceBobFinal: bigint;
+
+ let balanceBobRelayTokenBefore: bigint;
+ let balanceBobRelayTokenAfter: bigint;
+
+
+ before(async () => {
+ await usingPlaygrounds(async (_helper, privateKey) => {
+ alice = await privateKey('//Alice');
+ bob = await privateKey('//Bob'); // sovereign account on Statemine(t) funds donor
+ });
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ // Fund accounts on Statemine(t)
+ await helper.xcm.teleportNativeAsset(alice, STATEMINE_CHAIN, alice.addressRaw, FUNDING_AMOUNT);
+ await helper.xcm.teleportNativeAsset(alice, STATEMINE_CHAIN, bob.addressRaw, FUNDING_AMOUNT);
+ });
+
+ await usingStateminePlaygrounds(statemineUrl, async (helper) => {
+ const sovereignFundingAmount = 3_500_000_000n;
+
+ await helper.assets.create(
+ alice,
+ USDT_ASSET_ID,
+ alice.address,
+ USDT_ASSET_METADATA_MINIMAL_BALANCE,
+ );
+ await helper.assets.setMetadata(
+ alice,
+ USDT_ASSET_ID,
+ USDT_ASSET_METADATA_NAME,
+ USDT_ASSET_METADATA_DESCRIPTION,
+ USDT_ASSET_METADATA_DECIMALS,
+ );
+ await helper.assets.mint(
+ alice,
+ USDT_ASSET_ID,
+ alice.address,
+ USDT_ASSET_AMOUNT,
+ );
+
+ // funding parachain sovereing account on Statemine(t).
+ // The sovereign account should be created before any action
+ // (the assets pallet on Statemine(t) check if the sovereign account exists)
+ const parachainSovereingAccount = helper.address.paraSiblingSovereignAccount(QUARTZ_CHAIN);
+ await helper.balance.transferToSubstrate(bob, parachainSovereingAccount, sovereignFundingAmount);
+ });
+
+
+ await usingPlaygrounds(async (helper) => {
+ const location = {
+ V1: {
+ parents: 1,
+ interior: {X3: [
+ {
+ Parachain: STATEMINE_CHAIN,
+ },
+ {
+ PalletInstance: STATEMINE_PALLET_INSTANCE,
+ },
+ {
+ GeneralIndex: USDT_ASSET_ID,
+ },
+ ]},
+ },
+ };
+
+ const metadata =
+ {
+ name: USDT_ASSET_ID,
+ symbol: USDT_ASSET_METADATA_NAME,
+ decimals: USDT_ASSET_METADATA_DECIMALS,
+ minimalBalance: USDT_ASSET_METADATA_MINIMAL_BALANCE,
+ };
+ await helper.getSudo().foreignAssets.register(alice, alice.address, location, metadata);
+ balanceQuartzBefore = await helper.balance.getSubstrate(alice.address);
+ });
+
+
+ // Providing the relay currency to the quartz sender account
+ // (fee for USDT XCM are paid in relay tokens)
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ const destination = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ Parachain: QUARTZ_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: 'Here',
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT_RELAY,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
+ });
+
+ });
+
+ itSub('Should connect and send USDT from Statemine to Quartz', async ({helper}) => {
+ await usingStateminePlaygrounds(statemineUrl, async (helper) => {
+ const dest = {
+ V1: {
+ parents: 1,
+ interior: {X1: {
+ Parachain: QUARTZ_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: {
+ X2: [
+ {
+ PalletInstance: STATEMINE_PALLET_INSTANCE,
+ },
+ {
+ GeneralIndex: USDT_ASSET_ID,
+ },
+ ]},
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ balanceStmnBefore = await helper.balance.getSubstrate(alice.address);
+ await helper.xcm.limitedReserveTransferAssets(alice, dest, beneficiary, assets, feeAssetItem, 'Unlimited');
+
+ balanceStmnAfter = await helper.balance.getSubstrate(alice.address);
+
+ // common good parachain take commission in it native token
+ console.log(
+ '[Statemine -> Quartz] transaction fees on Statemine: %s WND',
+ helper.util.bigIntToDecimals(balanceStmnBefore - balanceStmnAfter, STATEMINE_DECIMALS),
+ );
+ expect(balanceStmnBefore > balanceStmnAfter).to.be.true;
+
+ });
+
+
+ // ensure that asset has been delivered
+ await helper.wait.newBlocks(3);
+
+ // expext collection id will be with id 1
+ const free = await helper.ft.getBalance(1, {Substrate: alice.address});
+
+ balanceQuartzAfter = await helper.balance.getSubstrate(alice.address);
+
+ console.log(
+ '[Statemine -> Quartz] transaction fees on Quartz: %s USDT',
+ helper.util.bigIntToDecimals(TRANSFER_AMOUNT - free, USDT_ASSET_METADATA_DECIMALS),
+ );
+ console.log(
+ '[Statemine -> Quartz] transaction fees on Quartz: %s QTZ',
+ helper.util.bigIntToDecimals(balanceQuartzAfter - balanceQuartzBefore),
+ );
+ // commission has not paid in USDT token
+ expect(free).to.be.equal(TRANSFER_AMOUNT);
+ // ... and parachain native token
+ expect(balanceQuartzAfter == balanceQuartzBefore).to.be.true;
+ });
+
+ itSub('Should connect and send USDT from Quartz to Statemine back', async ({helper}) => {
+ const destination = {
+ V1: {
+ parents: 1,
+ interior: {X2: [
+ {
+ Parachain: STATEMINE_CHAIN,
+ },
+ {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ },
+ ]},
+ },
+ };
+
+ const relayFee = 400_000_000_000_000n;
+ const currencies: [any, bigint][] = [
+ [
+ {
+ ForeignAssetId: 0,
+ },
+ TRANSFER_AMOUNT,
+ ],
+ [
+ {
+ NativeAssetId: 'Parent',
+ },
+ relayFee,
+ ],
+ ];
+
+ const feeItem = 1;
+
+ await helper.xTokens.transferMulticurrencies(alice, currencies, feeItem, destination, 'Unlimited');
+
+ // the commission has been paid in parachain native token
+ balanceQuartzFinal = await helper.balance.getSubstrate(alice.address);
+ console.log('[Quartz -> Statemine] transaction fees on Quartz: %s QTZ', helper.util.bigIntToDecimals(balanceQuartzFinal - balanceQuartzAfter));
+ expect(balanceQuartzAfter > balanceQuartzFinal).to.be.true;
+
+ await usingStateminePlaygrounds(statemineUrl, async (helper) => {
+ await helper.wait.newBlocks(3);
+
+ // The USDT token never paid fees. Its amount not changed from begin value.
+ // Also check that xcm transfer has been succeeded
+ expect((await helper.assets.account(USDT_ASSET_ID, alice.address))! == USDT_ASSET_AMOUNT).to.be.true;
+ });
+ });
+
+ itSub('Should connect and send Relay token to Quartz', async ({helper}) => {
+ balanceBobBefore = await helper.balance.getSubstrate(bob.address);
+ balanceBobRelayTokenBefore = await helper.tokens.accounts(bob.address, {NativeAssetId: 'Parent'});
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ const destination = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ Parachain: QUARTZ_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: bob.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: 'Here',
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT_RELAY,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ await helper.xcm.limitedReserveTransferAssets(bob, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
+ });
+
+ await helper.wait.newBlocks(3);
+
+ balanceBobAfter = await helper.balance.getSubstrate(bob.address);
+ balanceBobRelayTokenAfter = await helper.tokens.accounts(bob.address, {NativeAssetId: 'Parent'});
+
+ const wndFeeOnQuartz = balanceBobRelayTokenAfter - TRANSFER_AMOUNT_RELAY - balanceBobRelayTokenBefore;
+ const wndDiffOnQuartz = balanceBobRelayTokenAfter - balanceBobRelayTokenBefore;
+ console.log(
+ '[Relay (Westend) -> Quartz] transaction fees: %s QTZ',
+ helper.util.bigIntToDecimals(balanceBobAfter - balanceBobBefore),
+ );
+ console.log(
+ '[Relay (Westend) -> Quartz] transaction fees: %s WND',
+ helper.util.bigIntToDecimals(wndFeeOnQuartz, STATEMINE_DECIMALS),
+ );
+ console.log('[Relay (Westend) -> Quartz] actually delivered: %s WND', wndDiffOnQuartz);
+ expect(wndFeeOnQuartz == 0n, 'No incoming WND fees should be taken').to.be.true;
+ expect(balanceBobBefore == balanceBobAfter, 'No incoming QTZ fees should be taken').to.be.true;
+ });
+
+ itSub('Should connect and send Relay token back', async ({helper}) => {
+ let relayTokenBalanceBefore: bigint;
+ let relayTokenBalanceAfter: bigint;
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ relayTokenBalanceBefore = await helper.balance.getSubstrate(bob.address);
+ });
+
+ const destination = {
+ V1: {
+ parents: 1,
+ interior: {
+ X1:{
+ AccountId32: {
+ network: 'Any',
+ id: bob.addressRaw,
+ },
+ },
+ },
+ },
+ };
+
+ const currencies: any = [
+ [
+ {
+ NativeAssetId: 'Parent',
+ },
+ TRANSFER_AMOUNT_RELAY,
+ ],
+ ];
+
+ const feeItem = 0;
+
+ await helper.xTokens.transferMulticurrencies(bob, currencies, feeItem, destination, 'Unlimited');
+
+ balanceBobFinal = await helper.balance.getSubstrate(bob.address);
+ console.log('[Quartz -> Relay (Westend)] transaction fees: %s QTZ', helper.util.bigIntToDecimals(balanceBobAfter - balanceBobFinal));
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ await helper.wait.newBlocks(10);
+ relayTokenBalanceAfter = await helper.balance.getSubstrate(bob.address);
+
+ const diff = relayTokenBalanceAfter - relayTokenBalanceBefore;
+ console.log('[Quartz -> Relay (Westend)] actually delivered: %s WND', helper.util.bigIntToDecimals(diff, RELAY_DECIMALS));
+ expect(diff > 0, 'Relay tokens was not delivered back').to.be.true;
+ });
+ });
+});
+
describeXCM('[XCM] Integration test: Exchanging tokens with Karura', () => {
let alice: IKeyringPair;
let randomAccount: IKeyringPair;
@@ -123,14 +532,13 @@
};
const feeAssetItem = 0;
- const weightLimit = 5000000000;
- await helper.xcm.limitedReserveTransferAssets(randomAccount, destination, beneficiary, assets, feeAssetItem, weightLimit);
+ await helper.xcm.limitedReserveTransferAssets(randomAccount, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
balanceQuartzTokenMiddle = await helper.balance.getSubstrate(randomAccount.address);
const qtzFees = balanceQuartzTokenInit - balanceQuartzTokenMiddle - TRANSFER_AMOUNT;
+ expect(qtzFees > 0n, 'Negative fees QTZ, looks like nothing was transferred').to.be.true;
console.log('[Quartz -> Karura] transaction fees on Quartz: %s QTZ', helper.util.bigIntToDecimals(qtzFees));
- expect(qtzFees > 0n).to.be.true;
await usingKaruraPlaygrounds(karuraUrl, async (helper) => {
await helper.wait.newBlocks(3);
@@ -173,9 +581,7 @@
ForeignAsset: 0,
};
- const destWeight = 50000000;
-
- await helper.xTokens.transfer(randomAccount, id, TRANSFER_AMOUNT, destination, destWeight);
+ await helper.xTokens.transfer(randomAccount, id, TRANSFER_AMOUNT, destination, 'Unlimited');
balanceKaruraTokenFinal = await helper.balance.getSubstrate(randomAccount.address);
balanceQuartzForeignTokenFinal = await helper.tokens.accounts(randomAccount.address, id);
@@ -188,7 +594,7 @@
);
console.log('[Karura -> Quartz] outcome %s QTZ', helper.util.bigIntToDecimals(qtzOutcomeTransfer));
- expect(karFees > 0).to.be.true;
+ expect(karFees > 0, 'Negative fees KAR, looks like nothing was transferred').to.be.true;
expect(qtzOutcomeTransfer == TRANSFER_AMOUNT).to.be.true;
});
@@ -215,76 +621,7 @@
alice = await privateKey('//Alice');
});
});
-
- itSub('Quartz rejects tokens from the Relay', async ({helper}) => {
- await usingRelayPlaygrounds(relayUrl, async (helper) => {
- const destination = {
- V1: {
- parents: 0,
- interior: {X1: {
- Parachain: QUARTZ_CHAIN,
- },
- },
- }};
-
- const beneficiary = {
- V1: {
- parents: 0,
- interior: {X1: {
- AccountId32: {
- network: 'Any',
- id: alice.addressRaw,
- },
- }},
- },
- };
-
- const assets = {
- V1: [
- {
- id: {
- Concrete: {
- parents: 0,
- interior: 'Here',
- },
- },
- fun: {
- Fungible: 50_000_000_000_000_000n,
- },
- },
- ],
- };
-
- const feeAssetItem = 0;
- const weightLimit = 5_000_000_000;
-
- await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, weightLimit);
- });
- const maxWaitBlocks = 3;
-
- const dmpQueueExecutedDownward = await helper.wait.event(maxWaitBlocks, 'dmpQueue', 'ExecutedDownward');
-
- expect(
- dmpQueueExecutedDownward != null,
- '[Relay] dmpQueue.ExecutedDownward event is expected',
- ).to.be.true;
-
- const event = dmpQueueExecutedDownward!.event;
- const outcome = event.data[1] as XcmV2TraitsOutcome;
-
- expect(
- outcome.isIncomplete,
- '[Relay] The outcome of the XCM should be `Incomplete`',
- ).to.be.true;
-
- const incomplete = outcome.asIncomplete;
- expect(
- incomplete[1].toString() == 'AssetNotFound',
- '[Relay] The XCM error should be `AssetNotFound`',
- ).to.be.true;
- });
-
itSub('Quartz rejects KAR tokens from Karura', async ({helper}) => {
await usingKaruraPlaygrounds(karuraUrl, async (helper) => {
const destination = {
@@ -308,9 +645,7 @@
Token: 'KAR',
};
- const destWeight = 50000000;
-
- await helper.xTokens.transfer(alice, id, 100_000_000_000n, destination, destWeight);
+ await helper.xTokens.transfer(alice, id, 100_000_000_000n, destination, 'Unlimited');
});
const maxWaitBlocks = 3;
@@ -326,8 +661,8 @@
const outcome = event.data[1] as XcmV2TraitsError;
expect(
- outcome.isUntrustedReserveLocation,
- '[Karura] The XCM error should be `UntrustedReserveLocation`',
+ outcome.isFailedToTransactAsset,
+ '[Karura] The XCM error should be `FailedToTransactAsset`',
).to.be.true;
});
});
@@ -420,7 +755,7 @@
// >>> Propose external motion through council >>>
console.log('Propose external motion through council.......');
- const externalMotion = helper.democracy.externalProposeMajority(proposalHash);
+ const externalMotion = helper.democracy.externalProposeMajority({Legacy: proposalHash});
const encodedMotion = externalMotion?.method.toHex() || '';
const motionHash = blake2AsHex(encodedMotion);
console.log('Motion hash is %s', motionHash);
@@ -431,7 +766,16 @@
await helper.collective.council.vote(dorothyAccount, motionHash, councilProposalIdx, true);
await helper.collective.council.vote(baltatharAccount, motionHash, councilProposalIdx, true);
- await helper.collective.council.close(dorothyAccount, motionHash, councilProposalIdx, 1_000_000_000, externalMotion.encodedLength);
+ await helper.collective.council.close(
+ dorothyAccount,
+ motionHash,
+ councilProposalIdx,
+ {
+ refTime: 1_000_000_000,
+ proofSize: 1_000_000,
+ },
+ externalMotion.encodedLength,
+ );
console.log('Propose external motion through council.......DONE');
// <<< Propose external motion through council <<<
@@ -448,7 +792,16 @@
await helper.collective.techCommittee.vote(baltatharAccount, fastTrackHash, techProposalIdx, true);
await helper.collective.techCommittee.vote(alithAccount, fastTrackHash, techProposalIdx, true);
- await helper.collective.techCommittee.close(baltatharAccount, fastTrackHash, techProposalIdx, 1_000_000_000, fastTrack.encodedLength);
+ await helper.collective.techCommittee.close(
+ baltatharAccount,
+ fastTrackHash,
+ techProposalIdx,
+ {
+ refTime: 1_000_000_000,
+ proofSize: 1_000_000,
+ },
+ fastTrack.encodedLength,
+ );
console.log('Fast track proposal through technical committee.......DONE');
// <<< Fast track proposal through technical committee <<<
@@ -504,16 +857,15 @@
},
};
const amount = TRANSFER_AMOUNT;
- const destWeight = 850000000;
- await helper.xTokens.transfer(randomAccountQuartz, currencyId, amount, dest, destWeight);
+ await helper.xTokens.transfer(randomAccountQuartz, currencyId, amount, dest, 'Unlimited');
balanceQuartzTokenMiddle = await helper.balance.getSubstrate(randomAccountQuartz.address);
expect(balanceQuartzTokenMiddle < balanceQuartzTokenInit).to.be.true;
const transactionFees = balanceQuartzTokenInit - balanceQuartzTokenMiddle - TRANSFER_AMOUNT;
console.log('[Quartz -> Moonriver] transaction fees on Quartz: %s QTZ', helper.util.bigIntToDecimals(transactionFees));
- expect(transactionFees > 0).to.be.true;
+ expect(transactionFees > 0, 'Negative fees QTZ, looks like nothing was transferred').to.be.true;
await usingMoonriverPlaygrounds(moonriverUrl, async (helper) => {
await helper.wait.newBlocks(3);
@@ -559,15 +911,14 @@
},
},
};
- const destWeight = 50000000;
- await helper.xTokens.transferMultiasset(randomAccountMoonriver, asset, destination, destWeight);
+ await helper.xTokens.transferMultiasset(randomAccountMoonriver, asset, destination, 'Unlimited');
balanceMovrTokenFinal = await helper.balance.getEthereum(randomAccountMoonriver.address);
const movrFees = balanceMovrTokenMiddle - balanceMovrTokenFinal;
console.log('[Moonriver -> Quartz] transaction fees on Moonriver: %s MOVR', helper.util.bigIntToDecimals(movrFees));
- expect(movrFees > 0).to.be.true;
+ expect(movrFees > 0, 'Negative fees MOVR, looks like nothing was transferred').to.be.true;
const qtzRandomAccountAsset = await helper.assets.account(assetId, randomAccountMoonriver.address);
tests/src/xcm/xcmUnique.test.tsdiffbeforeafterboth--- a/tests/src/xcm/xcmUnique.test.ts
+++ b/tests/src/xcm/xcmUnique.test.ts
@@ -17,21 +17,430 @@
import {IKeyringPair} from '@polkadot/types/types';
import {blake2AsHex} from '@polkadot/util-crypto';
import config from '../config';
-import {XcmV2TraitsError, XcmV2TraitsOutcome} from '../interfaces';
-import {itSub, expect, describeXCM, usingPlaygrounds, usingAcalaPlaygrounds, usingRelayPlaygrounds, usingMoonbeamPlaygrounds} from '../util';
+import {XcmV2TraitsError} from '../interfaces';
+import {itSub, expect, describeXCM, usingPlaygrounds, usingAcalaPlaygrounds, usingRelayPlaygrounds, usingMoonbeamPlaygrounds, usingStatemintPlaygrounds} from '../util';
const UNIQUE_CHAIN = 2037;
+const STATEMINT_CHAIN = 1000;
const ACALA_CHAIN = 2000;
const MOONBEAM_CHAIN = 2004;
+const STATEMINT_PALLET_INSTANCE = 50;
+
const relayUrl = config.relayUrl;
+const statemintUrl = config.statemintUrl;
const acalaUrl = config.acalaUrl;
const moonbeamUrl = config.moonbeamUrl;
+const RELAY_DECIMALS = 12;
+const STATEMINT_DECIMALS = 12;
const ACALA_DECIMALS = 12;
const TRANSFER_AMOUNT = 2000000000000000000000000n;
+const FUNDING_AMOUNT = 3_500_000_0000_000_000n;
+
+const TRANSFER_AMOUNT_RELAY = 50_000_000_000_000_000n;
+
+const USDT_ASSET_ID = 100;
+const USDT_ASSET_METADATA_DECIMALS = 18;
+const USDT_ASSET_METADATA_NAME = 'USDT';
+const USDT_ASSET_METADATA_DESCRIPTION = 'USDT';
+const USDT_ASSET_METADATA_MINIMAL_BALANCE = 1n;
+const USDT_ASSET_AMOUNT = 10_000_000_000_000_000_000_000_000n;
+
+describeXCM('[XCM] Integration test: Exchanging USDT with Statemint', () => {
+ let alice: IKeyringPair;
+ let bob: IKeyringPair;
+
+ let balanceStmnBefore: bigint;
+ let balanceStmnAfter: bigint;
+
+ let balanceUniqueBefore: bigint;
+ let balanceUniqueAfter: bigint;
+ let balanceUniqueFinal: bigint;
+
+ let balanceBobBefore: bigint;
+ let balanceBobAfter: bigint;
+ let balanceBobFinal: bigint;
+
+ let balanceBobRelayTokenBefore: bigint;
+ let balanceBobRelayTokenAfter: bigint;
+
+
+ before(async () => {
+ await usingPlaygrounds(async (_helper, privateKey) => {
+ alice = await privateKey('//Alice');
+ bob = await privateKey('//Bob'); // sovereign account on Statemint funds donor
+ });
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ // Fund accounts on Statemint
+ await helper.xcm.teleportNativeAsset(alice, STATEMINT_CHAIN, alice.addressRaw, FUNDING_AMOUNT);
+ await helper.xcm.teleportNativeAsset(alice, STATEMINT_CHAIN, bob.addressRaw, FUNDING_AMOUNT);
+ });
+
+ await usingStatemintPlaygrounds(statemintUrl, async (helper) => {
+ const sovereignFundingAmount = 3_500_000_000n;
+
+ await helper.assets.create(
+ alice,
+ USDT_ASSET_ID,
+ alice.address,
+ USDT_ASSET_METADATA_MINIMAL_BALANCE,
+ );
+ await helper.assets.setMetadata(
+ alice,
+ USDT_ASSET_ID,
+ USDT_ASSET_METADATA_NAME,
+ USDT_ASSET_METADATA_DESCRIPTION,
+ USDT_ASSET_METADATA_DECIMALS,
+ );
+ await helper.assets.mint(
+ alice,
+ USDT_ASSET_ID,
+ alice.address,
+ USDT_ASSET_AMOUNT,
+ );
+
+ // funding parachain sovereing account on Statemint.
+ // The sovereign account should be created before any action
+ // (the assets pallet on Statemint check if the sovereign account exists)
+ const parachainSovereingAccount = helper.address.paraSiblingSovereignAccount(UNIQUE_CHAIN);
+ await helper.balance.transferToSubstrate(bob, parachainSovereingAccount, sovereignFundingAmount);
+ });
+
+
+ await usingPlaygrounds(async (helper) => {
+ const location = {
+ V1: {
+ parents: 1,
+ interior: {X3: [
+ {
+ Parachain: STATEMINT_CHAIN,
+ },
+ {
+ PalletInstance: STATEMINT_PALLET_INSTANCE,
+ },
+ {
+ GeneralIndex: USDT_ASSET_ID,
+ },
+ ]},
+ },
+ };
+
+ const metadata =
+ {
+ name: USDT_ASSET_ID,
+ symbol: USDT_ASSET_METADATA_NAME,
+ decimals: USDT_ASSET_METADATA_DECIMALS,
+ minimalBalance: USDT_ASSET_METADATA_MINIMAL_BALANCE,
+ };
+ await helper.getSudo().foreignAssets.register(alice, alice.address, location, metadata);
+ balanceUniqueBefore = await helper.balance.getSubstrate(alice.address);
+ });
+
+
+ // Providing the relay currency to the unique sender account
+ // (fee for USDT XCM are paid in relay tokens)
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ const destination = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ Parachain: UNIQUE_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: 'Here',
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT_RELAY,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
+ });
+
+ });
+
+ itSub('Should connect and send USDT from Statemint to Unique', async ({helper}) => {
+ await usingStatemintPlaygrounds(statemintUrl, async (helper) => {
+ const dest = {
+ V1: {
+ parents: 1,
+ interior: {X1: {
+ Parachain: UNIQUE_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: {
+ X2: [
+ {
+ PalletInstance: STATEMINT_PALLET_INSTANCE,
+ },
+ {
+ GeneralIndex: USDT_ASSET_ID,
+ },
+ ]},
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ balanceStmnBefore = await helper.balance.getSubstrate(alice.address);
+ await helper.xcm.limitedReserveTransferAssets(alice, dest, beneficiary, assets, feeAssetItem, 'Unlimited');
+
+ balanceStmnAfter = await helper.balance.getSubstrate(alice.address);
+
+ // common good parachain take commission in it native token
+ console.log(
+ '[Statemint -> Unique] transaction fees on Statemint: %s WND',
+ helper.util.bigIntToDecimals(balanceStmnBefore - balanceStmnAfter, STATEMINT_DECIMALS),
+ );
+ expect(balanceStmnBefore > balanceStmnAfter).to.be.true;
+
+ });
+
+
+ // ensure that asset has been delivered
+ await helper.wait.newBlocks(3);
+
+ // expext collection id will be with id 1
+ const free = await helper.ft.getBalance(1, {Substrate: alice.address});
+
+ balanceUniqueAfter = await helper.balance.getSubstrate(alice.address);
+
+ console.log(
+ '[Statemint -> Unique] transaction fees on Unique: %s USDT',
+ helper.util.bigIntToDecimals(TRANSFER_AMOUNT - free, USDT_ASSET_METADATA_DECIMALS),
+ );
+ console.log(
+ '[Statemint -> Unique] transaction fees on Unique: %s UNQ',
+ helper.util.bigIntToDecimals(balanceUniqueAfter - balanceUniqueBefore),
+ );
+ // commission has not paid in USDT token
+ expect(free).to.be.equal(TRANSFER_AMOUNT);
+ // ... and parachain native token
+ expect(balanceUniqueAfter == balanceUniqueBefore).to.be.true;
+ });
+
+ itSub('Should connect and send USDT from Unique to Statemint back', async ({helper}) => {
+ const destination = {
+ V1: {
+ parents: 1,
+ interior: {X2: [
+ {
+ Parachain: STATEMINT_CHAIN,
+ },
+ {
+ AccountId32: {
+ network: 'Any',
+ id: alice.addressRaw,
+ },
+ },
+ ]},
+ },
+ };
+
+ const relayFee = 400_000_000_000_000n;
+ const currencies: [any, bigint][] = [
+ [
+ {
+ ForeignAssetId: 0,
+ },
+ TRANSFER_AMOUNT,
+ ],
+ [
+ {
+ NativeAssetId: 'Parent',
+ },
+ relayFee,
+ ],
+ ];
+
+ const feeItem = 1;
+
+ await helper.xTokens.transferMulticurrencies(alice, currencies, feeItem, destination, 'Unlimited');
+
+ // the commission has been paid in parachain native token
+ balanceUniqueFinal = await helper.balance.getSubstrate(alice.address);
+ console.log('[Unique -> Statemint] transaction fees on Unique: %s UNQ', helper.util.bigIntToDecimals(balanceUniqueFinal - balanceUniqueAfter));
+ expect(balanceUniqueAfter > balanceUniqueFinal).to.be.true;
+
+ await usingStatemintPlaygrounds(statemintUrl, async (helper) => {
+ await helper.wait.newBlocks(3);
+
+ // The USDT token never paid fees. Its amount not changed from begin value.
+ // Also check that xcm transfer has been succeeded
+ expect((await helper.assets.account(USDT_ASSET_ID, alice.address))! == USDT_ASSET_AMOUNT).to.be.true;
+ });
+ });
+
+ itSub('Should connect and send Relay token to Unique', async ({helper}) => {
+ balanceBobBefore = await helper.balance.getSubstrate(bob.address);
+ balanceBobRelayTokenBefore = await helper.tokens.accounts(bob.address, {NativeAssetId: 'Parent'});
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ const destination = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ Parachain: UNIQUE_CHAIN,
+ },
+ },
+ }};
+
+ const beneficiary = {
+ V1: {
+ parents: 0,
+ interior: {X1: {
+ AccountId32: {
+ network: 'Any',
+ id: bob.addressRaw,
+ },
+ }},
+ },
+ };
+
+ const assets = {
+ V1: [
+ {
+ id: {
+ Concrete: {
+ parents: 0,
+ interior: 'Here',
+ },
+ },
+ fun: {
+ Fungible: TRANSFER_AMOUNT_RELAY,
+ },
+ },
+ ],
+ };
+
+ const feeAssetItem = 0;
+
+ await helper.xcm.limitedReserveTransferAssets(bob, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
+ });
+
+ await helper.wait.newBlocks(3);
+
+ balanceBobAfter = await helper.balance.getSubstrate(bob.address);
+ balanceBobRelayTokenAfter = await helper.tokens.accounts(bob.address, {NativeAssetId: 'Parent'});
+
+ const wndFeeOnUnique = balanceBobRelayTokenAfter - TRANSFER_AMOUNT_RELAY - balanceBobRelayTokenBefore;
+ const wndDiffOnUnique = balanceBobRelayTokenAfter - balanceBobRelayTokenBefore;
+ console.log(
+ '[Relay (Westend) -> Unique] transaction fees: %s UNQ',
+ helper.util.bigIntToDecimals(balanceBobAfter - balanceBobBefore),
+ );
+ console.log(
+ '[Relay (Westend) -> Unique] transaction fees: %s WND',
+ helper.util.bigIntToDecimals(wndFeeOnUnique, STATEMINT_DECIMALS),
+ );
+ console.log('[Relay (Westend) -> Unique] actually delivered: %s WND', wndDiffOnUnique);
+ expect(wndFeeOnUnique == 0n, 'No incoming WND fees should be taken').to.be.true;
+ expect(balanceBobBefore == balanceBobAfter, 'No incoming UNQ fees should be taken').to.be.true;
+ });
+
+ itSub('Should connect and send Relay token back', async ({helper}) => {
+ let relayTokenBalanceBefore: bigint;
+ let relayTokenBalanceAfter: bigint;
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ relayTokenBalanceBefore = await helper.balance.getSubstrate(bob.address);
+ });
+
+ const destination = {
+ V1: {
+ parents: 1,
+ interior: {
+ X1:{
+ AccountId32: {
+ network: 'Any',
+ id: bob.addressRaw,
+ },
+ },
+ },
+ },
+ };
+
+ const currencies: any = [
+ [
+ {
+ NativeAssetId: 'Parent',
+ },
+ TRANSFER_AMOUNT_RELAY,
+ ],
+ ];
+
+ const feeItem = 0;
+
+ await helper.xTokens.transferMulticurrencies(bob, currencies, feeItem, destination, 'Unlimited');
+
+ balanceBobFinal = await helper.balance.getSubstrate(bob.address);
+ console.log('[Unique -> Relay (Westend)] transaction fees: %s UNQ', helper.util.bigIntToDecimals(balanceBobAfter - balanceBobFinal));
+
+ await usingRelayPlaygrounds(relayUrl, async (helper) => {
+ await helper.wait.newBlocks(10);
+ relayTokenBalanceAfter = await helper.balance.getSubstrate(bob.address);
+
+ const diff = relayTokenBalanceAfter - relayTokenBalanceBefore;
+ console.log('[Unique -> Relay (Westend)] actually delivered: %s WND', helper.util.bigIntToDecimals(diff, RELAY_DECIMALS));
+ expect(diff > 0, 'Relay tokens was not delivered back').to.be.true;
+ });
+ });
+});
+
describeXCM('[XCM] Integration test: Exchanging tokens with Acala', () => {
let alice: IKeyringPair;
let randomAccount: IKeyringPair;
@@ -124,15 +533,13 @@
};
const feeAssetItem = 0;
- const weightLimit = 5000000000;
- await helper.xcm.limitedReserveTransferAssets(randomAccount, destination, beneficiary, assets, feeAssetItem, weightLimit);
-
+ await helper.xcm.limitedReserveTransferAssets(randomAccount, destination, beneficiary, assets, feeAssetItem, 'Unlimited');
balanceUniqueTokenMiddle = await helper.balance.getSubstrate(randomAccount.address);
const unqFees = balanceUniqueTokenInit - balanceUniqueTokenMiddle - TRANSFER_AMOUNT;
console.log('[Unique -> Acala] transaction fees on Unique: %s UNQ', helper.util.bigIntToDecimals(unqFees));
- expect(unqFees > 0n).to.be.true;
+ expect(unqFees > 0n, 'Negative fees UNQ, looks like nothing was transferred').to.be.true;
await usingAcalaPlaygrounds(acalaUrl, async (helper) => {
await helper.wait.newBlocks(3);
@@ -176,10 +583,7 @@
ForeignAsset: 0,
};
- const destWeight = 50000000;
-
- await helper.xTokens.transfer(randomAccount, id, TRANSFER_AMOUNT, destination, destWeight);
-
+ await helper.xTokens.transfer(randomAccount, id, TRANSFER_AMOUNT, destination, 'Unlimited');
balanceAcalaTokenFinal = await helper.balance.getSubstrate(randomAccount.address);
balanceUniqueForeignTokenFinal = await helper.tokens.accounts(randomAccount.address, id);
@@ -192,7 +596,7 @@
);
console.log('[Acala -> Unique] outcome %s UNQ', helper.util.bigIntToDecimals(unqOutcomeTransfer));
- expect(acaFees > 0).to.be.true;
+ expect(acaFees > 0, 'Negative fees ACA, looks like nothing was transferred').to.be.true;
expect(unqOutcomeTransfer == TRANSFER_AMOUNT).to.be.true;
});
@@ -219,76 +623,7 @@
alice = await privateKey('//Alice');
});
});
-
- itSub('Unique rejects tokens from the Relay', async ({helper}) => {
- await usingRelayPlaygrounds(relayUrl, async (helper) => {
- const destination = {
- V1: {
- parents: 0,
- interior: {X1: {
- Parachain: UNIQUE_CHAIN,
- },
- },
- }};
- const beneficiary = {
- V1: {
- parents: 0,
- interior: {X1: {
- AccountId32: {
- network: 'Any',
- id: alice.addressRaw,
- },
- }},
- },
- };
-
- const assets = {
- V1: [
- {
- id: {
- Concrete: {
- parents: 0,
- interior: 'Here',
- },
- },
- fun: {
- Fungible: 50_000_000_000_000_000n,
- },
- },
- ],
- };
-
- const feeAssetItem = 0;
- const weightLimit = 5_000_000_000;
-
- await helper.xcm.limitedReserveTransferAssets(alice, destination, beneficiary, assets, feeAssetItem, weightLimit);
- });
-
- const maxWaitBlocks = 3;
-
- const dmpQueueExecutedDownward = await helper.wait.event(maxWaitBlocks, 'dmpQueue', 'ExecutedDownward');
-
- expect(
- dmpQueueExecutedDownward != null,
- '[Relay] dmpQueue.ExecutedDownward event is expected',
- ).to.be.true;
-
- const event = dmpQueueExecutedDownward!.event;
- const outcome = event.data[1] as XcmV2TraitsOutcome;
-
- expect(
- outcome.isIncomplete,
- '[Relay] The outcome of the XCM should be `Incomplete`',
- ).to.be.true;
-
- const incomplete = outcome.asIncomplete;
- expect(
- incomplete[1].toString() == 'AssetNotFound',
- '[Relay] The XCM error should be `AssetNotFound`',
- ).to.be.true;
- });
-
itSub('Unique rejects ACA tokens from Acala', async ({helper}) => {
await usingAcalaPlaygrounds(acalaUrl, async (helper) => {
const destination = {
@@ -312,9 +647,7 @@
Token: 'ACA',
};
- const destWeight = 50000000;
-
- await helper.xTokens.transfer(alice, id, 100_000_000_000n, destination, destWeight);
+ await helper.xTokens.transfer(alice, id, 100_000_000_000n, destination, 'Unlimited');
});
const maxWaitBlocks = 3;
@@ -330,8 +663,8 @@
const outcome = event.data[1] as XcmV2TraitsError;
expect(
- outcome.isUntrustedReserveLocation,
- '[Acala] The XCM error should be `UntrustedReserveLocation`',
+ outcome.isFailedToTransactAsset,
+ '[Acala] The XCM error should be `FailedToTransactAsset`',
).to.be.true;
});
});
@@ -508,16 +841,15 @@
},
};
const amount = TRANSFER_AMOUNT;
- const destWeight = 850000000;
- await helper.xTokens.transfer(randomAccountUnique, currencyId, amount, dest, destWeight);
+ await helper.xTokens.transfer(randomAccountUnique, currencyId, amount, dest, 'Unlimited');
balanceUniqueTokenMiddle = await helper.balance.getSubstrate(randomAccountUnique.address);
expect(balanceUniqueTokenMiddle < balanceUniqueTokenInit).to.be.true;
const transactionFees = balanceUniqueTokenInit - balanceUniqueTokenMiddle - TRANSFER_AMOUNT;
console.log('[Unique -> Moonbeam] transaction fees on Unique: %s UNQ', helper.util.bigIntToDecimals(transactionFees));
- expect(transactionFees > 0).to.be.true;
+ expect(transactionFees > 0, 'Negative fees UNQ, looks like nothing was transferred').to.be.true;
await usingMoonbeamPlaygrounds(moonbeamUrl, async (helper) => {
await helper.wait.newBlocks(3);
@@ -572,7 +904,7 @@
const glmrFees = balanceGlmrTokenMiddle - balanceGlmrTokenFinal;
console.log('[Moonbeam -> Unique] transaction fees on Moonbeam: %s GLMR', helper.util.bigIntToDecimals(glmrFees));
- expect(glmrFees > 0).to.be.true;
+ expect(glmrFees > 0, 'Negative fees GLMR, looks like nothing was transferred').to.be.true;
const unqRandomAccountAsset = await helper.assets.account(assetId, randomAccountMoonbeam.address);