Class TokenMetadataDetails<T>

Constructors

constructor

new TokenMetadataDetails<T extends NumberType>(
data: iTokenMetadataDetails<T>,
): TokenMetadataDetails<T>
Type Parameters
- T extends NumberType
Parameters
- data: iTokenMetadataDetails<T>
Returns TokenMetadataDetails<T>
Overrides BaseNumberTypeClass.constructor
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:111

Properties

customData

customData: string

Custom data

`Optional`fetchedUri

fetchedUri?: string

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

`Optional`metadata

metadata?: Metadata<T>

The metadata fetched by the URI

tokenIds

tokenIds: UintRangeArray<T>

The token IDs that correspond to the metadata

`Optional`toUploadToIpfs

toUploadToIpfs?: boolean

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

uri

uri: string

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})

Methods

clone

clone(): TokenMetadataDetails
Deep copies the object and returns a new instance.

Returns TokenMetadataDetails
Inherited from BaseNumberTypeClass.clone
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:151

convert

convert(
convertFunction: (item: NumberType) => U,
options?: ConvertOptions,
): TokenMetadataDetails
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: (item: NumberType) => U
- Optionaloptions: ConvertOptions
Returns TokenMetadataDetails
Overrides BaseNumberTypeClass.convert
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:125

equals

equals>(
other: undefined | null | CustomType,
normalizeNumberTypes?: boolean,
): 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
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:147

getNumberFieldNames

getNumberFieldNames(): string[]
Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns string[]
Overrides BaseNumberTypeClass.getNumberFieldNames
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:121

hasNumberFields

hasNumberFields(): boolean
Checks if the object has number fields.

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:161

toJson

toJson(): JsonObject
Converts the object to a JSON object with all primitive types.

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:139

toJsonString

toJsonString(): string
Converts the object to a JSON string.

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/common/base.ts:143

toProto

toProto(): badges.TokenMetadata
Returns badges.TokenMetadata
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:337

`Static`batchUpdateTokenMetadata

batchUpdateTokenMetadata<T extends NumberType>(
currTokenMetadata: TokenMetadataDetails<T>[],
newTokenMetadataDetailsArr: TokenMetadataDetails<T>[],
): TokenMetadataDetails<T>[]
Batch update the metadataArr with the given metadata and tokenIds fetched from the given
Type Parameters
- T extends NumberType
Parameters
- currTokenMetadata: TokenMetadataDetails<T>[]
- newTokenMetadataDetailsArr: TokenMetadataDetails<T>[]
Returns TokenMetadataDetails<T>[]
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:166

`Static`getMetadataDetailsForTokenId

getMetadataDetailsForTokenId<T extends NumberType>(
tokenId: T,
metadataArr: TokenMetadataDetails<T>[],
): undefined | TokenMetadataDetails<T>
Returns the { metadata, uri, tokenIds, customData } metadata object from the TokenMetadataDetails[] for a specific tokenId.

If the tokenId does not exist in the TokenMetadataDetails[], returns undefined.
Type Parameters
- T extends NumberType
Parameters
- tokenId: T
- metadataArr: TokenMetadataDetails<T>[]
Returns undefined | TokenMetadataDetails<T>
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:253

`Static`getMetadataForTokenId

getMetadataForTokenId<T extends NumberType>(
tokenId: T,
metadataArr: TokenMetadataDetails<T>[],
): undefined | Metadata<T>
Returns the metadata from the TokenMetadataDetails[] for a specific tokenId.

If the tokenId does not exist in the TokenMetadataDetails[], returns undefined.
Type Parameters
- T extends NumberType
Parameters
- tokenId: T
- metadataArr: TokenMetadataDetails<T>[]
Returns undefined | Metadata<T>
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:270

`Static`removeTokenMetadata

removeTokenMetadata<T extends NumberType>(
currTokenMetadata: TokenMetadataDetails<T>[],
tokenIds: UintRange<T>[],
): TokenMetadataDetails<T>[]
Removes the metadata from the TokenMetadataDetails[] for specific token IDs.

Note that this function does not mutate the metadataArr, but instead returns a new one.
Type Parameters
- T extends NumberType
Parameters
- currTokenMetadata: TokenMetadataDetails<T>[]
- tokenIds: UintRange<T>[]
Returns TokenMetadataDetails<T>[]
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:134

`Static`setMetadataPropertyForSpecificIds

setMetadataPropertyForSpecificIds<T extends NumberType>(
 metadataArr: TokenMetadataDetails<T>[],
 tokenIds: UintRange<T>[],
 key: string,
 value: any,
): TokenMetadataDetails<T>[]
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 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")
```
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:284

`Static`updateTokenMetadata

updateTokenMetadata<T extends NumberType>(
currTokenMetadata: TokenMetadataDetails<T>[],
newTokenMetadataDetails: TokenMetadataDetails<T>,
): TokenMetadataDetails<T>[]
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 extends NumberType
Parameters
- currTokenMetadata: TokenMetadataDetails<T>[]
- newTokenMetadataDetails: TokenMetadataDetails<T>
Returns TokenMetadataDetails<T>[]
- Defined in CompSci/bitbadges/bitbadgesjs/packages/bitbadgesjs-sdk/src/api-indexer/metadata/tokenMetadata.ts:156

Class TokenMetadataDetails<T>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TokenMetadataDetails<T>

Properties

customData

OptionalfetchedUri

Optionalmetadata

tokenIds

OptionaltoUploadToIpfs

uri

Methods

clone

Returns TokenMetadataDetails

convert

Type Parameters

Parameters

Returns TokenMetadataDetails<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns badges.TokenMetadata

StaticbatchUpdateTokenMetadata

Type Parameters

Parameters

Returns TokenMetadataDetails<T>[]

StaticgetMetadataDetailsForTokenId

Type Parameters

Parameters

Returns undefined | TokenMetadataDetails<T>

StaticgetMetadataForTokenId

Type Parameters

Parameters

Returns undefined | Metadata<T>

StaticremoveTokenMetadata

Type Parameters

Parameters

Returns TokenMetadataDetails<T>[]

StaticsetMetadataPropertyForSpecificIds

Type Parameters

Parameters

Returns TokenMetadataDetails<T>[]

Example

StaticupdateTokenMetadata

Type Parameters

Parameters

Returns TokenMetadataDetails<T>[]

Settings

On This Page

`Optional`fetchedUri

`Optional`metadata

`Optional`toUploadToIpfs

`Static`batchUpdateTokenMetadata

`Static`getMetadataDetailsForTokenId

`Static`getMetadataForTokenId

`Static`removeTokenMetadata

`Static`setMetadataPropertyForSpecificIds

`Static`updateTokenMetadata