Class: TokenMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:72

TokenMetadata is used to represent the metadata for a range of token IDs. The metadata can be hosted via a URI (via uri) or stored on-chain (via customData).

We take first-match only for the token IDs. If a token ID is in multiple TokenMetadata, we take the first match in a linear search.

Extends#

• BaseNumberTypeClass<TokenMetadata<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iTokenMetadata<T>

Constructors#

Constructor#

new TokenMetadata<T>(tokenMetadata): TokenMetadata<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:77

Parameters#

tokenMetadata#

iTokenMetadata<T>

Returns#

TokenMetadata<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

customData#

customData: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:75

Arbitrary custom data that can be stored on-chain

Implementation of#

iTokenMetadata.customData

---

tokenIds#

tokenIds: UintRangeArray<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:74

The token IDs corresponding to the URI.

Implementation of#

iTokenMetadata.tokenIds

---

uri#

uri: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:73

The URI where to fetch the token metadata from.

Implementation of#

iTokenMetadata.uri

Methods#

clone()#

clone(): TokenMetadata

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

Deep copies the object and returns a new instance.

Returns#

TokenMetadata

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:84

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

TokenMetadata<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/common/base.ts:157

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

Returns#

string[]

Inherited from#

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/core/misc.ts:94

Returns#

TokenMetadata

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): TokenMetadata<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:102

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

TokenMetadata<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): TokenMetadata<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:110

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

TokenMetadata<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): TokenMetadata<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:118

Type Parameters#

U#

U extends NumberType

Parameters#

item#

TokenMetadata

convertFunction#

(item) => U

Returns#

TokenMetadata<U>

---

getFirstMatches()#

static getFirstMatches<T>(tokenMetadata): TokenMetadata<T>[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:129

Get first matches for the token metadata (i.e. if there are duplicated token IDs, we take the first match in a linear search).

Type Parameters#

T#

T extends NumberType

Parameters#

tokenMetadata#

TokenMetadata<T>[]

Returns#

TokenMetadata<T>[]