Class Role

Readonlyactions

Readonlyauthority

ReadonlyswigAddress

ReadonlyswigId

authorityType

• get authorityType(): AuthorityType

  Returns AuthorityType

id

• get id(): number

  role id

  Returns number

canManageAuthority

• canManageAuthority(): boolean

  check if the role can manage authorities

  Returns boolean

  booean

canSpendSol

• canSpendSol(amount?: bigint): boolean

  Check if the role has the pemission to spend sol at all, or more than the limit if amount is provided

  Parameters

  • Optionalamount: bigint

    The amount of role should be able to spend

  Returns boolean

  boolean

canSpendSolMax

• canSpendSolMax(): boolean

  Check if the role can spend any amount of SOL

  Returns boolean

  boolean

canSpendToken

• canSpendToken(mint: PublicKey, amount?: bigint): boolean

  Check if the role has the pemission to spend a given token at all, or more than the limit if amount is provided

  Parameters

  • mint: PublicKey

    token mint
  • Optionalamount: bigint

    amount the role should be able to spend

  Returns boolean

canSpendTokenMax

• canSpendTokenMax(mint: PublicKey): boolean

  Check if the role has the permission to spend any amount of the given token

  Parameters

  • mint: PublicKey

    token mint

  Returns boolean

  boolean

canUseProgram

• canUseProgram(programId: PublicKey): boolean

  Check if the authority can use a program

  Parameters

  • programId: PublicKey

    Program Id of the program to check

  Returns boolean

isRoot

• isRoot(): boolean

  Check if the role has root permission

  Returns boolean

  boolean

isSessionBased

• isSessionBased(): this is SessionBasedRole

  Check if the role has a session based authority

  Returns this is SessionBasedRole

  boolean

isTokenBased

• isTokenBased(): this is TokenBasedRole

  Check if the role has a token based authority

  Returns this is TokenBasedRole

  boolean

solSpend

• solSpend(): SpendController

  Get Sol SpendController for the actions

  Returns SpendController

  SpendController

solSpendLimit

• solSpendLimit(): null | bigint

  Gets the spend limit for a SOL. Return null if the spend is uncapped.

  Returns null | bigint

  bigint | null

tokenSpend

• tokenSpend(mint: PublicKey): SpendController

  Get Token SpendController for the actions

  Parameters

  • mint: PublicKey

    Token mint

  Returns SpendController

  SpendController

tokenSpendLimit

• tokenSpendLimit(mint: PublicKey): null | bigint

  Gets the spend limit for a given token mint. Return null if the spend is uncapped.

  Parameters

  • mint: PublicKey

    Token mint

  Returns null | bigint

  bigint | null

Staticfrom

• from(
      swigAddress: PublicKey,
      position: Position,
      roleData: Uint8Array,
      swigId: Uint8Array,
  ): Role

  Parameters

  • swigAddress: PublicKey
  • position: Position
  • roleData: Uint8Array
  • swigId: Uint8Array

  Returns Role