TradePort NFT Standards on Sui

Collection Contract Structure

Among the many ways to deploy and trade NFTs on Sui, the best for creator control and usability is the kiosk standard. In short, kiosks are on chain objects that can hold other objects. Kiosks give creators the ability to define requirements when transferring an asset in the NFT type’s TransferPolicy. This creates a safer, more reliable trading process and allows creators to enforce royalties on the NFT level.

NOTE: In this doc, kiosk refers to native Sui kiosks, not to be confused with Origin Byte kiosks. The Origin Byte standard has been deprecated in favor of native kiosks. For reliable trading, creators must use kiosks as described here.

For items to be tradable on TradePort, the following is required:

All items MUST be placed into a kiosk.
Each kiosk MUST be a shared object. Shared kiosks will have a “shared” flag on an explorer-like Suiscan or SuiVision.
Each NFT type MUST have a defined transfer policy.

Within a transfer policy, creators can define the rule by which the policy is used.

To ensure permanent tradability, creators MUST define a kiosk_lock_rule. This rule prevents users or marketplaces from removing items from the kiosk which could break trading across a collection.
If the creator wishes to enforce royalties, a royalty_rule must be implemented.

To learn more about Sui kiosks, transfer policies, and their implementation, please consult Mysten Lab’s documentation here.

Metadata Requirements

NFTs on Sui have a number of ways to store on-chain data but for an NFT to display correctly on TradePort, all required data but be correctly formatted in the NFT object’s fields.

The Basics

Each object must have the following fields:

name field - the name of the individual NFT.
image_url - the URL, preferably an IPFS URI, pointing to the NFT’s media file. All standard image and video formats are supported on TradePort. If you are unsure about your file format, reach out to the team in Discord before launching your collection.
description - the description of the collection.

Attributes

Non-unique and excessive metadata is often stored in the NFT fields. This prevents us from using unknown fields as a reliable source for attributes. So, all other NFT properties that the creator needs to appear on TradePort MUST be added to the attributes field on the NFT in one of the following formats:

Join Us on this Exciting Journey

We're excited for you to explore the new possibilities offered by our expansion to Base. Whether you're an avid collector, a passionate creator, or a developer aiming to build the next big thing in NFTs, TradePort is your gateway to endless opportunities.

Get Started Today

Start your TradePort experience by signing up for the Indexer Notification System! Connect one or multiple wallets to receive vital updates about your NFTs, including notifications when NFTs in your wallet sell or receive a bid. Say goodbye to constantly checking the marketplace—these important alerts will be delivered straight to your Discord DMs. Register now using the link below: https://www.tradeport.xyz/discord-bots/alerts/subscribe.