Interface iMetadata<T>

interface iMetadata<T> {
    _isUpdating?: boolean;
    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[];
    utility?: {
        description: string;
        image: string;
        name: string;
        url?: string;
    }[];
    video?: string;
}

Type Parameters

Implemented by

Properties

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

Properties

Optional_isUpdating

_isUpdating?: boolean

Whether the metadata is currently being updated.

Optionalattributes

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

The attributes of the badge or badge collection

OptionalbannerImage

bannerImage?: string

The banner image of the badge or badge collection.

Optionalcategory

category?: string

The category of the badge or badge collection (e.g. "Education", "Attendance").

description

description: string

The description of the badge or badge collection. Supports markdown.

OptionalexternalUrl

externalUrl?: string

The external URL of the badge or badge collection.

OptionalfetchedAt

fetchedAt?: T

The time the metadata was fetched.

OptionalfetchedAtBlock

fetchedAtBlock?: T

The block the metadata was fetched at.

image

image: string

The image of the badge or badge collection.

name

name: string

The name of the badge or badge collection.

OptionaloffChainTransferabilityInfo

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

The off-chain transferability info of the badge or badge collection

Optionalsocials

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

The socials of the badge or badge collection

Optionaltags

tags?: string[]

The tags of the badge or badge collection

Optionalutility

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

Optionalvideo

video?: string

The video of the badge or badge collection. 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