Class Metadata<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Methods

clone convert equals getNumberFieldNames toJson toJsonString DefaultPlaceholderMetadata ErrorMetadata

Constructors

constructor

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.

Methods

clone

convert

equals

  • equals<U>(other, normalizeNumberTypes?): boolean

  • 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

getNumberFieldNames

toJson

toJsonString

StaticDefaultPlaceholderMetadata

  • DefaultPlaceholderMetadata(): 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.DefaultPlaceholderMetadata().convert(Numberify)

    Returns Metadata<bigint>

StaticErrorMetadata

  • ErrorMetadata(): 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>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods