Class AuthorityAbstract

constructor

• new Authority(data: Uint8Array, roleId: null | number): Authority

  Parameters

  • data: Uint8Array
  • roleId: null | number

  Returns Authority

data

Abstractid

roleId

Abstractsession

Abstractsigner

Abstracttype

createAuthorityInfo

• get createAuthorityInfo(): AuthorityCreateInfo

  Data required to create a new authority.

  this is usually used when creating a new Role from an unitialized authority, with the AddInstruction

  Returns AuthorityCreateInfo

AbstractaddAuthority

• addAuthority(
      args: {
          actingRoleId: number;
          actions: Actions;
          newAuthorityInfo: CreateAuthorityInfo;
          options?: InstructionDataOptions;
          payer: PublicKey;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Creates an AddAuthority Instructon

  Parameters

  • args: {
        actingRoleId: number;
        actions: Actions;
        newAuthorityInfo: CreateAuthorityInfo;
        options?: InstructionDataOptions;
        payer: PublicKey;
        swigAddress: PublicKey;
    }

    The parameters required to create the Swig instruction.

    • actingRoleId: number

      The ID of the role signing the instruction.

    • actions: Actions

      Actions of the new authority

    • newAuthorityInfo: CreateAuthorityInfo

      CreateAuthorityInfo of new Authority to add

    • Optionaloptions?: InstructionDataOptions

      InstructionDataOptions

    • payer: PublicKey

      The public key of the swig payer.

    • swigAddress: PublicKey

      The public key of the swig

  Returns Promise<TransactionInstruction>

  AddAuthority Instruction.

Abstractcreate

• create(
      args: { actions: Actions; id: Uint8Array; payer: PublicKey },
  ): TransactionInstruction

  Creates a Swig instruction for initializing a new entity on-chain.

  Parameters

  • args: { actions: Actions; id: Uint8Array; payer: PublicKey }

    The parameters required to create the Swig instruction.

    • actions: Actions

      A container holding the set of actions to include. *

    • id: Uint8Array

      32-bytes Uint8Array.

    • payer: PublicKey

      The public key of the account paying for the transaction.

  Returns TransactionInstruction

  The serialized instruction for creating the Swig.

AbstractcreateAuthorityData

• createAuthorityData(): Uint8Array

  Data required to create a new authority.

  this is usually used when creating a new Role from an unitialized authority, with the AddInstruction

  Returns Uint8Array

isEqual

• isEqual(other: Authority): boolean

  Check two Authority are partially equal

  Parameters

  • other: Authority

  Returns boolean

isInitialized

• isInitialized(): boolean

  Authority is initilized if a role id is assigned

  Returns boolean

  boolean

matchesSigner

• matchesSigner(signer: Uint8Array): boolean

  Check two Authority has the same signer.

  Parameters

  • signer: Uint8Array

  Returns boolean

AbstractremoveAuthority

• removeAuthority(
      args: {
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          roleIdToRemove: number;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Creates an RemoveAuthority Instructon

  Parameters

  • args: {
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        roleIdToRemove: number;
        swigAddress: PublicKey;
    }

    The parameters required for RemoveAuthority instruction.

    • Optionaloptions?: InstructionDataOptions

      InstructionDataOptions

    • payer: PublicKey

      The public key of the swig payer.

    • roleId: number

      The ID of the role signing the instruction.

    • roleIdToRemove: number

      ID of the role to remove

    • swigAddress: PublicKey

      The public key of the swig

  Returns Promise<TransactionInstruction>

  RemoveAuthority Instruction.

Abstractsign

• sign(
      args: {
          innerInstructions: TransactionInstruction[];
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Creates a Sign instruction for signing provided instructions with the Swig

  Parameters

  • args: {
        innerInstructions: TransactionInstruction[];
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        swigAddress: PublicKey;
    }

    The parameters required to create the Swig instruction.

    • innerInstructions: TransactionInstruction[]

      The instructions the Swig is to sign.

    • Optionaloptions?: InstructionDataOptions

      InstructionDataOptions

    • payer: PublicKey

      The public key of the swig payer.

    • roleId: number

      The ID of the role signing the instruction.

    • swigAddress: PublicKey

      The public key of the swig

  Returns Promise<TransactionInstruction>

  Sign Instruction.

AbstractsubAccountCreate

• subAccountCreate(
      args: {
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          swigAddress: PublicKey;
          swigId: Uint8Array;
      },
  ): Promise<TransactionInstruction>

  Parameters

  • args: {
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        swigAddress: PublicKey;
        swigId: Uint8Array;
    }

  Returns Promise<TransactionInstruction>

AbstractsubAccountSign

• subAccountSign(
      args: {
          innerInstructions: TransactionInstruction[];
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          subAccount: PublicKey;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Parameters

  • args: {
        innerInstructions: TransactionInstruction[];
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        subAccount: PublicKey;
        swigAddress: PublicKey;
    }

  Returns Promise<TransactionInstruction>

AbstractsubAccountToggle

• subAccountToggle(
      args: {
          enabled: boolean;
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          subAccount: PublicKey;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Parameters

  • args: {
        enabled: boolean;
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        subAccount: PublicKey;
        swigAddress: PublicKey;
    }

  Returns Promise<TransactionInstruction>

AbstractsubAccountWithdrawSol

• subAccountWithdrawSol(
      args: {
          amount: bigint;
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          subAccount: PublicKey;
          swigAddress: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Parameters

  • args: {
        amount: bigint;
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        subAccount: PublicKey;
        swigAddress: PublicKey;
    }

  Returns Promise<TransactionInstruction>

AbstractsubAccountWithdrawToken

• subAccountWithdrawToken(
      args: {
          amount: bigint;
          mint: PublicKey;
          options?: InstructionDataOptions;
          payer: PublicKey;
          roleId: number;
          subAccount: PublicKey;
          swigAddress: PublicKey;
          tokenProgram?: PublicKey;
      },
  ): Promise<TransactionInstruction>

  Parameters

  • args: {
        amount: bigint;
        mint: PublicKey;
        options?: InstructionDataOptions;
        payer: PublicKey;
        roleId: number;
        subAccount: PublicKey;
        swigAddress: PublicKey;
        tokenProgram?: PublicKey;
    }

  Returns Promise<TransactionInstruction>