Class ApprovalCriteria<T>

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

Type Parameters

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties

approvalAmounts? coinTransfers? maxNumTransfers? merkleChallenges? mustOwnBadges? overridesFromOutgoingApprovals? overridesToIncomingApprovals? predeterminedBalances? requireFromDoesNotEqualInitiatedBy? requireFromEqualsInitiatedBy? requireToDoesNotEqualInitiatedBy? requireToEqualsInitiatedBy? zkProofs?

Methods

clone convert equals getNumberFieldNames hasNumberFields toJson toJsonString toProto fromJson fromJsonString fromProto

Constructors

constructor

Properties

OptionalapprovalAmounts

approvalAmounts?: ApprovalAmounts<T>

The maximum approved amounts for this approval.

OptionalcoinTransfers

coinTransfers?: iCoinTransfer<T>[]

The $BADGE transfers to be executed upon every approval.

OptionalmaxNumTransfers

maxNumTransfers?: MaxNumTransfers<T>

The max num transfers for this approval.

OptionalmerkleChallenges

merkleChallenges?: MerkleChallenge<T>[]

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

OptionalmustOwnBadges

mustOwnBadges?: MustOwnBadges<T>[]

The list of badges to be owned to be approved. Must have on-chain balances.

OptionaloverridesFromOutgoingApprovals

overridesFromOutgoingApprovals?: boolean

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

OptionaloverridesToIncomingApprovals

overridesToIncomingApprovals?: boolean

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

OptionalpredeterminedBalances

predeterminedBalances?: PredeterminedBalances<T>

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

OptionalrequireFromDoesNotEqualInitiatedBy

requireFromDoesNotEqualInitiatedBy?: boolean

Whether the from address must not equal the initiatedBy address.

OptionalrequireFromEqualsInitiatedBy

requireFromEqualsInitiatedBy?: boolean

Whether the from address must equal the initiatedBy address.

OptionalrequireToDoesNotEqualInitiatedBy

requireToDoesNotEqualInitiatedBy?: boolean

Whether the to address must not equal the initiatedBy address.

OptionalrequireToEqualsInitiatedBy

requireToEqualsInitiatedBy?: boolean

Whether the to address must equal the initiatedBy address.

OptionalzkProofs

zkProofs?: ZkProof[]

The list of ZK proofs that need to be satisfied. One use per proof solution.

Methods

clone

convert

equals

  • equals<U extends CustomType<U>>(
        other: undefined | null | CustomType<U>,
        normalizeNumberTypes?: boolean,
    ): boolean

    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

    Parameters

    • other: undefined | null | CustomType<U>
    • OptionalnormalizeNumberTypes: boolean

    Returns boolean

getNumberFieldNames

hasNumberFields

toJson

toJsonString

toProto

StaticfromJson

StaticfromJsonString

StaticfromProto

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR