RMRKAbstractNestableMultiAsset

RMRK team

RMRKAbstractNestableMultiAsset

Abstract implementation of joined RMRK nestable and multi-asset module.

Methods

RMRK_INTERFACE

function RMRK_INTERFACE() external pure returns (bytes4 rmrkInterface)

Interface identifier of the @rmrk-team/evm-contracts package

Returns

VERSION

function VERSION() external pure returns (string version)

Version of the @rmrk-team/evm-contracts package

Returns

acceptAsset

function acceptAsset(uint256 tokenId, uint256 index, uint64 assetId) external nonpayable

Accepts an asset at from the pending array of given token.

Migrates the asset from the token's pending asset array to the token's active asset array.Active assets cannot be removed by anyone, but can be replaced by a new asset.Requirements: - The caller must own the token or be approved to manage the token's assets - tokenId must exist. - index must be in range of the length of the pending asset array.Emits an {AssetAccepted} event.

Parameters

acceptChild

function acceptChild(uint256 parentId, uint256 childIndex, address childAddress, uint256 childId) external nonpayable

Used to accept a pending child token for a given parent token.

This moves the child token from parent token's pending child tokens array into the active child tokens array.

Parameters

addAssetEntry

function addAssetEntry(string metadataURI) external nonpayable returns (uint256 assetId)

Used to add a asset entry.

The ID of the asset is automatically assigned to be the next available asset ID.

Parameters

Returns

addAssetToToken

function addAssetToToken(uint256 tokenId, uint64 assetId, uint64 replacesAssetWithId) external nonpayable

Used to add an asset to a token.

If the given asset is already added to the token, the execution will be reverted.If the asset ID is invalid, the execution will be reverted.If the token already has the maximum amount of pending assets (128), the execution will be reverted.

Parameters

addChild

function addChild(uint256 parentId, uint256 childId, bytes data) external nonpayable

Used to add a child token to a given parent token.

This adds the child token into the given parent token's pending child tokens array.Requirements: - directOwnerOf on the child contract must resolve to the called contract. - the pending array of the parent contract must not be full.

Parameters

approve

function approve(address to, uint256 tokenId) external nonpayable

Used to grant a one-time approval to manage one's token.

Gives permission to to to transfer tokenId token to another account.The approval is cleared when the token is transferred.Only a single account can be approved at a time, so approving the zero address clears previous approvals.Requirements: - The caller must own the token or be an approved operator. - tokenId must exist.Emits an {Approval} event.

Parameters

approveForAssets

function approveForAssets(address to, uint256 tokenId) external nonpayable

Used to grant permission to the user to manage token's assets.

This differs from transfer approvals, as approvals are not cleared when the approved party accepts or rejects an asset, or sets asset priorities. This approval is cleared on token transfer.Only a single account can be approved at a time, so approving the 0x0 address clears previous approvals.Requirements: - The caller must own the token or be an approved operator. - tokenId must exist.Emits an {ApprovalForAssets} event.

Parameters

balanceOf

function balanceOf(address owner) external view returns (uint256 balance)

Used to retrieve the number of tokens in owner's account.

Parameters

Returns

burn

function burn(uint256 tokenId) external nonpayable

Used to burn a given token.

In case the token has any child tokens, the execution will be reverted.

Parameters

burn

function burn(uint256 tokenId, uint256 maxChildrenBurns) external nonpayable returns (uint256 burnedChildren)

Used to burn a given token.

When a token is burned, all of its child tokens are recursively burned as well.When specifying the maximum recursive burns, the execution will be reverted if there are more children to be burned.Setting the maxRecursiveBurn value to 0 will only attempt to burn the specified token and revert if there are any child tokens present.The approvals are cleared when the token is burned.Requirements: - tokenId must exist.Emits a {Transfer} event.

Parameters

Returns

childOf

function childOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child child)

Used to retrieve a specific active child token for a given parent token.

Returns a single Child struct locating at index of parent token's active child tokens array.The Child struct consists of the following values: [ tokenId, contractAddress ]

Parameters

Returns

childrenOf

function childrenOf(uint256 parentId) external view returns (struct IERC7401.Child[] children)

Used to retrieve the active child tokens of a given parent token.

Returns array of Child structs existing for parent token.The Child struct consists of the following values: [ tokenId, contractAddress ]

Parameters

Returns

contractURI

function contractURI() external view returns (string contractURI_)

Used to retrieve the metadata URI of the collection.

Returns

directOwnerOf

function directOwnerOf(uint256 tokenId) external view returns (address owner_, uint256 parentId, bool isNFT)

Used to retrieve the immediate owner of the given token.

If the immediate owner is another token, the address returned will be the parent token's collection address.

Parameters

Returns

getActiveAssetPriorities

function getActiveAssetPriorities(uint256 tokenId) external view returns (uint64[] priorities)

Used to retrieve the priorities of the active resoources of a given token.

Asset priorities are a non-sequential array of uint64 values with an array size equal to active asset priorites.

Parameters

Returns

getActiveAssets

function getActiveAssets(uint256 tokenId) external view returns (uint64[] assetIds)

Used to retrieve IDs of the active assets of given token.

Asset data is stored by reference, in order to access the data corresponding to the ID, call getAssetMetadata(tokenId, assetId).You can safely get 10k

Parameters

Returns

getApproved

function getApproved(uint256 tokenId) external view returns (address approved)

Used to retrieve the account approved to manage given token.

Requirements: - tokenId must exist.

Parameters

Returns

getApprovedForAssets

function getApprovedForAssets(uint256 tokenId) external view returns (address approved)

Used to retrieve the address of the account approved to manage assets of a given token.

Requirements: - tokenId must exist.

Parameters

Returns

getAssetMetadata

function getAssetMetadata(uint256 tokenId, uint64 assetId) external view returns (string metadata)

Used to fetch the asset metadata of the specified token's active asset with the given index.

Assets are stored by reference mapping _assets[assetId].Can be overriden to implement enumerate, fallback or other custom logic.

Parameters

Returns

getAssetReplacements

function getAssetReplacements(uint256 tokenId, uint64 newAssetId) external view returns (uint64 replacesAssetId)

Used to retrieve the asset that will be replaced if a given asset from the token's pending array is accepted.

Asset data is stored by reference, in order to access the data corresponding to the ID, call getAssetMetadata(tokenId, assetId).

Parameters

Returns

getPendingAssets

function getPendingAssets(uint256 tokenId) external view returns (uint64[] assetIds)

Used to retrieve IDs of the pending assets of given token.

Asset data is stored by reference, in order to access the data corresponding to the ID, call getAssetMetadata(tokenId, assetId).

Parameters

Returns

getRoyaltyPercentage

function getRoyaltyPercentage() external view returns (uint256 royaltyPercentageBps)

Used to retrieve the specified royalty percentage.

Returns

getRoyaltyRecipient

function getRoyaltyRecipient() external view returns (address recipient)

Used to retrieve the recipient of royalties.

Returns

isApprovedForAll

function isApprovedForAll(address owner, address operator) external view returns (bool isApproved)

Used to check if the given address is allowed to manage the tokens of the specified address.

Parameters

Returns

isApprovedForAllForAssets

function isApprovedForAllForAssets(address owner, address operator) external view returns (bool isApproved)

Used to check whether the address has been granted the operator role by a given address or not.

See {setApprovalForAllForAssets}.

Parameters

Returns

isContributor

function isContributor(address contributor) external view returns (bool isContributor_)

Used to check if the address is one of the contributors.

Parameters

Returns

manageContributor

function manageContributor(address contributor, bool grantRole) external nonpayable

Adds or removes a contributor to the smart contract.

Can only be called by the owner.Emits ContributorUpdate event.

Parameters

maxSupply

function maxSupply() external view returns (uint256 maxSupply_)

Used to retrieve the maximum supply of the collection.

Returns

name

function name() external view returns (string name_)

Used to retrieve the collection name.

Returns

nestTransferFrom

function nestTransferFrom(address from, address to, uint256 tokenId, uint256 destinationId, bytes data) external nonpayable

Used to transfer the token into another token.

Parameters

owner

function owner() external view returns (address owner_)

Returns the address of the current owner.

Returns

ownerOf

function ownerOf(uint256 tokenId) external view returns (address owner_)

Used to retrieve the root owner of a given token.

The root owner of the token is an externally owned account (EOA). If the given token is child of another NFT, this will return an EOA address. Otherwise, if the token is owned by an EOA, this EOA will be returned.

Parameters

Returns

pendingChildOf

function pendingChildOf(uint256 parentId, uint256 index) external view returns (struct IERC7401.Child child)

Used to retrieve a specific pending child token from a given parent token.

Returns a single Child struct locating at index of parent token's active child tokens array.The Child struct consists of the following values: [ tokenId, contractAddress ]

Parameters

Returns

pendingChildrenOf

function pendingChildrenOf(uint256 parentId) external view returns (struct IERC7401.Child[] children)

Used to retrieve the pending child tokens of a given parent token.

Returns array of pending Child structs existing for given parent.The Child struct consists of the following values: [ tokenId, contractAddress ]

Parameters

Returns

rejectAllAssets

function rejectAllAssets(uint256 tokenId, uint256 maxRejections) external nonpayable

Rejects all assets from the pending array of a given token.

Effecitvely deletes the pending array.Requirements: - The caller must own the token or be approved to manage the token's assets - tokenId must exist.Emits a {AssetRejected} event with assetId = 0.

Parameters

rejectAllChildren

function rejectAllChildren(uint256 tokenId, uint256 maxRejections) external nonpayable

Used to reject all pending children of a given parent token.

Removes the children from the pending array mapping.This does not update the ownership storage data on children. If necessary, ownership can be reclaimed by the rootOwner of the previous parent.Requirements: Requirements: - parentId must exist

Parameters

rejectAsset

function rejectAsset(uint256 tokenId, uint256 index, uint64 assetId) external nonpayable

Rejects an asset from the pending array of given token.

Removes the asset from the token's pending asset array.Requirements: - The caller must own the token or be approved to manage the token's assets - tokenId must exist. - index must be in range of the length of the pending asset array.Emits a {AssetRejected} event.

Parameters

renounceOwnership

function renounceOwnership() external nonpayable

Leaves the contract without owner. Functions using the onlyOwner modifier will be disabled.

Can only be called by the current owner.Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

royaltyInfo

function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)

Used to retrieve the information about who shall receive royalties of a sale of the specified token and how much they will be.

Parameters

Returns

safeTransferFrom

function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayable

Used to safely transfer a given token token from from to to.

Requirements: - from cannot be the zero address. - to cannot be the zero address. - tokenId token must exist and be owned by from. - If the caller is not from, it must be approved to move this token by either {approve} or {setApprovalForAll}. - If to refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.Emits a {Transfer} event.

Parameters

safeTransferFrom

function safeTransferFrom(address from, address to, uint256 tokenId, bytes data) external nonpayable

Used to safely transfer a given token token from from to to.

Requirements: - from cannot be the zero address. - to cannot be the zero address. - tokenId token must exist and be owned by from. - If the caller is not from, it must be approved to move this token by either {approve} or {setApprovalForAll}. - If to refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.Emits a {Transfer} event.

Parameters

setApprovalForAll

function setApprovalForAll(address operator, bool approved) external nonpayable

Used to approve or remove operator as an operator for the caller.

Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.Requirements: - The operator cannot be the caller.Emits an {ApprovalForAll} event.

Parameters

setApprovalForAllForAssets

function setApprovalForAllForAssets(address operator, bool approved) external nonpayable

Used to add or remove an operator of assets for the caller.

Operators can call {acceptAsset}, {rejectAsset}, {rejectAllAssets} or {setPriority} for any token owned by the caller.Requirements: - The operator cannot be the caller.Emits an {ApprovalForAllForAssets} event.

Parameters

setPriority

function setPriority(uint256 tokenId, uint64[] priorities) external nonpayable

Sets a new priority array for a given token.

The priority array is a non-sequential list of uint64s, where the lowest value is considered highest priority.Value 0 of a priority is a special case equivalent to unitialized.Requirements: - The caller must own the token or be approved to manage the token's assets - tokenId must exist. - The length of priorities must be equal the length of the active assets array.Emits a {AssetPrioritySet} event.

Parameters

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

Returns true if this contract implements the interface defined by interfaceId. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP (opens in a new tab) section] to learn more about how these ids are created. This function call must use less than 30 000 gas.

Parameters

Returns

symbol

function symbol() external view returns (string symbol_)

Used to retrieve the collection symbol.

Returns

totalAssets

function totalAssets() external view returns (uint256 totalAssets_)

Used to retrieve the total number of assets.

Returns

totalSupply

function totalSupply() external view returns (uint256 totalSupply_)

Used to retrieve the total supply of the tokens in a collection.

Returns

transferChild

function transferChild(uint256 tokenId, address to, uint256 destinationId, uint256 childIndex, address childAddress, uint256 childId, bool isPending, bytes data) external nonpayable

Used to transfer a child token from a given parent token.

When transferring a child token, the owner of the token is set to to, or is not updated in the event of to being the 0x0 address.

Parameters

transferFrom

function transferFrom(address from, address to, uint256 tokenId) external nonpayable

Transfers a given token from from to to.

Requirements: - from cannot be the zero address. - to cannot be the zero address. - tokenId token must be owned by from. - If the caller is not from, it must be approved to move this token by either {approve} or {setApprovalForAll}.Emits a {Transfer} event.

Parameters

transferOwnership

function transferOwnership(address newOwner) external nonpayable

Transfers ownership of the contract to a new owner.

Can only be called by the current owner.

Parameters

updateRoyaltyRecipient

function updateRoyaltyRecipient(address newRoyaltyRecipient) external nonpayable

Used to update recipient of royalties.

Custom access control has to be implemented to ensure that only the intended actors can update the beneficiary.

Parameters

Events

AllChildrenRejected

event AllChildrenRejected(uint256 indexed tokenId)

Used to notify listeners that all pending child tokens of a given token have been rejected.

Emitted when a token removes all a child tokens from its pending array.

Parameters

Approval

event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)

Emitted when owner enables approved to manage the tokenId token.

Parameters

ApprovalForAll

event ApprovalForAll(address indexed owner, address indexed operator, bool approved)

Emitted when owner enables or disables (approved) operator to manage all of its assets.

Parameters

ApprovalForAllForAssets

event ApprovalForAllForAssets(address indexed owner, address indexed operator, bool approved)

Used to notify listeners that owner has granted approval to the user to manage assets of all of their tokens.

Parameters

ApprovalForAssets

event ApprovalForAssets(address indexed owner, address indexed approved, uint256 indexed tokenId)

Used to notify listeners that owner has granted an approval to the user to manage the assets of a given token.

Approvals must be cleared on transfer

Parameters

AssetAccepted

event AssetAccepted(uint256 indexed tokenId, uint64 indexed assetId, uint64 indexed replacesId)

Used to notify listeners that an asset object at assetId is accepted by the token and migrated from token's pending assets array to active assets array of the token.

Parameters

AssetAddedToTokens

event AssetAddedToTokens(uint256[] tokenIds, uint64 indexed assetId, uint64 indexed replacesId)

Used to notify listeners that an asset object at assetId is added to token's pending asset array.

Parameters

AssetPrioritySet

event AssetPrioritySet(uint256 indexed tokenId)

Used to notify listeners that token's prioritiy array is reordered.

Parameters

AssetRejected

event AssetRejected(uint256 indexed tokenId, uint64 indexed assetId)

Used to notify listeners that an asset object at assetId is rejected from token and is dropped from the pending assets array of the token.

Parameters

AssetSet

event AssetSet(uint64 indexed assetId)

Used to notify listeners that an asset object is initialized at assetId.

Parameters

ChildAccepted

event ChildAccepted(uint256 indexed tokenId, uint256 childIndex, address indexed childAddress, uint256 indexed childId)

Used to notify listeners that a new child token was accepted by the parent token.

Emitted when a parent token accepts a token from its pending array, migrating it to the active array.

Parameters

ChildProposed

event ChildProposed(uint256 indexed tokenId, uint256 childIndex, address indexed childAddress, uint256 indexed childId)

Used to notify listeners that a new token has been added to a given token's pending children array.

Emitted when a child NFT is added to a token's pending array.

Parameters

ChildTransferred

event ChildTransferred(uint256 indexed tokenId, uint256 childIndex, address indexed childAddress, uint256 indexed childId, bool fromPending, bool toZero)

Used to notify listeners a child token has been transferred from parent token.

Emitted when a token transfers a child from itself, transferring ownership to the root owner.

Parameters

ContributorUpdate

event ContributorUpdate(address indexed contributor, bool isContributor)

Event that signifies that an address was granted contributor role or that the permission has been revoked.

This can only be triggered by a current owner, so there is no need to include that information in the event.

Parameters

NestTransfer

event NestTransfer(address indexed from, address indexed to, uint256 fromTokenId, uint256 toTokenId, uint256 indexed tokenId)

Used to notify listeners that the token is being transferred.

Emitted when tokenId token is transferred from from to to.

Parameters

OwnershipTransferred

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Used to anounce the transfer of ownership.

Parameters

Transfer

event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)

Emitted when tokenId token is transferred from from to to.

Parameters

Errors

ERC721AddressZeroIsNotaValidOwner

error ERC721AddressZeroIsNotaValidOwner()

Attempting to grant the token to 0x0 address

ERC721ApprovalToCurrentOwner

error ERC721ApprovalToCurrentOwner()

Attempting to grant approval to the current owner of the token

ERC721ApproveCallerIsNotOwnerNorApprovedForAll

error ERC721ApproveCallerIsNotOwnerNorApprovedForAll()

Attempting to grant approval when not being owner or approved for all should not be permitted

ERC721ApproveToCaller

error ERC721ApproveToCaller()

Attempting to grant approval to self

ERC721InvalidTokenId

error ERC721InvalidTokenId()

Attempting to use an invalid token ID

ERC721NotApprovedOrOwner

error ERC721NotApprovedOrOwner()

Attempting to manage a token without being its owner or approved by the owner

ERC721TransferFromIncorrectOwner

error ERC721TransferFromIncorrectOwner()

Attempting to transfer the token from an address that is not the owner

ERC721TransferToNonReceiverImplementer

error ERC721TransferToNonReceiverImplementer()

Attempting to safe transfer to an address that is unable to receive the token

ERC721TransferToTheZeroAddress

error ERC721TransferToTheZeroAddress()

Attempting to transfer the token to a 0x0 address

IndexOutOfBounds

error IndexOutOfBounds()

RMRKApprovalForAssetsToCurrentOwner

error RMRKApprovalForAssetsToCurrentOwner()

Attempting to grant approval of assets to their current owner

RMRKApproveForAssetsCallerIsNotOwnerNorApprovedForAll

error RMRKApproveForAssetsCallerIsNotOwnerNorApprovedForAll()

Attempting to grant approval of assets without being the caller or approved for all

RMRKAssetAlreadyExists

error RMRKAssetAlreadyExists()

Attempting to add an asset using an ID that has already been used

RMRKBadPriorityListLength

error RMRKBadPriorityListLength()

Attempting to set the priorities with an array of length that doesn't match the length of active assets array

RMRKChildAlreadyExists

error RMRKChildAlreadyExists()

Attempting to accept a child that has already been accepted

RMRKChildIndexOutOfRange

error RMRKChildIndexOutOfRange()

Attempting to interact with a child, using index that is higher than the number of children

RMRKIdZeroForbidden

error RMRKIdZeroForbidden()

Attempting to use ID 0, which is not supported

The ID 0 in RMRK suite is reserved for empty values. Guarding against its use ensures the expected operation

RMRKIndexOutOfRange

error RMRKIndexOutOfRange()

Attempting to interact with an asset, using index greater than number of assets

RMRKIsNotContract

error RMRKIsNotContract()

Attempting to interact with an end-user account when the contract account is expected

RMRKMaxPendingAssetsReached

error RMRKMaxPendingAssetsReached()

Attempting to add a pending asset after the number of pending assets has reached the limit (default limit is 128)

RMRKMaxPendingChildrenReached

error RMRKMaxPendingChildrenReached()

Attempting to add a pending child after the number of pending children has reached the limit (default limit is 128)

RMRKMaxRecursiveBurnsReached

error RMRKMaxRecursiveBurnsReached(address childContract, uint256 childId)

Attempting to burn a total number of recursive children higher than maximum set

Parameters

RMRKNestableTooDeep

error RMRKNestableTooDeep()

Attempting to nest a child over the nestable limit (current limit is 100 levels of nesting)

RMRKNestableTransferToDescendant

error RMRKNestableTransferToDescendant()

Attempting to nest the token to own descendant, which would create a loop and leave the looped tokens in limbo

RMRKNestableTransferToNonRMRKNestableImplementer

error RMRKNestableTransferToNonRMRKNestableImplementer()

Attempting to nest the token to a smart contract that doesn't support nesting

RMRKNestableTransferToSelf

error RMRKNestableTransferToSelf()

Attempting to nest the token into itself

RMRKNewContributorIsZeroAddress

error RMRKNewContributorIsZeroAddress()

Attempting to assign a 0x0 address as a contributor

RMRKNewOwnerIsZeroAddress

error RMRKNewOwnerIsZeroAddress()

Attempting to transfer the ownership to the 0x0 address

RMRKNoAssetMatchingId

error RMRKNoAssetMatchingId()

Attempting to interact with an asset that can not be found

RMRKNotApprovedForAssetsOrOwner

error RMRKNotApprovedForAssetsOrOwner()

Attempting to manage an asset without owning it or having been granted permission by the owner to do so

RMRKNotApprovedOrDirectOwner

error RMRKNotApprovedOrDirectOwner()

Attempting to interact with a token without being its owner or having been granted permission by the owner to do so

When a token is nested, only the direct owner (NFT parent) can mange it. In that case, approved addresses are not allowed to manage it, in order to ensure the expected behaviour

RMRKNotOwner

error RMRKNotOwner()

Attempting to interact with a management function without being the smart contract's owner

RMRKNotOwnerOrContributor

error RMRKNotOwnerOrContributor()

Attempting to interact with a function without being the owner or contributor of the collection

RMRKPendingChildIndexOutOfRange

error RMRKPendingChildIndexOutOfRange()

Attempting to interact with a pending child using an index greater than the size of pending array

RMRKRoyaltiesTooHigh

error RMRKRoyaltiesTooHigh()

Attempting to set the royalties to a value higher than 100% (10000 in basis points)

RMRKTokenDoesNotHaveAsset

error RMRKTokenDoesNotHaveAsset()

Attempting to compose a NFT of a token without active assets

RMRKUnexpectedAssetId

error RMRKUnexpectedAssetId()

Attempting to accept or reject an asset which does not match the one at the specified index

RMRKUnexpectedChildId

error RMRKUnexpectedChildId()

Attempting to accept or transfer a child which does not match the one at the specified index

RMRKUnexpectedNumberOfAssets

error RMRKUnexpectedNumberOfAssets()

Attempting to reject all pending assets but more assets than expected are pending

RMRKUnexpectedNumberOfChildren

error RMRKUnexpectedNumberOfChildren()

Attempting to reject all pending children but children assets than expected are pending