Class: OutgoingApprovalCriteria<T>

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

OutgoingApprovalCriteria represents the details of an outgoing approval.

Extends#

• BaseNumberTypeClass<OutgoingApprovalCriteria<T>>

Extended by#

• OutgoingApprovalCriteriaWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iOutgoingApprovalCriteria<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iOutgoingApprovalCriteria<T>

Returns#

OutgoingApprovalCriteria<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

altTimeChecks?#

optional altTimeChecks?: AltTimeChecks<T>

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

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

Implementation of#

iOutgoingApprovalCriteria.altTimeChecks

---

approvalAmounts?#

optional approvalAmounts?: ApprovalAmounts<T>

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

The maximum approved amounts for this approval.

Implementation of#

iOutgoingApprovalCriteria.approvalAmounts

---

autoDeletionOptions?#

optional autoDeletionOptions?: AutoDeletionOptions<T>

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

Whether the approval should be deleted after one use.

Implementation of#

iOutgoingApprovalCriteria.autoDeletionOptions

---

coinTransfers?#

optional coinTransfers?: CoinTransfer<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.coinTransfers

---

dynamicStoreChallenges?#

optional dynamicStoreChallenges?: DynamicStoreChallenge<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.dynamicStoreChallenges

---

ethSignatureChallenges?#

optional ethSignatureChallenges?: ETHSignatureChallenge[]

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

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

Implementation of#

iOutgoingApprovalCriteria.ethSignatureChallenges

---

evmQueryChallenges?#

optional evmQueryChallenges?: EVMQueryChallenge<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.evmQueryChallenges

---

initiatorChecks?#

optional initiatorChecks?: AddressChecks

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

Address checks for initiator

Implementation of#

iOutgoingApprovalCriteria.initiatorChecks

---

maxNumTransfers?#

optional maxNumTransfers?: MaxNumTransfers<T>

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

The max num transfers for this approval.

Implementation of#

iOutgoingApprovalCriteria.maxNumTransfers

---

merkleChallenges?#

optional merkleChallenges?: MerkleChallenge<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.merkleChallenges

---

mustOwnTokens?#

optional mustOwnTokens?: MustOwnTokens<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.mustOwnTokens

---

mustPrioritize?#

optional mustPrioritize?: boolean

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

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

Implementation of#

iOutgoingApprovalCriteria.mustPrioritize

---

predeterminedBalances?#

optional predeterminedBalances?: PredeterminedBalances<T>

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

The predetermined balances for each transfer. These allow approvals to use predetermined balance amounts rather than an incrementing tally system.

Implementation of#

iOutgoingApprovalCriteria.predeterminedBalances

---

recipientChecks?#

optional recipientChecks?: AddressChecks

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

Address checks for recipient

Implementation of#

iOutgoingApprovalCriteria.recipientChecks

---

requireToDoesNotEqualInitiatedBy?#

optional requireToDoesNotEqualInitiatedBy?: boolean

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

Whether the to address must not equal the initiatedBy address.

Implementation of#

iOutgoingApprovalCriteria.requireToDoesNotEqualInitiatedBy

---

requireToEqualsInitiatedBy?#

optional requireToEqualsInitiatedBy?: boolean

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

Whether the to address must equal the initiatedBy address.

Implementation of#

iOutgoingApprovalCriteria.requireToEqualsInitiatedBy

---

votingChallenges?#

optional votingChallenges?: VotingChallenge<T>[]

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

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

Implementation of#

iOutgoingApprovalCriteria.votingChallenges

Methods#

castToCollectionApprovalCriteria()#

castToCollectionApprovalCriteria(): ApprovalCriteria<T>

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

Returns#

ApprovalCriteria<T>

---

clone()#

clone(): OutgoingApprovalCriteria

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

Deep copies the object and returns a new instance.

Returns#

OutgoingApprovalCriteria

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

OutgoingApprovalCriteria<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): OutgoingApprovalCriteria<T>

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

Parameters#

prefix#

string

Returns#

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

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

Returns#

OutgoingApprovalCriteria

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

OutgoingApprovalCriteria<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

OutgoingApprovalCriteria<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

OutgoingApprovalCriteria

convertFunction#

(item) => U

Returns#

OutgoingApprovalCriteria<U>