Class SingleKeyAccount

Signer implementation for the SingleKey authentication scheme. This class extends a SingleKeyAccount by adding signing capabilities through a valid private key. Currently, the only supported signature schemes are Ed25519 and Secp256k1.

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

Implements

Index

Implementation - Account (On-Chain Model)

constructor accountAddress privateKey publicKey signingScheme sign signTransaction signTransactionWithAuthenticator signWithAuthenticator verifySignature verifySignatureAsync fromDerivationPath generate

Methods

getAnyPublicKey fromEd25519Account

Implementation - Account (On-Chain Model)

constructor

new SingleKeyAccount(args): SingleKeyAccount
Creates an instance of the SingleKeySigner using the provided private key and address. This allows for signing transactions and messages with the specified private key.
Parameters
- args: SingleKeySignerConstructorArgs
  The constructor arguments for initializing the SingleKeySigner.
Returns SingleKeyAccount
- Defined in src/account/SingleKeyAccount.ts:119

`Readonly`accountAddress

accountAddress: AccountAddress

Account address associated with the account

`Readonly`privateKey

privateKey: PrivateKeyInput

Private key associated with the account

`Readonly`publicKey

publicKey: AnyPublicKey

Public key associated with the account

`Readonly`signingScheme

signingScheme: SingleKey = SigningScheme.SingleKey

Signing scheme used to sign transactions

sign

sign(message): AnySignature
Sign the given message using the account's private key.
Parameters
- message: HexInput
  The message to be signed in HexInput format.
Returns AnySignature
A new AnySignature containing the signature of the message.
Implementation of SingleKeySigner.sign
- Defined in src/account/SingleKeyAccount.ts:256

signTransaction

signTransaction(transaction): AnySignature
Sign the given transaction using the account's private key. This function generates a signing message for the transaction and then signs it.
Parameters
- transaction: AnyRawTransaction
  The transaction to be signed.
Returns AnySignature
Signature - The resulting signature for the signed transaction.
Implementation of SingleKeySigner.signTransaction
- Defined in src/account/SingleKeyAccount.ts:269

signTransactionWithAuthenticator

signTransactionWithAuthenticator(transaction): AccountAuthenticatorSingleKey
Sign a transaction using the account's private key. This function returns an AccountAuthenticator that contains the signature of the transaction along with the account's public key.
Parameters
- transaction: AnyRawTransaction
  The raw transaction to be signed.
Returns AccountAuthenticatorSingleKey
An AccountAuthenticatorSingleKey containing the signature of the transaction and the account's public key.
Implementation of SingleKeySigner.signTransactionWithAuthenticator
- Defined in src/account/SingleKeyAccount.ts:245

signWithAuthenticator

signWithAuthenticator(message): AccountAuthenticatorSingleKey
Sign a message using the account's private key and return an AccountAuthenticator containing the signature along with the account's public key.
Parameters
- message: HexInput
  The signing message, represented as binary input in hexadecimal format.
Returns AccountAuthenticatorSingleKey
An instance of AccountAuthenticatorSingleKey containing the signature and the public key.
Implementation of SingleKeySigner.signWithAuthenticator
- Defined in src/account/SingleKeyAccount.ts:233

verifySignature

verifySignature(args): boolean
Verify the given message and signature with the public key.
Parameters
- args: VerifySingleKeySignatureArgs
  The arguments for verifying the signature.
Returns boolean
A boolean indicating whether the signature is valid.
Implementation of SingleKeySigner.verifySignature
- Defined in src/account/SingleKeyAccount.ts:196

verifySignatureAsync

verifySignatureAsync(args): Promise<boolean>
Verify the given message and signature with the account's public key.

This function checks if the provided signature is valid for the given message using the account's public key.
Parameters
- args: {
      aptosConfig: AptosConfig;
      message: HexInput;
      options?: {
          throwErrorWithReason?: boolean;
      };
      signature: Signature;
  }
  The arguments for verifying the signature.
  - aptosConfig: AptosConfig
  - message: HexInput
    The raw message data in HexInput format.
  - Optionaloptions?: {
    throwErrorWithReason?: boolean;
    }
    - OptionalthrowErrorWithReason?: boolean
  - signature: Signature
    The signed message signature.
Returns Promise<boolean>
A boolean indicating whether the signature is valid for the message.
Implementation of SingleKeySigner.verifySignatureAsync
- Defined in src/account/SingleKeyAccount.ts:213

`Static`fromDerivationPath

fromDerivationPath(args): SingleKeyAccount
Derives an account using a specified BIP44 path and mnemonic seed phrase, defaulting to the Ed25519 signature scheme. This function allows you to create a single key account based on the provided derivation path and mnemonic.
Parameters
- args: SingleKeySignerFromDerivationPathArgs
  The arguments for deriving the account.
Returns SingleKeyAccount
- Defined in src/account/SingleKeyAccount.ts:170

`Static`generate

generate(args?): SingleKeyAccount
Derives an account from a randomly generated private key based on the specified signing scheme. The default generation scheme is Ed25519, but it can also support Secp256k1Ecdsa.
Parameters
- args: SingleKeySignerGenerateArgs = {}
  The arguments for generating the account.
Returns SingleKeyAccount
An account with the generated private key based on the specified signing scheme.

Throws
Error if an unsupported signature scheme is provided.
- Defined in src/account/SingleKeyAccount.ts:141

Methods

getAnyPublicKey

getAnyPublicKey(): AnyPublicKey
Returns AnyPublicKey
Implementation of SingleKeySigner.getAnyPublicKey
- Defined in src/account/SingleKeyAccount.ts:126

`Static`fromEd25519Account

fromEd25519Account(account): SingleKeyAccount
Parameters
- account: Ed25519Account
Returns SingleKeyAccount
- Defined in src/account/SingleKeyAccount.ts:275

Class SingleKeyAccount

Implements

Index

Implementation - Account (On-Chain Model)

Methods

Implementation - Account (On-Chain Model)

constructor

Parameters

Returns SingleKeyAccount

ReadonlyaccountAddress

ReadonlyprivateKey

ReadonlypublicKey

ReadonlysigningScheme

sign

Parameters

Returns AnySignature

signTransaction

Parameters

Returns AnySignature

signTransactionWithAuthenticator

Parameters

Returns AccountAuthenticatorSingleKey

signWithAuthenticator

Parameters

Returns AccountAuthenticatorSingleKey

verifySignature

Parameters

Returns boolean

verifySignatureAsync

Parameters

aptosConfig: AptosConfig

message: HexInput

Optionaloptions?: { throwErrorWithReason?: boolean; }

OptionalthrowErrorWithReason?: boolean

signature: Signature

Returns Promise<boolean>

StaticfromDerivationPath

Parameters

Returns SingleKeyAccount

Staticgenerate

Parameters

Returns SingleKeyAccount

Throws

Methods

getAnyPublicKey

Returns AnyPublicKey

StaticfromEd25519Account

Parameters

Returns SingleKeyAccount

Settings

On This Page

`Readonly`accountAddress

`Readonly`privateKey

`Readonly`publicKey

`Readonly`signingScheme

`Optional`options?: {
throwErrorWithReason?: boolean;
}

`Optional`throwErrorWithReason?: boolean

`Static`fromDerivationPath

`Static`generate

`Static`fromEd25519Account