Class Authority`Abstract`

Hierarchy (View Summary)

Authority
- SessionBasedAuthority
- TokenBasedAuthority

Constructors

constructor

new Authority(data: Uint8Array): Authority
Parameters
- data: Uint8Array
Returns Authority
- Defined in lib/dist/index.d.ts:1131

Properties

`Abstract`address

address: Uint8Array

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.

`Abstract`addressString

addressString: string

String representation of the authority address.

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

data

data: Uint8Array

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

Deprecated

Use address instead

`Abstract`session

session: boolean

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

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

Deprecated

Use signerAddress instead

`Abstract`signerAddress

signerAddress: Uint8Array

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

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

`Abstract`signerAddressString

signerAddressString: string

String representation of the signerAddress.

For TokenBasedAuthority: same as addressString. For SessionBasedAuthority: base58 encoded 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.
- Defined in lib/dist/index.d.ts:1179

`Abstract`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>
- Defined in lib/dist/index.d.ts:1286

`Abstract`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>
- Defined in lib/dist/index.d.ts:1300

isEqual

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

matchesAddress

matchesAddress(address: Uint8Array): boolean
Check if the given address bytes match this authority's address.
Parameters
- address: Uint8Array
Returns boolean
- Defined in lib/dist/index.d.ts:1316

matchesSigner

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

`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.
- Defined in lib/dist/index.d.ts:1198

`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.
- Defined in lib/dist/index.d.ts:1142

`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.
- Defined in lib/dist/index.d.ts:1159

`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>
- Defined in lib/dist/index.d.ts:1224

`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>
- Defined in lib/dist/index.d.ts:1231

`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>
- Defined in lib/dist/index.d.ts:1239

`Abstract`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>
- Defined in lib/dist/index.d.ts:1248

`Abstract`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>
- Defined in lib/dist/index.d.ts:1257

`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>
- Defined in lib/dist/index.d.ts:1268

`Abstract`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.
  - Optionaloptions?: 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.
- Defined in lib/dist/index.d.ts:1216

Class AuthorityAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Authority

Properties

Abstractaddress

AbstractaddressString

data

Abstractid

Deprecated

Abstractsession

Abstractsigner

Deprecated

AbstractsignerAddress

AbstractsignerAddressString

Abstracttype

Methods

AbstractaddAuthority

Parameters

actingRoleId: number

actions: Actions

newAuthorityInfo: CreateAuthorityInfo

Optionaloptions?: InstructionDataOptions

payer: SolPublicKeyData

swigAddress: SolPublicKeyData

Returns Promise<SwigInstructionContext>

AbstractcloseSwig

Parameters

Returns Promise<SwigInstructionContext>

AbstractcloseTokenAccount

Parameters

Returns Promise<SwigInstructionContext>

isEqual

Parameters

Returns boolean

matchesAddress

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>

Class Authority`Abstract`

`Abstract`address

`Abstract`addressString

`Abstract`id

`Abstract`session

`Abstract`signer

`Abstract`signerAddress

`Abstract`signerAddressString

`Abstract`type

`Abstract`addAuthority

`Optional`options?: InstructionDataOptions

`Abstract`closeSwig

`Abstract`closeTokenAccount

`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

`Abstract`updateAuthority

`Optional`options?: InstructionDataOptions