Class BadgeMetadata<T>

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

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

Index

Constructors

constructor

Properties

badgeIds customData uri

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromJson fromJsonString fromProto getFirstMatches

Constructors

constructor

new BadgeMetadata<T>(badgeMetadata): BadgeMetadata<T>
Type Parameters
- T extends NumberType
Parameters
- badgeMetadata: iBadgeMetadata<T>
Returns BadgeMetadata<T>
Overrides BaseNumberTypeClass.constructor
- Defined in src/core/misc.ts:53

Properties

badgeIds

badgeIds: UintRangeArray<T>

The badge IDs corresponding to the URI.

customData

customData: string

Arbitrary custom data that can be stored on-chain

uri

uri: string

The URI where to fetch the badge metadata from.

Methods

clone

clone(): BadgeMetadata<T>
Deep copies the object and returns a new instance.

Returns BadgeMetadata<T>
Inherited from BaseNumberTypeClass.clone
- Defined in src/common/base.ts:121

convert

convert(convertFunction, options?): BadgeMetadata
Converts the object to a different NumberType equivalent.
Type Parameters
- U extends NumberType
Parameters
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: ConvertOptions
Returns BadgeMetadata
Overrides BaseNumberTypeClass.convert
- Defined in src/core/misc.ts:60

equals

equals(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
- U extends CustomType
Parameters
- other: undefined | null | CustomType
- OptionalnormalizeNumberTypes: boolean
Returns boolean
Inherited from BaseNumberTypeClass.equals
- Defined in src/common/base.ts:117

getNumberFieldNames

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

Returns string[]
Inherited from BaseNumberTypeClass.getNumberFieldNames
- Defined in src/common/base.ts:127

hasNumberFields

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

Returns boolean
Inherited from BaseNumberTypeClass.hasNumberFields
- Defined in src/common/base.ts:131

toJson

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

Returns JsonObject
Inherited from BaseNumberTypeClass.toJson
- Defined in src/common/base.ts:109

toJsonString

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

Returns string
Inherited from BaseNumberTypeClass.toJsonString
- Defined in src/common/base.ts:113

toProto

toProto(): proto.badges.BadgeMetadata
Returns proto.badges.BadgeMetadata
- Defined in src/core/misc.ts:70

`Static`fromJson

fromJson(jsonValue, convertFunction, options?): BadgeMetadata
Type Parameters
- U extends NumberType
Parameters
- jsonValue: JsonValue
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns BadgeMetadata
- Defined in src/core/misc.ts:78

`Static`fromJsonString

fromJsonString(jsonString, convertFunction, options?): BadgeMetadata
Type Parameters
- U extends NumberType
Parameters
- jsonString: string
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
- Optionaloptions: Partial<JsonReadOptions>
Returns BadgeMetadata
- Defined in src/core/misc.ts:86

`Static`fromProto

fromProto(item, convertFunction): BadgeMetadata
Type Parameters
- U extends NumberType
Parameters
- item: proto.badges.BadgeMetadata
- convertFunction: ((item: NumberType) => U)
 - - (item): U
 - Parameters
 item: NumberType
 Returns U
Returns BadgeMetadata
- Defined in src/core/misc.ts:94

`Static`getFirstMatches

getFirstMatches<T>(badgeMetadata): BadgeMetadata<T>[]
Get first matches for the badge metadata (i.e. if there are duplicated badge IDs, we take the first match in a linear search).
Type Parameters
- T extends NumberType
Parameters
- badgeMetadata: BadgeMetadata<T>[]
Returns BadgeMetadata<T>[]
- Defined in src/core/misc.ts:105

Class BadgeMetadata<T>

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BadgeMetadata<T>

Properties

badgeIds

customData

uri

Methods

clone

Returns BadgeMetadata<T>

convert

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadata<U>

equals

Type Parameters

Parameters

Returns boolean

getNumberFieldNames

Returns string[]

hasNumberFields

Returns boolean

toJson

Returns JsonObject

toJsonString

Returns string

toProto

Returns proto.badges.BadgeMetadata

StaticfromJson

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadata<U>

StaticfromJsonString

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadata<U>

StaticfromProto

Type Parameters

Parameters

Parameters

Returns U

Returns BadgeMetadata<U>

StaticgetFirstMatches

Type Parameters

Parameters

Returns BadgeMetadata<T>[]

Settings

On This Page

`Static`fromJson

`Static`fromJsonString

`Static`fromProto

`Static`getFirstMatches