Class Secp256k1Authority

constructor

• new Secp256k1Authority(data: Uint8Array, roleId?: number): Secp256k1Authority

  Parameters

  • data: Uint8Array
  • OptionalroleId: number

  Returns Secp256k1Authority

type

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>

publicKeyBytes

• get publicKeyBytes(): Uint8Array

  Returns Uint8Array

publicKeyString

• get publicKeyString(): string

  Returns string

secp256k1Address

• get secp256k1Address(): Uint8Array<ArrayBufferLike>

  20-byte Secp256k1 address

  Returns Uint8Array<ArrayBufferLike>

secp256k1AddressString

• get secp256k1AddressString(): string

  Secp256k1 0x-prefixed address string

  Returns string

secp256k1PublicKey

• get secp256k1PublicKey(): Uint8Array<ArrayBufferLike>

  33-byte Secp256k1 compressed publickey bytes

  Returns Uint8Array<ArrayBufferLike>

secp256k1PublicKeyString

• get secp256k1PublicKeyString(): string

  Secp256k1 compressed publickey 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>

addAuthority

• 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

    • options: InstructionDataOptions

      InstructionDataOptions

    • payer: PublicKey

      The public key of the swig payer.

    • swigAddress: PublicKey

      The public key of the swig

  Returns Promise<TransactionInstruction>

  AddAuthority Instruction.

create

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

createAuthorityData

• 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

odometer

• odometer(): number

  Returns number

removeAuthority

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

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

sign

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

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

subAccountCreate

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

subAccountSign

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

subAccountToggle

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

subAccountWithdrawSol

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

subAccountWithdrawToken

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

StaticfromPublicKey

• fromPublicKey(pk: string | Uint8Array<ArrayBufferLike>): Secp256k1Authority

  Parameters

  • pk: string | Uint8Array<ArrayBufferLike>

  Returns Secp256k1Authority

StaticfromPublicKeyBytes

• fromPublicKeyBytes(pkBytes: Uint8Array): Secp256k1Authority

  Parameters

  • pkBytes: Uint8Array

  Returns Secp256k1Authority

StaticfromPublicKeyString

• fromPublicKeyString(pkString: string): Secp256k1Authority

  Parameters

  • pkString: string

  Returns Secp256k1Authority