Class: ETHSignatureProof

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

ETHSignatureProof is used to represent an Ethereum signature proof. The ETH signature proof is used to prove that a specific nonce was signed by an Ethereum address.

Extends#

• CustomTypeClass<ETHSignatureProof>

Implements#

• iETHSignatureProof

Constructors#

Constructor#

new ETHSignatureProof(ethSignatureProof): ETHSignatureProof

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

Parameters#

ethSignatureProof#

iETHSignatureProof

Returns#

ETHSignatureProof

Overrides#

CustomTypeClass.constructor

Properties#

nonce#

nonce: string

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

The nonce that was signed. The signature scheme is ETHSign(nonce + "-" + creatorAddress).

Implementation of#

iETHSignatureProof.nonce

---

signature#

signature: string

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

The Ethereum signature of the nonce.

Implementation of#

iETHSignatureProof.signature

Methods#

clone()#

clone(): ETHSignatureProof

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

Deep copies the object and returns a new instance.

Returns#

ETHSignatureProof

Overrides#

CustomTypeClass.clone

---

convert()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

ETHSignatureProof

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

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

Returns#

ETHSignatureProof

---

fromJson()#

static fromJson(jsonValue, options?): ETHSignatureProof

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

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

ETHSignatureProof

---

fromJsonString()#

static fromJsonString(jsonString, options?): ETHSignatureProof

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

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

ETHSignatureProof

---

fromProto()#

static fromProto(item): ETHSignatureProof

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

Parameters#

item#

ETHSignatureProof

Returns#

ETHSignatureProof

---

required()#

static required(): ETHSignatureProof

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

Returns#

ETHSignatureProof