Type alias NftType

Type declaration

• Optional description?: string

  A string describing this NFT type for use in user interfaces.

  In user interfaces with limited space, names should be hidden beyond the first newline character or 140 characters until revealed by the user.

  E.g.:

  • "Receipts issued by the exchange to record details about purchases. After settlement, these receipts are redeemed for the purchased tokens.";
  • "Receipts issued by the crowdfunding campaign to document the value of funds pledged. If the user decides to cancel their pledge before the campaign completes, these receipts can be redeemed for a full refund.";
  • "Tickets issued for events at ACME Stadium.";
  • Sealed ballots certified by ACME decentralized organization during the voting period. After the voting period ends, these ballots must be revealed to reclaim the tokens used for voting."

• Optional extensions?: Extensions

  A mapping of NFT type extension identifiers to extension definitions. Extensions may be widely standardized or application-specific.

• Optional fields?: string[]

  A list of identifiers for fields contained in NFTs of this type. On successful parsing evaluations, the bottom item on the altstack indicates the matched NFT type, and the remaining altstack items represent NFT field contents in the order listed (where fields[0] is the second-to-bottom item, and the final item in fields is the top of the altstack).

  Fields should be ordered by recommended importance from most important to least important; in user interfaces, clients should display fields at lower indexes more prominently than those at higher indexes, e.g. if some fields cannot be displayed in minimized interfaces, higher-importance fields can still be represented. (Note, this ordering is controlled by the bytecode specified in token.nft.parse.bytecode.)

  If this is a sequential NFT, (the category's parse.bytecode is undefined), fields should be omitted or set to undefined.

• name: string

  The name of this NFT type for use in interfaces. Names longer than 20 characters may be elided in some interfaces.

  E.g. Market Order Buys, Limit Order Sales, Pledge Receipts, ACME Stadium Tickets, Sealed Votes, etc.

• Optional uris?: URIs

  A mapping of identifiers to URIs associated with this NFT type. URI identifiers may be widely-standardized or registry-specific. Values must be valid URIs, including a protocol prefix (e.g. https:// or ipfs://). Clients are only required to support https and ipfs URIs, but any scheme may be specified.