Class Mnemonic

_mnemonic

toEcdsaPrivateKey

• toEcdsaPrivateKey(passphrase?, path?): Promise<PrivateKey>

• Parameters

  • Optional passphrase: string = ""

  • Optional path: 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?, path?): Promise<PrivateKey>

• Parameters

  • Optional passphrase: string = ""

  • Optional path: 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?): Promise<PrivateKey>

• Parameters

  • Optional passphrase: 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): Promise<Uint8Array>

• Parameters

  • passphrase: string

  Returns Promise<Uint8Array>

toStandardECDSAsecp256k1PrivateKey

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

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

  Parameters

  • Optional passphrase: string = ""

  • Optional index: number

  Returns Promise<PrivateKey>

toStandardEd25519PrivateKey

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

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

  Parameters

  • Optional passphrase: string = ""

  • Optional index: number

  Returns Promise<PrivateKey>

toString

• toString(): string

• Returns string

Static fromString

• fromString(mnemonic): 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>

Static fromWords

• fromWords(words): 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

Static generate

• generate(): Promise<Mnemonic>

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

  Returns Promise<Mnemonic>

Static generate12

• generate12(): Promise<Mnemonic>

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

  Returns Promise<Mnemonic>