Class TokenBasedAuthorityAbstract

data

Abstractid

Abstractsigner

Abstracttype

AbstractaddAuthority

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

  Creates an AddAuthority Instructon

  Parameters

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

    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: SolPublicKeyData

      The public key of the swig payer.

    • swigAddress: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  AddAuthority Instruction.

isEqual

• isEqual(other: Authority): boolean

  Check two Authority are partially equal

  Parameters

  • other: Authority

  Returns boolean

matchesSigner

• matchesSigner(signer: Uint8Array): boolean

  Check two Authority has the same signer.

  Parameters

  • signer: Uint8Array

  Returns boolean

AbstractremoveAuthority

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

  Creates an RemoveAuthority Instructon

  Parameters

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

    The parameters required for RemoveAuthority instruction.

    • Optionaloptions?: InstructionDataOptions

      InstructionDataOptions

    • payer: SolPublicKeyData

      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: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  RemoveAuthority Instruction.

Abstractsign

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

  Creates a Sign instruction for signing provided instructions with the Swig

  Parameters

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

    The parameters required to create the Swig instruction.

    • innerInstructions: SolInstruction[]

      The instructions the Swig is to sign.

    • Optionaloptions?: InstructionDataOptions

      InstructionDataOptions

    • payer: SolPublicKeyData

      The public key of the swig payer.

    • roleId: number

      The ID of the role signing the instruction.

    • swigAddress: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  Sign Instruction.

AbstractsubAccountCreate

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

AbstractsubAccountSign

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

AbstractsubAccountToggle

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

AbstractsubAccountWithdrawSol

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

AbstractsubAccountWithdrawToken

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

  Parameters

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

  Returns Promise<SwigInstructionContext>