Options
All
  • Public
  • Public/Protected
  • All
Menu

Module AuthorityToSet

Index

Properties

Functions

Properties

accounts

accounts: PermissionLevelWeight[]

keys

keys: KeyWait[]

threshold

threshold: number

waits

waits: WeightWait[]

Functions

explicitAuthorities

  • A function to build the Authority to update

    Parameters

    • threshold: number

      The threshold required from associated PermissionLevelsWeights, KeyLevelWeights and WaitWeights to activate this auth.

    • Default value permissionLevelWeights: PermissionLevelWeight[] = []

      The PermissionLevelWeights to contribute to this auth

    • Default value keyWeights: KeyWait[] = []

      The KeyLevelWeights to contribute to this auth

    • Default value waitWeights: WeightWait[] = []

      The WaitWeights to contribute to this auth If the threshold is set to high for it to be satisfied by the associated permissionWeights the updateAuth action will assert.

    Returns AuthorityToSet

forAccount

  • Convenience function to get an AuthorityToSet for a given user with a named permission. Typical usecase for this would be when assigning the control of one account's permission to a different controlling account. eg. A bookkeeper account should be given pay permission on a treasury account. This function would supply the AuthorityToSet for a bookkeeper with their active permission into the updateAuth function.

    Parameters

    • account: Account

      Account to hold the new authority

    • permission: string

      The name of the new authority to be added to account

    Returns AuthorityToSet

forContractCode

Generated using TypeDoc