Calls
burn
Burn a token 🔥 Caller must be the token owner NamespaceclaimUnownedCollection
Bridged collections from Ethereum will initially lack an owner. These collections will be assigned to the pallet. This allows for claiming those collections assuming they were assigned to the pallet NamespacecreateCollection
Create a new collection Additional tokens can be minted viamint
name
- the name of the collectioninitial_issuance
- number of tokens to mint nowmax_issuance
- maximum number of tokens allowed in collectiontoken_owner
- the token owner, defaults to the callermetadata_scheme
- The off-chain metadata referencing scheme for tokens in thisroyalties_schedule
- defacto royalties plan for secondary sales, this will apply to all tokens in the collection by defaultcross_chain_compatibility
- Is this collection XLS-20 compatible. Note, if enabled, the metadata_scheme will be immutable
mint
Mint tokens for an existing collectioncollection_id
- the collection to mint tokens inquantity
- how many tokens to minttoken_owner
- the token owner, defaults to the caller if unspecified Caller must be the collection owner
setBaseUri
Set the base URI of a collection Caller must be the current collection owner.\ Cannot change if XLS20 compatibility is enabled. NamespacesetMaxIssuance
Set the max issuance of a collection Caller must be the current collection owner NamespacesetMintFee
NamespacesetName
Set the name of a collection Caller must be the current collection owner NamespacesetOwner
Set the owner of a collection Caller must be the current collection owner NamespacesetRoyaltiesSchedule
Set the royalties schedule of a collection Caller must be the current collection owner NamespacetogglePublicMint
Namespacetransfer
Transfer ownership of an NFT Caller must be the token owner NamespacesetUtilityFlags
Set utility flags of a collection. Allows the restriction of certain operations on a collection such as transfer, burn or mint. Flags apply to all tokens in the collection, but individual token flags take priority over collection flags.-
collection_id
- The collection to set the utility flags for -
utility_flags
- An object containing the utility flags.
setTokenTransferableFlag
Set transferable flag on a token, allowing or disallowing transfers. Token utility flags take priority over the collection utility flags, enabling fine-grained control over individual token transferability. Priority Order:- Token-level flags (highest priority)
- Collection-level flags (fallback)
token_id
- The token id (collection_id, serial_number) to set the flags fortransferable
- Whether the token should be transferable
issueSoulbound
Issue soulbound tokens. The issuance will be pending until the designated token owner accepts the issuance. Soulbound tokens will always be non-transferable.-
collection_id
- The collection id to create the issuance for -
quantity
- The number of tokens to issue -
token_owner
- Account id of the token owner -
burn_authority
- The token burn authority. This value will dictate which account is allowed to burn the token, and cannot be altered post-issuance.
acceptSoulboundIssuance
Accept the issuance of a soulbound tokencollection_id
- The collection id the issuance is forissuance_id
- The issuance id. An issuance id is created and emitted when a soulbound token is issued. All pending issuances for an account can be retrieved by querying the collection’s pending issuances.
setAdditionalData
Sets additional data for a token. This allows storing extra information for a token outside the collection metadata.token_id
- The token id (collection_id, serial_number) to set data foradditional_data
- Optional additional data. PassNone
to remove existing data
mintWithAdditionalData
Mint a single token alongside some additional data. This is equivalent to callingmint
followed by setAdditionalData
, but more efficient.
collection_id
- The collection to mint the token intoken_owner
- The token owner, defaults to the caller if unspecifiedadditional_data
- Additional data to store with the token