Class AbstractedAccount

Abstract class representing a generic Aptos account.

This class serves as a single entry point for account generation, allowing accounts to be created either through Account.generate() or Account.fromDerivationPath. Although it is defined as an abstract class, it should be treated as an interface and enforced using the implements keyword.

Note: Generating an account instance does not create the account on-chain.

Hierarchy (view full)

Account
- AbstractedAccount

Index

Implementation - Account (On-Chain Model)

`Readonly`accountAddress

accountAddress: AccountAddress

Account address associated with the account

`Readonly`publicKey

publicKey: AbstractPublicKey

Public key associated with the account

sign

sign: ((message: HexInput) => AbstractSignature)

Sign the given message using the available signing capabilities.

Type declaration

- (message): AbstractSignature
- Parameters
  - message: HexInput
    in HexInput format
  Returns AbstractSignature
  Signature

`Readonly`signingScheme

signingScheme: SingleKey = SigningScheme.SingleKey

Signing scheme used to sign transactions

signTransaction

signTransaction(transaction): AbstractSignature
Sign the given transaction using the available signing capabilities.
Parameters
- transaction: AnyRawTransaction
  the transaction to be signed
Returns AbstractSignature
Signature
Overrides Account.signTransaction
- Defined in src/account/AbstractedAccount.ts:98

signTransactionWithAuthenticator

signTransactionWithAuthenticator(transaction): AccountAuthenticatorAbstraction
Sign a transaction using the available signing capabilities.
Parameters
- transaction: AnyRawTransaction
  the raw transaction
Returns AccountAuthenticatorAbstraction
the AccountAuthenticator containing the signature of the transaction, together with the account's public key
Overrides Account.signTransactionWithAuthenticator
- Defined in src/account/AbstractedAccount.ts:92

signWithAuthenticator

signWithAuthenticator(message): AccountAuthenticatorAbstraction
Sign a message using the available signing capabilities.
Parameters
- message: HexInput
  the signing message, as binary input
Returns AccountAuthenticatorAbstraction
the AccountAuthenticator containing the signature, together with the account's public key
Overrides Account.signWithAuthenticator
- Defined in src/account/AbstractedAccount.ts:84

verifySignature

verifySignature(args): boolean
Verify the given message and signature with the public key. This function helps ensure the integrity and authenticity of a message by validating its signature.
Parameters
- args: VerifySignatureArgs
  The arguments for verifying the signature.
Returns boolean
A boolean indicating whether the signature is valid.
Inherited from Account.verifySignature
- Defined in src/account/Account.ts:331

`Static`authKey

authKey(args): AuthenticationKey
Retrieve the authentication key for the associated account using the provided public key. This key enables account owners to rotate their private key(s) associated with the account without changing the address that hosts their account. See here for more info: https://aptos.dev/concepts/accounts#single-signer-authentication
Parameters
- args: {
  publicKey: AccountPublicKey;
  }
  The arguments for retrieving the authentication key.
  - publicKey: AccountPublicKey
    The public key of the account.
Returns AuthenticationKey
The authentication key for the associated account.
Inherited from Account.authKey
- Defined in src/account/Account.ts:279

`Static`fromDerivationPath

fromDerivationPath(args): Ed25519Account
Generates an account from a specified derivation path and mnemonic. This function allows you to create an account using different signing schemes based on the provided arguments.
Parameters
- args: GenerateEd25519AccountArgs & PrivateKeyFromDerivationPathArgs
  The arguments for generating the account.
Returns Ed25519Account
Inherited from Account.fromDerivationPath
- Defined in src/account/Account.ts:253
fromDerivationPath(args): SingleKeyAccount
Parameters
- args: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs
Returns SingleKeyAccount
Inherited from Account.fromDerivationPath
- Defined in src/account/Account.ts:254
fromDerivationPath(args): SingleKeyAccount
Parameters
- args: GenerateSingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs
Returns SingleKeyAccount
Inherited from Account.fromDerivationPath
- Defined in src/account/Account.ts:257
fromDerivationPath(args): Account
Parameters
- args: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs
Returns Account
Inherited from Account.fromDerivationPath
- Defined in src/account/Account.ts:258

`Static`fromPrivateKey

fromPrivateKey(args): Ed25519Account
Creates an account from a given private key and address. This function allows you to instantiate an account based on the provided private key, and it can differentiate between legacy and non-legacy accounts.
Parameters
- args: CreateEd25519AccountFromPrivateKeyArgs
  The arguments for creating the account.
Returns Ed25519Account
An instance of either Ed25519Account or SingleKeyAccount based on the provided private key.
Inherited from Account.fromPrivateKey
- Defined in src/account/Account.ts:208
fromPrivateKey(args): SingleKeyAccount
Parameters
- args: CreateSingleKeyAccountFromPrivateKeyArgs
Returns SingleKeyAccount
Inherited from Account.fromPrivateKey
- Defined in src/account/Account.ts:209
fromPrivateKey(args): SingleKeyAccount
Parameters
- args: CreateAccountFromPrivateKeyArgs
Returns SingleKeyAccount
Inherited from Account.fromPrivateKey
- Defined in src/account/Account.ts:210

`Static`fromPrivateKeyAndAddress

fromPrivateKeyAndAddress(args): SingleKeyAccount
Parameters
- args: CreateAccountFromPrivateKeyArgs
  The arguments required to create an account from a private key.
Returns SingleKeyAccount
Account

Deprecated
use fromPrivateKey instead. Instantiates an account using a private key and a specified account address. This is primarily used to instantiate an Account that has had its authentication key rotated.
Inherited from Account.fromPrivateKeyAndAddress
- Defined in src/account/Account.ts:237

`Static`generate

generate(args?): Ed25519Account
Generates a new account based on the specified signing scheme and legacy option. This function allows you to create an account with either the Ed25519 signing scheme or a different scheme as specified.
Parameters
- Optionalargs: GenerateEd25519AccountArgs
  The arguments for generating the account.
Returns Ed25519Account
Inherited from Account.generate
- Defined in src/account/Account.ts:183
generate(args): SingleKeyAccount
Parameters
- args: GenerateEd25519SingleKeyAccountArgs
Returns SingleKeyAccount
Inherited from Account.generate
- Defined in src/account/Account.ts:184
generate(args): SingleKeyAccount
Parameters
- args: GenerateSingleKeyAccountArgs
Returns SingleKeyAccount
Inherited from Account.generate
- Defined in src/account/Account.ts:185
generate(args): Account
Parameters
- args: GenerateAccountArgs
Returns Account
Inherited from Account.generate
- Defined in src/account/Account.ts:186

Constructors

constructor

new AbstractedAccount(__namedParameters): AbstractedAccount
Parameters
- __namedParameters: AbstractedAccountConstructorArgs
Returns AbstractedAccount
Overrides Account.constructor
- Defined in src/account/AbstractedAccount.ts:45

Methods

setSigner

setSigner(signer): void
Update the signer function for the account. This can be done after asynchronous operations are complete to update the context of the signer function.
Parameters
- signer: ((digest: HexInput) => HexInput)
  The new signer function to use for the account.
  - - (digest): HexInput
    - Parameters
      digest: HexInput
      Returns HexInput
Returns void
- Defined in src/account/AbstractedAccount.ts:108

`Static`fromPermissionedSigner

fromPermissionedSigner(signer): AbstractedAccount
Creates an AbstractedAccount from an Ed25519Account that has a permissioned signer function and using the 0x1::permissioned_delegation::authenticate function to verify the signature.
Parameters
- signer: {
  accountAddress?: AccountAddress;
  signer: Ed25519Account;
  }
  The Ed25519Account that can be used to sign permissioned transactions.
  - OptionalaccountAddress?: AccountAddress
  - signer: Ed25519Account
Returns AbstractedAccount
The AbstractedAccount
- Defined in src/account/AbstractedAccount.ts:65

Properties

`Readonly`authenticationFunction

authenticationFunction: string

Class AbstractedAccount

Hierarchy (view full)

Index

Implementation - Account (On-Chain Model)

Constructors

Methods

Properties

Implementation - Account (On-Chain Model)

ReadonlyaccountAddress

ReadonlypublicKey

sign

Type declaration

Parameters

Returns AbstractSignature

ReadonlysigningScheme

signTransaction

Parameters

Returns AbstractSignature

signTransactionWithAuthenticator

Parameters

Returns AccountAuthenticatorAbstraction

signWithAuthenticator

Parameters

Returns AccountAuthenticatorAbstraction

verifySignature

Parameters

Returns boolean

StaticauthKey

Parameters

publicKey: AccountPublicKey

Returns AuthenticationKey

StaticfromDerivationPath

Parameters

Returns Ed25519Account

Parameters

Returns SingleKeyAccount

Parameters

Returns SingleKeyAccount

Parameters

Returns Account

StaticfromPrivateKey

Parameters

Returns Ed25519Account

Parameters

Returns SingleKeyAccount

Parameters

Returns SingleKeyAccount

StaticfromPrivateKeyAndAddress

Parameters

Returns SingleKeyAccount

Deprecated

Staticgenerate

Parameters

Returns Ed25519Account

Parameters

Returns SingleKeyAccount

Parameters

Returns SingleKeyAccount

Parameters

Returns Account

Constructors

constructor

Parameters

Returns AbstractedAccount

Methods

setSigner

Parameters

Parameters

Returns HexInput

Returns void

StaticfromPermissionedSigner

Parameters

OptionalaccountAddress?: AccountAddress

signer: Ed25519Account

Returns AbstractedAccount

Properties

ReadonlyauthenticationFunction

Settings

On This Page

`Readonly`accountAddress

`Readonly`publicKey

`Readonly`signingScheme

`Static`authKey

`Static`fromDerivationPath

`Static`fromPrivateKey

`Static`fromPrivateKeyAndAddress

`Static`generate

`Static`fromPermissionedSigner

`Optional`accountAddress?: AccountAddress

`Readonly`authenticationFunction