zNFT Token Standard
Usage & Flow
Role Setup
- Assign Roles: Use the role management handlers (
Roles/Add
,Roles/Remove
,Roles/Get-Roles
) to assign roles such asadmin
andminter
.
Minting
- Mint New Tokens:
Use theMint
handler by providing a recipient and valid structured metadata. - Supply Check:
The minting process verifies that the total number of minted tokens does not exceed the maximum supply.
Metadata Management
- Update Metadata:
TheManage/Update-Metadata
handler allows updating token metadata unless it has been frozen. - Freeze Metadata:
Metadata can be frozen to ensure immutability.
Contract Pausing
- Pause/Unpause:
ThePausable/Pause
andPausable/Unpause
handlers allow an admin to pause or resume the contract.
Royalty Management
- Configure Royalties:
TheManage/Set-Royalty
handler is used by an admin to set the global royalty percentage and recipient. - Query Royalties:
TheGet-Royalty
handler retrieves the current royalty settings.
NFT Operations
- Transfers, Approvals, and Burning:
Standard handlers (e.g.,Transfer
,Approve
,Get-Approved
,Set-Approval-For-All
,Is-Approved-For-All
,Burn
) enable typical NFT operations. - Query Functions:
Handlers such asBalance-Of
,Owner-Of
,Token-Metadata
, andAll-Tokens
provide necessary information for UI display or indexing.