Class: IncomingApprovalCriteriaWithDetails<T>

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

Extends#

• IncomingApprovalCriteria<T>

Type Parameters#

T#

T extends NumberType

Implements#

• iIncomingApprovalCriteriaWithDetails<T>

Constructors#

Constructor#

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

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

Parameters#

data#

iIncomingApprovalCriteriaWithDetails<T>

Returns#

IncomingApprovalCriteriaWithDetails<T>

Overrides#

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

iIncomingApprovalCriteriaWithDetails.altTimeChecks

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.approvalAmounts

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.autoDeletionOptions

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.coinTransfers

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.dynamicStoreChallenges

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.ethSignatureChallenges

Inherited from#

IncomingApprovalCriteria.ethSignatureChallenges

---

evmQueryChallenges?#

optional evmQueryChallenges?: EVMQueryChallengeWithDetails<T>[]

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

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

Implementation of#

iIncomingApprovalCriteriaWithDetails.evmQueryChallenges

Overrides#

IncomingApprovalCriteria.evmQueryChallenges

---

initiatorChecks?#

optional initiatorChecks?: AddressChecks

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

Address checks for initiator

Implementation of#

iIncomingApprovalCriteriaWithDetails.initiatorChecks

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.maxNumTransfers

Inherited from#

IncomingApprovalCriteria.maxNumTransfers

---

merkleChallenges?#

optional merkleChallenges?: MerkleChallengeWithDetails<T>[]

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

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

Implementation of#

iIncomingApprovalCriteriaWithDetails.merkleChallenges

Overrides#

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

iIncomingApprovalCriteriaWithDetails.mustOwnTokens

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.mustPrioritize

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.predeterminedBalances

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.requireFromDoesNotEqualInitiatedBy

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.requireFromEqualsInitiatedBy

Inherited from#

IncomingApprovalCriteria.requireFromEqualsInitiatedBy

---

senderChecks?#

optional senderChecks?: AddressChecks

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

Address checks for sender

Implementation of#

iIncomingApprovalCriteriaWithDetails.senderChecks

Inherited from#

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

iIncomingApprovalCriteriaWithDetails.votingChallenges

Inherited from#

IncomingApprovalCriteria.votingChallenges

Methods#

castToCollectionApprovalCriteria()#

castToCollectionApprovalCriteria(): ApprovalCriteriaWithDetails<T>

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

Returns#

ApprovalCriteriaWithDetails<T>

Overrides#

IncomingApprovalCriteria.castToCollectionApprovalCriteria

---

clone()#

clone(): IncomingApprovalCriteriaWithDetails<T>

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

Deep copies the object and returns a new instance.

Returns#

IncomingApprovalCriteriaWithDetails<T>

Overrides#

IncomingApprovalCriteria.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

IncomingApprovalCriteriaWithDetails<U>

Overrides#

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

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

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

IncomingApprovalCriteria.hasNumberFields

---

toBech32Addresses()#

toBech32Addresses(prefix): IncomingApprovalCriteria<T>

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

Parameters#

prefix#

string

Returns#

IncomingApprovalCriteria<T>

Inherited from#

IncomingApprovalCriteria.toBech32Addresses

---

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#

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

IncomingApprovalCriteria.toJsonString

---

toProto()#

toProto(): IncomingApprovalCriteria

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

Returns#

IncomingApprovalCriteria

Inherited from#

IncomingApprovalCriteria.toProto

---

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>

Inherited from#

IncomingApprovalCriteria.fromJson

---

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>

Inherited from#

IncomingApprovalCriteria.fromJsonString

---

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>

Inherited from#

IncomingApprovalCriteria.fromProto