Metadata Standards

Crystara follows industry-standard metadata formats for NFTs, ensuring compatibility with various wallets, marketplaces, and applications. This page outlines the metadata standards used by Crystara.

Overview

Crystara implements metadata standards based on the ERC-1155 off-chain data schema, which provides a flexible and extensible way to represent NFT metadata. This ensures that NFTs created on Crystara are compatible with the broader ecosystem.

Collection URI Standards

Collection metadata provides information about an entire collection of NFTs. The following is the standard format for collection metadata on Crystara:

{
  "image": "https://cdn.crystara.trade/collections/0xfd566b048d7ea241ebd4d28a3d60a9eaaaa29a718dfff52f2ff4ca8581363b85-Hungy Hippos/image.jpg",
  "external_url": "https://crystara.trade/collections/0xfd566b048d7ea241ebd4d28a3d60a9eaaaa29a718dfff52f2ff4ca8581363b85-Hungy Hippos"
}

Collection Metadata Fields

Field	Type	Description
image	String	URL to the collection's cover image
external_url	String	URL to the collection's page on Crystara

Token URI Standards

Individual token metadata provides detailed information about a specific NFT. The following is the standard format for token metadata on Crystara:

{
  "image": "https://gateway.irys.xyz/QH3rksVhbFg5L9vvjGzb4POUibCEG-TGPInmofp-O-o",
  "animation_url": "https://gateway.irys.xyz/QH3rksVhbFg5L9vvjHzb4POUibCEG-TGPInmofp-O-o",
  "external_url": "https://petra.app/",
  "attributes": [
    {
      "trait_type": "web",
      "value": "yes"
    },
    {
      "trait_type": "mobile",
      "value": "yes"
    },
    {
      "trait_type": "extension",
      "value": "yes"
    }
  ],
  "properties": {
    "files": [
      {
        "uri": "https://gateway.irys.xyz/QH3rksVhbFg5L9vvjGzb4POUibCEG-ENXUnmofp-O-o",
        "type": "image/png"
      },
      {
        "uri": "https://gateway.irys.xyz/QH3rksVhbFg5L9vvjGzb4POUibCEG-UENCnmofp-O-o",
        "type": "unknown",
        "cdn": true
      },
      {
        "uri": "https://gateway.irys.xyz/QH3rksVhbFg5L9vvjGzb4POUibCEG-DJHUUnmofp-O-o",
        "type": "video/mp4"
      }
    ],
    "category": "video"
  }
}

Token Metadata Fields

Field	Type	Description
image	String	URL to the token's primary image
animation_url	String	URL to the token's animation or interactive content (optional)
external_url	String	URL to view the token on an external site
attributes	Array	List of trait objects that define the token's characteristics
properties	Object	Additional properties including files and category

Attributes

Attributes represent the traits or characteristics of an NFT. Each attribute has:

• trait_type: The name of the trait (e.g., "Background", "Eyes", "Rarity")
• value: The specific value for this trait (e.g., "Blue", "Rare")

Properties

The properties object contains additional metadata about the token:

• files: An array of file objects associated with the token
• category: The primary category of the token (e.g., "image", "video", "audio", "3d")

File Objects

Each file object in the files array contains:

• uri: URL to the file
• type: MIME type of the file (e.g., "image/png", "video/mp4")
• cdn: Boolean indicating if the file is served through a CDN (optional)

Best Practices for Creators

When creating NFTs on Crystara, we recommend the following best practices for metadata:

1. Use Permanent Storage: Store metadata and assets on permanent storage solutions like IPFS or Arweave
2. Include High-Quality Images: Provide high-resolution images for better display across platforms
3. Provide Complete Attributes: Include comprehensive attributes to improve discoverability and filtering
4. Optimize File Sizes: Balance quality with file size for better performance
5. Include Alternative Media: When applicable, include both static images and animations/videos

Metadata Validation

Crystara provides tools to validate your metadata before minting. You can use our metadata validation endpoint to ensure your metadata conforms to our standards:

POST /api/validate-metadata

For more information on using this endpoint, see the Utility Routes documentation.

Additional Resources

• ERC-1155 Metadata URI JSON Schema
• IPFS Documentation

For any questions regarding metadata standards on Crystara, please contact [email protected].