zNFT Metadata Structure

The zNFT Metadata Structure provides a consistent format for all tokens within the ZoAO ecosystem. This schema is designed to ensure compatibility, extensibility, and security while allowing campaign-specific enhancements—such as the genome attribute used in the Zoo Keepers Genesis campaign.

Standard Metadata Schema

{
  "version": "0.1.0",
  "frozen": "false",
  "id": "Token ID",
  "name": "Token Name",
  "description": "A detailed description of the token.",
  "external_url": "ar://0asx0asx00",
  "media": [
    {
      "id": "profile",
      "url": "https://example.com/image1.png",
      "mimeType": "image/png",
      "alt": "Primary view of the token"
    }
  ],
  "attributes": [
    {
      "trait_type": "Rarity",
      "value": "Legendary"
    },
    {
      "display_type": "number",
      "trait_type": "Power",
      "value": "100"
    }
  ],
  "properties": {
    "customField1": "value1",
    "customField2": "value2"
  },
}

Each zNFT token metadata object includes the following fields:

Prop	Type	Default
`version`	`string`	`0.1.0`
`id`	`string`	`Token ID`
`name`	`string`	-
`description`	`string`	-
`external_url`	`string`	-
`media`	`MediaObject[]`	-
`attributes`	`Attribute[]`	-
`properties`	`Record<string, any>`	-

MediaObject Interface

Prop	Type	Default
`id`	`string`	-
`url`	`string`	-
`mimeType`	`string`	-
`alt`	`string`	-

Attributes Interface

Prop	Type	Default
`display_type`	`'number' \| 'boost' \| 'boost_percentage' \| 'date' \| 'string'`	`'string'`
`trait_type`	`string`	-
`value`	`string`	-

Metadata Validation

To ensure consistency and correctness, the metadata needs to be validated against this schema. The validation must check that all required fields are present and correctly formatted, ensuring robust integration and a seamless user experience across the ecosystem.

Learn more about the metadata validation process.

The metadata validation process is crucial for maintaining the integrity of the ZoAO ecosystem. It ensures that all tokens adhere to the defined schema, preventing potential issues that could arise from malformed or incomplete metadata.

Summary

The zNFT Metadata Structure provides a flexible yet robust foundation for all tokens in the ZoAO ecosystem. By adhering to this schema, we can ensure a consistent and extensible approach to metadata management, paving the way for future innovations and enhancements.