difftreelog
feat Rewrite tuple to named structures for TokenPropertyPermission. fix: AbiCoder derive macro
in: master
23 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
@@ -86,6 +86,21 @@
)
}
+pub fn impl_enum_solidity_type<'a>(name: &syn::Ident) -> proc_macro2::TokenStream {
+ quote! {
+ #[cfg(feature = "stubgen")]
+ impl ::evm_coder::solidity::SolidityType for #name {
+ fn names(tc: &::evm_coder::solidity::TypeCollector) -> Vec<String> {
+ Vec::new()
+ }
+
+ fn len() -> usize {
+ 1
+ }
+ }
+ }
+}
+
pub fn impl_enum_solidity_type_name(name: &syn::Ident) -> proc_macro2::TokenStream {
quote!(
#[cfg(feature = "stubgen")]
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
@@ -86,6 +86,7 @@
let abi_type = impl_enum_abi_type(name, option_count);
let abi_read = impl_enum_abi_read(name);
let abi_write = impl_enum_abi_write(name);
+ let solidity_type = impl_enum_solidity_type(name);
let solidity_type_name = impl_enum_solidity_type_name(name);
let solidity_struct_collect = impl_enum_solidity_struct_collect(
name,
@@ -102,6 +103,7 @@
#abi_type
#abi_read
#abi_write
+ #solidity_type
#solidity_type_name
#solidity_struct_collect
})
crates/evm-coder/src/abi/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/abi/impls.rs
+++ b/crates/evm-coder/src/abi/impls.rs
@@ -184,6 +184,11 @@
}
}
+macro_rules! count {
+ () => (0usize);
+ ( $x:tt $($xs:tt)* ) => (1usize + count!($($xs)*));
+}
+
macro_rules! impl_tuples {
($($ident:ident)+) => {
impl<$($ident: AbiType,)+> AbiType for ($($ident,)+)
@@ -198,7 +203,7 @@
shift_left(1)
fixed(")")
);
- const FIELDS_COUNT: usize = 0 $(+ {let _ = <$ident as AbiType>::FIELDS_COUNT; 1})+;
+ const FIELDS_COUNT: usize = count!($($ident)*);
fn is_dynamic() -> bool {
false
crates/evm-coder/src/solidity/impls.rsdiffbeforeafterboth--- a/crates/evm-coder/src/solidity/impls.rs
+++ b/crates/evm-coder/src/solidity/impls.rs
@@ -74,6 +74,16 @@
}
}
+impl<T: StructCollect + sealed::CanBePlacedInVec> StructCollect for Vec<T> {
+ fn name() -> String {
+ <T as StructCollect>::name() + "[]"
+ }
+
+ fn declaration() -> String {
+ unimplemented!("Vectors have not declarations.")
+ }
+}
+
macro_rules! count {
() => (0usize);
( $x:tt $($xs:tt)* ) => (1usize + count!($($xs)*));
@@ -131,60 +141,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
@@ -76,7 +76,8 @@
self.anonymous.borrow_mut().insert(names, id);
format!("Tuple{}", id)
}
- pub fn collect_struct<T: StructCollect>(&self) -> String {
+ pub fn collect_struct<T: StructCollect + SolidityType>(&self) -> String {
+ let _names = T::names(self);
self.collect(<T as StructCollect>::declaration());
<T as StructCollect>::name()
}
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
@@ -100,6 +100,15 @@
}
#[test]
+ #[cfg(feature = "stubgen")]
+ fn struct_collect_vec() {
+ assert_eq!(
+ <Vec<u8> as ::evm_coder::solidity::StructCollect>::name(),
+ "uint8[]"
+ );
+ }
+
+ #[test]
fn impl_abi_type_signature() {
assert_eq!(
<TypeStruct1SimpleParam as evm_coder::abi::AbiType>::SIGNATURE
pallets/common/src/eth.rsdiffbeforeafterboth--- a/pallets/common/src/eth.rs
+++ b/pallets/common/src/eth.rs
@@ -16,6 +16,7 @@
//! The module contains a number of functions for converting and checking ethereum identifiers.
+use sp_std::{vec, vec::Vec};
use evm_coder::{
AbiCoder,
types::{uint256, address},
@@ -183,3 +184,102 @@
/// 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: EthTokenPermissions,
+ /// TokenPermission value.
+ value: bool,
+}
+
+impl PropertyPermission {
+ pub fn into_vec(pp: up_data_structs::PropertyPermission) -> Vec<Self> {
+ vec![
+ PropertyPermission {
+ code: EthTokenPermissions::Mutable,
+ value: pp.mutable,
+ },
+ PropertyPermission {
+ code: EthTokenPermissions::TokenOwner,
+ value: pp.token_owner,
+ },
+ PropertyPermission {
+ code: EthTokenPermissions::CollectionAdmin,
+ value: pp.collection_admin,
+ },
+ ]
+ }
+
+ 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 {
+ EthTokenPermissions::Mutable => token_permission.mutable = value,
+ EthTokenPermissions::TokenOwner => token_permission.token_owner = value,
+ EthTokenPermissions::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 {
+ 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 {
+ if permissions.len() > <EthTokenPermissions as evm_coder::abi::AbiType>::FIELDS_COUNT {
+ return Err(alloc::format!(
+ "Actual number of fields {} for {}, which exceeds the maximum value of {}",
+ permissions.len(),
+ stringify!(EthTokenPermissions),
+ <EthTokenPermissions as evm_coder::abi::AbiType>::FIELDS_COUNT
+ )
+ .as_str()
+ .into());
+ }
+
+ 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)
+ }
+}
pallets/evm-contract-helpers/src/stubs/ContractHelpers.rawdiffbeforeafterbothbinary blob — no preview
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
@@ -470,9 +470,12 @@
uint256 sub;
}
+/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+ /// @dev Owner of token can nest tokens under it.
+ TokenOwner,
+ /// @dev Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
/// @dev anonymous struct
@@ -516,9 +519,11 @@
uint256 field_2;
}
-/// @dev Property struct
+/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
+ /// @dev Property key.
string key;
+ /// @dev Property value.
bytes value;
}
pallets/nonfungible/src/erc.rsdiffbeforeafterboth--- a/pallets/nonfungible/src/erc.rs
+++ b/pallets/nonfungible/src/erc.rs
@@ -38,7 +38,7 @@
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, PrecompileResult, CollectionCall, static_property::key},
- eth::{Property as PropertyStruct, EthCrossAccount, EthTokenPermissions},
+ eth::{Property as PropertyStruct, EthCrossAccount},
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
use pallet_evm_coder_substrate::call;
@@ -94,40 +94,12 @@
fn set_token_property_permissions(
&mut self,
caller: caller,
- permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
+ permissions: Vec<pallet_common::eth::TokenPropertyPermission>,
) -> Result<()> {
let caller = T::CrossAccountId::from_eth(caller);
- let mut perms = Vec::new();
-
- for (key, pp) in permissions {
- if pp.len() > EthTokenPermissions::FIELDS_COUNT {
- return Err(alloc::format!(
- "Actual number of fields {} for {}, which exceeds the maximum value of {}",
- pp.len(),
- stringify!(EthTokenPermissions),
- EthTokenPermissions::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 = pallet_common::eth::TokenPropertyPermission::into_property_key_permissions(
+ permissions,
+ )?;
<Pallet<T>>::set_token_property_permissions(self, &caller, perms)
.map_err(dispatch_to_evm::<T>)
@@ -136,19 +108,11 @@
/// @notice Get permissions for token properties.
fn token_property_permissions(
&self,
- ) -> Result<Vec<(string, Vec<(EthTokenPermissions, bool)>)>> {
+ ) -> Result<Vec<pallet_common::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(pallet_common::eth::TokenPropertyPermission::from)
.collect())
}
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,12 +127,30 @@
}
}
-/// @dev Property struct
+/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
+ /// @dev Property key.
string key;
+ /// @dev Property value.
bytes value;
}
+/// @dev Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// @dev Token property key.
+ string key;
+ /// @dev Token property permissions.
+ PropertyPermission[] permissions;
+}
+
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// @dev TokenPermission field.
+ EthTokenPermissions code;
+ /// @dev TokenPermission value.
+ bool 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`]
@@ -141,18 +159,6 @@
TokenOwner,
/// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
-}
-
-/// @dev anonymous struct
-struct Tuple61 {
- string field_0;
- Tuple59[] field_1;
-}
-
-/// @dev anonymous struct
-struct Tuple59 {
- EthTokenPermissions field_0;
- bool field_1;
}
/// @title A contract that allows you to work with collections.
@@ -608,9 +614,12 @@
uint256 sub;
}
+/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+ /// @dev Owner of token can nest tokens under it.
+ TokenOwner,
+ /// @dev Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
/// @dev anonymous struct
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -33,7 +33,7 @@
use pallet_common::{
CollectionHandle, CollectionPropertyPermissions, CommonCollectionOperations,
erc::{CommonEvmHandler, CollectionCall, static_property::key},
- eth::{Property as PropertyStruct, EthCrossAccount, EthTokenPermissions},
+ eth::{Property as PropertyStruct, EthCrossAccount},
Error as CommonError,
};
use pallet_evm::{account::CrossAccountId, PrecompileHandle};
@@ -97,47 +97,13 @@
fn set_token_property_permissions(
&mut self,
caller: caller,
- permissions: Vec<(string, Vec<(EthTokenPermissions, bool)>)>,
+ permissions: Vec<pallet_common::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,
- };
+ let perms = pallet_common::eth::TokenPropertyPermission::into_property_key_permissions(
+ permissions,
+ )?;
- 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,
- });
- }
-
<Pallet<T>>::set_token_property_permissions(self, &caller, perms)
.map_err(dispatch_to_evm::<T>)
}
@@ -145,19 +111,11 @@
/// @notice Get permissions for token properties.
fn token_property_permissions(
&self,
- ) -> Result<Vec<(string, Vec<(EthTokenPermissions, bool)>)>> {
+ ) -> Result<Vec<pallet_common::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(pallet_common::eth::TokenPropertyPermission::from)
.collect())
}
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,12 +127,30 @@
}
}
-/// @dev Property struct
+/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
+ /// @dev Property key.
string key;
+ /// @dev Property value.
bytes value;
}
+/// @dev Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// @dev Token property key.
+ string key;
+ /// @dev Token property permissions.
+ PropertyPermission[] permissions;
+}
+
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// @dev TokenPermission field.
+ EthTokenPermissions code;
+ /// @dev TokenPermission value.
+ bool 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`]
@@ -141,18 +159,6 @@
TokenOwner,
/// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]
CollectionAdmin
-}
-
-/// @dev anonymous struct
-struct Tuple60 {
- string field_0;
- Tuple58[] field_1;
-}
-
-/// @dev anonymous struct
-struct Tuple58 {
- EthTokenPermissions field_0;
- bool field_1;
}
/// @title A contract that allows you to work with collections.
@@ -608,9 +614,12 @@
uint256 sub;
}
+/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+ /// @dev Owner of token can nest tokens under it.
+ TokenOwner,
+ /// @dev Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
/// @dev anonymous struct
pallets/refungible/src/stubs/UniqueRefungibleToken.rawdiffbeforeafterbothbinary blob — no preview
pallets/unique/src/eth/stubs/CollectionHelpers.rawdiffbeforeafterbothbinary blob — no preview
tests/src/eth/abi/nonFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/nonFungible.json
+++ b/tests/src/eth/abi/nonFungible.json
@@ -752,22 +752,22 @@
"inputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
"internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "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 +818,22 @@
"outputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
"internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "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[]"
}
tests/src/eth/abi/reFungible.jsondiffbeforeafterboth--- a/tests/src/eth/abi/reFungible.json
+++ b/tests/src/eth/abi/reFungible.json
@@ -734,22 +734,22 @@
"inputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
"internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "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 +809,22 @@
"outputs": [
{
"components": [
- { "internalType": "string", "name": "field_0", "type": "string" },
+ { "internalType": "string", "name": "key", "type": "string" },
{
"components": [
{
"internalType": "enum EthTokenPermissions",
- "name": "field_0",
+ "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[]"
}
tests/src/eth/api/UniqueFungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueFungible.sol
+++ b/tests/src/eth/api/UniqueFungible.sol
@@ -316,9 +316,12 @@
bool field_1;
}
+/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+ /// @dev Owner of token can nest tokens under it.
+ TokenOwner,
+ /// @dev Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
/// @dev anonymous struct
@@ -356,9 +359,11 @@
uint256 field_2;
}
-/// @dev Property struct
+/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
+ /// @dev Property key.
string key;
+ /// @dev Property value.
bytes value;
}
tests/src/eth/api/UniqueNFT.soldiffbeforeafterboth1// SPDX-License-Identifier: OTHER2// This code is automatically generated34pragma solidity >=0.8.0 <0.9.0;56/// @dev common stubs holder7interface Dummy {89}1011interface ERC165 is Dummy {12 function supportsInterface(bytes4 interfaceID) external view returns (bool);13}1415/// @title A contract that allows to set and delete token properties and change token property permissions.16/// @dev the ERC-165 identifier for this interface is 0xde0695c217interface TokenProperties is Dummy, ERC165 {18 // /// @notice Set permissions for token property.19 // /// @dev Throws error if `msg.sender` is not admin or owner of the collection.20 // /// @param key Property key.21 // /// @param isMutable Permission to mutate property.22 // /// @param collectionAdmin Permission to mutate property by collection admin if property is mutable.23 // /// @param tokenOwner Permission to mutate property by token owner if property is mutable.24 // /// @dev EVM selector for this function is: 0x222d97fa,25 // /// or in textual repr: setTokenPropertyPermission(string,bool,bool,bool)26 // function setTokenPropertyPermission(string memory key, bool isMutable, bool collectionAdmin, bool tokenOwner) external;2728 /// @notice Set permissions for token property.29 /// @dev Throws error if `msg.sender` is not admin or owner of the collection.30 /// @param permissions Permissions for keys.31 /// @dev EVM selector for this function is: 0xbd92983a,32 /// or in textual repr: setTokenPropertyPermissions((string,(uint8,bool)[])[])33 function setTokenPropertyPermissions(Tuple53[] memory permissions) external;3435 /// @notice Get permissions for token properties.36 /// @dev EVM selector for this function is: 0xf23d7790,37 /// or in textual repr: tokenPropertyPermissions()38 function tokenPropertyPermissions() external view returns (Tuple53[] memory);3940 // /// @notice Set token property value.41 // /// @dev Throws error if `msg.sender` has no permission to edit the property.42 // /// @param tokenId ID of the token.43 // /// @param key Property key.44 // /// @param value Property value.45 // /// @dev EVM selector for this function is: 0x1752d67b,46 // /// or in textual repr: setProperty(uint256,string,bytes)47 // function setProperty(uint256 tokenId, string memory key, bytes memory value) external;4849 /// @notice Set token properties value.50 /// @dev Throws error if `msg.sender` has no permission to edit the property.51 /// @param tokenId ID of the token.52 /// @param properties settable properties53 /// @dev EVM selector for this function is: 0x14ed3a6e,54 /// or in textual repr: setProperties(uint256,(string,bytes)[])55 function setProperties(uint256 tokenId, Property[] memory properties) external;5657 // /// @notice Delete token property value.58 // /// @dev Throws error if `msg.sender` has no permission to edit the property.59 // /// @param tokenId ID of the token.60 // /// @param key Property key.61 // /// @dev EVM selector for this function is: 0x066111d1,62 // /// or in textual repr: deleteProperty(uint256,string)63 // function deleteProperty(uint256 tokenId, string memory key) external;6465 /// @notice Delete token properties value.66 /// @dev Throws error if `msg.sender` has no permission to edit the property.67 /// @param tokenId ID of the token.68 /// @param keys Properties key.69 /// @dev EVM selector for this function is: 0xc472d371,70 /// or in textual repr: deleteProperties(uint256,string[])71 function deleteProperties(uint256 tokenId, string[] memory keys) external;7273 /// @notice Get token property value.74 /// @dev Throws error if key not found75 /// @param tokenId ID of the token.76 /// @param key Property key.77 /// @return Property value bytes78 /// @dev EVM selector for this function is: 0x7228c327,79 /// or in textual repr: property(uint256,string)80 function property(uint256 tokenId, string memory key) external view returns (bytes memory);81}8283/// @dev Property struct84struct Property {85 string key;86 bytes value;87}8889/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) fields as an enumeration.90enum EthTokenPermissions {91 /// @dev Permission to change the property and property permission. See [`up_data_structs::PropertyPermission::mutable`]92 Mutable,93 /// @dev Change permission for the collection administrator. See [`up_data_structs::PropertyPermission::token_owner`]94 TokenOwner,95 /// @dev Permission to change the property for the owner of the token. See [`up_data_structs::PropertyPermission::collection_admin`]96 CollectionAdmin97}9899/// @dev anonymous struct100struct Tuple53 {101 string field_0;102 Tuple51[] field_1;103}104105/// @dev anonymous struct106struct Tuple51 {107 EthTokenPermissions field_0;108 bool field_1;109}110111/// @title A contract that allows you to work with collections.112/// @dev the ERC-165 identifier for this interface is 0x81172a75113interface Collection is Dummy, ERC165 {114 // /// Set collection property.115 // ///116 // /// @param key Property key.117 // /// @param value Propery value.118 // /// @dev EVM selector for this function is: 0x2f073f66,119 // /// or in textual repr: setCollectionProperty(string,bytes)120 // function setCollectionProperty(string memory key, bytes memory value) external;121122 /// Set collection properties.123 ///124 /// @param properties Vector of properties key/value pair.125 /// @dev EVM selector for this function is: 0x50b26b2a,126 /// or in textual repr: setCollectionProperties((string,bytes)[])127 function setCollectionProperties(Property[] memory properties) external;128129 // /// Delete collection property.130 // ///131 // /// @param key Property key.132 // /// @dev EVM selector for this function is: 0x7b7debce,133 // /// or in textual repr: deleteCollectionProperty(string)134 // function deleteCollectionProperty(string memory key) external;135136 /// Delete collection properties.137 ///138 /// @param keys Properties keys.139 /// @dev EVM selector for this function is: 0xee206ee3,140 /// or in textual repr: deleteCollectionProperties(string[])141 function deleteCollectionProperties(string[] memory keys) external;142143 /// Get collection property.144 ///145 /// @dev Throws error if key not found.146 ///147 /// @param key Property key.148 /// @return bytes The property corresponding to the key.149 /// @dev EVM selector for this function is: 0xcf24fd6d,150 /// or in textual repr: collectionProperty(string)151 function collectionProperty(string memory key) external view returns (bytes memory);152153 /// Get collection properties.154 ///155 /// @param keys Properties keys. Empty keys for all propertyes.156 /// @return Vector of properties key/value pairs.157 /// @dev EVM selector for this function is: 0x285fb8e6,158 /// or in textual repr: collectionProperties(string[])159 function collectionProperties(string[] memory keys) external view returns (Property[] memory);160161 // /// Set the sponsor of the collection.162 // ///163 // /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.164 // ///165 // /// @param sponsor Address of the sponsor from whose account funds will be debited for operations with the contract.166 // /// @dev EVM selector for this function is: 0x7623402e,167 // /// or in textual repr: setCollectionSponsor(address)168 // function setCollectionSponsor(address sponsor) external;169170 /// Set the sponsor of the collection.171 ///172 /// @dev In order for sponsorship to work, it must be confirmed on behalf of the sponsor.173 ///174 /// @param sponsor Cross account address of the sponsor from whose account funds will be debited for operations with the contract.175 /// @dev EVM selector for this function is: 0x84a1d5a8,176 /// or in textual repr: setCollectionSponsorCross((address,uint256))177 function setCollectionSponsorCross(EthCrossAccount memory sponsor) external;178179 /// Whether there is a pending sponsor.180 /// @dev EVM selector for this function is: 0x058ac185,181 /// or in textual repr: hasCollectionPendingSponsor()182 function hasCollectionPendingSponsor() external view returns (bool);183184 /// Collection sponsorship confirmation.185 ///186 /// @dev After setting the sponsor for the collection, it must be confirmed with this function.187 /// @dev EVM selector for this function is: 0x3c50e97a,188 /// or in textual repr: confirmCollectionSponsorship()189 function confirmCollectionSponsorship() external;190191 /// Remove collection sponsor.192 /// @dev EVM selector for this function is: 0x6e0326a3,193 /// or in textual repr: removeCollectionSponsor()194 function removeCollectionSponsor() external;195196 /// Get current sponsor.197 ///198 /// @return Tuble with sponsor address and his substrate mirror. If there is no confirmed sponsor error "Contract has no sponsor" throw.199 /// @dev EVM selector for this function is: 0x6ec0a9f1,200 /// or in textual repr: collectionSponsor()201 function collectionSponsor() external view returns (EthCrossAccount memory);202203 /// Get current collection limits.204 ///205 /// @return Array of tuples (byte, bool, uint256) with limits and their values. Order of limits:206 /// "accountTokenOwnershipLimit",207 /// "sponsoredDataSize",208 /// "sponsoredDataRateLimit",209 /// "tokenLimit",210 /// "sponsorTransferTimeout",211 /// "sponsorApproveTimeout"212 /// "ownerCanTransfer",213 /// "ownerCanDestroy",214 /// "transfersEnabled"215 /// Return `false` if a limit not set.216 /// @dev EVM selector for this function is: 0xf63bc572,217 /// or in textual repr: collectionLimits()218 function collectionLimits() external view returns (Tuple31[] memory);219220 /// Set limits for the collection.221 /// @dev Throws error if limit not found.222 /// @param limit Name of the limit. Valid names:223 /// "accountTokenOwnershipLimit",224 /// "sponsoredDataSize",225 /// "sponsoredDataRateLimit",226 /// "tokenLimit",227 /// "sponsorTransferTimeout",228 /// "sponsorApproveTimeout"229 /// "ownerCanTransfer",230 /// "ownerCanDestroy",231 /// "transfersEnabled"232 /// @param status enable\disable limit. Works only with `true`.233 /// @param value Value of the limit.234 /// @dev EVM selector for this function is: 0x88150bd0,235 /// or in textual repr: setCollectionLimit(uint8,bool,uint256)236 function setCollectionLimit(237 CollectionLimits limit,238 bool status,239 uint256 value240 ) external;241242 /// Get contract address.243 /// @dev EVM selector for this function is: 0xf6b4dfb4,244 /// or in textual repr: contractAddress()245 function contractAddress() external view returns (address);246247 /// Add collection admin.248 /// @param newAdmin Cross account administrator address.249 /// @dev EVM selector for this function is: 0x859aa7d6,250 /// or in textual repr: addCollectionAdminCross((address,uint256))251 function addCollectionAdminCross(EthCrossAccount memory newAdmin) external;252253 /// Remove collection admin.254 /// @param admin Cross account administrator address.255 /// @dev EVM selector for this function is: 0x6c0cd173,256 /// or in textual repr: removeCollectionAdminCross((address,uint256))257 function removeCollectionAdminCross(EthCrossAccount memory admin) external;258259 // /// Add collection admin.260 // /// @param newAdmin Address of the added administrator.261 // /// @dev EVM selector for this function is: 0x92e462c7,262 // /// or in textual repr: addCollectionAdmin(address)263 // function addCollectionAdmin(address newAdmin) external;264265 // /// Remove collection admin.266 // ///267 // /// @param admin Address of the removed administrator.268 // /// @dev EVM selector for this function is: 0xfafd7b42,269 // /// or in textual repr: removeCollectionAdmin(address)270 // function removeCollectionAdmin(address admin) external;271272 /// Toggle accessibility of collection nesting.273 ///274 /// @param enable If "true" degenerates to nesting: 'Owner' else to nesting: 'Disabled'275 /// @dev EVM selector for this function is: 0x112d4586,276 /// or in textual repr: setCollectionNesting(bool)277 function setCollectionNesting(bool enable) external;278279 /// Toggle accessibility of collection nesting.280 ///281 /// @param enable If "true" degenerates to nesting: {OwnerRestricted: [1, 2, 3]} else to nesting: 'Disabled'282 /// @param collections Addresses of collections that will be available for nesting.283 /// @dev EVM selector for this function is: 0x64872396,284 /// or in textual repr: setCollectionNesting(bool,address[])285 function setCollectionNesting(bool enable, address[] memory collections) external;286287 /// Returns nesting for a collection288 /// @dev EVM selector for this function is: 0x22d25bfe,289 /// or in textual repr: collectionNestingRestrictedCollectionIds()290 function collectionNestingRestrictedCollectionIds() external view returns (Tuple36 memory);291292 /// Returns permissions for a collection293 /// @dev EVM selector for this function is: 0x5b2eaf4b,294 /// or in textual repr: collectionNestingPermissions()295 function collectionNestingPermissions() external view returns (Tuple39[] memory);296297 /// Set the collection access method.298 /// @param mode Access mode299 /// 0 for Normal300 /// 1 for AllowList301 /// @dev EVM selector for this function is: 0x41835d4c,302 /// or in textual repr: setCollectionAccess(uint8)303 function setCollectionAccess(uint8 mode) external;304305 /// Checks that user allowed to operate with collection.306 ///307 /// @param user User address to check.308 /// @dev EVM selector for this function is: 0x91b6df49,309 /// or in textual repr: allowlistedCross((address,uint256))310 function allowlistedCross(EthCrossAccount memory user) external view returns (bool);311312 // /// Add the user to the allowed list.313 // ///314 // /// @param user Address of a trusted user.315 // /// @dev EVM selector for this function is: 0x67844fe6,316 // /// or in textual repr: addToCollectionAllowList(address)317 // function addToCollectionAllowList(address user) external;318319 /// Add user to allowed list.320 ///321 /// @param user User cross account address.322 /// @dev EVM selector for this function is: 0xa0184a3a,323 /// or in textual repr: addToCollectionAllowListCross((address,uint256))324 function addToCollectionAllowListCross(EthCrossAccount memory user) external;325326 // /// Remove the user from the allowed list.327 // ///328 // /// @param user Address of a removed user.329 // /// @dev EVM selector for this function is: 0x85c51acb,330 // /// or in textual repr: removeFromCollectionAllowList(address)331 // function removeFromCollectionAllowList(address user) external;332333 /// Remove user from allowed list.334 ///335 /// @param user User cross account address.336 /// @dev EVM selector for this function is: 0x09ba452a,337 /// or in textual repr: removeFromCollectionAllowListCross((address,uint256))338 function removeFromCollectionAllowListCross(EthCrossAccount memory user) external;339340 /// Switch permission for minting.341 ///342 /// @param mode Enable if "true".343 /// @dev EVM selector for this function is: 0x00018e84,344 /// or in textual repr: setCollectionMintMode(bool)345 function setCollectionMintMode(bool mode) external;346347 // /// Check that account is the owner or admin of the collection348 // ///349 // /// @param user account to verify350 // /// @return "true" if account is the owner or admin351 // /// @dev EVM selector for this function is: 0x9811b0c7,352 // /// or in textual repr: isOwnerOrAdmin(address)353 // function isOwnerOrAdmin(address user) external view returns (bool);354355 /// Check that account is the owner or admin of the collection356 ///357 /// @param user User cross account to verify358 /// @return "true" if account is the owner or admin359 /// @dev EVM selector for this function is: 0x3e75a905,360 /// or in textual repr: isOwnerOrAdminCross((address,uint256))361 function isOwnerOrAdminCross(EthCrossAccount memory user) external view returns (bool);362363 /// Returns collection type364 ///365 /// @return `Fungible` or `NFT` or `ReFungible`366 /// @dev EVM selector for this function is: 0xd34b55b8,367 /// or in textual repr: uniqueCollectionType()368 function uniqueCollectionType() external view returns (string memory);369370 /// Get collection owner.371 ///372 /// @return Tuble with sponsor address and his substrate mirror.373 /// If address is canonical then substrate mirror is zero and vice versa.374 /// @dev EVM selector for this function is: 0xdf727d3b,375 /// or in textual repr: collectionOwner()376 function collectionOwner() external view returns (EthCrossAccount memory);377378 // /// Changes collection owner to another account379 // ///380 // /// @dev Owner can be changed only by current owner381 // /// @param newOwner new owner account382 // /// @dev EVM selector for this function is: 0x4f53e226,383 // /// or in textual repr: changeCollectionOwner(address)384 // function changeCollectionOwner(address newOwner) external;385386 /// Get collection administrators387 ///388 /// @return Vector of tuples with admins address and his substrate mirror.389 /// If address is canonical then substrate mirror is zero and vice versa.390 /// @dev EVM selector for this function is: 0x5813216b,391 /// or in textual repr: collectionAdmins()392 function collectionAdmins() external view returns (EthCrossAccount[] memory);393394 /// Changes collection owner to another account395 ///396 /// @dev Owner can be changed only by current owner397 /// @param newOwner new owner cross account398 /// @dev EVM selector for this function is: 0x6496c497,399 /// or in textual repr: changeCollectionOwnerCross((address,uint256))400 function changeCollectionOwnerCross(EthCrossAccount memory newOwner) external;401}402403/// @dev Cross account struct404struct EthCrossAccount {405 address eth;406 uint256 sub;407}408409/// @dev anonymous struct410struct Tuple39 {411 CollectionPermissions field_0;412 bool field_1;413}414415enum CollectionPermissions {416 CollectionAdmin,417 TokenOwner418}419420/// @dev anonymous struct421struct Tuple36 {422 bool field_0;423 uint256[] field_1;424}425426/// @dev [`CollectionLimits`](up_data_structs::CollectionLimits) representation for EVM.427enum CollectionLimits {428 /// @dev How many tokens can a user have on one account.429 AccountTokenOwnership,430 /// @dev How many bytes of data are available for sponsorship.431 SponsoredDataSize,432 /// @dev In any case, chain default: [`SponsoringRateLimit::SponsoringDisabled`]433 SponsoredDataRateLimit,434 /// @dev How many tokens can be mined into this collection.435 TokenLimit,436 /// @dev Timeouts for transfer sponsoring.437 SponsorTransferTimeout,438 /// @dev Timeout for sponsoring an approval in passed blocks.439 SponsorApproveTimeout,440 /// @dev Whether the collection owner of the collection can send tokens (which belong to other users).441 OwnerCanTransfer,442 /// @dev Can the collection owner burn other people's tokens.443 OwnerCanDestroy,444 /// @dev Is it possible to send tokens from this collection between users.445 TransferEnabled446}447448/// @dev anonymous struct449struct Tuple31 {450 CollectionLimits field_0;451 bool field_1;452 uint256 field_2;453}454455/// @title ERC-721 Non-Fungible Token Standard, optional metadata extension456/// @dev See https://eips.ethereum.org/EIPS/eip-721457/// @dev the ERC-165 identifier for this interface is 0x5b5e139f458interface ERC721Metadata is Dummy, ERC165 {459 // /// @notice A descriptive name for a collection of NFTs in this contract460 // /// @dev real implementation of this function lies in `ERC721UniqueExtensions`461 // /// @dev EVM selector for this function is: 0x06fdde03,462 // /// or in textual repr: name()463 // function name() external view returns (string memory);464465 // /// @notice An abbreviated name for NFTs in this contract466 // /// @dev real implementation of this function lies in `ERC721UniqueExtensions`467 // /// @dev EVM selector for this function is: 0x95d89b41,468 // /// or in textual repr: symbol()469 // function symbol() external view returns (string memory);470471 /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.472 ///473 /// @dev If the token has a `url` property and it is not empty, it is returned.474 /// Else If the collection does not have a property with key `schemaName` or its value is not equal to `ERC721Metadata`, it return an error `tokenURI not set`.475 /// If the collection property `baseURI` is empty or absent, return "" (empty string)476 /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix477 /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).478 ///479 /// @return token's const_metadata480 /// @dev EVM selector for this function is: 0xc87b56dd,481 /// or in textual repr: tokenURI(uint256)482 function tokenURI(uint256 tokenId) external view returns (string memory);483}484485/// @title ERC721 Token that can be irreversibly burned (destroyed).486/// @dev the ERC-165 identifier for this interface is 0x42966c68487interface ERC721Burnable is Dummy, ERC165 {488 /// @notice Burns a specific ERC721 token.489 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized490 /// operator of the current owner.491 /// @param tokenId The NFT to approve492 /// @dev EVM selector for this function is: 0x42966c68,493 /// or in textual repr: burn(uint256)494 function burn(uint256 tokenId) external;495}496497/// @dev inlined interface498interface ERC721UniqueMintableEvents {499 event MintingFinished();500}501502/// @title ERC721 minting logic.503/// @dev the ERC-165 identifier for this interface is 0x476ff149504interface ERC721UniqueMintable is Dummy, ERC165, ERC721UniqueMintableEvents {505 /// @dev EVM selector for this function is: 0x05d2035b,506 /// or in textual repr: mintingFinished()507 function mintingFinished() external view returns (bool);508509 /// @notice Function to mint a token.510 /// @param to The new owner511 /// @return uint256 The id of the newly minted token512 /// @dev EVM selector for this function is: 0x6a627842,513 /// or in textual repr: mint(address)514 function mint(address to) external returns (uint256);515516 // /// @notice Function to mint a token.517 // /// @dev `tokenId` should be obtained with `nextTokenId` method,518 // /// unlike standard, you can't specify it manually519 // /// @param to The new owner520 // /// @param tokenId ID of the minted NFT521 // /// @dev EVM selector for this function is: 0x40c10f19,522 // /// or in textual repr: mint(address,uint256)523 // function mint(address to, uint256 tokenId) external returns (bool);524525 /// @notice Function to mint token with the given tokenUri.526 /// @param to The new owner527 /// @param tokenUri Token URI that would be stored in the NFT properties528 /// @return uint256 The id of the newly minted token529 /// @dev EVM selector for this function is: 0x45c17782,530 /// or in textual repr: mintWithTokenURI(address,string)531 function mintWithTokenURI(address to, string memory tokenUri) external returns (uint256);532533 // /// @notice Function to mint token with the given tokenUri.534 // /// @dev `tokenId` should be obtained with `nextTokenId` method,535 // /// unlike standard, you can't specify it manually536 // /// @param to The new owner537 // /// @param tokenId ID of the minted NFT538 // /// @param tokenUri Token URI that would be stored in the NFT properties539 // /// @dev EVM selector for this function is: 0x50bb4e7f,540 // /// or in textual repr: mintWithTokenURI(address,uint256,string)541 // function mintWithTokenURI(address to, uint256 tokenId, string memory tokenUri) external returns (bool);542543 /// @dev Not implemented544 /// @dev EVM selector for this function is: 0x7d64bcb4,545 /// or in textual repr: finishMinting()546 function finishMinting() external returns (bool);547}548549/// @title Unique extensions for ERC721.550/// @dev the ERC-165 identifier for this interface is 0x0e48fdb4551interface ERC721UniqueExtensions is Dummy, ERC165 {552 /// @notice A descriptive name for a collection of NFTs in this contract553 /// @dev EVM selector for this function is: 0x06fdde03,554 /// or in textual repr: name()555 function name() external view returns (string memory);556557 /// @notice An abbreviated name for NFTs in this contract558 /// @dev EVM selector for this function is: 0x95d89b41,559 /// or in textual repr: symbol()560 function symbol() external view returns (string memory);561562 /// @notice A description for the collection.563 /// @dev EVM selector for this function is: 0x7284e416,564 /// or in textual repr: description()565 function description() external view returns (string memory);566567 /// Returns the owner (in cross format) of the token.568 ///569 /// @param tokenId Id for the token.570 /// @dev EVM selector for this function is: 0x2b29dace,571 /// or in textual repr: crossOwnerOf(uint256)572 function crossOwnerOf(uint256 tokenId) external view returns (EthCrossAccount memory);573574 /// Returns the token properties.575 ///576 /// @param tokenId Id for the token.577 /// @param keys Properties keys. Empty keys for all propertyes.578 /// @return Vector of properties key/value pairs.579 /// @dev EVM selector for this function is: 0xe07ede7e,580 /// or in textual repr: properties(uint256,string[])581 function properties(uint256 tokenId, string[] memory keys) external view returns (Property[] memory);582583 /// @notice Set or reaffirm the approved address for an NFT584 /// @dev The zero address indicates there is no approved address.585 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized586 /// operator of the current owner.587 /// @param approved The new substrate address approved NFT controller588 /// @param tokenId The NFT to approve589 /// @dev EVM selector for this function is: 0x0ecd0ab0,590 /// or in textual repr: approveCross((address,uint256),uint256)591 function approveCross(EthCrossAccount memory approved, uint256 tokenId) external;592593 /// @notice Transfer ownership of an NFT594 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`595 /// is the zero address. Throws if `tokenId` is not a valid NFT.596 /// @param to The new owner597 /// @param tokenId The NFT to transfer598 /// @dev EVM selector for this function is: 0xa9059cbb,599 /// or in textual repr: transfer(address,uint256)600 function transfer(address to, uint256 tokenId) external;601602 /// @notice Transfer ownership of an NFT603 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`604 /// is the zero address. Throws if `tokenId` is not a valid NFT.605 /// @param to The new owner606 /// @param tokenId The NFT to transfer607 /// @dev EVM selector for this function is: 0x2ada85ff,608 /// or in textual repr: transferCross((address,uint256),uint256)609 function transferCross(EthCrossAccount memory to, uint256 tokenId) external;610611 /// @notice Transfer ownership of an NFT from cross account address to cross account address612 /// @dev Throws unless `msg.sender` is the current owner. Throws if `to`613 /// is the zero address. Throws if `tokenId` is not a valid NFT.614 /// @param from Cross acccount address of current owner615 /// @param to Cross acccount address of new owner616 /// @param tokenId The NFT to transfer617 /// @dev EVM selector for this function is: 0xd5cf430b,618 /// or in textual repr: transferFromCross((address,uint256),(address,uint256),uint256)619 function transferFromCross(620 EthCrossAccount memory from,621 EthCrossAccount memory to,622 uint256 tokenId623 ) external;624625 // /// @notice Burns a specific ERC721 token.626 // /// @dev Throws unless `msg.sender` is the current owner or an authorized627 // /// operator for this NFT. Throws if `from` is not the current owner. Throws628 // /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.629 // /// @param from The current owner of the NFT630 // /// @param tokenId The NFT to transfer631 // /// @dev EVM selector for this function is: 0x79cc6790,632 // /// or in textual repr: burnFrom(address,uint256)633 // function burnFrom(address from, uint256 tokenId) external;634635 /// @notice Burns a specific ERC721 token.636 /// @dev Throws unless `msg.sender` is the current owner or an authorized637 /// operator for this NFT. Throws if `from` is not the current owner. Throws638 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.639 /// @param from The current owner of the NFT640 /// @param tokenId The NFT to transfer641 /// @dev EVM selector for this function is: 0xbb2f5a58,642 /// or in textual repr: burnFromCross((address,uint256),uint256)643 function burnFromCross(EthCrossAccount memory from, uint256 tokenId) external;644645 /// @notice Returns next free NFT ID.646 /// @dev EVM selector for this function is: 0x75794a3c,647 /// or in textual repr: nextTokenId()648 function nextTokenId() external view returns (uint256);649650 // /// @notice Function to mint multiple tokens.651 // /// @dev `tokenIds` should be an array of consecutive numbers and first number652 // /// should be obtained with `nextTokenId` method653 // /// @param to The new owner654 // /// @param tokenIds IDs of the minted NFTs655 // /// @dev EVM selector for this function is: 0x44a9945e,656 // /// or in textual repr: mintBulk(address,uint256[])657 // function mintBulk(address to, uint256[] memory tokenIds) external returns (bool);658659 // /// @notice Function to mint multiple tokens with the given tokenUris.660 // /// @dev `tokenIds` is array of pairs of token ID and token URI. Token IDs should be consecutive661 // /// numbers and first number should be obtained with `nextTokenId` method662 // /// @param to The new owner663 // /// @param tokens array of pairs of token ID and token URI for minted tokens664 // /// @dev EVM selector for this function is: 0x36543006,665 // /// or in textual repr: mintBulkWithTokenURI(address,(uint256,string)[])666 // function mintBulkWithTokenURI(address to, Tuple13[] memory tokens) external returns (bool);667668 /// @notice Function to mint a token.669 /// @param to The new owner crossAccountId670 /// @param properties Properties of minted token671 /// @return uint256 The id of the newly minted token672 /// @dev EVM selector for this function is: 0xb904db03,673 /// or in textual repr: mintCross((address,uint256),(string,bytes)[])674 function mintCross(EthCrossAccount memory to, Property[] memory properties) external returns (uint256);675}676677/// @dev anonymous struct678struct Tuple13 {679 uint256 field_0;680 string field_1;681}682683/// @title ERC-721 Non-Fungible Token Standard, optional enumeration extension684/// @dev See https://eips.ethereum.org/EIPS/eip-721685/// @dev the ERC-165 identifier for this interface is 0x780e9d63686interface ERC721Enumerable is Dummy, ERC165 {687 /// @notice Enumerate valid NFTs688 /// @param index A counter less than `totalSupply()`689 /// @return The token identifier for the `index`th NFT,690 /// (sort order not specified)691 /// @dev EVM selector for this function is: 0x4f6ccce7,692 /// or in textual repr: tokenByIndex(uint256)693 function tokenByIndex(uint256 index) external view returns (uint256);694695 /// @dev Not implemented696 /// @dev EVM selector for this function is: 0x2f745c59,697 /// or in textual repr: tokenOfOwnerByIndex(address,uint256)698 function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256);699700 /// @notice Count NFTs tracked by this contract701 /// @return A count of valid NFTs tracked by this contract, where each one of702 /// them has an assigned and queryable owner not equal to the zero address703 /// @dev EVM selector for this function is: 0x18160ddd,704 /// or in textual repr: totalSupply()705 function totalSupply() external view returns (uint256);706}707708/// @dev inlined interface709interface ERC721Events {710 event Transfer(address indexed from, address indexed to, uint256 indexed tokenId);711 event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId);712 event ApprovalForAll(address indexed owner, address indexed operator, bool approved);713}714715/// @title ERC-721 Non-Fungible Token Standard716/// @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md717/// @dev the ERC-165 identifier for this interface is 0x983a942b718interface ERC721 is Dummy, ERC165, ERC721Events {719 /// @notice Count all NFTs assigned to an owner720 /// @dev NFTs assigned to the zero address are considered invalid, and this721 /// function throws for queries about the zero address.722 /// @param owner An address for whom to query the balance723 /// @return The number of NFTs owned by `owner`, possibly zero724 /// @dev EVM selector for this function is: 0x70a08231,725 /// or in textual repr: balanceOf(address)726 function balanceOf(address owner) external view returns (uint256);727728 /// @notice Find the owner of an NFT729 /// @dev NFTs assigned to zero address are considered invalid, and queries730 /// about them do throw.731 /// @param tokenId The identifier for an NFT732 /// @return The address of the owner of the NFT733 /// @dev EVM selector for this function is: 0x6352211e,734 /// or in textual repr: ownerOf(uint256)735 function ownerOf(uint256 tokenId) external view returns (address);736737 /// @dev Not implemented738 /// @dev EVM selector for this function is: 0xb88d4fde,739 /// or in textual repr: safeTransferFrom(address,address,uint256,bytes)740 function safeTransferFrom(741 address from,742 address to,743 uint256 tokenId,744 bytes memory data745 ) external;746747 /// @dev Not implemented748 /// @dev EVM selector for this function is: 0x42842e0e,749 /// or in textual repr: safeTransferFrom(address,address,uint256)750 function safeTransferFrom(751 address from,752 address to,753 uint256 tokenId754 ) external;755756 /// @notice Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE757 /// TO CONFIRM THAT `to` IS CAPABLE OF RECEIVING NFTS OR ELSE758 /// THEY MAY BE PERMANENTLY LOST759 /// @dev Throws unless `msg.sender` is the current owner or an authorized760 /// operator for this NFT. Throws if `from` is not the current owner. Throws761 /// if `to` is the zero address. Throws if `tokenId` is not a valid NFT.762 /// @param from The current owner of the NFT763 /// @param to The new owner764 /// @param tokenId The NFT to transfer765 /// @dev EVM selector for this function is: 0x23b872dd,766 /// or in textual repr: transferFrom(address,address,uint256)767 function transferFrom(768 address from,769 address to,770 uint256 tokenId771 ) external;772773 /// @notice Set or reaffirm the approved address for an NFT774 /// @dev The zero address indicates there is no approved address.775 /// @dev Throws unless `msg.sender` is the current NFT owner, or an authorized776 /// operator of the current owner.777 /// @param approved The new approved NFT controller778 /// @param tokenId The NFT to approve779 /// @dev EVM selector for this function is: 0x095ea7b3,780 /// or in textual repr: approve(address,uint256)781 function approve(address approved, uint256 tokenId) external;782783 /// @notice Sets or unsets the approval of a given operator.784 /// The `operator` is allowed to transfer all tokens of the `caller` on their behalf.785 /// @param operator Operator786 /// @param approved Should operator status be granted or revoked?787 /// @dev EVM selector for this function is: 0xa22cb465,788 /// or in textual repr: setApprovalForAll(address,bool)789 function setApprovalForAll(address operator, bool approved) external;790791 /// @dev Not implemented792 /// @dev EVM selector for this function is: 0x081812fc,793 /// or in textual repr: getApproved(uint256)794 function getApproved(uint256 tokenId) external view returns (address);795796 /// @notice Tells whether the given `owner` approves the `operator`.797 /// @dev EVM selector for this function is: 0xe985e9c5,798 /// or in textual repr: isApprovedForAll(address,address)799 function isApprovedForAll(address owner, address operator) external view returns (bool);800801 /// @notice Returns collection helper contract address802 /// @dev EVM selector for this function is: 0x1896cce6,803 /// or in textual repr: collectionHelperAddress()804 function collectionHelperAddress() external view returns (address);805}806807interface UniqueNFT is808 Dummy,809 ERC165,810 ERC721,811 ERC721Enumerable,812 ERC721UniqueExtensions,813 ERC721UniqueMintable,814 ERC721Burnable,815 ERC721Metadata,816 Collection,817 TokenProperties818{}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,12 +80,30 @@
function property(uint256 tokenId, string memory key) external view returns (bytes memory);
}
-/// @dev Property struct
+/// @dev Ethereum representation of collection [`PropertyKey`](up_data_structs::PropertyKey) and [`PropertyValue`](up_data_structs::PropertyValue).
struct Property {
+ /// @dev Property key.
string key;
+ /// @dev Property value.
bytes value;
}
+/// @dev Ethereum representation of Token Property Permissions.
+struct TokenPropertyPermission {
+ /// @dev Token property key.
+ string key;
+ /// @dev Token property permissions.
+ PropertyPermission[] permissions;
+}
+
+/// @dev Ethereum representation of TokenPermissions (see [`up_data_structs::PropertyPermission`]) as an key and value.
+struct PropertyPermission {
+ /// @dev TokenPermission field.
+ EthTokenPermissions code;
+ /// @dev TokenPermission value.
+ bool 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`]
@@ -96,18 +114,6 @@
CollectionAdmin
}
-/// @dev anonymous struct
-struct Tuple52 {
- string field_0;
- Tuple50[] field_1;
-}
-
-/// @dev anonymous struct
-struct Tuple50 {
- EthTokenPermissions field_0;
- bool field_1;
-}
-
/// @title A contract that allows you to work with collections.
/// @dev the ERC-165 identifier for this interface is 0x81172a75
interface Collection is Dummy, ERC165 {
@@ -412,9 +418,12 @@
bool field_1;
}
+/// @dev Ethereum representation of `NestingPermissions` (see [`up_data_structs::NestingPermissions`]) fields as an enumeration.
enum CollectionPermissions {
- CollectionAdmin,
- TokenOwner
+ /// @dev Owner of token can nest tokens under it.
+ TokenOwner,
+ /// @dev Admin of token collection can nest tokens under token.
+ CollectionAdmin
}
/// @dev anonymous struct