Skip to content

Ed25519.fromMnemonic

Derives an Ed25519 private key from a BIP-39 mnemonic.

This is equivalent to passing Mnemonic.toSeed(mnemonic, { passphrase }) to Ed25519.fromSeed.

Imports

Named
import { Ed25519 } from 'ox'

Examples

import { Ed25519 } from 'ox'
 
const privateKey = Ed25519.fromMnemonic(
  'test test test test test test test test test test test junk'
)

Definition

function fromMnemonic<as>(
  mnemonic: string,
  options?: fromMnemonic.Options<as>,
): fromMnemonic.ReturnType<as>

Source: src/core/Ed25519.ts

Parameters

mnemonic

  • Type: string

BIP-39 mnemonic phrase.

options

  • Type: fromMnemonic.Options<as>
  • Optional

Options.

options.as

  • Type: "Bytes" | "Hex" | as
  • Optional

Format of the returned private key.

options.passphrase

  • Type: string
  • Optional

Optional BIP-39 passphrase.

Return Type

An Ed25519 private key.

fromMnemonic.ReturnType<as>