Skip to content

Secp256k1.fromMnemonic

Derives a valid secp256k1 private key from a BIP-39 mnemonic.

This is equivalent to Mnemonic.toPrivateKey, and derives the private key at m/44'/60'/0'/0/0 by default.

Imports

Named
import { Secp256k1 } from 'ox'

Examples

import { Secp256k1 } from 'ox'
 
const privateKey = Secp256k1.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/Secp256k1.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.

options.path

  • Type: string
  • Optional

Derivation path.

Return Type

A valid secp256k1 private key.

fromMnemonic.ReturnType<as>