Utility Functions

collection

function collection(bytes32 collectionId) external view returns(address maintainer, string memory name, string memory symbol, string memory uri);
  • Function type: read-only

As input, this function takes a collectionId, and returns all of that collectionId’s data: its host address, name, symbol and uri.

item

function item(uint256 itemId) external view returns(bytes32 collectionId, Header memory header, bytes32 domainSeparator, uint256 totalSupply);
  • Function type: read-only

As input, this function takes an itemId, and returns all data related to it: its Collection’s collectionId, its Header, its domainSeparator and its totalSupply.

interoperable of

function interoperableOf(uint256 itemId) external view returns(address);
  • Function type: read

The output of this function returns the Interoperable Interface address of the passed itemId.

collection uri

function collectionUri(bytes32 collectionId) external view returns(string memory);
  • Function type: read-only.

As Input, this takes a collectionId and returns the uri related to that Collection.

See the Dynamic Metadata section to learn more about how uri works.

interoperable interface model

function interoperableInterfaceModel() external view returns(address);
  • Function type: read-only

The output of this function returns the address of the Interoperable Interface Factory model contract, a clone of which is deployed—and initialized—for each individual itemId when the itemId is created.

This means that each itemId has its very own unique Interoperable Interface address (whereas the Main Interface is a singleton address shared by all Items). To learn more about Interoperable Interfaces, see the next section.

Last updated