difftreelog
feat(refungible-pallet) ERC-721 EVM API
in: master
12 files changed
Makefilediffbeforeafterboth--- a/Makefile
+++ b/Makefile
@@ -15,8 +15,9 @@
NONFUNGIBLE_EVM_STUBS=./pallets/nonfungible/src/stubs
NONFUNGIBLE_EVM_ABI=./tests/src/eth/nonFungibleAbi.json
-RENFUNGIBLE_EVM_ABI=./tests/src/eth/reFungibleAbi.json
-RENFUNGIBLE_TOKEN_EVM_ABI=./tests/src/eth/reFungibleTokenAbi.json
+REFUNGIBLE_EVM_STUBS=./pallets/refungible/src/stubs
+REFUNGIBLE_EVM_ABI=./tests/src/eth/reFungibleAbi.json
+REFUNGIBLE_TOKEN_EVM_ABI=./tests/src/eth/reFungibleTokenAbi.json
CONTRACT_HELPERS_STUBS=./pallets/evm-contract-helpers/src/stubs/
CONTRACT_HELPERS_ABI=./tests/src/eth/util/contractHelpersAbi.json
@@ -36,6 +37,10 @@
UniqueNFT.sol:
PACKAGE=pallet-nonfungible NAME=erc::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
PACKAGE=pallet-nonfungible NAME=erc::gen_impl OUTPUT=$(NONFUNGIBLE_EVM_STUBS)/$@ ./.maintain/scripts/generate_sol.sh
+
+UniqueRefungible.sol:
+ PACKAGE=pallet-refungible NAME=erc::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
+ PACKAGE=pallet-refungible NAME=erc::gen_impl OUTPUT=$(REFUNGIBLE_EVM_STUBS)/$@ ./.maintain/scripts/generate_sol.sh
UniqueRefungible.sol:
PACKAGE=pallet-refungible NAME=erc::gen_iface OUTPUT=$(TESTS_API)/$@ ./.maintain/scripts/generate_sol.sh
@@ -61,9 +66,13 @@
INPUT=$(NONFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(NONFUNGIBLE_EVM_STUBS)/UniqueNFT.raw ./.maintain/scripts/compile_stub.sh
INPUT=$(NONFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(NONFUNGIBLE_EVM_ABI) ./.maintain/scripts/generate_abi.sh
+UniqueRefungible: UniqueRefungible.sol
+ INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_STUBS)/UniqueRefungible.raw ./.maintain/scripts/compile_stub.sh
+ INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_ABI) ./.maintain/scripts/generate_abi.sh
+
UniqueRefungibleToken: UniqueRefungibleToken.sol
INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_STUBS)/UniqueRefungibleToken.raw ./.maintain/scripts/compile_stub.sh
- INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(RENFUNGIBLE_TOKEN_EVM_ABI) ./.maintain/scripts/generate_abi.sh
+ INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_TOKEN_EVM_ABI) ./.maintain/scripts/generate_abi.sh
UniqueRefungible: UniqueRefungible.sol
INPUT=$(REFUNGIBLE_EVM_STUBS)/$< OUTPUT=$(REFUNGIBLE_EVM_STUBS)/UniqueRefungible.raw ./.maintain/scripts/compile_stub.sh
pallets/refungible/src/erc.rsdiffbeforeafterboth--- a/pallets/refungible/src/erc.rs
+++ b/pallets/refungible/src/erc.rs
@@ -15,18 +15,607 @@
// along with Unique Network. If not, see <http://www.gnu.org/licenses/>.
extern crate alloc;
-use evm_coder::{generate_stubgen, solidity_interface, types::*};
-use pallet_common::{CollectionHandle, erc::CollectionCall, erc::CommonEvmHandler};
+use alloc::string::ToString;
+use core::{
+ char::{REPLACEMENT_CHARACTER, decode_utf16},
+ convert::TryInto,
+};
+use evm_coder::{ToLog, execution::*, generate_stubgen, solidity, solidity_interface, types::*, weight};
+use frame_support::{BoundedBTreeMap, BoundedVec};
+use pallet_common::{
+ CollectionHandle, CollectionPropertyPermissions,
+ erc::{
+ CommonEvmHandler, CollectionCall,
+ static_property::{key, value as property_value},
+ },
+};
+use pallet_evm::{account::CrossAccountId, PrecompileHandle};
+use pallet_evm_coder_substrate::{call, dispatch_to_evm};
+use pallet_structure::{SelfWeightOf as StructureWeight, weights::WeightInfo as _};
+use sp_core::H160;
+use sp_std::{collections::btree_map::BTreeMap, vec::Vec, vec};
+use up_data_structs::{
+ CollectionId, CollectionPropertiesVec, Property, PropertyKey, PropertyKeyPermission,
+ PropertyPermission, TokenId,
+};
+
+use crate::{
+ AccountBalance, Config, CreateItemData, Pallet, RefungibleHandle, SelfWeightOf,
+ TokenProperties, TokensMinted, weights::WeightInfo,
+};
-use pallet_evm::PrecompileHandle;
-use pallet_evm_coder_substrate::call;
+#[solidity_interface(name = "TokenProperties")]
+impl<T: Config> RefungibleHandle<T> {
+ fn set_token_property_permission(
+ &mut self,
+ caller: caller,
+ key: string,
+ is_mutable: bool,
+ collection_admin: bool,
+ token_owner: bool,
+ ) -> Result<()> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ <Pallet<T>>::set_token_property_permissions(
+ self,
+ &caller,
+ vec![PropertyKeyPermission {
+ key: <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "too long key")?,
+ permission: PropertyPermission {
+ mutable: is_mutable,
+ collection_admin,
+ token_owner,
+ },
+ }],
+ )
+ .map_err(dispatch_to_evm::<T>)
+ }
-use crate::{Config, RefungibleHandle};
+ fn set_property(
+ &mut self,
+ caller: caller,
+ token_id: uint256,
+ key: string,
+ value: bytes,
+ ) -> Result<()> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
+ let key = <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "key too long")?;
+ let value = value.try_into().map_err(|_| "value too long")?;
+ let nesting_budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ <Pallet<T>>::set_token_property(
+ self,
+ &caller,
+ TokenId(token_id),
+ Property { key, value },
+ &nesting_budget,
+ )
+ .map_err(dispatch_to_evm::<T>)
+ }
+
+ fn delete_property(&mut self, token_id: uint256, caller: caller, key: string) -> Result<()> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
+ let key = <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "key too long")?;
+
+ let nesting_budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ <Pallet<T>>::delete_token_property(self, &caller, TokenId(token_id), key, &nesting_budget)
+ .map_err(dispatch_to_evm::<T>)
+ }
+
+ /// Throws error if key not found
+ fn property(&self, token_id: uint256, key: string) -> Result<bytes> {
+ let token_id: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
+ let key = <Vec<u8>>::from(key)
+ .try_into()
+ .map_err(|_| "key too long")?;
+
+ let props = <TokenProperties<T>>::get((self.id, token_id));
+ let prop = props.get(&key).ok_or("key not found")?;
+
+ Ok(prop.to_vec())
+ }
+}
+
+#[derive(ToLog)]
+pub enum ERC721Events {
+ Transfer {
+ #[indexed]
+ from: address,
+ #[indexed]
+ to: address,
+ #[indexed]
+ token_id: uint256,
+ },
+ /// @dev Not supported
+ Approval {
+ #[indexed]
+ owner: address,
+ #[indexed]
+ approved: address,
+ #[indexed]
+ token_id: uint256,
+ },
+ /// @dev Not supported
+ #[allow(dead_code)]
+ ApprovalForAll {
+ #[indexed]
+ owner: address,
+ #[indexed]
+ operator: address,
+ approved: bool,
+ },
+}
+
+#[derive(ToLog)]
+pub enum ERC721MintableEvents {
+ /// @dev Not supported
+ #[allow(dead_code)]
+ MintingFinished {},
+}
+
+#[solidity_interface(name = "ERC721Metadata")]
+impl<T: Config> RefungibleHandle<T> {
+ fn name(&self) -> Result<string> {
+ Ok(decode_utf16(self.name.iter().copied())
+ .map(|r| r.unwrap_or(REPLACEMENT_CHARACTER))
+ .collect::<string>())
+ }
+
+ fn symbol(&self) -> Result<string> {
+ Ok(string::from_utf8_lossy(&self.token_prefix).into())
+ }
+
+ /// @notice A distinct Uniform Resource Identifier (URI) for a given asset.
+ ///
+ /// @dev If the token has a `url` property and it is not empty, it is returned.
+ /// 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`.
+ /// If the collection property `baseURI` is empty or absent, return "" (empty string)
+ /// otherwise, if token property `suffix` present and is non-empty, return concatenation of baseURI and suffix
+ /// otherwise, return concatenation of `baseURI` and stringified token id (decimal stringifying, without paddings).
+ ///
+ /// @return token's const_metadata
+ #[solidity(rename_selector = "tokenURI")]
+ fn token_uri(&self, token_id: uint256) -> Result<string> {
+ let token_id_u32: u32 = token_id.try_into().map_err(|_| "token id overflow")?;
+
+ if let Ok(url) = get_token_property(self, token_id_u32, &key::url()) {
+ if !url.is_empty() {
+ return Ok(url);
+ }
+ } else if !is_erc721_metadata_compatible::<T>(self.id) {
+ return Err("tokenURI not set".into());
+ }
+
+ if let Some(base_uri) =
+ pallet_common::Pallet::<T>::get_collection_property(self.id, &key::base_uri())
+ {
+ if !base_uri.is_empty() {
+ let base_uri = string::from_utf8(base_uri.into_inner()).map_err(|e| {
+ Error::Revert(alloc::format!(
+ "Can not convert value \"baseURI\" to string with error \"{}\"",
+ e
+ ))
+ })?;
+ if let Ok(suffix) = get_token_property(self, token_id_u32, &key::suffix()) {
+ if !suffix.is_empty() {
+ return Ok(base_uri + suffix.as_str());
+ }
+ }
+
+ return Ok(base_uri + token_id.to_string().as_str());
+ }
+ }
+
+ Ok("".into())
+ }
+}
+
+#[solidity_interface(name = "ERC721Enumerable")]
+impl<T: Config> RefungibleHandle<T> {
+ fn token_by_index(&self, index: uint256) -> Result<uint256> {
+ Ok(index)
+ }
+
+ /// Not implemented
+ fn token_of_owner_by_index(&self, _owner: address, _index: uint256) -> Result<uint256> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+
+ fn total_supply(&self) -> Result<uint256> {
+ self.consume_store_reads(1)?;
+ Ok(<Pallet<T>>::total_supply(self).into())
+ }
+}
+
+#[solidity_interface(name = "ERC721", events(ERC721Events))]
+impl<T: Config> RefungibleHandle<T> {
+ fn balance_of(&self, owner: address) -> Result<uint256> {
+ self.consume_store_reads(1)?;
+ let owner = T::CrossAccountId::from_eth(owner);
+ let balance = <AccountBalance<T>>::get((self.id, owner));
+ Ok(balance.into())
+ }
+
+ fn owner_of(&self, token_id: uint256) -> Result<address> {
+ self.consume_store_reads(2)?;
+ let token = token_id.try_into()?;
+ let owner = <Pallet<T>>::token_owner(self.id, token);
+ Ok(owner
+ .map(|address| *address.as_eth())
+ .unwrap_or_else(|| H160::default()))
+ }
+
+ /// @dev Not implemented
+ fn safe_transfer_from_with_data(
+ &mut self,
+ _from: address,
+ _to: address,
+ _token_id: uint256,
+ _data: bytes,
+ _value: value,
+ ) -> Result<void> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn safe_transfer_from(
+ &mut self,
+ _from: address,
+ _to: address,
+ _token_id: uint256,
+ _value: value,
+ ) -> Result<void> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn transfer_from(
+ &mut self,
+ _caller: caller,
+ _from: address,
+ _to: address,
+ _token_id: uint256,
+ _value: value,
+ ) -> Result<void> {
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn approve(
+ &mut self,
+ _caller: caller,
+ _approved: address,
+ _token_id: uint256,
+ _value: value,
+ ) -> Result<void> {
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn set_approval_for_all(
+ &mut self,
+ _caller: caller,
+ _operator: address,
+ _approved: bool,
+ ) -> Result<void> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn get_approved(&self, _token_id: uint256) -> Result<address> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+
+ /// @dev Not implemented
+ fn is_approved_for_all(&self, _owner: address, _operator: address) -> Result<address> {
+ // TODO: Not implemetable
+ Err("not implemented".into())
+ }
+}
+
+#[solidity_interface(name = "ERC721Burnable")]
+impl<T: Config> RefungibleHandle<T> {
+ /// @dev Not implemented
+ fn burn(&mut self, _caller: caller, _token_id: uint256, _value: value) -> Result<void> {
+ Err("not implemented".into())
+ }
+}
+
+#[solidity_interface(name = "ERC721Mintable", events(ERC721MintableEvents))]
+impl<T: Config> RefungibleHandle<T> {
+ fn minting_finished(&self) -> Result<bool> {
+ Ok(false)
+ }
+
+ /// `token_id` should be obtained with `next_token_id` method,
+ /// unlike standard, you can't specify it manually
+ #[weight(<SelfWeightOf<T>>::create_item())]
+ fn mint(&mut self, caller: caller, to: address, token_id: uint256) -> Result<bool> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let to = T::CrossAccountId::from_eth(to);
+ let token_id: u32 = token_id.try_into()?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ if <TokensMinted<T>>::get(self.id)
+ .checked_add(1)
+ .ok_or("item id overflow")?
+ != token_id
+ {
+ return Err("item id should be next".into());
+ }
+
+ let const_data = BoundedVec::default();
+ let users = [(to.clone(), 1)]
+ .into_iter()
+ .collect::<BTreeMap<_, _>>()
+ .try_into()
+ .unwrap();
+ <Pallet<T>>::create_item(
+ self,
+ &caller,
+ CreateItemData::<T> {
+ const_data,
+ users,
+ properties: CollectionPropertiesVec::default(),
+ },
+ &budget,
+ )
+ .map_err(dispatch_to_evm::<T>)?;
+
+ Ok(true)
+ }
+
+ /// `token_id` should be obtained with `next_token_id` method,
+ /// unlike standard, you can't specify it manually
+ #[solidity(rename_selector = "mintWithTokenURI")]
+ #[weight(<SelfWeightOf<T>>::create_item())]
+ fn mint_with_token_uri(
+ &mut self,
+ caller: caller,
+ to: address,
+ token_id: uint256,
+ token_uri: string,
+ ) -> Result<bool> {
+ let key = key::url();
+ let permission = get_token_permission::<T>(self.id, &key)?;
+ if !permission.collection_admin {
+ return Err("Operation is not allowed".into());
+ }
+
+ let caller = T::CrossAccountId::from_eth(caller);
+ let to = T::CrossAccountId::from_eth(to);
+ let token_id: u32 = token_id.try_into().map_err(|_| "amount overflow")?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ if <TokensMinted<T>>::get(self.id)
+ .checked_add(1)
+ .ok_or("item id overflow")?
+ != token_id
+ {
+ return Err("item id should be next".into());
+ }
+
+ let mut properties = CollectionPropertiesVec::default();
+ properties
+ .try_push(Property {
+ key,
+ value: token_uri
+ .into_bytes()
+ .try_into()
+ .map_err(|_| "token uri is too long")?,
+ })
+ .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;
+
+ let const_data = BoundedVec::default();
+ let users = [(to.clone(), 1)]
+ .into_iter()
+ .collect::<BTreeMap<_, _>>()
+ .try_into()
+ .unwrap();
+ <Pallet<T>>::create_item(
+ self,
+ &caller,
+ CreateItemData::<T> {
+ const_data,
+ users,
+ properties,
+ },
+ &budget,
+ )
+ .map_err(dispatch_to_evm::<T>)?;
+ Ok(true)
+ }
+
+ /// @dev Not implemented
+ fn finish_minting(&mut self, _caller: caller) -> Result<bool> {
+ Err("not implementable".into())
+ }
+}
+
+fn get_token_property<T: Config>(
+ collection: &CollectionHandle<T>,
+ token_id: u32,
+ key: &up_data_structs::PropertyKey,
+) -> Result<string> {
+ collection.consume_store_reads(1)?;
+ let properties = <TokenProperties<T>>::try_get((collection.id, token_id))
+ .map_err(|_| Error::Revert("Token properties not found".into()))?;
+ if let Some(property) = properties.get(key) {
+ return Ok(string::from_utf8_lossy(property).into());
+ }
+
+ Err("Property tokenURI not found".into())
+}
+
+fn is_erc721_metadata_compatible<T: Config>(collection_id: CollectionId) -> bool {
+ if let Some(shema_name) =
+ pallet_common::Pallet::<T>::get_collection_property(collection_id, &key::schema_name())
+ {
+ let shema_name = shema_name.into_inner();
+ shema_name == property_value::ERC721_METADATA
+ } else {
+ false
+ }
+}
+
+fn get_token_permission<T: Config>(
+ collection_id: CollectionId,
+ key: &PropertyKey,
+) -> Result<PropertyPermission> {
+ let token_property_permissions = CollectionPropertyPermissions::<T>::try_get(collection_id)
+ .map_err(|_| Error::Revert("No permissions for collection".into()))?;
+ let a = token_property_permissions
+ .get(key)
+ .map(Clone::clone)
+ .ok_or_else(|| {
+ let key = string::from_utf8(key.clone().into_inner()).unwrap_or_default();
+ Error::Revert(alloc::format!("No permission for key {}", key))
+ })?;
+ Ok(a)
+}
+
+#[solidity_interface(name = "ERC721UniqueExtensions")]
+impl<T: Config> RefungibleHandle<T> {
+ /// @notice Returns next free RFT ID.
+ fn next_token_id(&self) -> Result<uint256> {
+ self.consume_store_reads(1)?;
+ Ok(<TokensMinted<T>>::get(self.id)
+ .checked_add(1)
+ .ok_or("item id overflow")?
+ .into())
+ }
+
+ #[weight(<SelfWeightOf<T>>::create_multiple_items(token_ids.len() as u32))]
+ fn mint_bulk(&mut self, caller: caller, to: address, token_ids: Vec<uint256>) -> Result<bool> {
+ let caller = T::CrossAccountId::from_eth(caller);
+ let to = T::CrossAccountId::from_eth(to);
+ let mut expected_index = <TokensMinted<T>>::get(self.id)
+ .checked_add(1)
+ .ok_or("item id overflow")?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let total_tokens = token_ids.len();
+ for id in token_ids.into_iter() {
+ let id: u32 = id.try_into().map_err(|_| "token id overflow")?;
+ if id != expected_index {
+ return Err("item id should be next".into());
+ }
+ expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;
+ }
+ let const_data = BoundedVec::default();
+ let users = [(to.clone(), 1)]
+ .into_iter()
+ .collect::<BTreeMap<_, _>>()
+ .try_into()
+ .unwrap();
+ let create_item_data = CreateItemData::<T> {
+ const_data,
+ users,
+ properties: CollectionPropertiesVec::default(),
+ };
+ let data = (0..total_tokens)
+ .map(|_| create_item_data.clone())
+ .collect();
+
+ <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
+ Ok(true)
+ }
+
+ #[solidity(rename_selector = "mintBulkWithTokenURI")]
+ #[weight(<SelfWeightOf<T>>::create_multiple_items(tokens.len() as u32))]
+ fn mint_bulk_with_token_uri(
+ &mut self,
+ caller: caller,
+ to: address,
+ tokens: Vec<(uint256, string)>,
+ ) -> Result<bool> {
+ let key = key::url();
+ let caller = T::CrossAccountId::from_eth(caller);
+ let to = T::CrossAccountId::from_eth(to);
+ let mut expected_index = <TokensMinted<T>>::get(self.id)
+ .checked_add(1)
+ .ok_or("item id overflow")?;
+ let budget = self
+ .recorder
+ .weight_calls_budget(<StructureWeight<T>>::find_parent());
+
+ let mut data = Vec::with_capacity(tokens.len());
+ let const_data = BoundedVec::default();
+ let users: BoundedBTreeMap<_, _, _> = [(to.clone(), 1)]
+ .into_iter()
+ .collect::<BTreeMap<_, _>>()
+ .try_into()
+ .unwrap();
+ for (id, token_uri) in tokens {
+ let id: u32 = id.try_into().map_err(|_| "token id overflow")?;
+ if id != expected_index {
+ return Err("item id should be next".into());
+ }
+ expected_index = expected_index.checked_add(1).ok_or("item id overflow")?;
+
+ let mut properties = CollectionPropertiesVec::default();
+ properties
+ .try_push(Property {
+ key: key.clone(),
+ value: token_uri
+ .into_bytes()
+ .try_into()
+ .map_err(|_| "token uri is too long")?,
+ })
+ .map_err(|e| Error::Revert(alloc::format!("Can't add property: {:?}", e)))?;
+
+ let create_item_data = CreateItemData::<T> {
+ const_data: const_data.clone(),
+ users: users.clone(),
+ properties,
+ };
+ data.push(create_item_data);
+ }
+
+ <Pallet<T>>::create_multiple_items(self, &caller, data, &budget)
+ .map_err(dispatch_to_evm::<T>)?;
+ Ok(true)
+ }
+}
+
#[solidity_interface(
name = "UniqueRefungible",
- is(via("CollectionHandle<T>", common_mut, Collection),)
+ is(
+ ERC721,
+ ERC721Metadata,
+ ERC721Enumerable,
+ ERC721UniqueExtensions,
+ ERC721Mintable,
+ ERC721Burnable,
+ via("CollectionHandle<T>", common_mut, Collection),
+ TokenProperties,
+ )
)]
impl<T: Config> RefungibleHandle<T> where T::AccountId: From<[u8; 32]> {}
pallets/refungible/src/lib.rsdiffbeforeafterboth--- a/pallets/refungible/src/lib.rs
+++ b/pallets/refungible/src/lib.rs
@@ -88,6 +88,7 @@
#![cfg_attr(not(feature = "std"), no_std)]
use crate::erc_token::ERC20Events;
+use crate::erc::ERC721Events;
use codec::{Encode, Decode, MaxEncodedLen};
use core::ops::Deref;
@@ -96,7 +97,8 @@
use pallet_evm::{account::CrossAccountId, Pallet as PalletEvm};
use pallet_evm_coder_substrate::WithRecorder;
use pallet_common::{
- CommonCollectionOperations, Error as CommonError, Event as CommonEvent, Pallet as PalletCommon,
+ CommonCollectionOperations, Error as CommonError, Event as CommonEvent,
+ eth::collection_id_to_address, Pallet as PalletCommon,
};
use pallet_structure::Pallet as PalletStructure;
use scale_info::TypeInfo;
@@ -117,6 +119,9 @@
pub mod erc;
pub mod erc_token;
pub mod weights;
+
+pub type CreateItemData<T> =
+ CreateRefungibleExData<<T as pallet_evm::account::Config>::CrossAccountId>;
pub(crate) type SelfWeightOf<T> = <T as Config>::WeightInfo;
/// Token data, stored independently from other data used to describe it
@@ -779,6 +784,7 @@
token,
)),
);
+
<PalletCommon<T>>::deposit_event(CommonEvent::Transfer(
collection.id,
token,
@@ -797,7 +803,7 @@
pub fn create_multiple_items(
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
- data: Vec<CreateRefungibleExData<T::CrossAccountId>>,
+ data: Vec<CreateItemData<T>>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
if !collection.is_owner_or_admin(sender) {
@@ -942,6 +948,14 @@
TokenId(token_id),
)),
);
+ <PalletEvm<T>>::deposit_log(
+ ERC721Events::Transfer {
+ from: H160::default(),
+ to: *user.as_eth(),
+ token_id: token_id.into(),
+ }
+ .to_log(collection_id_to_address(collection.id)),
+ );
<PalletCommon<T>>::deposit_event(CommonEvent::ItemCreated(
collection.id,
TokenId(token_id),
@@ -1120,7 +1134,7 @@
pub fn create_item(
collection: &RefungibleHandle<T>,
sender: &T::CrossAccountId,
- data: CreateRefungibleExData<T::CrossAccountId>,
+ data: CreateItemData<T>,
nesting_budget: &dyn Budget,
) -> DispatchResult {
Self::create_multiple_items(collection, sender, vec![data], nesting_budget)
pallets/refungible/src/stubs/UniqueRefungible.soldiffbeforeafterboth--- a/pallets/refungible/src/stubs/UniqueRefungible.sol
+++ b/pallets/refungible/src/stubs/UniqueRefungible.sol
@@ -3,6 +3,12 @@
pragma solidity >=0.8.0 <0.9.0;
+// Anonymous struct
+struct Tuple0 {
+ uint256 field_0;
+ string field_1;
+}
+
// Common stubs holder
contract Dummy {
uint8 dummy;
@@ -21,6 +27,351 @@
}
}
+// Inline
+contract ERC721Events {
+ event Transfer(
+ address indexed from,
+ address indexed to,
+ uint256 indexed tokenId
+ );
+ event Approval(
+ address indexed owner,
+ address indexed approved,
+ uint256 indexed tokenId
+ );
+ event ApprovalForAll(
+ address indexed owner,
+ address indexed operator,
+ bool approved
+ );
+}
+
+// Inline
+contract ERC721MintableEvents {
+ event MintingFinished();
+}
+
+// Selector: 0784ee64
+contract ERC721UniqueExtensions is Dummy, ERC165 {
+ // @notice Returns next free RFT ID.
+ //
+ // Selector: nextTokenId() 75794a3c
+ function nextTokenId() public view returns (uint256) {
+ require(false, stub_error);
+ dummy;
+ return 0;
+ }
+
+ // Selector: mintBulk(address,uint256[]) 44a9945e
+ function mintBulk(address to, uint256[] memory tokenIds)
+ public
+ returns (bool)
+ {
+ require(false, stub_error);
+ to;
+ tokenIds;
+ dummy = 0;
+ return false;
+ }
+
+ // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
+ function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
+ public
+ returns (bool)
+ {
+ require(false, stub_error);
+ to;
+ tokens;
+ dummy = 0;
+ return false;
+ }
+}
+
+// Selector: 41369377
+contract TokenProperties is Dummy, ERC165 {
+ // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa
+ function setTokenPropertyPermission(
+ string memory key,
+ bool isMutable,
+ bool collectionAdmin,
+ bool tokenOwner
+ ) public {
+ require(false, stub_error);
+ key;
+ isMutable;
+ collectionAdmin;
+ tokenOwner;
+ dummy = 0;
+ }
+
+ // Selector: setProperty(uint256,string,bytes) 1752d67b
+ function setProperty(
+ uint256 tokenId,
+ string memory key,
+ bytes memory value
+ ) public {
+ require(false, stub_error);
+ tokenId;
+ key;
+ value;
+ dummy = 0;
+ }
+
+ // Selector: deleteProperty(uint256,string) 066111d1
+ function deleteProperty(uint256 tokenId, string memory key) public {
+ require(false, stub_error);
+ tokenId;
+ key;
+ dummy = 0;
+ }
+
+ // Throws error if key not found
+ //
+ // Selector: property(uint256,string) 7228c327
+ function property(uint256 tokenId, string memory key)
+ public
+ view
+ returns (bytes memory)
+ {
+ require(false, stub_error);
+ tokenId;
+ key;
+ dummy;
+ return hex"";
+ }
+}
+
+// Selector: 42966c68
+contract ERC721Burnable is Dummy, ERC165 {
+ // @dev Not implemented
+ //
+ // Selector: burn(uint256) 42966c68
+ function burn(uint256 tokenId) public {
+ require(false, stub_error);
+ tokenId;
+ dummy = 0;
+ }
+}
+
+// Selector: 58800161
+contract ERC721 is Dummy, ERC165, ERC721Events {
+ // Selector: balanceOf(address) 70a08231
+ function balanceOf(address owner) public view returns (uint256) {
+ require(false, stub_error);
+ owner;
+ dummy;
+ return 0;
+ }
+
+ // Selector: ownerOf(uint256) 6352211e
+ function ownerOf(uint256 tokenId) public view returns (address) {
+ require(false, stub_error);
+ tokenId;
+ dummy;
+ return 0x0000000000000000000000000000000000000000;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672
+ function safeTransferFromWithData(
+ address from,
+ address to,
+ uint256 tokenId,
+ bytes memory data
+ ) public {
+ require(false, stub_error);
+ from;
+ to;
+ tokenId;
+ data;
+ dummy = 0;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: safeTransferFrom(address,address,uint256) 42842e0e
+ function safeTransferFrom(
+ address from,
+ address to,
+ uint256 tokenId
+ ) public {
+ require(false, stub_error);
+ from;
+ to;
+ tokenId;
+ dummy = 0;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: transferFrom(address,address,uint256) 23b872dd
+ function transferFrom(
+ address from,
+ address to,
+ uint256 tokenId
+ ) public {
+ require(false, stub_error);
+ from;
+ to;
+ tokenId;
+ dummy = 0;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: approve(address,uint256) 095ea7b3
+ function approve(address approved, uint256 tokenId) public {
+ require(false, stub_error);
+ approved;
+ tokenId;
+ dummy = 0;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: setApprovalForAll(address,bool) a22cb465
+ function setApprovalForAll(address operator, bool approved) public {
+ require(false, stub_error);
+ operator;
+ approved;
+ dummy = 0;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: getApproved(uint256) 081812fc
+ function getApproved(uint256 tokenId) public view returns (address) {
+ require(false, stub_error);
+ tokenId;
+ dummy;
+ return 0x0000000000000000000000000000000000000000;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: isApprovedForAll(address,address) e985e9c5
+ function isApprovedForAll(address owner, address operator)
+ public
+ view
+ returns (address)
+ {
+ require(false, stub_error);
+ owner;
+ operator;
+ dummy;
+ return 0x0000000000000000000000000000000000000000;
+ }
+}
+
+// Selector: 5b5e139f
+contract ERC721Metadata is Dummy, ERC165 {
+ // Selector: name() 06fdde03
+ function name() public view returns (string memory) {
+ require(false, stub_error);
+ dummy;
+ return "";
+ }
+
+ // Selector: symbol() 95d89b41
+ function symbol() public view returns (string memory) {
+ require(false, stub_error);
+ dummy;
+ return "";
+ }
+
+ // Returns token's const_metadata
+ //
+ // Selector: tokenURI(uint256) c87b56dd
+ function tokenURI(uint256 tokenId) public view returns (string memory) {
+ require(false, stub_error);
+ tokenId;
+ dummy;
+ return "";
+ }
+}
+
+// Selector: 68ccfe89
+contract ERC721Mintable is Dummy, ERC165, ERC721MintableEvents {
+ // Selector: mintingFinished() 05d2035b
+ function mintingFinished() public view returns (bool) {
+ require(false, stub_error);
+ dummy;
+ return false;
+ }
+
+ // `token_id` should be obtained with `next_token_id` method,
+ // unlike standard, you can't specify it manually
+ //
+ // Selector: mint(address,uint256) 40c10f19
+ function mint(address to, uint256 tokenId) public returns (bool) {
+ require(false, stub_error);
+ to;
+ tokenId;
+ dummy = 0;
+ return false;
+ }
+
+ // `token_id` should be obtained with `next_token_id` method,
+ // unlike standard, you can't specify it manually
+ //
+ // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f
+ function mintWithTokenURI(
+ address to,
+ uint256 tokenId,
+ string memory tokenUri
+ ) public returns (bool) {
+ require(false, stub_error);
+ to;
+ tokenId;
+ tokenUri;
+ dummy = 0;
+ return false;
+ }
+
+ // @dev Not implemented
+ //
+ // Selector: finishMinting() 7d64bcb4
+ function finishMinting() public returns (bool) {
+ require(false, stub_error);
+ dummy = 0;
+ return false;
+ }
+}
+
+// Selector: 780e9d63
+contract ERC721Enumerable is Dummy, ERC165 {
+ // Selector: tokenByIndex(uint256) 4f6ccce7
+ function tokenByIndex(uint256 index) public view returns (uint256) {
+ require(false, stub_error);
+ index;
+ dummy;
+ return 0;
+ }
+
+ // Not implemented
+ //
+ // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59
+ function tokenOfOwnerByIndex(address owner, uint256 index)
+ public
+ view
+ returns (uint256)
+ {
+ require(false, stub_error);
+ owner;
+ index;
+ dummy;
+ return 0;
+ }
+
+ // Selector: totalSupply() 18160ddd
+ function totalSupply() public view returns (uint256) {
+ require(false, stub_error);
+ dummy;
+ return 0;
+ }
+}
+
// Selector: 7d9262e6
contract Collection is Dummy, ERC165 {
// Set collection property.
@@ -248,4 +599,15 @@
}
}
-contract UniqueRefungible is Dummy, ERC165, Collection {}
+contract UniqueRefungible is
+ Dummy,
+ ERC165,
+ ERC721,
+ ERC721Metadata,
+ ERC721Enumerable,
+ ERC721UniqueExtensions,
+ ERC721Mintable,
+ ERC721Burnable,
+ Collection,
+ TokenProperties
+{}
tests/src/eth/api/UniqueRefungible.soldiffbeforeafterboth--- a/tests/src/eth/api/UniqueRefungible.sol
+++ b/tests/src/eth/api/UniqueRefungible.sol
@@ -3,6 +3,12 @@
pragma solidity >=0.8.0 <0.9.0;
+// Anonymous struct
+struct Tuple0 {
+ uint256 field_0;
+ string field_1;
+}
+
// Common stubs holder
interface Dummy {
@@ -12,6 +18,203 @@
function supportsInterface(bytes4 interfaceID) external view returns (bool);
}
+// Inline
+interface ERC721Events {
+ event Transfer(
+ address indexed from,
+ address indexed to,
+ uint256 indexed tokenId
+ );
+ event Approval(
+ address indexed owner,
+ address indexed approved,
+ uint256 indexed tokenId
+ );
+ event ApprovalForAll(
+ address indexed owner,
+ address indexed operator,
+ bool approved
+ );
+}
+
+// Inline
+interface ERC721MintableEvents {
+ event MintingFinished();
+}
+
+// Selector: 0784ee64
+interface ERC721UniqueExtensions is Dummy, ERC165 {
+ // @notice Returns next free RFT ID.
+ //
+ // Selector: nextTokenId() 75794a3c
+ function nextTokenId() external view returns (uint256);
+
+ // Selector: mintBulk(address,uint256[]) 44a9945e
+ function mintBulk(address to, uint256[] memory tokenIds)
+ external
+ returns (bool);
+
+ // Selector: mintBulkWithTokenURI(address,(uint256,string)[]) 36543006
+ function mintBulkWithTokenURI(address to, Tuple0[] memory tokens)
+ external
+ returns (bool);
+}
+
+// Selector: 41369377
+interface TokenProperties is Dummy, ERC165 {
+ // Selector: setTokenPropertyPermission(string,bool,bool,bool) 222d97fa
+ function setTokenPropertyPermission(
+ string memory key,
+ bool isMutable,
+ bool collectionAdmin,
+ bool tokenOwner
+ ) external;
+
+ // Selector: setProperty(uint256,string,bytes) 1752d67b
+ function setProperty(
+ uint256 tokenId,
+ string memory key,
+ bytes memory value
+ ) external;
+
+ // Selector: deleteProperty(uint256,string) 066111d1
+ function deleteProperty(uint256 tokenId, string memory key) external;
+
+ // Throws error if key not found
+ //
+ // Selector: property(uint256,string) 7228c327
+ function property(uint256 tokenId, string memory key)
+ external
+ view
+ returns (bytes memory);
+}
+
+// Selector: 42966c68
+interface ERC721Burnable is Dummy, ERC165 {
+ // @dev Not implemented
+ //
+ // Selector: burn(uint256) 42966c68
+ function burn(uint256 tokenId) external;
+}
+
+// Selector: 58800161
+interface ERC721 is Dummy, ERC165, ERC721Events {
+ // Selector: balanceOf(address) 70a08231
+ function balanceOf(address owner) external view returns (uint256);
+
+ // Selector: ownerOf(uint256) 6352211e
+ function ownerOf(uint256 tokenId) external view returns (address);
+
+ // @dev Not implemented
+ //
+ // Selector: safeTransferFromWithData(address,address,uint256,bytes) 60a11672
+ function safeTransferFromWithData(
+ address from,
+ address to,
+ uint256 tokenId,
+ bytes memory data
+ ) external;
+
+ // @dev Not implemented
+ //
+ // Selector: safeTransferFrom(address,address,uint256) 42842e0e
+ function safeTransferFrom(
+ address from,
+ address to,
+ uint256 tokenId
+ ) external;
+
+ // @dev Not implemented
+ //
+ // Selector: transferFrom(address,address,uint256) 23b872dd
+ function transferFrom(
+ address from,
+ address to,
+ uint256 tokenId
+ ) external;
+
+ // @dev Not implemented
+ //
+ // Selector: approve(address,uint256) 095ea7b3
+ function approve(address approved, uint256 tokenId) external;
+
+ // @dev Not implemented
+ //
+ // Selector: setApprovalForAll(address,bool) a22cb465
+ function setApprovalForAll(address operator, bool approved) external;
+
+ // @dev Not implemented
+ //
+ // Selector: getApproved(uint256) 081812fc
+ function getApproved(uint256 tokenId) external view returns (address);
+
+ // @dev Not implemented
+ //
+ // Selector: isApprovedForAll(address,address) e985e9c5
+ function isApprovedForAll(address owner, address operator)
+ external
+ view
+ returns (address);
+}
+
+// Selector: 5b5e139f
+interface ERC721Metadata is Dummy, ERC165 {
+ // Selector: name() 06fdde03
+ function name() external view returns (string memory);
+
+ // Selector: symbol() 95d89b41
+ function symbol() external view returns (string memory);
+
+ // Returns token's const_metadata
+ //
+ // Selector: tokenURI(uint256) c87b56dd
+ function tokenURI(uint256 tokenId) external view returns (string memory);
+}
+
+// Selector: 68ccfe89
+interface ERC721Mintable is Dummy, ERC165, ERC721MintableEvents {
+ // Selector: mintingFinished() 05d2035b
+ function mintingFinished() external view returns (bool);
+
+ // `token_id` should be obtained with `next_token_id` method,
+ // unlike standard, you can't specify it manually
+ //
+ // Selector: mint(address,uint256) 40c10f19
+ function mint(address to, uint256 tokenId) external returns (bool);
+
+ // `token_id` should be obtained with `next_token_id` method,
+ // unlike standard, you can't specify it manually
+ //
+ // Selector: mintWithTokenURI(address,uint256,string) 50bb4e7f
+ function mintWithTokenURI(
+ address to,
+ uint256 tokenId,
+ string memory tokenUri
+ ) external returns (bool);
+
+ // @dev Not implemented
+ //
+ // Selector: finishMinting() 7d64bcb4
+ function finishMinting() external returns (bool);
+}
+
+// Selector: 780e9d63
+interface ERC721Enumerable is Dummy, ERC165 {
+ // Selector: tokenByIndex(uint256) 4f6ccce7
+ function tokenByIndex(uint256 index) external view returns (uint256);
+
+ // Not implemented
+ //
+ // Selector: tokenOfOwnerByIndex(address,uint256) 2f745c59
+ function tokenOfOwnerByIndex(address owner, uint256 index)
+ external
+ view
+ returns (uint256);
+
+ // Selector: totalSupply() 18160ddd
+ function totalSupply() external view returns (uint256);
+}
+
// Selector: 7d9262e6
interface Collection is Dummy, ERC165 {
// Set collection property.
@@ -160,4 +363,15 @@
function setCollectionMintMode(bool mode) external;
}
-interface UniqueRefungible is Dummy, ERC165, Collection {}
+interface UniqueRefungible is
+ Dummy,
+ ERC165,
+ ERC721,
+ ERC721Metadata,
+ ERC721Enumerable,
+ ERC721UniqueExtensions,
+ ERC721Mintable,
+ ERC721Burnable,
+ Collection,
+ TokenProperties
+{}
tests/src/eth/reFungibleAbi.jsondiffbeforeafterboth1[2 {3 "anonymous": false,4 "inputs": [5 {6 "indexed": true,7 "internalType": "address",8 "name": "owner",9 "type": "address"10 },11 {12 "indexed": true,13 "internalType": "address",14 "name": "approved",15 "type": "address"16 },17 {18 "indexed": true,19 "internalType": "uint256",20 "name": "tokenId",21 "type": "uint256"22 }23 ],24 "name": "Approval",25 "type": "event"26 },27 {28 "anonymous": false,29 "inputs": [30 {31 "indexed": true,32 "internalType": "address",33 "name": "owner",34 "type": "address"35 },36 {37 "indexed": true,38 "internalType": "address",39 "name": "operator",40 "type": "address"41 },42 {43 "indexed": false,44 "internalType": "bool",45 "name": "approved",46 "type": "bool"47 }48 ],49 "name": "ApprovalForAll",50 "type": "event"51 },52 {53 "anonymous": false,54 "inputs": [],55 "name": "MintingFinished",56 "type": "event"57 },58 {59 "anonymous": false,60 "inputs": [61 {62 "indexed": true,63 "internalType": "address",64 "name": "from",65 "type": "address"66 },67 {68 "indexed": true,69 "internalType": "address",70 "name": "to",71 "type": "address"72 },73 {74 "indexed": true,75 "internalType": "uint256",76 "name": "tokenId",77 "type": "uint256"78 }79 ],80 "name": "Transfer",81 "type": "event"82 },83 {84 "inputs": [85 { "internalType": "address", "name": "newAdmin", "type": "address" }86 ],87 "name": "addCollectionAdmin",88 "outputs": [],89 "stateMutability": "nonpayable",90 "type": "function"91 },92 {93 "inputs": [94 { "internalType": "uint256", "name": "newAdmin", "type": "uint256" }95 ],96 "name": "addCollectionAdminSubstrate",97 "outputs": [],98 "stateMutability": "nonpayable",99 "type": "function"100 },101 {102 "inputs": [103 { "internalType": "address", "name": "user", "type": "address" }104 ],105 "name": "addToCollectionAllowList",106 "outputs": [],107 "stateMutability": "nonpayable",108 "type": "function"109 },110 {111 "inputs": [112 { "internalType": "address", "name": "approved", "type": "address" },113 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }114 ],115 "name": "approve",116 "outputs": [],117 "stateMutability": "nonpayable",118 "type": "function"119 },120 {121 "inputs": [122 { "internalType": "address", "name": "owner", "type": "address" }123 ],124 "name": "balanceOf",125 "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],126 "stateMutability": "view",127 "type": "function"128 },129 {130 "inputs": [131 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }132 ],133 "name": "burn",134 "outputs": [],135 "stateMutability": "nonpayable",136 "type": "function"137 },138 {139 "inputs": [{ "internalType": "string", "name": "key", "type": "string" }],140 "name": "collectionProperty",141 "outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],142 "stateMutability": "view",143 "type": "function"144 },145 {146 "inputs": [],147 "name": "confirmCollectionSponsorship",148 "outputs": [],149 "stateMutability": "nonpayable",150 "type": "function"151 },152 {153 "inputs": [],154 "name": "contractAddress",155 "outputs": [{ "internalType": "address", "name": "", "type": "address" }],156 "stateMutability": "view",157 "type": "function"158 },159 {160 "inputs": [{ "internalType": "string", "name": "key", "type": "string" }],161 "name": "deleteCollectionProperty",162 "outputs": [],163 "stateMutability": "nonpayable",164 "type": "function"165 },166 {167 "inputs": [168 { "internalType": "uint256", "name": "tokenId", "type": "uint256" },169 { "internalType": "string", "name": "key", "type": "string" }170 ],171 "name": "deleteProperty",172 "outputs": [],173 "stateMutability": "nonpayable",174 "type": "function"175 },176 {177 "inputs": [],178 "name": "finishMinting",179 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],180 "stateMutability": "nonpayable",181 "type": "function"182 },183 {184 "inputs": [185 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }186 ],187 "name": "getApproved",188 "outputs": [{ "internalType": "address", "name": "", "type": "address" }],189 "stateMutability": "view",190 "type": "function"191 },192 {193 "inputs": [194 { "internalType": "address", "name": "owner", "type": "address" },195 { "internalType": "address", "name": "operator", "type": "address" }196 ],197 "name": "isApprovedForAll",198 "outputs": [{ "internalType": "address", "name": "", "type": "address" }],199 "stateMutability": "view",200 "type": "function"201 },202 {203 "inputs": [204 { "internalType": "address", "name": "to", "type": "address" },205 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }206 ],207 "name": "mint",208 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],209 "stateMutability": "nonpayable",210 "type": "function"211 },212 {213 "inputs": [214 { "internalType": "address", "name": "to", "type": "address" },215 { "internalType": "uint256[]", "name": "tokenIds", "type": "uint256[]" }216 ],217 "name": "mintBulk",218 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],219 "stateMutability": "nonpayable",220 "type": "function"221 },222 {223 "inputs": [224 { "internalType": "address", "name": "to", "type": "address" },225 {226 "components": [227 { "internalType": "uint256", "name": "field_0", "type": "uint256" },228 { "internalType": "string", "name": "field_1", "type": "string" }229 ],230 "internalType": "struct Tuple0[]",231 "name": "tokens",232 "type": "tuple[]"233 }234 ],235 "name": "mintBulkWithTokenURI",236 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],237 "stateMutability": "nonpayable",238 "type": "function"239 },240 {241 "inputs": [242 { "internalType": "address", "name": "to", "type": "address" },243 { "internalType": "uint256", "name": "tokenId", "type": "uint256" },244 { "internalType": "string", "name": "tokenUri", "type": "string" }245 ],246 "name": "mintWithTokenURI",247 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],248 "stateMutability": "nonpayable",249 "type": "function"250 },251 {252 "inputs": [],253 "name": "mintingFinished",254 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],255 "stateMutability": "view",256 "type": "function"257 },258 {259 "inputs": [],260 "name": "name",261 "outputs": [{ "internalType": "string", "name": "", "type": "string" }],262 "stateMutability": "view",263 "type": "function"264 },265 {266 "inputs": [],267 "name": "nextTokenId",268 "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],269 "stateMutability": "view",270 "type": "function"271 },272 {273 "inputs": [274 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }275 ],276 "name": "ownerOf",277 "outputs": [{ "internalType": "address", "name": "", "type": "address" }],278 "stateMutability": "view",279 "type": "function"280 },281 {282 "inputs": [283 { "internalType": "uint256", "name": "tokenId", "type": "uint256" },284 { "internalType": "string", "name": "key", "type": "string" }285 ],286 "name": "property",287 "outputs": [{ "internalType": "bytes", "name": "", "type": "bytes" }],288 "stateMutability": "view",289 "type": "function"290 },291 {292 "inputs": [293 { "internalType": "address", "name": "admin", "type": "address" }294 ],295 "name": "removeCollectionAdmin",296 "outputs": [],297 "stateMutability": "nonpayable",298 "type": "function"299 },300 {301 "inputs": [302 { "internalType": "uint256", "name": "admin", "type": "uint256" }303 ],304 "name": "removeCollectionAdminSubstrate",305 "outputs": [],306 "stateMutability": "nonpayable",307 "type": "function"308 },309 {310 "inputs": [311 { "internalType": "address", "name": "user", "type": "address" }312 ],313 "name": "removeFromCollectionAllowList",314 "outputs": [],315 "stateMutability": "nonpayable",316 "type": "function"317 },318 {319 "inputs": [320 { "internalType": "address", "name": "from", "type": "address" },321 { "internalType": "address", "name": "to", "type": "address" },322 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }323 ],324 "name": "safeTransferFrom",325 "outputs": [],326 "stateMutability": "nonpayable",327 "type": "function"328 },329 {330 "inputs": [331 { "internalType": "address", "name": "from", "type": "address" },332 { "internalType": "address", "name": "to", "type": "address" },333 { "internalType": "uint256", "name": "tokenId", "type": "uint256" },334 { "internalType": "bytes", "name": "data", "type": "bytes" }335 ],336 "name": "safeTransferFromWithData",337 "outputs": [],338 "stateMutability": "nonpayable",339 "type": "function"340 },341 {342 "inputs": [343 { "internalType": "address", "name": "operator", "type": "address" },344 { "internalType": "bool", "name": "approved", "type": "bool" }345 ],346 "name": "setApprovalForAll",347 "outputs": [],348 "stateMutability": "nonpayable",349 "type": "function"350 },351 {352 "inputs": [{ "internalType": "uint8", "name": "mode", "type": "uint8" }],353 "name": "setCollectionAccess",354 "outputs": [],355 "stateMutability": "nonpayable",356 "type": "function"357 },358 {359 "inputs": [360 { "internalType": "string", "name": "limit", "type": "string" },361 { "internalType": "uint32", "name": "value", "type": "uint32" }362 ],363 "name": "setCollectionLimit",364 "outputs": [],365 "stateMutability": "nonpayable",366 "type": "function"367 },368 {369 "inputs": [370 { "internalType": "string", "name": "limit", "type": "string" },371 { "internalType": "bool", "name": "value", "type": "bool" }372 ],373 "name": "setCollectionLimit",374 "outputs": [],375 "stateMutability": "nonpayable",376 "type": "function"377 },378 {379 "inputs": [{ "internalType": "bool", "name": "mode", "type": "bool" }],380 "name": "setCollectionMintMode",381 "outputs": [],382 "stateMutability": "nonpayable",383 "type": "function"384 },385 {386 "inputs": [{ "internalType": "bool", "name": "enable", "type": "bool" }],387 "name": "setCollectionNesting",388 "outputs": [],389 "stateMutability": "nonpayable",390 "type": "function"391 },392 {393 "inputs": [394 { "internalType": "bool", "name": "enable", "type": "bool" },395 {396 "internalType": "address[]",397 "name": "collections",398 "type": "address[]"399 }400 ],401 "name": "setCollectionNesting",402 "outputs": [],403 "stateMutability": "nonpayable",404 "type": "function"405 },406 {407 "inputs": [408 { "internalType": "string", "name": "key", "type": "string" },409 { "internalType": "bytes", "name": "value", "type": "bytes" }410 ],411 "name": "setCollectionProperty",412 "outputs": [],413 "stateMutability": "nonpayable",414 "type": "function"415 },416 {417 "inputs": [418 { "internalType": "address", "name": "sponsor", "type": "address" }419 ],420 "name": "setCollectionSponsor",421 "outputs": [],422 "stateMutability": "nonpayable",423 "type": "function"424 },425 {426 "inputs": [427 { "internalType": "uint256", "name": "tokenId", "type": "uint256" },428 { "internalType": "string", "name": "key", "type": "string" },429 { "internalType": "bytes", "name": "value", "type": "bytes" }430 ],431 "name": "setProperty",432 "outputs": [],433 "stateMutability": "nonpayable",434 "type": "function"435 },436 {437 "inputs": [438 { "internalType": "string", "name": "key", "type": "string" },439 { "internalType": "bool", "name": "isMutable", "type": "bool" },440 { "internalType": "bool", "name": "collectionAdmin", "type": "bool" },441 { "internalType": "bool", "name": "tokenOwner", "type": "bool" }442 ],443 "name": "setTokenPropertyPermission",444 "outputs": [],445 "stateMutability": "nonpayable",446 "type": "function"447 },448 {449 "inputs": [450 { "internalType": "bytes4", "name": "interfaceID", "type": "bytes4" }451 ],452 "name": "supportsInterface",453 "outputs": [{ "internalType": "bool", "name": "", "type": "bool" }],454 "stateMutability": "view",455 "type": "function"456 },457 {458 "inputs": [],459 "name": "symbol",460 "outputs": [{ "internalType": "string", "name": "", "type": "string" }],461 "stateMutability": "view",462 "type": "function"463 },464 {465 "inputs": [466 { "internalType": "uint256", "name": "index", "type": "uint256" }467 ],468 "name": "tokenByIndex",469 "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],470 "stateMutability": "view",471 "type": "function"472 },473 {474 "inputs": [475 { "internalType": "address", "name": "owner", "type": "address" },476 { "internalType": "uint256", "name": "index", "type": "uint256" }477 ],478 "name": "tokenOfOwnerByIndex",479 "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],480 "stateMutability": "view",481 "type": "function"482 },483 {484 "inputs": [485 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }486 ],487 "name": "tokenURI",488 "outputs": [{ "internalType": "string", "name": "", "type": "string" }],489 "stateMutability": "view",490 "type": "function"491 },492 {493 "inputs": [],494 "name": "totalSupply",495 "outputs": [{ "internalType": "uint256", "name": "", "type": "uint256" }],496 "stateMutability": "view",497 "type": "function"498 },499 {500 "inputs": [501 { "internalType": "address", "name": "from", "type": "address" },502 { "internalType": "address", "name": "to", "type": "address" },503 { "internalType": "uint256", "name": "tokenId", "type": "uint256" }504 ],505 "name": "transferFrom",506 "outputs": [],507 "stateMutability": "nonpayable",508 "type": "function"509 }510]tests/src/interfaces/augment-api-errors.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-errors.ts
+++ b/tests/src/interfaces/augment-api-errors.ts
@@ -446,25 +446,83 @@
[key: string]: AugmentedError<ApiType>;
};
rmrkCore: {
+ /**
+ * Not the target owner of the sent NFT.
+ **/
CannotAcceptNonOwnedNft: AugmentedError<ApiType>;
+ /**
+ * Not the target owner of the sent NFT.
+ **/
CannotRejectNonOwnedNft: AugmentedError<ApiType>;
+ /**
+ * NFT was not sent and is not pending.
+ **/
CannotRejectNonPendingNft: AugmentedError<ApiType>;
+ /**
+ * If an NFT is sent to a descendant, that would form a nesting loop, an ouroboros.
+ * Sending to self is redundant.
+ **/
CannotSendToDescendentOrSelf: AugmentedError<ApiType>;
+ /**
+ * Too many tokens created in the collection, no new ones are allowed.
+ **/
CollectionFullOrLocked: AugmentedError<ApiType>;
+ /**
+ * Only destroying collections without tokens is allowed.
+ **/
CollectionNotEmpty: AugmentedError<ApiType>;
+ /**
+ * Collection does not exist, has a wrong type, or does not map to a Unique ID.
+ **/
CollectionUnknown: AugmentedError<ApiType>;
+ /**
+ * Property of the type of RMRK collection could not be read successfully.
+ **/
CorruptedCollectionType: AugmentedError<ApiType>;
- NftTypeEncodeError: AugmentedError<ApiType>;
+ /**
+ * Could not find an ID for a collection. It is likely there were too many collections created on the chain, causing an overflow.
+ **/
NoAvailableCollectionId: AugmentedError<ApiType>;
+ /**
+ * Token does not exist, or there is no suitable ID for it, likely too many tokens were created in a collection, causing an overflow.
+ **/
NoAvailableNftId: AugmentedError<ApiType>;
+ /**
+ * Could not find an ID for the resource. It is likely there were too many resources created on an NFT, causing an overflow.
+ **/
NoAvailableResourceId: AugmentedError<ApiType>;
+ /**
+ * Token is marked as non-transferable, and thus cannot be transferred.
+ **/
NonTransferable: AugmentedError<ApiType>;
+ /**
+ * No permission to perform action.
+ **/
NoPermission: AugmentedError<ApiType>;
+ /**
+ * No such resource found.
+ **/
ResourceDoesntExist: AugmentedError<ApiType>;
+ /**
+ * Resource is not pending for the operation.
+ **/
ResourceNotPending: AugmentedError<ApiType>;
+ /**
+ * Could not find a property by the supplied key.
+ **/
RmrkPropertyIsNotFound: AugmentedError<ApiType>;
+ /**
+ * Too many symbols supplied as the property key. The maximum is [256](up_data_structs::MAX_PROPERTY_KEY_LENGTH).
+ **/
RmrkPropertyKeyIsTooLong: AugmentedError<ApiType>;
+ /**
+ * Too many bytes supplied as the property value. The maximum is [32768](up_data_structs::MAX_PROPERTY_VALUE_LENGTH).
+ **/
RmrkPropertyValueIsTooLong: AugmentedError<ApiType>;
+ /**
+ * Something went wrong when decoding encoded data from the storage.
+ * Perhaps, there was a wrong key supplied for the type, or the data was improperly stored.
+ **/
UnableToDecodeRmrkData: AugmentedError<ApiType>;
/**
* Generic error
@@ -472,12 +530,33 @@
[key: string]: AugmentedError<ApiType>;
};
rmrkEquip: {
+ /**
+ * Base collection linked to this ID does not exist.
+ **/
BaseDoesntExist: AugmentedError<ApiType>;
+ /**
+ * No Theme named "default" is associated with the Base.
+ **/
NeedsDefaultThemeFirst: AugmentedError<ApiType>;
+ /**
+ * Could not find an ID for a Base collection. It is likely there were too many collections created on the chain, causing an overflow.
+ **/
NoAvailableBaseId: AugmentedError<ApiType>;
+ /**
+ * Could not find a suitable ID for a Part, likely too many Part tokens were created in the Base, causing an overflow
+ **/
NoAvailablePartId: AugmentedError<ApiType>;
+ /**
+ * Cannot assign equippables to a fixed Part.
+ **/
NoEquippableOnFixedPart: AugmentedError<ApiType>;
+ /**
+ * Part linked to this ID does not exist.
+ **/
PartDoesntExist: AugmentedError<ApiType>;
+ /**
+ * No permission to perform action.
+ **/
PermissionError: AugmentedError<ApiType>;
/**
* Generic error
@@ -508,15 +587,15 @@
};
structure: {
/**
- * While iterating over children, reached the breadth limit.
+ * While nesting, reached the breadth limit of nesting, exceeding the provided budget.
**/
BreadthLimit: AugmentedError<ApiType>;
/**
- * While searching for the owner, reached the depth limit.
+ * While nesting, reached the depth limit of nesting, exceeding the provided budget.
**/
DepthLimit: AugmentedError<ApiType>;
/**
- * While searching for the owner, encountered an already checked account, detecting a loop.
+ * While nesting, encountered an already checked account, detecting a loop.
**/
OuroborosDetected: AugmentedError<ApiType>;
/**
tests/src/interfaces/augment-api-query.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-query.ts
+++ b/tests/src/interfaces/augment-api-query.ts
@@ -492,7 +492,13 @@
[key: string]: QueryableStorageEntry<ApiType>;
};
rmrkCore: {
+ /**
+ * Latest yet-unused collection ID.
+ **/
collectionIndex: AugmentedQuery<ApiType, () => Observable<u32>, []> & QueryableStorageEntry<ApiType, []>;
+ /**
+ * Mapping from RMRK collection ID to Unique's.
+ **/
uniqueCollectionId: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<u32>, [u32]> & QueryableStorageEntry<ApiType, [u32]>;
/**
* Generic query
@@ -500,7 +506,13 @@
[key: string]: QueryableStorageEntry<ApiType>;
};
rmrkEquip: {
+ /**
+ * Checkmark that a Base has a Theme NFT named "default".
+ **/
baseHasDefaultTheme: AugmentedQuery<ApiType, (arg: u32 | AnyNumber | Uint8Array) => Observable<bool>, [u32]> & QueryableStorageEntry<ApiType, [u32]>;
+ /**
+ * Map of a Base ID and a Part ID to an NFT in the Base collection serving as the Part.
+ **/
inernalPartId: AugmentedQuery<ApiType, (arg1: u32 | AnyNumber | Uint8Array, arg2: u32 | AnyNumber | Uint8Array) => Observable<Option<u32>>, [u32, u32]> & QueryableStorageEntry<ApiType, [u32, u32]>;
/**
* Generic query
tests/src/interfaces/augment-api-tx.tsdiffbeforeafterboth--- a/tests/src/interfaces/augment-api-tx.ts
+++ b/tests/src/interfaces/augment-api-tx.ts
@@ -348,103 +348,259 @@
};
rmrkCore: {
/**
- * Accepts an NFT sent from another account to self or owned NFT
+ * Accept an NFT sent from another account to self or an owned NFT.
+ *
+ * The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.
*
- * Parameters:
- * - `origin`: sender of the transaction
- * - `rmrk_collection_id`: collection id of the nft to be accepted
- * - `rmrk_nft_id`: nft id of the nft to be accepted
- * - `new_owner`: either origin's account ID or origin-owned NFT, whichever the NFT was
- * sent to
+ * # Permissions:
+ * - Token-owner-to-be
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT to be accepted.
+ * - `rmrk_nft_id`: ID of the NFT to be accepted.
+ * - `new_owner`: Either the sender's account ID or a sender-owned NFT,
+ * whichever the accepted NFT was sent to.
**/
acceptNft: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array, newOwner: RmrkTraitsNftAccountIdOrCollectionNftTuple | { AccountId: any } | { CollectionAndNftTuple: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsNftAccountIdOrCollectionNftTuple]>;
/**
- * accept the addition of a new resource to an existing NFT
+ * Accept the addition of a newly created pending resource to an existing NFT.
+ *
+ * This transaction is needed when a resource is created and assigned to an NFT
+ * by a non-owner, i.e. the collection issuer, with one of the
+ * [`add_...` transactions](Pallet::add_basic_resource).
+ *
+ * # Permissions:
+ * - Token owner
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `rmrk_nft_id`: ID of the NFT with a pending resource to be accepted.
+ * - `resource_id`: ID of the newly created pending resource.
**/
acceptResource: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array, resourceId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, u32]>;
/**
- * accept the removal of a resource of an existing NFT
+ * Accept the removal of a removal-pending resource from an NFT.
+ *
+ * This transaction is needed when a non-owner, i.e. the collection issuer,
+ * requests a [removal](`Pallet::remove_resource`) of a resource from an NFT.
+ *
+ * # Permissions:
+ * - Token owner
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `rmrk_nft_id`: ID of the NFT with a resource to be removed.
+ * - `resource_id`: ID of the removal-pending resource.
**/
acceptResourceRemoval: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array, resourceId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, u32]>;
/**
- * Create basic resource
+ * Create and set/propose a basic resource for an NFT.
+ *
+ * A basic resource is the simplest, lacking a Base and anything that comes with it.
+ * See RMRK docs for more information and examples.
+ *
+ * # Permissions:
+ * - Collection issuer - if not the token owner, adding the resource will warrant
+ * the owner's [acceptance](Pallet::accept_resource).
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `nft_id`: ID of the NFT to assign a resource to.
+ * - `resource`: Data of the resource to be created.
**/
addBasicResource: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, nftId: u32 | AnyNumber | Uint8Array, resource: RmrkTraitsResourceBasicResource | { src?: any; metadata?: any; license?: any; thumb?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsResourceBasicResource]>;
/**
- * Create composable resource
+ * Create and set/propose a composable resource for an NFT.
+ *
+ * A composable resource links to a Base and has a subset of its Parts it is composed of.
+ * See RMRK docs for more information and examples.
+ *
+ * # Permissions:
+ * - Collection issuer - if not the token owner, adding the resource will warrant
+ * the owner's [acceptance](Pallet::accept_resource).
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `nft_id`: ID of the NFT to assign a resource to.
+ * - `resource`: Data of the resource to be created.
**/
addComposableResource: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, nftId: u32 | AnyNumber | Uint8Array, resource: RmrkTraitsResourceComposableResource | { parts?: any; base?: any; src?: any; metadata?: any; license?: any; thumb?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsResourceComposableResource]>;
/**
- * Create slot resource
+ * Create and set/propose a slot resource for an NFT.
+ *
+ * A slot resource links to a Base and a slot ID in it which it can fit into.
+ * See RMRK docs for more information and examples.
+ *
+ * # Permissions:
+ * - Collection issuer - if not the token owner, adding the resource will warrant
+ * the owner's [acceptance](Pallet::accept_resource).
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `nft_id`: ID of the NFT to assign a resource to.
+ * - `resource`: Data of the resource to be created.
**/
addSlotResource: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, nftId: u32 | AnyNumber | Uint8Array, resource: RmrkTraitsResourceSlotResource | { base?: any; src?: any; metadata?: any; slot?: any; license?: any; thumb?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsResourceSlotResource]>;
/**
- * burn nft
+ * Burn an NFT, destroying it and its nested tokens up to the specified limit.
+ * If the burning budget is exceeded, the transaction is reverted.
+ *
+ * This is the way to burn a nested token as well.
+ *
+ * For more information, see [`burn_recursively`](pallet_nonfungible::pallet::Pallet::burn_recursively).
+ *
+ * # Permissions:
+ * * Token owner
+ *
+ * # Arguments:
+ * - `collection_id`: RMRK ID of the collection in which the NFT to burn belongs to.
+ * - `nft_id`: ID of the NFT to be destroyed.
+ * - `max_burns`: Maximum number of tokens to burn, assuming nesting. The transaction
+ * is reverted if there are more tokens to burn in the nesting tree than this number.
+ * This is primarily a mechanism of transaction weight control.
**/
burnNft: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array, nftId: u32 | AnyNumber | Uint8Array, maxBurns: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, u32]>;
/**
- * Change the issuer of a collection
+ * Change the issuer of a collection. Analogous to Unique's collection's [`owner`](up_data_structs::Collection).
*
- * Parameters:
- * - `origin`: sender of the transaction
- * - `collection_id`: collection id of the nft to change issuer of
- * - `new_issuer`: Collection's new issuer
+ * # Permissions:
+ * * Collection issuer
+ *
+ * # Arguments:
+ * - `collection_id`: RMRK collection ID to change the issuer of.
+ * - `new_issuer`: Collection's new issuer.
**/
changeCollectionIssuer: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array, newIssuer: MultiAddress | { Id: any } | { Index: any } | { Raw: any } | { Address32: any } | { Address20: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, MultiAddress]>;
/**
- * Create a collection
+ * Create a new collection of NFTs.
+ *
+ * # Permissions:
+ * * Anyone - will be assigned as the issuer of the collection.
+ *
+ * # Arguments:
+ * - `metadata`: Metadata describing the collection, e.g. IPFS hash. Cannot be changed.
+ * - `max`: Optional maximum number of tokens.
+ * - `symbol`: UTF-8 string with token prefix, by which to represent the token in wallets and UIs.
+ * Analogous to Unique's [`token_prefix`](up_data_structs::Collection). Cannot be changed.
**/
createCollection: AugmentedSubmittable<(metadata: Bytes | string | Uint8Array, max: Option<u32> | null | object | string | Uint8Array, symbol: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Bytes, Option<u32>, Bytes]>;
/**
- * destroy collection
+ * Destroy a collection.
+ *
+ * Only empty collections can be destroyed. If it has any tokens, they must be burned first.
+ *
+ * # Permissions:
+ * * Collection issuer
+ *
+ * # Arguments:
+ * - `collection_id`: RMRK ID of the collection to destroy.
**/
destroyCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
/**
- * lock collection
+ * "Lock" the collection and prevent new token creation. Cannot be undone.
+ *
+ * # Permissions:
+ * * Collection issuer
+ *
+ * # Arguments:
+ * - `collection_id`: RMRK ID of the collection to lock.
**/
lockCollection: AugmentedSubmittable<(collectionId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32]>;
/**
- * Mints an NFT in the specified collection
- * Sets metadata and the royalty attribute
+ * Mint an NFT in a specified collection.
+ *
+ * # Permissions:
+ * * Collection issuer
*
- * Parameters:
- * - `collection_id`: The class of the asset to be minted.
- * - `nft_id`: The nft value of the asset to be minted.
- * - `recipient`: Receiver of the royalty
- * - `royalty`: Permillage reward from each trade for the Recipient
- * - `metadata`: Arbitrary data about an nft, e.g. IPFS hash
- * - `transferable`: Ability to transfer this NFT
+ * # Arguments:
+ * - `owner`: Owner account of the NFT. If set to None, defaults to the sender (collection issuer).
+ * - `collection_id`: RMRK collection ID for the NFT to be minted within. Cannot be changed.
+ * - `recipient`: Receiver account of the royalty. Has no effect if the `royalty_amount` is not set. Cannot be changed.
+ * - `royalty_amount`: Optional permillage reward from each trade for the `recipient`. Cannot be changed.
+ * - `metadata`: Arbitrary data about an NFT, e.g. IPFS hash. Cannot be changed.
+ * - `transferable`: Can this NFT be transferred? Cannot be changed.
+ * - `resources`: Resource data to be added to the NFT immediately after minting.
**/
mintNft: AugmentedSubmittable<(owner: Option<AccountId32> | null | object | string | Uint8Array, collectionId: u32 | AnyNumber | Uint8Array, recipient: Option<AccountId32> | null | object | string | Uint8Array, royaltyAmount: Option<Permill> | null | object | string | Uint8Array, metadata: Bytes | string | Uint8Array, transferable: bool | boolean | Uint8Array, resources: Option<Vec<RmrkTraitsResourceResourceTypes>> | null | object | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Option<AccountId32>, u32, Option<AccountId32>, Option<Permill>, Bytes, bool, Option<Vec<RmrkTraitsResourceResourceTypes>>]>;
/**
- * Rejects an NFT sent from another account to self or owned NFT
+ * Reject an NFT sent from another account to self or owned NFT.
+ * The NFT in question will not be sent back and burnt instead.
+ *
+ * The NFT in question must be pending, and, thus, be [sent](`Pallet::send`) first.
+ *
+ * # Permissions:
+ * - Token-owner-to-be-not
*
- * Parameters:
- * - `origin`: sender of the transaction
- * - `rmrk_collection_id`: collection id of the nft to be accepted
- * - `rmrk_nft_id`: nft id of the nft to be accepted
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK ID of the NFT to be rejected.
+ * - `rmrk_nft_id`: ID of the NFT to be rejected.
**/
rejectNft: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
/**
- * remove resource
+ * Remove and erase a resource from an NFT.
+ *
+ * If the sender does not own the NFT, then it will be pending confirmation,
+ * and will have to be [accepted](Pallet::accept_resource_removal) by the token owner.
+ *
+ * # Permissions
+ * - Collection issuer
+ *
+ * # Arguments
+ * - `collection_id`: RMRK ID of a collection to which the NFT making use of the resource belongs to.
+ * - `nft_id`: ID of the NFT with a resource to be removed.
+ * - `resource_id`: ID of the resource to be removed.
**/
removeResource: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, nftId: u32 | AnyNumber | Uint8Array, resourceId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, u32]>;
/**
- * Transfers a NFT from an Account or NFT A to another Account or NFT B
+ * Transfer an NFT from an account/NFT A to another account/NFT B.
+ * The token must be transferable. Nesting cannot occur deeper than the [`NESTING_BUDGET`].
*
- * Parameters:
- * - `origin`: sender of the transaction
- * - `rmrk_collection_id`: collection id of the nft to be transferred
- * - `rmrk_nft_id`: nft id of the nft to be transferred
- * - `new_owner`: new owner of the nft which can be either an account or a NFT
+ * If the target owner is an NFT owned by another account, then the NFT will enter
+ * the pending state and will have to be accepted by the other account.
+ *
+ * # Permissions:
+ * - Token owner
+ *
+ * # Arguments:
+ * - `collection_id`: RMRK ID of the collection of the NFT to be transferred.
+ * - `nft_id`: ID of the NFT to be transferred.
+ * - `new_owner`: New owner of the nft which can be either an account or a NFT.
**/
send: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array, newOwner: RmrkTraitsNftAccountIdOrCollectionNftTuple | { AccountId: any } | { CollectionAndNftTuple: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsNftAccountIdOrCollectionNftTuple]>;
/**
- * set a different order of resource priority
+ * Set a different order of resource priorities for an NFT. Priorities can be used,
+ * for example, for order of rendering.
+ *
+ * Note that the priorities are not updated automatically, and are an empty vector
+ * by default. There is no pre-set definition for the order to be particular,
+ * it can be interpreted arbitrarily use-case by use-case.
+ *
+ * # Permissions:
+ * - Token owner
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID of the NFT.
+ * - `rmrk_nft_id`: ID of the NFT to rearrange resource priorities for.
+ * - `priorities`: Ordered vector of resource IDs.
**/
setPriority: AugmentedSubmittable<(rmrkCollectionId: u32 | AnyNumber | Uint8Array, rmrkNftId: u32 | AnyNumber | Uint8Array, priorities: Vec<u32> | (u32 | AnyNumber | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [u32, u32, Vec<u32>]>;
/**
- * set a custom value on an NFT
+ * Add or edit a custom user property, a key-value pair, describing the metadata
+ * of a token or a collection, on either one of these.
+ *
+ * Note that in this proxy implementation many details regarding RMRK are stored
+ * as scoped properties prefixed with "rmrk:", normally inaccessible
+ * to external transactions and RPCs.
+ *
+ * # Permissions:
+ * - Collection issuer - in case of collection property
+ * - Token owner - in case of NFT property
+ *
+ * # Arguments:
+ * - `rmrk_collection_id`: RMRK collection ID.
+ * - `maybe_nft_id`: Optional ID of the NFT. If left empty, then the property is set for the collection.
+ * - `key`: Key of the custom property to be referenced by.
+ * - `value`: Value of the custom property to be stored.
**/
setProperty: AugmentedSubmittable<(rmrkCollectionId: Compact<u32> | AnyNumber | Uint8Array, maybeNftId: Option<u32> | null | object | string | Uint8Array, key: Bytes | string | Uint8Array, value: Bytes | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u32>, Option<u32>, Bytes, Bytes]>;
/**
@@ -454,32 +610,50 @@
};
rmrkEquip: {
/**
- * Creates a new Base.
- * Modeled after [base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)
+ * Create a new Base.
+ *
+ * Modeled after the [Base interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/base.md)
+ *
+ * # Permissions
+ * - Anyone - will be assigned as the issuer of the Base.
*
- * Parameters:
- * - origin: Caller, will be assigned as the issuer of the Base
- * - base_type: media type, e.g. "svg"
- * - symbol: arbitrary client-chosen symbol
- * - parts: array of Fixed and Slot parts composing the base, confined in length by
- * RmrkPartsLimit
+ * # Arguments:
+ * - `base_type`: Arbitrary media type, e.g. "svg".
+ * - `symbol`: Arbitrary client-chosen symbol.
+ * - `parts`: Array of Fixed and Slot Parts composing the Base,
+ * confined in length by [`RmrkPartsLimit`](up_data_structs::RmrkPartsLimit).
**/
createBase: AugmentedSubmittable<(baseType: Bytes | string | Uint8Array, symbol: Bytes | string | Uint8Array, parts: Vec<RmrkTraitsPartPartType> | (RmrkTraitsPartPartType | { FixedPart: any } | { SlotPart: any } | string | Uint8Array)[]) => SubmittableExtrinsic<ApiType>, [Bytes, Bytes, Vec<RmrkTraitsPartPartType>]>;
+ /**
+ * Update the array of Collections allowed to be equipped to a Base's specified Slot Part.
+ *
+ * Modeled after [equippable interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/equippable.md).
+ *
+ * # Permissions:
+ * - Base issuer
+ *
+ * # Arguments:
+ * - `base_id`: Base containing the Slot Part to be updated.
+ * - `part_id`: Slot Part whose Equippable List is being updated.
+ * - `equippables`: List of equippables that will override the current Equippables list.
+ **/
equippable: AugmentedSubmittable<(baseId: u32 | AnyNumber | Uint8Array, slotId: u32 | AnyNumber | Uint8Array, equippables: RmrkTraitsPartEquippableList | { All: any } | { Empty: any } | { Custom: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32, RmrkTraitsPartEquippableList]>;
/**
- * Adds a Theme to a Base.
- * Modeled after [themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md)
- * Themes are stored in the Themes storage
+ * Add a Theme to a Base.
* A Theme named "default" is required prior to adding other Themes.
*
- * Parameters:
- * - origin: The caller of the function, must be issuer of the base
- * - base_id: The Base containing the Theme to be updated
- * - theme: The Theme to add to the Base. A Theme has a name and properties, which are an
+ * Modeled after [Themeadd interaction](https://github.com/rmrk-team/rmrk-spec/blob/master/standards/rmrk2.0.0/interactions/themeadd.md).
+ *
+ * # Permissions:
+ * - Base issuer
+ *
+ * # Arguments:
+ * - `base_id`: Base ID containing the Theme to be updated.
+ * - `theme`: Theme to add to the Base. A Theme has a name and properties, which are an
* array of [key, value, inherit].
- * - key: arbitrary BoundedString, defined by client
- * - value: arbitrary BoundedString, defined by client
- * - inherit: optional bool
+ * - `key`: Arbitrary BoundedString, defined by client.
+ * - `value`: Arbitrary BoundedString, defined by client.
+ * - `inherit`: Optional bool.
**/
themeAdd: AugmentedSubmittable<(baseId: u32 | AnyNumber | Uint8Array, theme: RmrkTraitsTheme | { name?: any; properties?: any; inherit?: any } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, RmrkTraitsTheme]>;
/**
tests/src/interfaces/default/types.tsdiffbeforeafterboth--- a/tests/src/interfaces/default/types.ts
+++ b/tests/src/interfaces/default/types.ts
@@ -1314,7 +1314,6 @@
/** @name PalletRmrkCoreError */
export interface PalletRmrkCoreError extends Enum {
readonly isCorruptedCollectionType: boolean;
- readonly isNftTypeEncodeError: boolean;
readonly isRmrkPropertyKeyIsTooLong: boolean;
readonly isRmrkPropertyValueIsTooLong: boolean;
readonly isRmrkPropertyIsNotFound: boolean;
@@ -1333,7 +1332,7 @@
readonly isCannotRejectNonPendingNft: boolean;
readonly isResourceNotPending: boolean;
readonly isNoAvailableResourceId: boolean;
- readonly type: 'CorruptedCollectionType' | 'NftTypeEncodeError' | 'RmrkPropertyKeyIsTooLong' | 'RmrkPropertyValueIsTooLong' | 'RmrkPropertyIsNotFound' | 'UnableToDecodeRmrkData' | 'CollectionNotEmpty' | 'NoAvailableCollectionId' | 'NoAvailableNftId' | 'CollectionUnknown' | 'NoPermission' | 'NonTransferable' | 'CollectionFullOrLocked' | 'ResourceDoesntExist' | 'CannotSendToDescendentOrSelf' | 'CannotAcceptNonOwnedNft' | 'CannotRejectNonOwnedNft' | 'CannotRejectNonPendingNft' | 'ResourceNotPending' | 'NoAvailableResourceId';
+ readonly type: 'CorruptedCollectionType' | 'RmrkPropertyKeyIsTooLong' | 'RmrkPropertyValueIsTooLong' | 'RmrkPropertyIsNotFound' | 'UnableToDecodeRmrkData' | 'CollectionNotEmpty' | 'NoAvailableCollectionId' | 'NoAvailableNftId' | 'CollectionUnknown' | 'NoPermission' | 'NonTransferable' | 'CollectionFullOrLocked' | 'ResourceDoesntExist' | 'CannotSendToDescendentOrSelf' | 'CannotAcceptNonOwnedNft' | 'CannotRejectNonOwnedNft' | 'CannotRejectNonPendingNft' | 'ResourceNotPending' | 'NoAvailableResourceId';
}
/** @name PalletRmrkCoreEvent */
tests/src/interfaces/lookup.tsdiffbeforeafterboth--- a/tests/src/interfaces/lookup.ts
+++ b/tests/src/interfaces/lookup.ts
@@ -2990,7 +2990,7 @@
* Lookup400: pallet_rmrk_core::pallet::Error<T>
**/
PalletRmrkCoreError: {
- _enum: ['CorruptedCollectionType', 'NftTypeEncodeError', 'RmrkPropertyKeyIsTooLong', 'RmrkPropertyValueIsTooLong', 'RmrkPropertyIsNotFound', 'UnableToDecodeRmrkData', 'CollectionNotEmpty', 'NoAvailableCollectionId', 'NoAvailableNftId', 'CollectionUnknown', 'NoPermission', 'NonTransferable', 'CollectionFullOrLocked', 'ResourceDoesntExist', 'CannotSendToDescendentOrSelf', 'CannotAcceptNonOwnedNft', 'CannotRejectNonOwnedNft', 'CannotRejectNonPendingNft', 'ResourceNotPending', 'NoAvailableResourceId']
+ _enum: ['CorruptedCollectionType', 'RmrkPropertyKeyIsTooLong', 'RmrkPropertyValueIsTooLong', 'RmrkPropertyIsNotFound', 'UnableToDecodeRmrkData', 'CollectionNotEmpty', 'NoAvailableCollectionId', 'NoAvailableNftId', 'CollectionUnknown', 'NoPermission', 'NonTransferable', 'CollectionFullOrLocked', 'ResourceDoesntExist', 'CannotSendToDescendentOrSelf', 'CannotAcceptNonOwnedNft', 'CannotRejectNonOwnedNft', 'CannotRejectNonPendingNft', 'ResourceNotPending', 'NoAvailableResourceId']
},
/**
* Lookup402: pallet_rmrk_equip::pallet::Error<T>
tests/src/interfaces/types-lookup.tsdiffbeforeafterboth--- a/tests/src/interfaces/types-lookup.ts
+++ b/tests/src/interfaces/types-lookup.ts
@@ -3144,7 +3144,6 @@
/** @name PalletRmrkCoreError (400) */
export interface PalletRmrkCoreError extends Enum {
readonly isCorruptedCollectionType: boolean;
- readonly isNftTypeEncodeError: boolean;
readonly isRmrkPropertyKeyIsTooLong: boolean;
readonly isRmrkPropertyValueIsTooLong: boolean;
readonly isRmrkPropertyIsNotFound: boolean;
@@ -3163,7 +3162,7 @@
readonly isCannotRejectNonPendingNft: boolean;
readonly isResourceNotPending: boolean;
readonly isNoAvailableResourceId: boolean;
- readonly type: 'CorruptedCollectionType' | 'NftTypeEncodeError' | 'RmrkPropertyKeyIsTooLong' | 'RmrkPropertyValueIsTooLong' | 'RmrkPropertyIsNotFound' | 'UnableToDecodeRmrkData' | 'CollectionNotEmpty' | 'NoAvailableCollectionId' | 'NoAvailableNftId' | 'CollectionUnknown' | 'NoPermission' | 'NonTransferable' | 'CollectionFullOrLocked' | 'ResourceDoesntExist' | 'CannotSendToDescendentOrSelf' | 'CannotAcceptNonOwnedNft' | 'CannotRejectNonOwnedNft' | 'CannotRejectNonPendingNft' | 'ResourceNotPending' | 'NoAvailableResourceId';
+ readonly type: 'CorruptedCollectionType' | 'RmrkPropertyKeyIsTooLong' | 'RmrkPropertyValueIsTooLong' | 'RmrkPropertyIsNotFound' | 'UnableToDecodeRmrkData' | 'CollectionNotEmpty' | 'NoAvailableCollectionId' | 'NoAvailableNftId' | 'CollectionUnknown' | 'NoPermission' | 'NonTransferable' | 'CollectionFullOrLocked' | 'ResourceDoesntExist' | 'CannotSendToDescendentOrSelf' | 'CannotAcceptNonOwnedNft' | 'CannotRejectNonOwnedNft' | 'CannotRejectNonPendingNft' | 'ResourceNotPending' | 'NoAvailableResourceId';
}
/** @name PalletRmrkEquipError (402) */