Class Authority

Interface that should be implemented by ABI serializable objects.

Hierarchy-Diagram

UML class diagram of Authority
Legend
icon for a class in the UML class diagram class
icon for a public method in the UML class diagram public method
underlined static property/method

Hierarchy (view full)

Properties

accounts keys threshold waits abiBase abiFields abiName

Accessors

keyThreshold waitThreshold structFields

Methods

equals hasPermission keyWeight sort from

Properties

accounts

accounts: PermissionLevelWeight[]

keys

keys: KeyWeight[]

threshold

threshold: UInt32

waits

waits: WaitWeight[]

Static abiBase

abiBase: ABISerializableConstructor

Static abiFields

abiFields: ABIField[]

Static abiName

abiName: string = '__struct'

Accessors

keyThreshold

  • get keyThreshold(): number

  • Weight a key needs to sign for this authority.

    Returns number

waitThreshold

Static structFields

  • get structFields(): ABIField[]

  • Returns ABIField[]

Methods

equals

  • equals(other): boolean

  • Return true if this struct equals the other.

    Note: This compares the ABI encoded bytes of both structs, subclasses should implement their own fast equality check when possible.

    Parameters

    • other: any

    Returns boolean

hasPermission

  • hasPermission(publicKey, includePartial?): boolean

  • Check if given public key has permission in this authority,

    Parameters

    • publicKey: PublicKeyType

      The key to check.

    • includePartial: boolean = false

      Whether to consider auths where the key is included but can't be reached alone (e.g. multisig).

    Returns boolean

    Attention

    Does not take indirect permissions for the key via account weights into account.

keyWeight

  • keyWeight(publicKey): number

  • Return the weight for given public key, or zero if it is not included in this authority.

    Parameters

    Returns number

sort

  • sort(): void

  • Sorts the authority weights in place, should be called before including the authority in a updateauth action or it might be rejected.

    Returns void

Static from

Settings

Member Visibility

Theme

On This Page

accountskeysthresholdwaitsabiBaseabiFieldsabiNamekeyThresholdwaitThresholdstructFieldsequalshasPermissionkeyWeightsortfrom