Collection registration

❗️

Ropsten only

This functionality is only available in RopstenRopsten - Ethereum's testnet, used for testing, experimenting and debugging. and is not yet available on MainnetMainnet - Ethereum's mainnet, used for projects which are ready for production.. To create and update collections and metadata schema in mainnet, use this form.

This functionality is not available for users who have previously registered a collection via online form submission. To update existing collections, submit a request here.

Requests may take up to 2 business days (AEST).

🚧

Requirements


A collection refers to a deployed smart contract. All minted assets belong to a collection, and in order to mint assets on L2 you must first register your collection (smart contract) with Immutable X. Each collection belongs to a project.


Create a collection

A collection contains the following fields:

Field

Required (Default value)

Value Type / Notes

name

yes

text

description

no

text

owner_public_key

yes

Generate the Public Key

contract_address

yes

text

metadata_api_url

yes

https://docs.x.immutable.com/docs/asset-metadata

icon_url

no

Do not put an empty text or a non-url for this as it will result to a broken icon link in Marketplace.

collection_image_url

no

Used for display purposes.

🚧

owner_public_key

Take extra care to ensure that your owner_public_key is correct and matches the owner of the smart contract specified in contract_address. Updating the owner_public_key is not possible.


📘

View example code

The repository imx-examples provides easy to use open source examples. Follow the instructions in the README to get started.


Update an existing collection

🚧

Modifications not allowed for these fields

contract_address is a field that should not be changed. If metadata_api_url is modified AFTER minting, the existing assets that used the previous metadata_api_url will not be modified. The new metadata_api_url will be used for new mints.


Field

Required (Default value)

Value Type / Notes

name

text

description

text

icon_url

Do not put an empty text or a non-url for this as it may result in a broken icon when used.

collection_image_url

Used for display purposes.


📘

View example code

The repository imx-examples provides easy to use open source examples. Follow the instructions in the README to get started.


Did this page help you?