Class AccountAbstract

constructor

• new Account(): Account

• Returns Account

Abstract ReadonlyaccountAddress

Abstract ReadonlypublicKey

AbstractsigningScheme

Abstractsign

• sign(message): Signature

• Sign the given message using the available signing capabilities.

  Parameters

  • message: HexInput

    in HexInput format

  Returns Signature

  Signature

AbstractsignTransaction

• signTransaction(transaction): Signature

• Sign the given transaction using the available signing capabilities.

  Parameters

  • transaction: AnyRawTransaction

    the transaction to be signed

  Returns Signature

  Signature

AbstractsignTransactionWithAuthenticator

• signTransactionWithAuthenticator(transaction): 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): 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): boolean

• Verify the given message and signature with the public key.

  Parameters

  • args: VerifySignatureArgs

  Returns boolean

StaticauthKey

• authKey(args): AuthenticationKey

• Parameters

  • args: {
        publicKey: AccountPublicKey;
    }

    • publicKey: AccountPublicKey

      PublicKey - public key of the account

  Returns AuthenticationKey

  The authentication key for the associated account

  Deprecated

  use publicKey.authKey() instead. 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

StaticfromDerivationPath

• fromDerivationPath(args): Ed25519Account

• Derives an account with bip44 path and mnemonics

  Parameters

  • args: GenerateEd25519AccountArgs & PrivateKeyFromDerivationPathArgs

  Returns Ed25519Account
• fromDerivationPath(args): SingleKeyAccount

• Parameters

  • args: GenerateEd25519SingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs

  Returns SingleKeyAccount

• fromDerivationPath(args): SingleKeyAccount

• Parameters

  • args: GenerateSingleKeyAccountArgs & PrivateKeyFromDerivationPathArgs

  Returns SingleKeyAccount

• fromDerivationPath(args): Account

• Parameters

  • args: GenerateAccountArgs & PrivateKeyFromDerivationPathArgs

  Returns Account

StaticfromPrivateKey

• fromPrivateKey(args): Ed25519Account

• Creates an account from the provided private key.

  Parameters

  • args: CreateEd25519AccountFromPrivateKeyArgs

  Returns Ed25519Account
• fromPrivateKey(args): SingleKeyAccount

• Parameters

  • args: CreateEd25519SingleKeyAccountFromPrivateKeyArgs

  Returns SingleKeyAccount

• fromPrivateKey(args): SingleKeyAccount

• Parameters

  • args: CreateSingleKeyAccountFromPrivateKeyArgs

  Returns SingleKeyAccount

• fromPrivateKey(args): Account

• Parameters

  • args: CreateAccountFromPrivateKeyArgs

  Returns Account

StaticfromPrivateKeyAndAddress

• fromPrivateKeyAndAddress(args): Account

• Parameters

  • args: CreateAccountFromPrivateKeyArgs

  Returns Account

  Account

  Deprecated

  use fromPrivateKey instead. Instantiates an account given 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?): Ed25519Account

• Derives an account from a randomly generated private key.

  Parameters

  • Optionalargs: GenerateEd25519AccountArgs

  Returns Ed25519Account

  An account compatible with the provided signature scheme
• generate(args): SingleKeyAccount

• Parameters

  • args: GenerateEd25519SingleKeyAccountArgs

  Returns SingleKeyAccount

• generate(args): SingleKeyAccount

• Parameters

  • args: GenerateSingleKeyAccountArgs

  Returns SingleKeyAccount

• generate(args): Account

• Parameters

  • args: GenerateAccountArgs

  Returns Account