Class: SiwbbChallenge<T>

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:42

Extends#

• BaseNumberTypeClass<SiwbbChallenge<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iSiwbbChallenge<T>

Constructors#

Constructor#

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

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:52

Parameters#

data#

iSiwbbChallenge<T>

Returns#

SiwbbChallenge<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

address#

address: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:43

The user's address

Implementation of#

iSiwbbChallenge.address

---

bitbadgesAddress#

bitbadgesAddress: string

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:46

The converted BitBadges address of params.address. This can be used as the unique identifier for the user (e.g. avoid duplicate sign ins from equivalent 0x and bb1 addresses).

Implementation of#

iSiwbbChallenge.bitbadgesAddress

---

chain#

chain: SupportedChain

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:44

The chain of the address

Implementation of#

iSiwbbChallenge.chain

---

ownershipRequirements?#

optional ownershipRequirements?: SiwbbAssetConditionGroup<T>

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:45

The ownership requirements for the user

Implementation of#

iSiwbbChallenge.ownershipRequirements

---

verificationResponse?#

optional verificationResponse?: object

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:47

Verification response

errorMessage?#

optional errorMessage?: string

success#

success: boolean

Implementation of#

iSiwbbChallenge.verificationResponse

Methods#

clone()#

clone(): SiwbbChallenge

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

Deep copies the object and returns a new instance.

Returns#

SiwbbChallenge

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

Defined in: packages/bitbadgesjs-sdk/src/core/blockin.ts:69

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(val) => U

options?#

ConvertOptions

Returns#

SiwbbChallenge<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