Class AccountAbstract

Abstract ReadonlyaccountAddress

Abstract ReadonlypublicKey

AbstractsigningScheme

Abstractsign

• sign(message: HexInput): Signature

  Sign the given message using the available signing capabilities.

  Parameters

  • message: HexInput

    in HexInput format

  Returns Signature

  Signature

AbstractsignTransaction

• signTransaction(transaction: AnyRawTransaction): Signature

  Sign the given transaction using the available signing capabilities.

  Parameters

  • transaction: AnyRawTransaction

    the transaction to be signed

  Returns Signature

  Signature

AbstractsignTransactionWithAuthenticator

• 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

AbstractsignWithAuthenticator

• 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

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.

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.

StaticauthKey

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

StaticfromDerivationPath

• 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
• 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
• 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
• 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

StaticfromPrivateKey

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

StaticfromPrivateKeyAndAddress

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

Staticgenerate

• 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
• 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
• 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
• 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

constructor

• new Account(): Account

  Returns Account