Class Account`Abstract`

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 Summary)

Account

Implemented by

Index

Implementation - Account (On-Chain Model)

accountAddress publicKey signingScheme sign signTransaction signTransactionWithAuthenticator signWithAuthenticator verifySignature verifySignatureAsync authKey fromDerivationPath fromPrivateKey fromPrivateKeyAndAddress generate

Constructors

constructor

Implementation - Account (On-Chain Model)

`Abstract` `Readonly`accountAddress

accountAddress: AccountAddress

Account address associated with the account

`Abstract` `Readonly`publicKey

publicKey: AccountPublicKey

Public key associated with the account

`Abstract`signingScheme

signingScheme: SigningScheme

Signing scheme used to sign transactions

`Abstract`sign

sign(message: HexInput): Signature
Sign the given message using the available signing capabilities.
Parameters
- message: HexInput
  in HexInput format
Returns Signature
Signature
- Defined in src/account/Account.ts:310

`Abstract`signTransaction

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

`Abstract`signTransactionWithAuthenticator

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

`Abstract`signWithAuthenticator

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

verifySignature

verifySignature(args: VerifySignatureArgs): 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.
  
  Represents the arguments required to verify a digital signature.
  - message: HexInput
  - signature: Signature
Returns boolean
A boolean indicating whether the signature is valid.
- Defined in src/account/Account.ts:332

verifySignatureAsync

verifySignatureAsync(
    args: {
        aptosConfig: AptosConfig;
        message: HexInput;
        signature: Signature;
    },
): Promise<boolean>
Verify the given message and signature with the public key. It fetches any on chain state if needed for verification.
Parameters
- args: { aptosConfig: AptosConfig; message: HexInput; signature: Signature }
  The arguments for verifying the signature.
  - aptosConfig: AptosConfig
    The configuration object for connecting to the Aptos network
  - message: HexInput
    Raw message data in HexInput format.
  - signature: Signature
    Signed message signature.
Returns Promise<boolean>
A boolean indicating whether the signature is valid.
- Defined in src/account/Account.ts:347

`Static`authKey

authKey(args: { publicKey: AccountPublicKey }): 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.
- Defined in src/account/Account.ts:280

`Static`fromDerivationPath

fromDerivationPath(
args: GenerateEd25519AccountArgs & PrivateKeyFromDerivationPathArgs,
): 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.
  
  Arguments for generating an Ed25519 account, specifying the signing scheme and legacy option.
  - Optionallegacy?: true
  - Optionalscheme?: Ed25519
  Arguments for deriving a private key using a mnemonic phrase and a specified BIP44 path.
  - mnemonic: string
  - path: string
Returns Ed25519Account
- Defined in src/account/Account.ts:254
fromDerivationPath(
args: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs,
): SingleKeyAccount
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: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs
  The arguments for generating the account.
  
  Arguments for generating a SingleKeyAccount with an underlying Ed25519PrivateKey. The legacy argument must be set to false to ensure an Ed25519SingleKeyAccount is returned.
  - legacy: false
  - Optionalscheme?: Ed25519
  Arguments for deriving a private key using a mnemonic phrase and a specified BIP44 path.
  - mnemonic: string
  - path: string
Returns SingleKeyAccount
- Defined in src/account/Account.ts:255
fromDerivationPath(
args: GenerateSingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs,
): SingleKeyAccount
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: GenerateSingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs
  The arguments for generating the account.
  
  Arguments for generating a SingleKeyAccount using a supported private key other than Ed25519PrivateKey. The legacy argument is optional and defaults to false, and cannot be set to true.
  - Optionallegacy?: false
  - scheme: Secp256k1Ecdsa
  Arguments for deriving a private key using a mnemonic phrase and a specified BIP44 path.
  - mnemonic: string
  - path: string
Returns SingleKeyAccount
- Defined in src/account/Account.ts:258
fromDerivationPath(
args: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs,
): Account
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: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs
  The arguments for generating the account.
  
  Arguments for generating an opaque Account when the input signature scheme is unknown at compile time.
  - Optionallegacy?: boolean
  - Optionalscheme?: SigningSchemeInput
  Arguments for deriving a private key using a mnemonic phrase and a specified BIP44 path.
  - mnemonic: string
  - path: string
Returns Account
- Defined in src/account/Account.ts:259

`Static`fromPrivateKey

fromPrivateKey(args: CreateEd25519AccountFromPrivateKeyArgs): 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.
  
  Arguments for creating an Ed25519Account from an Ed25519PrivateKey. To use the SingleKey authentication scheme, set legacy to false.
  - Optionaladdress?: AccountAddressInput
  - Optionallegacy?: true
  - privateKey: Ed25519PrivateKey
Returns Ed25519Account
An instance of either Ed25519Account or SingleKeyAccount based on the provided private key.
- Defined in src/account/Account.ts:209
fromPrivateKey(args: CreateSingleKeyAccountFromPrivateKeyArgs): SingleKeyAccount
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: CreateSingleKeyAccountFromPrivateKeyArgs
  The arguments for creating the account.
  
  Arguments for creating a SingleKeyAccount from a supported private key, excluding Ed25519PrivateKey. The legacy argument is always false and cannot be set to true.
  - Optionaladdress?: AccountAddressInput
  - Optionallegacy?: false
  - privateKey: PrivateKeyInput
Returns SingleKeyAccount
An instance of either Ed25519Account or SingleKeyAccount based on the provided private key.
- Defined in src/account/Account.ts:210
fromPrivateKey(args: CreateAccountFromPrivateKeyArgs): SingleKeyAccount
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: CreateAccountFromPrivateKeyArgs
  The arguments for creating the account.
  
  Arguments for creating an Account from a private key when the key type is unknown at compile time.
  - Optionaladdress?: AccountAddressInput
  - Optionallegacy?: boolean
  - privateKey: PrivateKeyInput
Returns SingleKeyAccount
An instance of either Ed25519Account or SingleKeyAccount based on the provided private key.
- Defined in src/account/Account.ts:211

`Static`fromPrivateKeyAndAddress

fromPrivateKeyAndAddress(
args: CreateAccountFromPrivateKeyArgs,
): SingleKeyAccount
Parameters
- args: CreateAccountFromPrivateKeyArgs
  The arguments required to create an account from a private key.
  
  Arguments for creating an Account from a private key when the key type is unknown at compile time.
  - Optionaladdress?: AccountAddressInput
  - Optionallegacy?: boolean
  - privateKey: PrivateKeyInput
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.
- Defined in src/account/Account.ts:238

`Static`generate

generate(args?: GenerateEd25519AccountArgs): 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.
  
  Arguments for generating an Ed25519 account, specifying the signing scheme and legacy option.
  - Optionallegacy?: true
  - Optionalscheme?: Ed25519
Returns Ed25519Account
- Defined in src/account/Account.ts:184
generate(args: GenerateEd25519SingleKeyAccountArgs): SingleKeyAccount
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
- args: GenerateEd25519SingleKeyAccountArgs
  The arguments for generating the account.
  
  Arguments for generating a SingleKeyAccount with an underlying Ed25519PrivateKey. The legacy argument must be set to false to ensure an Ed25519SingleKeyAccount is returned.
  - legacy: false
  - Optionalscheme?: Ed25519
Returns SingleKeyAccount
- Defined in src/account/Account.ts:185
generate(args: GenerateSingleKeyAccountArgs): SingleKeyAccount
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
- args: GenerateSingleKeyAccountArgs
  The arguments for generating the account.
  
  Arguments for generating a SingleKeyAccount using a supported private key other than Ed25519PrivateKey. The legacy argument is optional and defaults to false, and cannot be set to true.
  - Optionallegacy?: false
  - scheme: Secp256k1Ecdsa
Returns SingleKeyAccount
- Defined in src/account/Account.ts:186
generate(args: GenerateAccountArgs): Account
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
- args: GenerateAccountArgs
  The arguments for generating the account.
  
  Arguments for generating an opaque Account when the input signature scheme is unknown at compile time.
  - Optionallegacy?: boolean
  - Optionalscheme?: SigningSchemeInput
Returns Account
- Defined in src/account/Account.ts:187

Constructors

constructor

new Account(): Account
Returns Account

Class AccountAbstract

Hierarchy (View Summary)

Implemented by

Index

Implementation - Account (On-Chain Model)

Constructors

Implementation - Account (On-Chain Model)

Abstract ReadonlyaccountAddress

Abstract ReadonlypublicKey

AbstractsigningScheme

Abstractsign

Parameters

Returns Signature

AbstractsignTransaction

Parameters

Returns Signature

AbstractsignTransactionWithAuthenticator

Parameters

Returns AccountAuthenticator

AbstractsignWithAuthenticator

Parameters

Returns AccountAuthenticator

verifySignature

Parameters

message: HexInput

signature: Signature

Returns boolean

verifySignatureAsync

Parameters

aptosConfig: AptosConfig

message: HexInput

signature: Signature

Returns Promise<boolean>

StaticauthKey

Parameters

publicKey: AccountPublicKey

Returns AuthenticationKey

StaticfromDerivationPath

Parameters

Optionallegacy?: true

Optionalscheme?: Ed25519

mnemonic: string

path: string

Returns Ed25519Account

Parameters

legacy: false

Optionalscheme?: Ed25519

mnemonic: string

path: string

Returns SingleKeyAccount

Parameters

Optionallegacy?: false

scheme: Secp256k1Ecdsa

mnemonic: string

path: string

Returns SingleKeyAccount

Parameters

Optionallegacy?: boolean

Optionalscheme?: SigningSchemeInput

mnemonic: string

path: string

Returns Account

StaticfromPrivateKey

Parameters

Optionaladdress?: AccountAddressInput

Optionallegacy?: true

privateKey: Ed25519PrivateKey

Returns Ed25519Account

Parameters

Optionaladdress?: AccountAddressInput

Optionallegacy?: false

privateKey: PrivateKeyInput

Returns SingleKeyAccount

Parameters

Optionaladdress?: AccountAddressInput

Optionallegacy?: boolean

privateKey: PrivateKeyInput

Returns SingleKeyAccount

StaticfromPrivateKeyAndAddress

Parameters

Class Account`Abstract`

`Abstract` `Readonly`accountAddress

`Abstract` `Readonly`publicKey

`Abstract`signingScheme

`Abstract`sign

`Abstract`signTransaction

`Abstract`signTransactionWithAuthenticator

`Abstract`signWithAuthenticator

`Static`authKey

`Static`fromDerivationPath

`Optional`legacy?: true

`Optional`scheme?: Ed25519

`Optional`scheme?: Ed25519

`Optional`legacy?: false

`Optional`legacy?: boolean

`Optional`scheme?: SigningSchemeInput

`Static`fromPrivateKey

`Optional`address?: AccountAddressInput

`Optional`legacy?: true

`Optional`address?: AccountAddressInput

`Optional`legacy?: false

`Optional`address?: AccountAddressInput

`Optional`legacy?: boolean

`Static`fromPrivateKeyAndAddress

`Optional`address?: AccountAddressInput

`Optional`legacy?: boolean

`Static`generate

`Optional`legacy?: true

`Optional`scheme?: Ed25519

`Optional`scheme?: Ed25519

`Optional`legacy?: false

`Optional`legacy?: boolean

`Optional`scheme?: SigningSchemeInput