Class Ed25519SessionAuthority

constructor

• new Ed25519SessionAuthority(data: Uint8Array): Ed25519SessionAuthority

  Parameters

  • data: Uint8Array

  Returns Ed25519SessionAuthority

data

type

address

• get address(): SolPublicKey

  Returns SolPublicKey

ed25519PublicKey

• get ed25519PublicKey(): SolPublicKey

  Returns SolPublicKey

expirySlot

• get expirySlot(): bigint

  Slot when the session expires

  Returns bigint

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>

maxDuration

• get maxDuration(): bigint

  Max duration on a session

  Returns bigint

publicKey

• get publicKey(): SolPublicKey

  Returns SolPublicKey

sessionKey

• get sessionKey(): SolPublicKey

  Ed25519 based Public Key as Session key

  Returns SolPublicKey

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;
          payer: SolPublicKeyData;
          swigAddress: SolPublicKeyData;
      },
  ): Promise<SwigInstructionContext>

  Creates an AddAuthority Instructon

  Parameters

  • args: {
        actingRoleId: number;
        actions: Actions;
        newAuthorityInfo: CreateAuthorityInfo;
        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

    • payer: SolPublicKeyData

      The public key of the swig payer.

    • swigAddress: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  AddAuthority Instruction.

createSession

• createSession(
      args: {
          newSessionKey: SolPublicKeyData;
          payer: SolPublicKeyData;
          roleId: number;
          sessionDuration?: bigint;
          swigAddress: SolPublicKeyData;
      },
  ): Promise<SwigInstructionContext>

  Creates an CreateSession Instructon

  Parameters

  • args: {
        newSessionKey: SolPublicKeyData;
        payer: SolPublicKeyData;
        roleId: number;
        sessionDuration?: bigint;
        swigAddress: SolPublicKeyData;
    }

    The parameters required to create the Swig instruction.

    • newSessionKey: SolPublicKeyData

      Ed25519 Public key of the Session key

    • payer: SolPublicKeyData

      The public key of the swig payer.

    • roleId: number

      The ID of the role signing the instruction.

    • OptionalsessionDuration?: bigint

      Session duration in slots

    • swigAddress: SolPublicKeyData

      The public key of the swig

  Returns Promise<SwigInstructionContext>

  AddAuthority Instruction.

removeAuthority

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

  Creates an RemoveAuthority Instructon

  Parameters

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

    The parameters required for RemoveAuthority instruction.

    • 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[];
          payer: SolPublicKeyData;
          roleId: number;
          swigAddress: SolPublicKeyData;
      },
  ): Promise<SwigInstructionContext>

  Creates a Sign instruction for signing provided instructions with the Swig

  Parameters

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

    The parameters required to create the Swig instruction.

    • innerInstructions: SolInstruction[]

      The instructions the Swig is to sign.

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

subAccountCreate

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountSign

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountToggle

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountWithdrawSol

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

subAccountWithdrawToken

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

  Parameters

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

  Returns Promise<SwigInstructionContext>

StaticfromBytes

• fromBytes(bytes: Uint8Array): Ed25519SessionAuthority

  Parameters

  • bytes: Uint8Array

  Returns Ed25519SessionAuthority