Class: ChallengeDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1971

Extends#

• BaseNumberTypeClass<ChallengeDetails<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iChallengeDetails<T>

Constructors#

Constructor#

new ChallengeDetails<T>(data): ChallengeDetails<T>

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1980

Parameters#

data#

iChallengeDetails<T>

Returns#

ChallengeDetails<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

isHashed#

isHashed: boolean

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1975

True if the leaves are hashed. Hash(preimage[i]) = leaves[i]

Implementation of#

iChallengeDetails.isHashed

---

leaves#

leaves: string[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1974

The leaves of the Merkle tree. Leaves should be considered public. Use preimages for the private codes + isHashed. For whitelist trees, these can be the plaintext BitBadges addresses.

Implementation of#

iChallengeDetails.leaves

---

numLeaves?#

optional numLeaves?: T

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1973

The number of leaves in the Merkle tree. This takes priority over leaves.length if defined (used for buffer time between leaf generation and leaf length select)

Implementation of#

iChallengeDetails.numLeaves

---

preimages?#

optional preimages?: string[]

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1976

The preimages of the leaves (only used if isHashed = true). Oftentimes, this is used for private codes so should not be present when user-facing.

Implementation of#

iChallengeDetails.preimages

---

seedCode?#

optional seedCode?: string

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1977

Seed code for generating the leaves

Implementation of#

iChallengeDetails.seedCode

---

tree?#

optional tree?: MerkleTree

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1978

The Merkle tree

Implementation of#

iChallengeDetails.tree

---

treeOptions?#

optional treeOptions?: Options

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1972

The Merkle tree options for how to build it

Implementation of#

iChallengeDetails.treeOptions

Methods#

clone()#

clone(): ChallengeDetails

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

Deep copies the object and returns a new instance.

Returns#

ChallengeDetails

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/approvals.ts:1994

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ChallengeDetails<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/approvals.ts:1990

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