https://github.com/axic/bip32-path

Bitcoin BIP32 ('HD Wallet') path helpers.
https://github.com/axic/bip32-path

Last synced: 2 days ago
JSON representation

Bitcoin BIP32 ('HD Wallet') path helpers.

• Host: GitHub
• URL: https://github.com/axic/bip32-path
• Owner: axic
• License: mit
• Created: 2016-02-16T21:10:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-28T07:08:32.000Z (almost 7 years ago)
• Last Synced: 2024-04-25T07:01:15.050Z (5 months ago)
• Language: JavaScript
• Size: 11.7 KB
• Stars: 15
• Watchers: 4
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BIP32 Path

Bitcoin BIP32 ("HD Wallet") path helpers.

There are multiple path representations being used by different implementations. These includes:

- `m/44'/0'/0'/0/0` where the apostrophe means hardened key

- `m/44h/0h/0h/0/0` where the letter `h` means hardened key

- and a binary representation predominantly used by Trezor & compatible wallets and some software tools, such as [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib)

Some useful links:

- [BIP32 specification](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)

- [BIP44 specification](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki)

- [BIP39, an online tool to convert/derive keys](https://dcpos.github.io/bip39/)

- [BIP32JP, an online tool to convert/derive keys](https://bip32jp.github.io/english/index.html)

### API

- `BIPPath.fromString(path, reqRoot)` - creates an instance from a path written as text. Set `reqRoot` to true if the `m/` prefix is mandatory.

- `BIPPath.fromPathArray(path)` - creates an instance from a binary path array

- `new BIPPath(path)` - alias for `BIPPath.fromPathArray(path)`

- `.toString(noRoot, oldStyle)` - returns a text encoded path. Set to `noRoot` to true to omit the `m/` prefix. Set `oldStyle` true to use `h` instead of `'` for marking hardened nodes.

- `.toPathArray()` - returns a binary path array

- `BIPPath.validateString(path, reqRoot)` - returns true if the input is a valid path string

- `BIPPath.validatePathArray(path)` - returns true if the input is a valid binary path array

Binary path arrays contain each node as a separate number, where hardened nodes are marked by setting the 32th bit: `m/44'/1/1/0` corresponds to `[ 0x8000002c, 1, 1, 0 ]`

### Examples

```js

var bippath = require('bip32-path')

bippath.fromPathArray([0x8000002c, 1, 1, 0]).toString() // m/44'/1/1/0

bippath.fromString("m/44'/0'/0'").toString(false, true) // m/44h/0h/0h

bippath.fromString("m/44h/0h/0'").toString(true) // 44'/0'/0'

bippath.fromString("m/44'/0'/0'").toPathArray() // [ 0x8000002c, 0x80000000, 0x80000000 ]

```