Class SessionBasedAuthority`Abstract`

Hierarchy (View Summary)

Authority
- SessionBasedAuthority
  - Ed25519SessionAuthority
  - Secp256k1SessionAuthority

Constructors

constructor

new SessionBasedAuthority(data: Uint8Array): SessionBasedAuthority
Parameters
- data: Uint8Array
Returns SessionBasedAuthority
Inherited from Authority.constructor
- Defined in lib/dist/index.d.ts:937

Properties

data

data: Uint8Array

`Abstract`expirySlot

expirySlot: bigint

Slot when the session expires

`Abstract`id

id: Uint8Array

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.

`Abstract`maxDuration

maxDuration: bigint

Max duration on a session

session

session: boolean

Indicates if Authority is Session-based or not. true if Authority is Session-based

`Abstract`sessionKey

sessionKey: SolPublicKey

Ed25519 based Public Key as Session key

`Abstract`signer

signer: Uint8Array

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.

`Abstract`type

type: AuthorityType

AuthorityType

Methods

`Abstract`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
  - 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.
Inherited from Authority.addAuthority
- Defined in lib/dist/index.d.ts:985

`Abstract`createSession

createSession(
    args: {
        newSessionKey: SolPublicKeyData;
        options?: InstructionDataOptions;
        payer: SolPublicKeyData;
        roleId: number;
        sessionDuration?: bigint;
        swigAddress: SolPublicKeyData;
    },
): Promise<SwigInstructionContext>
Creates an CreateSession Instructon
Parameters
- args: {
      newSessionKey: SolPublicKeyData;
      options?: InstructionDataOptions;
      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
  - Optionaloptions?: InstructionDataOptions
    InstructionDataOptions
  - 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.
- Defined in lib/dist/index.d.ts:1099

isEqual

isEqual(other: Authority): boolean
Check two Authority are partially equal
Parameters
- other: Authority
Returns boolean
Inherited from Authority.isEqual
- Defined in lib/dist/index.d.ts:1063

matchesSigner

matchesSigner(signer: Uint8Array): boolean
Check two Authority has the same signer.
Parameters
- signer: Uint8Array
Returns boolean
Inherited from Authority.matchesSigner
- Defined in lib/dist/index.d.ts:1067

`Abstract`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.
  - 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.
Inherited from Authority.removeAuthority
- Defined in lib/dist/index.d.ts:1004

`Abstract`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.
  - 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.
Inherited from Authority.sign
- Defined in lib/dist/index.d.ts:948

`Abstract`signV2

signV2(
    args: {
        innerInstructions: SolInstruction[];
        options?: InstructionDataOptions;
        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;
      roleId: number;
      swigAddress: SolPublicKeyData;
      swigSystemAddress: SolPublicKeyData;
  }
  The parameters required to create the Swig instruction.
  - innerInstructions: SolInstruction[]
    The instructions the Swig is to sign.
  - Optionaloptions?: InstructionDataOptions
    InstructionDataOptions
  - 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.
Inherited from Authority.signV2
- Defined in lib/dist/index.d.ts:965

`Abstract`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>
Inherited from Authority.subAccountCreate
- Defined in lib/dist/index.d.ts:1011

`Abstract`subAccountSign

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>
Inherited from Authority.subAccountSign
- Defined in lib/dist/index.d.ts:1018

`Abstract`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>
Inherited from Authority.subAccountToggle
- Defined in lib/dist/index.d.ts:1026

`Abstract`subAccountWithdrawSol

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>
Inherited from Authority.subAccountWithdrawSol
- Defined in lib/dist/index.d.ts:1035

`Abstract`subAccountWithdrawToken

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>
Inherited from Authority.subAccountWithdrawToken
- Defined in lib/dist/index.d.ts:1043

`Abstract`transferAssets

transferAssets(
    args: {
        options?: InstructionDataOptions;
        payer: SolPublicKeyData;
        roleId: number;
        swigAddress: SolPublicKeyData;
        swigSystemAddress: SolPublicKeyData;
    },
): Promise<SwigInstructionContext>
Parameters
- args: {
      options?: InstructionDataOptions;
      payer: SolPublicKeyData;
      roleId: number;
      swigAddress: SolPublicKeyData;
      swigSystemAddress: SolPublicKeyData;
  }
Returns Promise<SwigInstructionContext>
Inherited from Authority.transferAssets
- Defined in lib/dist/index.d.ts:1053

Class SessionBasedAuthorityAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SessionBasedAuthority

Properties

data

AbstractexpirySlot

Abstractid

AbstractmaxDuration

session

AbstractsessionKey

Abstractsigner

Abstracttype

Methods

AbstractaddAuthority

Parameters

actingRoleId: number

actions: Actions

newAuthorityInfo: CreateAuthorityInfo

Optionaloptions?: InstructionDataOptions

payer: SolPublicKeyData

swigAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

AbstractcreateSession

Parameters

newSessionKey: SolPublicKeyData

Optionaloptions?: InstructionDataOptions

payer: SolPublicKeyData

roleId: number

OptionalsessionDuration?: bigint

swigAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

isEqual

Parameters

Returns boolean

matchesSigner

Parameters

Returns boolean

AbstractremoveAuthority

Parameters

Optionaloptions?: InstructionDataOptions

payer: SolPublicKeyData

roleId: number

roleIdToRemove: number

swigAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

Abstractsign

Parameters

innerInstructions: SolInstruction[]

Optionaloptions?: InstructionDataOptions

payer: SolPublicKeyData

roleId: number

swigAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

AbstractsignV2

Parameters

innerInstructions: SolInstruction[]

Optionaloptions?: InstructionDataOptions

roleId: number

swigAddress: SolPublicKeyData

swigSystemAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

AbstractsubAccountCreate

Parameters

Returns Promise<SwigInstructionContext>

AbstractsubAccountSign

Parameters

Returns Promise<SwigInstructionContext>

AbstractsubAccountToggle

Parameters

Returns Promise<SwigInstructionContext>

AbstractsubAccountWithdrawSol

Parameters

Returns Promise<SwigInstructionContext>

Class SessionBasedAuthority`Abstract`

`Abstract`expirySlot

`Abstract`id

`Abstract`maxDuration

`Abstract`sessionKey

`Abstract`signer

`Abstract`type

`Abstract`addAuthority

`Optional`options?: InstructionDataOptions

`Abstract`createSession

`Optional`options?: InstructionDataOptions

`Optional`sessionDuration?: bigint

`Abstract`removeAuthority

`Optional`options?: InstructionDataOptions

`Abstract`sign

`Optional`options?: InstructionDataOptions

`Abstract`signV2

`Optional`options?: InstructionDataOptions

`Abstract`subAccountCreate

`Abstract`subAccountSign

`Abstract`subAccountToggle

`Abstract`subAccountWithdrawSol

`Abstract`subAccountWithdrawToken

`Abstract`transferAssets