Transient Labs Developer Docs
  • 👋Welcome!
  • 📑TL Creator Contracts
    • Creator Contracts Overview
    • Implementation Contracts
      • v3.x.x
      • v2.x.x
      • v1.x.x
    • Smart Contract Documentation
    • Common Features
      • Access Control
      • Royalties
      • Story Inscriptions
      • NFT Delegation
      • BlockList
    • ERC721TL
    • ERC1155TL
    • Shatter
    • ERC7160TL
    • Doppelganger
    • Collector's Choice
  • ⛔BlockList
    • BlockList Overview
    • Implementation Contracts
    • Deployments
    • Smart Contract Documentation
  • 🔖Story Inscriptions
    • Story Inscriptions Overview
    • Story Inscription Format
    • Smart Contract Documentation
  • 🖼️T.R.A.C.E.
    • T.R.A.C.E. Overview
    • Record Schema
    • Implementation
    • Smart Contract Documentation
      • TRACE
      • TRACERSRegistry
  • 🥞Stacks
    • Stacks Overview
    • Deployments
    • Smart Contract Documentation
  • 🎨Dynamic Art
    • Dynamic Art Overview
    • How to Create
    • How to Display
  • 🔗Integrations
    • Deploying TL Contracts
    • NFT Delegation
    • Integrating with Marketplaces
    • Metadata Structure
    • Inheriting TL Contracts
    • Onchain Art
    • Embeddable Components
  • ❔Miscellaneous
    • Supported Blockchains
    • tl-sol-tools
    • Licensing
    • Batch Upload Secret JSON
Powered by GitBook
On this page
  • Metadata Structure
  • Details
  1. Integrations

Metadata Structure

Transient Labs structures metadata in accordance with major marketplaces, plus a few extra fields

TL Metadata is supported by all major marketplaces, such as SuperRare, OpenSea, LooksRare, and Nifty Gateway. The metadata follows widely accepted standards, with a few additional fields.

Metadata Structure

{
    "name": "string",
    "description": "string",
    "external_url": "string",
    "attributes": [
        {
            "trait_type": "string",
            "value": "string"
        },
        ...
    ],
    "tags": [
        "string",
        "string",
        ...
    ],
    "image": "string",
    "image_sha256": "string",
    "animation_url": "string",
    "animation_sha256": "string",
    "media": {
        "dimensions": "<number>x<number>",
        "size": "<number>",
        "mimeType": "string"
    }
}

Details

name (required)

The title of the NFT

description (required)

The description that goes along with the NFT. You can use Markdown on OpenSea and SuperRare, although markdown links are not supported on SuperRare (regular links are).

A note on line breaks in Markdown: You need two spaces in front of the escape characters. For example: \n

external_url (optional)

A url string that would show up under the item on OpenSea and can be used to direct people to your website or other content you want them to see.

attributes (optional)
tags (optional)

These are essentially hashtags on SuperRare. OpenSea does not yet support although they may be looking into this based on some beta features available in collection settings. We shall see.

image (required)

The uri of the image. Supported file types are jpeg, png, and gif.

image_sha256 (optional)

The sha256 hash of the image. Useful for assuring that the downloaded file is correct.

animation_url (only required for videos, 3d, and html)

The uri of the animation. Supported file types are mp4, mp3, glb, gltf, html

animation_sha256 (optional)

The sha256 hash of the animation. Useful for assuring that the downloaded file is correct.

media (optional)

An object containing some details about the main asset for faster indexing.

  • uri - the link to the main asset (either image or animation_url)

  • size - the size of the main asset in bytes shown as a string

  • dimensions - the dimensions of the main asset if available, otherwise the dimensions of the thumbnail image ex: 100x100

  • mimeType - the mime type of the main asset

PreviousIntegrating with MarketplacesNextInheriting TL Contracts

Last updated 1 month ago

A list of key-value pair objects. The trait_type is always the key and value is the value. You can read more about these . Note, boosts or anything like that are not supported outside of OpenSea.

here
🔗
Page cover image