Class Account

constructor

• new Account(secretKey: UserSecretKey, hrp?: string): Account

  Creates an account object from a secret key

  Parameters

  • secretKey: UserSecretKey
  • hrp: string = LibraryConfig.DefaultAddressHrp

  Returns Account

Readonlyaddress

nonce

ReadonlypublicKey

ReadonlysecretKey

getNonceThenIncrement

• getNonceThenIncrement(): bigint

  Gets the nonce (the one from the object's state) and increments it.

  Returns bigint

incrementNonce

• incrementNonce(): void

  Increments (locally) the nonce (the account sequence number).

  Returns void

saveToKeystore

• saveToKeystore(path: PathLike, password: string): void

  Saves the wallet to a keystore file

  Parameters

  • path: PathLike
  • password: string

  Returns void

saveToPem

• saveToPem(path: string): void

  Saves the wallet to a pem file

  Parameters

  • path: string

  Returns void

sign

• sign(data: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>

  Signs using the secret key of the account.

  Parameters

  • data: Uint8Array

  Returns Promise<Uint8Array<ArrayBufferLike>>

signMessage

• signMessage(message: Message): Promise<Uint8Array<ArrayBufferLike>>

  Serializes the message, computes the signature and returns it.

  Parameters

  • message: Message

  Returns Promise<Uint8Array<ArrayBufferLike>>

signTransaction

• signTransaction(transaction: Transaction): Promise<Uint8Array<ArrayBufferLike>>

  Serializes the transaction, computes the signature and returns it.

  Parameters

  • transaction: Transaction

  Returns Promise<Uint8Array<ArrayBufferLike>>

verify

• verify(data: Uint8Array, signature: Uint8Array): Promise<boolean>

  Verifies the signature using the public key of the account.

  Parameters

  • data: Uint8Array
  • signature: Uint8Array

  Returns Promise<boolean>

verifyMessageSignature

• verifyMessageSignature(
      message: Message,
      signature: Uint8Array,
  ): Promise<boolean>

  Verifies the message signature using the public key of the account.

  Parameters

  • message: Message
  • signature: Uint8Array

  Returns Promise<boolean>

verifyTransactionSignature

• verifyTransactionSignature(
      transaction: Transaction,
      signature: Uint8Array,
  ): Promise<boolean>

  Verifies the transaction signature using the public key of the account.

  Parameters

  • transaction: Transaction
  • signature: Uint8Array

  Returns Promise<boolean>

StaticnewFromKeypair

• newFromKeypair(keypair: KeyPair, hrp?: string): Account

  Named constructor Returns an Account object, initialized with the secret key.

  Parameters

  • keypair: KeyPair
  • hrp: string = LibraryConfig.DefaultAddressHrp

  Returns Account

StaticnewFromKeystore

• newFromKeystore(
      filePath: string,
      password: string,
      addressIndex?: number,
      hrp?: string,
  ): Account

  Named constructor Loads a secret key from an encrypted keystore file. Handles both keystores that hold a mnemonic and ones that hold a secret key (legacy). For keystores that hold an encrypted mnemonic, the optional "addressIndex" parameter is used to derive the desired secret key. Returns an Account object, initialized with the secret key.

  Parameters

  • filePath: string
  • password: string
  • OptionaladdressIndex: number
  • hrp: string = LibraryConfig.DefaultAddressHrp

  Returns Account

StaticnewFromMnemonic

• newFromMnemonic(mnemonic: string, addressIndex?: number, hrp?: string): Account

  Named constructor Loads (derives) a secret key from a mnemonic. The optional "addressIndex" parameter is used to guide the derivation. Returns an Account object, initialized with the secret key.

  Parameters

  • mnemonic: string
  • addressIndex: number = 0
  • hrp: string = LibraryConfig.DefaultAddressHrp

  Returns Account

StaticnewFromPem

• newFromPem(path: PathLike, index?: number, hrp?: string): Promise<Account>

  Named constructor Loads a secret key from a PEM file. PEM files may contain multiple accounts - thus, an (optional) "index" is used to select the desired secret key. Returns an Account object, initialized with the secret key.

  Parameters

  • path: PathLike
  • index: number = 0
  • hrp: string = LibraryConfig.DefaultAddressHrp

  Returns Promise<Account>