Class: ApprovalCriteria<T>

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

ApprovalCriteria represents the criteria for an approval. The approvee must satisfy all of the criteria to be approved.

Extends#

• BaseNumberTypeClass<ApprovalCriteria<T>>

Extended by#

• ApprovalCriteriaWithDetails

Type Parameters#

T#

T extends NumberType

Implements#

• iApprovalCriteria<T>

Constructors#

Constructor#

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

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

Parameters#

msg#

iApprovalCriteria<T>

Returns#

ApprovalCriteria<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

allowBackedMinting?#

optional allowBackedMinting?: boolean

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

If true, this collection approval allows backed minting operations (CosmosCoinBackedPath). When false, this approval cannot be used for transfers involving backed minting addresses. This prevents accidental allowances when toListIds is "All".

Implementation of#

iApprovalCriteria.allowBackedMinting

---

allowSpecialWrapping?#

optional allowSpecialWrapping?: boolean

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

If true, this collection approval allows special wrapping operations (CosmosCoinWrapperPath). When false, this approval cannot be used for transfers involving wrapping addresses. This prevents accidental allowances when toListIds is "All".

Implementation of#

iApprovalCriteria.allowSpecialWrapping

---

altTimeChecks?#

optional altTimeChecks?: AltTimeChecks<T>

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

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

Implementation of#

iApprovalCriteria.altTimeChecks

---

approvalAmounts?#

optional approvalAmounts?: ApprovalAmounts<T>

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

The maximum approved amounts for this approval.

Implementation of#

iApprovalCriteria.approvalAmounts

---

autoDeletionOptions?#

optional autoDeletionOptions?: AutoDeletionOptions<T>

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

Whether the approval should be deleted after one use.

Implementation of#

iApprovalCriteria.autoDeletionOptions

---

coinTransfers?#

optional coinTransfers?: CoinTransfer<T>[]

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

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

Implementation of#

iApprovalCriteria.coinTransfers

---

dynamicStoreChallenges?#

optional dynamicStoreChallenges?: DynamicStoreChallenge<T>[]

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

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

Implementation of#

iApprovalCriteria.dynamicStoreChallenges

---

ethSignatureChallenges?#

optional ethSignatureChallenges?: ETHSignatureChallenge[]

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

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

Implementation of#

iApprovalCriteria.ethSignatureChallenges

---

evmQueryChallenges?#

optional evmQueryChallenges?: EVMQueryChallenge<T>[]

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

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

Implementation of#

iApprovalCriteria.evmQueryChallenges

---

initiatorChecks?#

optional initiatorChecks?: AddressChecks

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

Address checks for initiator

Implementation of#

iApprovalCriteria.initiatorChecks

---

maxNumTransfers?#

optional maxNumTransfers?: MaxNumTransfers<T>

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

The max num transfers for this approval.

Implementation of#

iApprovalCriteria.maxNumTransfers

---

merkleChallenges?#

optional merkleChallenges?: MerkleChallenge<T>[]

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

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

Implementation of#

iApprovalCriteria.merkleChallenges

---

mustOwnTokens?#

optional mustOwnTokens?: MustOwnTokens<T>[]

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

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

Implementation of#

iApprovalCriteria.mustOwnTokens

---

mustPrioritize?#

optional mustPrioritize?: boolean

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

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

Implementation of#

iApprovalCriteria.mustPrioritize

---

overridesFromOutgoingApprovals?#

optional overridesFromOutgoingApprovals?: boolean

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

Whether this approval overrides the from address's approved outgoing transfers.

Implementation of#

iApprovalCriteria.overridesFromOutgoingApprovals

---

overridesToIncomingApprovals?#

optional overridesToIncomingApprovals?: boolean

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

Whether this approval overrides the to address's approved incoming transfers.

Implementation of#

iApprovalCriteria.overridesToIncomingApprovals

---

predeterminedBalances?#

optional predeterminedBalances?: PredeterminedBalances<T>

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

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

Implementation of#

iApprovalCriteria.predeterminedBalances

---

recipientChecks?#

optional recipientChecks?: AddressChecks

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

Address checks for recipient

Implementation of#

iApprovalCriteria.recipientChecks

---

requireFromDoesNotEqualInitiatedBy?#

optional requireFromDoesNotEqualInitiatedBy?: boolean

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

Whether the from address must not equal the initiatedBy address.

Implementation of#

iApprovalCriteria.requireFromDoesNotEqualInitiatedBy

---

requireFromEqualsInitiatedBy?#

optional requireFromEqualsInitiatedBy?: boolean

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

Whether the from address must equal the initiatedBy address.

Implementation of#

iApprovalCriteria.requireFromEqualsInitiatedBy

---

requireToDoesNotEqualInitiatedBy?#

optional requireToDoesNotEqualInitiatedBy?: boolean

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

Whether the to address must not equal the initiatedBy address.

Implementation of#

iApprovalCriteria.requireToDoesNotEqualInitiatedBy

---

requireToEqualsInitiatedBy?#

optional requireToEqualsInitiatedBy?: boolean

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

Whether the to address must equal the initiatedBy address.

Implementation of#

iApprovalCriteria.requireToEqualsInitiatedBy

---

senderChecks?#

optional senderChecks?: AddressChecks

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

Address checks for sender

Implementation of#

iApprovalCriteria.senderChecks

---

userApprovalSettings?#

optional userApprovalSettings?: UserApprovalSettings<T>

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

Issuer-imposed constraints on user-level approvals. Includes royalties, allowed denoms, and coin transfer restrictions.

Implementation of#

iApprovalCriteria.userApprovalSettings

---

votingChallenges?#

optional votingChallenges?: VotingChallenge<T>[]

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

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

Implementation of#

iApprovalCriteria.votingChallenges

Methods#

clone()#

clone(): ApprovalCriteria

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

Deep copies the object and returns a new instance.

Returns#

ApprovalCriteria

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

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

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

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

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

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

Parameters#

prefix#

string

Returns#

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

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

Returns#

ApprovalCriteria

---

fromJson()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonValue#

JsonValue

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

ApprovalCriteria<U>

---

fromJsonString()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

jsonString#

string

convertFunction#

(item) => U

options?#

Partial<JsonReadOptions>

Returns#

ApprovalCriteria<U>

---

fromProto()#

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

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

Type Parameters#

U#

U extends NumberType

Parameters#

item#

ApprovalCriteria

convertFunction#

(item) => U

Returns#

ApprovalCriteria<U>