Class: MerkleChallenge<T>

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

MerkleChallenge is used to represent a merkle challenge for an approval.

Extends#

• BaseNumberTypeClass<MerkleChallenge<T>>

Extended by#

• MerkleChallengeWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iMerkleChallenge<T>

Constructors#

Constructor#

new MerkleChallenge<T>(merkleChallenge): MerkleChallenge<T>

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

Parameters#

merkleChallenge#

iMerkleChallenge<T>

Returns#

MerkleChallenge<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

challengeTrackerId#

challengeTrackerId: string

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

Tracker ID details for the merkle challenge.

Implementation of#

iMerkleChallenge.challengeTrackerId

---

customData#

customData: string

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

Arbitrary custom data that can be stored on-chain.

Implementation of#

iMerkleChallenge.customData

---

expectedProofLength#

expectedProofLength: T

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

The expected proof length of the merkle proof.

Implementation of#

iMerkleChallenge.expectedProofLength

---

leafSigner#

leafSigner: string

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

The signer of the leaf. Currently only supports ETH addresses.

Implementation of#

iMerkleChallenge.leafSigner

---

maxUsesPerLeaf#

maxUsesPerLeaf: T

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

Whether or not to enforce max uses per leaf. Used to prevent replay attacks.

Implementation of#

iMerkleChallenge.maxUsesPerLeaf

---

root#

root: string

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

The root of the merkle tree.

Implementation of#

iMerkleChallenge.root

---

uri#

uri: string

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

The URI where to fetch the merkle challenge metadata from.

Implementation of#

iMerkleChallenge.uri

---

useCreatorAddressAsLeaf#

useCreatorAddressAsLeaf: boolean

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

Whether or not to override any leaf value and use the creator address as the leaf. Used for whitelist trees.

Implementation of#

iMerkleChallenge.useCreatorAddressAsLeaf

Methods#

clone()#

clone(): MerkleChallenge

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

Deep copies the object and returns a new instance.

Returns#

MerkleChallenge

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

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

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(): MerkleChallenge

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

Returns#

MerkleChallenge

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MerkleChallenge<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

MerkleChallenge<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

MerkleChallenge

convertFunction#

(item) => U

Returns#

MerkleChallenge<U>

---

required()#

static required(): MerkleChallenge<NumberType>

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

Returns#

MerkleChallenge<NumberType>