Class: GetReservedClaimCodesSuccessResponse

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:808

Extends#

• CustomTypeClass<GetReservedClaimCodesSuccessResponse>

Implements#

• iGetReservedClaimCodesSuccessResponse

Constructors#

Constructor#

new GetReservedClaimCodesSuccessResponse(data): GetReservedClaimCodesSuccessResponse

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:815

Parameters#

data#

iGetReservedClaimCodesSuccessResponse

Returns#

GetReservedClaimCodesSuccessResponse

Overrides#

CustomTypeClass.constructor

Properties#

leafSignatures?#

optional leafSignatures?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:813

The leaf signatures for the reserved claim codes to prove address <-> leaf mapping.

Implementation of#

iGetReservedClaimCodesSuccessResponse.leafSignatures

---

reservedCodes?#

optional reservedCodes?: string[]

Defined in: packages/bitbadgesjs-sdk/src/api-indexer/requests/requests.ts:812

The previously reserved claim codes for the user. These are what are used in the eventual on-chain merkle proof to complete the transaction.

Implementation of#

iGetReservedClaimCodesSuccessResponse.reservedCodes

Methods#

clone()#

clone(): GetReservedClaimCodesSuccessResponse

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

Deep copies the object and returns a new instance.

Returns#

GetReservedClaimCodesSuccessResponse

Inherited from#

CustomTypeClass.clone

---

convert()#

convert<U>(_convertFunction?, options?): CustomType<any>

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

Type Parameters#

U#

U extends NumberType

Parameters#

_convertFunction?#

(val) => U

options?#

ConvertOptions

Returns#

CustomType<any>

Deprecated#

This function is unnecessary as this field has no numeric types. Please use the .clone() method instead.

Inherited from#

CustomTypeClass.convert

---

equals()#

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

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

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#

CustomTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

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

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

Returns#

string[]

Inherited from#

CustomTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

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

Checks if the object has number fields.

Returns#

boolean

Inherited from#

CustomTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

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

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

Returns#

JsonObject

Inherited from#

CustomTypeClass.toJson

---

toJsonString()#

toJsonString(): string

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

Converts the object to a JSON string.

Returns#

string

Inherited from#

CustomTypeClass.toJsonString