Class: TokenMetadataDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:103

Extends#

• BaseNumberTypeClass<TokenMetadataDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iTokenMetadataDetails<T>

Constructors#

Constructor#

new TokenMetadataDetails<T>(data): TokenMetadataDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:111

Parameters#

data#

iTokenMetadataDetails<T>

Returns#

TokenMetadataDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

customData#

customData: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:108

Custom data

Implementation of#

iTokenMetadataDetails.customData

fetchedUri?#

optional fetchedUri?: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:107

The URI that the metadata was fetched from with placeholders replaced.

Implementation of#

iTokenMetadataDetails.fetchedUri

metadata?#

optional metadata?: Metadata<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:105

The metadata fetched by the URI

Implementation of#

iTokenMetadataDetails.metadata

tokenIds#

tokenIds: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:104

The token IDs that correspond to the metadata

Implementation of#

iTokenMetadataDetails.tokenIds

toUploadToIpfs?#

optional toUploadToIpfs?: boolean

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:109

Flag to denote if the metadata is new and should be updated. Used internally.

Implementation of#

iTokenMetadataDetails.toUploadToIpfs

uri#

uri: string

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:106

The URI that the metadata was fetched from. This is the original on-chain URI, so may still have placeholders (i.e. {id} or {address})

Implementation of#

iTokenMetadataDetails.uri

Methods#

clone()#

clone(): TokenMetadataDetails

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

TokenMetadataDetails

Inherited from#

BaseNumberTypeClass.clone

convert()#

convert<U>(convertFunction, options?): TokenMetadataDetails<U>

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:125

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

TokenMetadataDetails<U>

Overrides#

BaseNumberTypeClass.convert

equals()#

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

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

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#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:121

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

toProto()#

toProto(): TokenMetadata

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:337

Returns#

TokenMetadata

batchUpdateTokenMetadata()#

static batchUpdateTokenMetadata<T>(currTokenMetadata, newTokenMetadataDetailsArr): TokenMetadataDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:166

Batch update the metadataArr with the given metadata and tokenIds fetched from the given

Type Parameters#

T#

T extends NumberType

Parameters#

currTokenMetadata#

TokenMetadataDetails<T>[]

newTokenMetadataDetailsArr#

TokenMetadataDetails<T>[]

Returns#

TokenMetadataDetails<T>[]

getMetadataDetailsForTokenId()#

static getMetadataDetailsForTokenId<T>(tokenId, metadataArr): TokenMetadataDetails<T> | undefined

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:253

Returns the { metadata, uri, tokenIds, customData } metadata object from the TokenMetadataDetails<bigint>[] for a specific tokenId.

If the tokenId does not exist in the TokenMetadataDetails<bigint>[], returns undefined.

Type Parameters#

T#

T extends NumberType

Parameters#

tokenId#

T

metadataArr#

TokenMetadataDetails<T>[]

Returns#

TokenMetadataDetails<T> | undefined

getMetadataForTokenId()#

static getMetadataForTokenId<T>(tokenId, metadataArr): Metadata<T> | undefined

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:270

Returns the metadata from the TokenMetadataDetails<bigint>[] for a specific tokenId.

If the tokenId does not exist in the TokenMetadataDetails<bigint>[], returns undefined.

Type Parameters#

T#

T extends NumberType

Parameters#

tokenId#

T

metadataArr#

TokenMetadataDetails<T>[]

Returns#

Metadata<T> | undefined

removeTokenMetadata()#

static removeTokenMetadata<T>(currTokenMetadata, tokenIds): TokenMetadataDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:134

Removes the metadata from the TokenMetadataDetails<bigint>[] for specific token IDs.

Note that this function does not mutate the metadataArr, but instead returns a new one.

Type Parameters#

T#

T extends NumberType

Parameters#

currTokenMetadata#

TokenMetadataDetails<T>[]

tokenIds#

UintRange<T>[]

Returns#

TokenMetadataDetails<T>[]

setMetadataPropertyForSpecificIds()#

static setMetadataPropertyForSpecificIds<T>(metadataArr, tokenIds, key, value): TokenMetadataDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:284

For each tokenId in tokenIds, populates the metadata array with the given key, value JSON property pair.

If you want to update the entire metadata (not just a specific key value pair), use updateTokenMetadata instead.

This is typically used when customizing or creating a token.

Type Parameters#

T#

T extends NumberType

Parameters#

metadataArr#

TokenMetadataDetails<T>[]

tokenIds#

UintRange<T>[]

key#

string

value#

any

Returns#

TokenMetadataDetails<T>[]

Example#

Use this function to set the "name" property of all tokens to "test" via setMetadataPropertyForAll(metadataArr, tokenIds, uri, "name", "test")

updateTokenMetadata()#

static updateTokenMetadata<T>(currTokenMetadata, newTokenMetadataDetails): TokenMetadataDetails<T>[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:156

Update the metadataArr with the given metadata and tokenIds fetched from the given uri.

Note that this function does not mutate the metadataArr, but instead returns a new one.

Type Parameters#

T#

T extends NumberType

Parameters#

currTokenMetadata#

TokenMetadataDetails<T>[]

newTokenMetadataDetails#

TokenMetadataDetails<T>

Returns#

TokenMetadataDetails<T>[]