Interface iMetadata<T>

interface iMetadata<T extends NumberType> {
    _isUpdating?: boolean;
    additionalInfo?: {
        description: string;
        image: string;
        name: string;
        url?: string;
    }[];
    attributes?: {
        name: string;
        type: string;
        value: string
        | number
        | boolean;
    }[];
    bannerImage?: string;
    category?: string;
    description: string;
    externalUrl?: string;
    fetchedAt?: T;
    fetchedAtBlock?: T;
    image: string;
    name: string;
    offChainTransferabilityInfo?: { assignMethod: string; host: string };
    socials?: { [key: string]: string };
    tags?: string[];
    video?: string;
}

Type Parameters

Implemented by

Properties

_isUpdating? additionalInfo? attributes? bannerImage? category? description externalUrl? fetchedAt? fetchedAtBlock? image name offChainTransferabilityInfo? socials? tags? video?

Properties

Optional_isUpdating

_isUpdating?: boolean

Whether the metadata is currently being updated.

OptionaladditionalInfo

additionalInfo?: {
    description: string;
    image: string;
    name: string;
    url?: string;
}[]

Header links for this item displayed right under the title

Optionalattributes

attributes?: { name: string; type: string; value: string | number | boolean }[]

The attributes for this item

OptionalbannerImage

bannerImage?: string

The banner image for this item.

Optionalcategory

category?: string

The category for this item (e.g. "Education", "Attendance").

description

description: string

The description of this item. Supports markdown.

OptionalexternalUrl

externalUrl?: string

The external URL for this item.

OptionalfetchedAt

fetchedAt?: T

The time the metadata was fetched.

OptionalfetchedAtBlock

fetchedAtBlock?: T

The block the metadata was fetched at.

image

image: string

The image for this item.

name

name: string

The name of this item.

OptionaloffChainTransferabilityInfo

offChainTransferabilityInfo?: { assignMethod: string; host: string }

The off-chain transferability info for this item (used for badges - off-chain, disregard for others)

Optionalsocials

socials?: { [key: string]: string }

The socials for this item

Optionaltags

tags?: string[]

The tags for this item

Optionalvideo

video?: string

The video for this item. If a standard video is used, this should be a link to the video. We will use image as the poster image. If a youtube video is used, we embed it as an iframe.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR