Class PermissionAccount

A Switchboard account representing a permission or privilege granted by one account signer to another account.

Hierarchy

PermissionAccount

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PermissionAccount(params: AccountParams): PermissionAccount

- Defined in src/sbv2.ts:1685
PermissionAccount constructor

Parameters
- params: AccountParams
  
  initialization params.
Returns PermissionAccount

Properties

Optional keypair

keypair?: Keypair

program

program: Program<Idl>

publicKey

publicKey: PublicKey

Methods

isPermissionEnabled

isPermissionEnabled(permission: SwitchboardPermissionValue): Promise<boolean>

- Defined in src/sbv2.ts:1706
Check if a specific permission is enabled on this permission account

Parameters
- permission: SwitchboardPermissionValue
Returns Promise<boolean>

loadData

loadData(): Promise<any>

- Defined in src/sbv2.ts:1718
Load and parse PermissionAccount data based on the program IDL.

Returns Promise<any>
PermissionAccount data parsed in accordance with the Switchboard IDL.

set

set(params: PermissionSetParams): Promise<string>

- Defined in src/sbv2.ts:1803
Sets the permission in the PermissionAccount

Parameters
- params: PermissionSetParams
Returns Promise<string>
TransactionSignature.

setTx

setTx(params: PermissionSetParams): Promise<Transaction>

- Defined in src/sbv2.ts:1834
Sets the permission in the PermissionAccount

Parameters
- params: PermissionSetParams
Returns Promise<Transaction>
TransactionSignature.

setVoterWeight

setVoterWeight(params: PermissionSetVoterWeightParams): Promise<string>

- Defined in src/sbv2.ts:1867
Parameters
- params: PermissionSetVoterWeightParams
Returns Promise<string>

setVoterWeightTx

setVoterWeightTx(params: PermissionSetVoterWeightParams): Promise<Transaction>

- Defined in src/sbv2.ts:1879
Parameters
- params: PermissionSetVoterWeightParams
Returns Promise<Transaction>

size

size(): number

- Defined in src/sbv2.ts:1729
Get the size of a PermissionAccount on chain.

Returns number
size.

Static create

create(program: Program<Idl>, params: PermissionInitParams): Promise<PermissionAccount>

- Defined in src/sbv2.ts:1739
Create and initialize the PermissionAccount.

Parameters
- program: Program<Idl>
  
  Switchboard program representation holding connection and IDL.
- params: PermissionInitParams
Returns Promise<PermissionAccount>
newly generated PermissionAccount.

Static fromSeed

fromSeed(program: Program<Idl>, authority: PublicKey, granter: PublicKey, grantee: PublicKey): [PermissionAccount, number]

- Defined in src/sbv2.ts:1780
Loads a PermissionAccount from the expected PDA seed format.

Parameters
- program: Program<Idl>
- authority: PublicKey
  
  The authority pubkey to be incorporated into the account seed.
- granter: PublicKey
  
  The granter pubkey to be incorporated into the account seed.
- grantee: PublicKey
  
  The grantee pubkey to be incorporated into the account seed.
Returns [PermissionAccount, number]
PermissionAccount and PDA bump.

Generated using TypeDoc