Class Secp256r1Authority

constructor

• new Secp256r1Authority(data: Uint8Array): Secp256r1Authority

  Parameters

  • data: Uint8Array

  Returns Secp256r1Authority

type

address

• get address(): Uint8Array<ArrayBufferLike>

  The address that identifies this Authority.

  For Ed25519/ProgramExec: the public key bytes. For Secp256k1: the 20-byte Ethereum address derived from the public key. For Secp256r1: the compressed public key bytes.

  Returns Uint8Array<ArrayBufferLike>

addressString

• get addressString(): string

  String representation of the authority address.

  For Ed25519/ProgramExec: base58 encoded. For Secp256k1/Secp256r1: unprefixed hex.

  Returns string

id

• get id(): Uint8Array<ArrayBufferLike>

  This is the ID for the Authority.

  This would usually the data that represents the Authority

  For TokenBasedAuthority, it is either a Ed25519 or Secp256k1 Public Key.

  For SessionBasedAuthority, It could be public key bytes, groth16 proof etc.

  Returns Uint8Array<ArrayBufferLike>

  Deprecated

  Use address instead

publicKeyBytes

• get publicKeyBytes(): Uint8Array

  Returns Uint8Array

publicKeyString

• get publicKeyString(): string

  Returns string

secp256r1PublicKey

• get secp256r1PublicKey(): Uint8Array<ArrayBufferLike>

  33-byte Secp256r1 compressed publickey bytes

  Returns Uint8Array<ArrayBufferLike>

secp256r1PublicKeyString

• get secp256r1PublicKeyString(): string

  Returns string

signer

• get signer(): Uint8Array<ArrayBufferLike>

  This is the Signer ID for the Authority.

  This would usually the public key bytes that identifies the signer on behalf of the authority,

  For TokenBasedAuthority, it is either a Ed25519 or Secp256k1 Public Key.

  For SessionBasedAuthority, it is the Session Key.

  Returns Uint8Array<ArrayBufferLike>

  Deprecated

  Use signerAddress instead

signerAddress

• get signerAddress(): Uint8Array<ArrayBufferLike>

  The address that identifies the signer acting on behalf of this Authority.

  For TokenBasedAuthority: same as address. For SessionBasedAuthority: the session key bytes.

  Returns Uint8Array<ArrayBufferLike>

signerAddressString

• get signerAddressString(): string

  String representation of the signerAddress.

  For TokenBasedAuthority: same as addressString. For SessionBasedAuthority: base58 encoded session key.

  Returns string

addAuthority

• 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

    • options: InstructionDataOptions

      InstructionDataOptions

    • payer: SolPublicKeyData

      The public key of the swig payer.

    • swigAddress: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  AddAuthority Instruction.

closeSwig

• closeSwig(
      args: {
          destination: SolPublicKeyData;
          options: InstructionDataOptions;
          roleId: number;
          swigAddress: SolPublicKeyData;
          swigSystemAddress: SolPublicKeyData;
      },
  ): Promise<SwigInstructionContext>

  Creates a CloseSwig instruction that closes the swig account and wallet address PDA, transferring all remaining lamports to the destination.

  Requires All or ManageAuthority permission. Both the swig account and wallet address PDA must have only rent-exempt minimum lamports (no excess SOL).

  The account is resized to 1 byte with a ClosedSwigAccount discriminator to prevent rehydration attacks.

  Parameters

  • args: {
        destination: SolPublicKeyData;
        options: InstructionDataOptions;
        roleId: number;
        swigAddress: SolPublicKeyData;
        swigSystemAddress: SolPublicKeyData;
    }

  Returns Promise<SwigInstructionContext>

closeTokenAccount

• closeTokenAccount(
      args: {
          destination: SolPublicKeyData;
          options: InstructionDataOptions;
          roleId: number;
          swigAddress: SolPublicKeyData;
          swigSystemAddress: SolPublicKeyData;
          tokenAccounts: SolPublicKeyData[];
          tokenProgram: SolPublicKeyData;
      },
  ): Promise<SwigInstructionContext>

  Creates a CloseTokenAccount instruction that closes token accounts owned by the swig wallet address, transferring rent to the destination.

  Requires All or ManageAuthority permission. Token accounts must have zero balance before closing.

  Parameters

  • args: {
        destination: SolPublicKeyData;
        options: InstructionDataOptions;
        roleId: number;
        swigAddress: SolPublicKeyData;
        swigSystemAddress: SolPublicKeyData;
        tokenAccounts: SolPublicKeyData[];
        tokenProgram: SolPublicKeyData;
    }

  Returns Promise<SwigInstructionContext>

odometer

• odometer(): number

  Returns number

removeAuthority

• 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.

    • options: 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.

sign

• 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.

    • options: 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.

signV2

• signV2(
      args: {
          innerInstructions: SolInstruction[];
          options: InstructionDataOptions;
          payer: SolPublicKeyData;
          roleId: number;
          swigAddress: SolPublicKeyData;
          swigSystemAddress: 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;
        swigSystemAddress: SolPublicKeyData;
    }

    The parameters required to create the Swig instruction.

    • innerInstructions: SolInstruction[]

      The instructions the Swig is to sign.

    • options: 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

    • swigSystemAddress: SolPublicKeyData

  Returns Promise<SwigInstructionContext>

  Sign Instruction.

subAccountCreate

• 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>

subAccountSign

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountToggle

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

  Parameters

  • args: {
        actingRoleId: number;
        enabled: boolean;
        options: InstructionDataOptions;
        payer: SolPublicKeyData;
        subAccount: SolPublicKeyData;
        subAccountRoleId: number;
        swigAddress: SolPublicKeyData;
    }

  Returns Promise<SwigInstructionContext>

subAccountWithdrawSol

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountWithdrawToken

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

transferAssets

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

updateAuthority

• updateAuthority(
      args: {
          options: InstructionDataOptions;
          payer: SolPublicKeyData;
          roleId: number;
          roleIdToUpdate: number;
          swigAddress: SolPublicKeyData;
          updateActionsInfo: UpdateAuthorityActionsInfo;
      },
  ): Promise<SwigInstructionContext>

  Creates an UpdateAuthority Instructon

  Parameters

  • args: {
        options: InstructionDataOptions;
        payer: SolPublicKeyData;
        roleId: number;
        roleIdToUpdate: number;
        swigAddress: SolPublicKeyData;
        updateActionsInfo: UpdateAuthorityActionsInfo;
    }

    The parameters required for RemoveAuthority instruction.

    • options: InstructionDataOptions

      InstructionDataOptions

    • payer: SolPublicKeyData

      The public key of the swig payer.

    • roleId: number

      The ID of the role signing the instruction.

    • roleIdToUpdate: number

      ID of the role to remove

    • swigAddress: SolPublicKeyData

      The public key of the swig account

    • updateActionsInfo: UpdateAuthorityActionsInfo

  Returns Promise<SwigInstructionContext>

  RemoveAuthority Instruction.