Class: AddressChecks

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

AddressChecks defines checks for address types (EVM contract, liquidity pool, etc.)

Extends#

• CustomTypeClass<AddressChecks>

Implements#

• iAddressChecks

Constructors#

Constructor#

new AddressChecks(msg): AddressChecks

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

Parameters#

msg#

iAddressChecks

Returns#

AddressChecks

Overrides#

CustomTypeClass.constructor

Properties#

mustBeEvmContract?#

optional mustBeEvmContract?: boolean

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

Require the address to be an EVM contract (has code).

Implementation of#

iAddressChecks.mustBeEvmContract

---

mustBeLiquidityPool?#

optional mustBeLiquidityPool?: boolean

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

Require the address to be a liquidity pool.

Implementation of#

iAddressChecks.mustBeLiquidityPool

---

mustNotBeEvmContract?#

optional mustNotBeEvmContract?: boolean

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

Require the address to not be an EVM contract (no code).

Implementation of#

iAddressChecks.mustNotBeEvmContract

---

mustNotBeLiquidityPool?#

optional mustNotBeLiquidityPool?: boolean

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

Require the address to not be a liquidity pool.

Implementation of#

iAddressChecks.mustNotBeLiquidityPool

Methods#

clone()#

clone(): AddressChecks

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

Deep copies the object and returns a new instance.

Returns#

AddressChecks

Inherited from#

CustomTypeClass.clone

---

convert()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

AddressChecks

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

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

Returns#

AddressChecks

---

fromJson()#

static fromJson(jsonValue, options?): AddressChecks

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

Parameters#

jsonValue#

JsonValue

options?#

Partial<JsonReadOptions>

Returns#

AddressChecks

---

fromJsonString()#

static fromJsonString(jsonString, options?): AddressChecks

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

Parameters#

jsonString#

string

options?#

Partial<JsonReadOptions>

Returns#

AddressChecks

---

fromProto()#

static fromProto(item): AddressChecks

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

Parameters#

item#

AddressChecks

Returns#

AddressChecks