Skip to content

Mnemonic.path

Creates an Ethereum-based BIP-44 HD path.

Imports

Named
import { Mnemonic } from 'ox'

Examples

import { HdKey } from 'ox'
 
const path = HdKey.path({ account: 1, index: 2 })

"m/44'/60'/1'/0/2"

Definition

function path(
  options?: path.Options,
): string

Source: src/core/HdKey.ts

Parameters

options

  • Type: path.Options
  • Optional

Path options.

options.account

  • Type: number
  • Optional

The account.

options.change

  • Type: number
  • Optional

The change.

options.index

  • Type: number
  • Optional

The address index.

Return Type

The path.

string