Class: ETHSignatureChallenge

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

ETHSignatureChallenge is used to represent an Ethereum signature challenge for an approval.

Extends#

• CustomTypeClass<ETHSignatureChallenge>

Implements#

• iETHSignatureChallenge

Constructors#

Constructor#

new ETHSignatureChallenge(ethSignatureChallenge): ETHSignatureChallenge

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

Parameters#

ethSignatureChallenge#

iETHSignatureChallenge

Returns#

ETHSignatureChallenge

Overrides#

CustomTypeClass.constructor

Properties#

challengeTrackerId#

challengeTrackerId: string

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

The ID of this ETH signature challenge for tracking the number of uses per signature.

Implementation of#

iETHSignatureChallenge.challengeTrackerId

---

customData#

customData: string

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

Arbitrary custom data associated with this ETH signature challenge.

Implementation of#

iETHSignatureChallenge.customData

---

signer#

signer: string

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

The Ethereum address that must sign the nonce for verification.

Implementation of#

iETHSignatureChallenge.signer

---

uri#

uri: string

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

The URI associated with this ETH signature challenge, optionally providing metadata about the challenge.

Implementation of#

iETHSignatureChallenge.uri

Methods#

clone()#

clone(): ETHSignatureChallenge

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

Deep copies the object and returns a new instance.

Returns#

ETHSignatureChallenge

Overrides#

CustomTypeClass.clone

---

convert()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ETHSignatureChallenge

Deprecated#

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

Overrides#

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

---

toProto()#

toProto(): ETHSignatureChallenge

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

Returns#

ETHSignatureChallenge

---

fromJson()#

static fromJson(jsonValue, options?): ETHSignatureChallenge

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

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

ETHSignatureChallenge

---

fromJsonString()#

static fromJsonString(jsonString, options?): ETHSignatureChallenge

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

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

ETHSignatureChallenge

---

fromProto()#

static fromProto(item): ETHSignatureChallenge

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

Parameters#

item#

ETHSignatureChallenge

Returns#

ETHSignatureChallenge

---

required()#

static required(): ETHSignatureChallenge

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

Returns#

ETHSignatureChallenge