https://github.com/synonymdev/bip32

https://github.com/synonymdev/bip32

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/synonymdev/bip32
• Owner: synonymdev
• License: mit
• Archived: true
• Created: 2022-10-18T18:54:04.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-18T18:59:06.000Z (over 3 years ago)
• Last Synced: 2025-01-20T21:18:27.722Z (about 1 year ago)
• Language: TypeScript
• Size: 317 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bip32

[![Github CI](https://github.com/bitcoinjs/bip32/actions/workflows/main_ci.yml/badge.svg)](https://github.com/bitcoinjs/bip32/actions/workflows/main_ci.yml) [![NPM](https://img.shields.io/npm/v/bip32.svg)](https://www.npmjs.org/package/bip32) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

A [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) compatible library written in TypeScript with transpiled JavaScript committed to git.

## Example

TypeScript

``` typescript

import BIP32Factory from 'bip32';

import * as ecc from 'tiny-secp256k1';

import { BIP32Interface } from 'bip32';

// You must wrap a tiny-secp256k1 compatible implementation

const bip32 = BIP32Factory(ecc);

const node: BIP32Interface = bip32.fromBase58('xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi');

const child: BIP32Interface = node.derivePath('m/0/0');

// ...

```

NodeJS

``` javascript

const ecc = require('tiny-secp256k1')

const { BIP32Factory } = require('bip32')

// You must wrap a tiny-secp256k1 compatible implementation

const bip32 = BIP32Factory(ecc)

const node = bip32.fromBase58('xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi')

const child = node.derivePath('m/0/0')

```

## LICENSE [MIT](LICENSE)

A derivation (and extraction for modularity) of the `HDWallet`/`HDNode` written and tested by [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib) contributors since 2014.