Class: IncomingApprovalCriteria<T>

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

IncomingApprovalCriteria represents the details of an incoming approval.

Extends#

• BaseNumberTypeClass<IncomingApprovalCriteria<T>>

Extended by#

• IncomingApprovalCriteriaWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iIncomingApprovalCriteria<T>

Constructors#

Constructor#

new IncomingApprovalCriteria<T>(msg): IncomingApprovalCriteria<T>

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

Parameters#

msg#

iIncomingApprovalCriteria<T>

Returns#

IncomingApprovalCriteria<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

altTimeChecks?#

optional altTimeChecks?: AltTimeChecks<T>

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

Alternative time-based checks for approval denial (offline hours/days).

Implementation of#

iIncomingApprovalCriteria.altTimeChecks

---

approvalAmounts?#

optional approvalAmounts?: ApprovalAmounts<T>

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

The maximum approved amounts for this approval.

Implementation of#

iIncomingApprovalCriteria.approvalAmounts

---

autoDeletionOptions?#

optional autoDeletionOptions?: AutoDeletionOptions<T>

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

Whether the approval should be deleted after one use.

Implementation of#

iIncomingApprovalCriteria.autoDeletionOptions

---

coinTransfers?#

optional coinTransfers?: CoinTransfer<T>[]

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

The BADGE or sdk.coin transfers to be executed upon every approval.

Implementation of#

iIncomingApprovalCriteria.coinTransfers

---

dynamicStoreChallenges?#

optional dynamicStoreChallenges?: DynamicStoreChallenge<T>[]

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

The list of dynamic store challenges that the initiator must pass for approval.

Implementation of#

iIncomingApprovalCriteria.dynamicStoreChallenges

---

ethSignatureChallenges?#

optional ethSignatureChallenges?: ETHSignatureChallenge[]

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

The list of ETH signature challenges that the initiator must pass for approval.

Implementation of#

iIncomingApprovalCriteria.ethSignatureChallenges

---

evmQueryChallenges?#

optional evmQueryChallenges?: EVMQueryChallenge<T>[]

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

EVM query challenges that must pass for approval. Read-only contract queries that verify external EVM state.

Implementation of#

iIncomingApprovalCriteria.evmQueryChallenges

---

initiatorChecks?#

optional initiatorChecks?: AddressChecks

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

Address checks for initiator

Implementation of#

iIncomingApprovalCriteria.initiatorChecks

---

maxNumTransfers?#

optional maxNumTransfers?: MaxNumTransfers<T>

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

The max num transfers for this approval.

Implementation of#

iIncomingApprovalCriteria.maxNumTransfers

---

merkleChallenges?#

optional merkleChallenges?: MerkleChallenge<T>[]

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

The list of merkle challenges that need valid proofs to be approved.

Implementation of#

iIncomingApprovalCriteria.merkleChallenges

---

mustOwnTokens?#

optional mustOwnTokens?: MustOwnTokens<T>[]

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

The list of must own tokens that need valid proofs to be approved.

Implementation of#

iIncomingApprovalCriteria.mustOwnTokens

---

mustPrioritize?#

optional mustPrioritize?: boolean

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

If true, this approval must be explicitly prioritized in PrioritizedApprovals to be used.

Implementation of#

iIncomingApprovalCriteria.mustPrioritize

---

predeterminedBalances?#

optional predeterminedBalances?: PredeterminedBalances<T>

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

The predetermined balances for each transfer using this approval.

Implementation of#

iIncomingApprovalCriteria.predeterminedBalances

---

requireFromDoesNotEqualInitiatedBy?#

optional requireFromDoesNotEqualInitiatedBy?: boolean

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

Whether the from address must not equal the initiatedBy address.

Implementation of#

iIncomingApprovalCriteria.requireFromDoesNotEqualInitiatedBy

---

requireFromEqualsInitiatedBy?#

optional requireFromEqualsInitiatedBy?: boolean

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

Whether the from address must equal the initiatedBy address.

Implementation of#

iIncomingApprovalCriteria.requireFromEqualsInitiatedBy

---

senderChecks?#

optional senderChecks?: AddressChecks

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

Address checks for sender

Implementation of#

iIncomingApprovalCriteria.senderChecks

---

votingChallenges?#

optional votingChallenges?: VotingChallenge<T>[]

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

The list of voting challenges that must be satisfied for approval.

Implementation of#

iIncomingApprovalCriteria.votingChallenges

Methods#

castToCollectionApprovalCriteria()#

castToCollectionApprovalCriteria(): ApprovalCriteria<T>

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

Returns#

ApprovalCriteria<T>

---

clone()#

clone(): IncomingApprovalCriteria

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

Deep copies the object and returns a new instance.

Returns#

IncomingApprovalCriteria

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

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

---

toBech32Addresses()#

toBech32Addresses(prefix): IncomingApprovalCriteria<T>

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

Parameters#

prefix#

string

Returns#

IncomingApprovalCriteria<T>

---

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

---

toProto()#

toProto(): IncomingApprovalCriteria

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

Returns#

IncomingApprovalCriteria

---

fromJson()#

static fromJson<U>(jsonValue, convertFunction, options?): IncomingApprovalCriteria<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

IncomingApprovalCriteria<U>

---

fromJsonString()#

static fromJsonString<U>(jsonString, convertFunction, options?): IncomingApprovalCriteria<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

IncomingApprovalCriteria<U>

---

fromProto()#

static fromProto<U>(item, convertFunction): IncomingApprovalCriteria<U>

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

IncomingApprovalCriteria

convertFunction#

(item) => U

Returns#

IncomingApprovalCriteria<U>