Class Mnemonic

_mnemonic

calculateDerivationPathValues

• calculateDerivationPathValues(derivationPath: string): number[]

  Converts a derivation path from string to an array of integers. Note that this expects precisely 5 components in the derivation path, as per BIP-44: m / purpose' / coin_type' / account' / change / address_index Takes into account ' for hardening as per BIP-32, and does not prescribe which components should be hardened.

  Parameters

  • derivationPath: string

    the derivation path in BIP-44 format, e.g. "m/44'/60'/0'/0/0"

  Returns number[]

  to be used with PrivateKey#derive

toEcdsaPrivateKey

• toEcdsaPrivateKey(passphrase?: string, path?: number[]): Promise<PrivateKey>

  Parameters

  • Optionalpassphrase: string = ""
  • Optionalpath: number[]

  Returns Promise<PrivateKey>

  Deprecated

  • Use toStandardEd25519PrivateKey() or toStandardECDSAsecp256k1PrivateKey() instead Recover an ECDSA private key from this mnemonic phrase, with an optional passphrase.

toEd25519PrivateKey

• toEd25519PrivateKey(passphrase?: string, path?: number[]): Promise<PrivateKey>

  Parameters

  • Optionalpassphrase: string = ""
  • Optionalpath: number[]

  Returns Promise<PrivateKey>

  Deprecated

  • Use toStandardEd25519PrivateKey() or toStandardECDSAsecp256k1PrivateKey() instead Recover an Ed25519 private key from this mnemonic phrase, with an optional passphrase.

toLegacyPrivateKey

• toLegacyPrivateKey(): Promise<PrivateKey>

  Returns Promise<PrivateKey>

toPrivateKey

• toPrivateKey(passphrase?: string): Promise<PrivateKey>

  Parameters

  • Optionalpassphrase: string = ""

  Returns Promise<PrivateKey>

  Deprecated

  • Use toStandardEd25519PrivateKey() or toStandardECDSAsecp256k1PrivateKey() instead Recover a private key from this mnemonic phrase, with an optional passphrase.

toSeed

• toSeed(passphrase: string): Promise<Uint8Array<ArrayBufferLike>>

  Parameters

  • passphrase: string

  Returns Promise<Uint8Array<ArrayBufferLike>>

toStandardECDSAsecp256k1PrivateKey

• toStandardECDSAsecp256k1PrivateKey(
      passphrase?: string,
      index?: number,
  ): Promise<PrivateKey>

  Recover an ECDSA private key from this mnemonic phrase, with an optional passphrase.

  Parameters

  • Optionalpassphrase: string = ""
  • Optionalindex: number

  Returns Promise<PrivateKey>

toStandardECDSAsecp256k1PrivateKeyCustomDerivationPath

• toStandardECDSAsecp256k1PrivateKeyCustomDerivationPath(
      passphrase?: string,
      derivationPath: string,
  ): Promise<PrivateKey>

  Recover an ECDSAsecp256k1 private key from this mnemonic phrase and derivation path, with an optional passphrase

  Parameters

  • passphrase: string = ""

    the passphrase used to protect the mnemonic, use "" for none
  • derivationPath: string

    the derivation path in BIP-44 format, e.g. "m/44'/60'/0'/0/0"

  Returns Promise<PrivateKey>

  the private key

toStandardECDSAsecp256k1PrivateKeyImpl

• toStandardECDSAsecp256k1PrivateKeyImpl(
      passphrase: string,
      derivationPathValues: number[],
  ): Promise<PrivateKey>

  Common implementation for both toStandardECDSAsecp256k1PrivateKey functions.

  Parameters

  • passphrase: string

    the passphrase used to protect the mnemonic, use "" for none
  • derivationPathValues: number[]

    derivation path as an integer array, see: calculateDerivationPathValues

  Returns Promise<PrivateKey>

  a private key

toStandardEd25519PrivateKey

• toStandardEd25519PrivateKey(
      passphrase?: string,
      index?: number,
  ): Promise<PrivateKey>

  Recover an Ed25519 private key from this mnemonic phrase, with an optional passphrase.

  Parameters

  • Optionalpassphrase: string = ""
  • Optionalindex: number

  Returns Promise<PrivateKey>

toString

• toString(): string

  Returns string

StaticfromString

• fromString(mnemonic: string): Promise<Mnemonic>

  Recover a mnemonic phrase from a string, splitting on spaces. Handles 12, 22 (legacy), and 24 words.

  Parameters

  • mnemonic: string

  Returns Promise<Mnemonic>

StaticfromWords

• fromWords(words: string[]): Promise<Mnemonic>

  Construct a mnemonic from a list of words. Handles 12, 22 (legacy), and 24 words.

  An exception of BadMnemonicError will be thrown if the mnemonic contains unknown words or fails the checksum. An invalid mnemonic can still be used to create private keys, the exception will contain the failing mnemonic in case you wish to ignore the validation error and continue.

  Parameters

  • words: string[]

  Returns Promise<Mnemonic>

  Throws

Staticgenerate

• generate(): Promise<Mnemonic>

  Returns a new random 24-word mnemonic from the BIP-39 standard English word list.

  Returns Promise<Mnemonic>

Staticgenerate12

• generate12(): Promise<Mnemonic>

  Returns a new random 12-word mnemonic from the BIP-39 standard English word list.

  Returns Promise<Mnemonic>