AbstractAbstractaddressAbstractaddressString representation of the authority address.
For Ed25519/ProgramExec: base58 encoded. For Secp256k1/Secp256r1: unprefixed hex.
AbstractexpirySlot when the session expires
AbstractidThis 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.
Use address instead
AbstractmaxMax duration on a session
Indicates if Authority is Session-based or not. true if Authority is Session-based
AbstractsessionEd25519 based Public Key as Session key
AbstractsignerThis 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.
Use signerAddress instead
AbstractsignerThe address that identifies the signer acting on behalf of this Authority.
For TokenBasedAuthority: same as address. For SessionBasedAuthority: the session key bytes.
AbstractsignerString representation of the signerAddress.
For TokenBasedAuthority: same as addressString. For SessionBasedAuthority: base58 encoded session key.
AbstracttypeAbstractaddCreates an AddAuthority Instructon
The parameters required to create the Swig instruction.
The ID of the role signing the instruction.
Actions of the new authority
CreateAuthorityInfo of new Authority to add
Optionaloptions?: InstructionDataOptionsThe public key of the swig payer.
The public key of the swig
AddAuthority Instruction.
AbstractcloseCreates 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.
AbstractcloseCreates 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.
AbstractcreateCreates an CreateSession Instructon
The parameters required to create the Swig instruction.
Ed25519 Public key of the Session key
Optionaloptions?: InstructionDataOptionsThe public key of the swig payer.
The ID of the role signing the instruction.
OptionalsessionDuration?: bigintSession duration in slots
The public key of the swig
AddAuthority Instruction.
Check if the given address bytes match this authority's address.
AbstractremoveCreates an RemoveAuthority Instructon
The parameters required for RemoveAuthority instruction.
Optionaloptions?: InstructionDataOptionsThe public key of the swig payer.
The ID of the role signing the instruction.
ID of the role to remove
The public key of the swig
RemoveAuthority Instruction.
AbstractsignCreates a Sign instruction for signing provided instructions with the Swig
The parameters required to create the Swig instruction.
The instructions the Swig is to sign.
Optionaloptions?: InstructionDataOptionsThe public key of the swig payer.
The ID of the role signing the instruction.
The public key of the swig
Sign Instruction.
AbstractsignCreates a Sign instruction for signing provided instructions with the Swig
The parameters required to create the Swig instruction.
The instructions the Swig is to sign.
Optionaloptions?: InstructionDataOptionsThe ID of the role signing the instruction.
The public key of the swig
Sign Instruction.
AbstractsubAbstractsubAbstractsubAbstractsubAbstractsubAbstracttransferAbstractupdateCreates an UpdateAuthority Instructon
The parameters required for RemoveAuthority instruction.
Optionaloptions?: InstructionDataOptionsThe public key of the swig payer.
The ID of the role signing the instruction.
ID of the role to remove
The public key of the swig account
RemoveAuthority Instruction.
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.