Class Metadata<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_isUpdating?: boolean

Whether the metadata is currently being updated.

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

The attributes of the badge or badge collection

category?: string

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

description: string

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

externalUrl?: string

The external URL of the badge or badge collection.

fetchedAt?: T

The time the metadata was fetched.

fetchedAtBlock?: T

The block the metadata was fetched at.

image: string

The image of the badge or badge collection.

name: string

The name of the badge or badge collection.

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

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

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

The socials of the badge or badge collection

tags?: string[]

The tags of the badge or badge collection

utility?: {
    description: string;
    image: string;
    name: string;
    url?: string;
}[]
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.

Methods

  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

  • Returns a new Metadata object with default placeholder values. By default, it returns as type, but you can convert it with .convert method.

    import { Numberify } from 'bitbadgesjs-sdk'
    const metadata = Metadata.DefaultPlaceholderMetadata().convert(Numberify)

    Returns Metadata<bigint>

  • Returns a new Metadata object with default placeholder values. By default, it returns as type, but you can convert it with .convert method.

    import { Numberify } from 'bitbadgesjs-sdk'
    const metadata = Metadata.ErrorMetadata().convert(Numberify)

    Returns Metadata<bigint>