Hierarchical Deterministic (HD) Wallet

This library is still under development and not ready for production use.

A complete Hierarchical Deterministic (HD) Wallet generator for 200+ cryptocurrencies, built with TypeScript.

This library offers a flexible and scalable solution for developers integrating multi-currency wallet functionality. It adheres to standard protocols for compatibility with other wallets and services, and provides features like secure seed generation, robust key management, and streamlined account control. By simplifying blockchain interactions, it enhances the developer experience and strengthens end-user security.

For Python support, explore python-hdwallet, the original implementation of this library. Try it live at https://hdwallet.online, our interactive web playground.

Full documentation is coming soon — until then, explore the examples folder for every feature or check the python-hdwallet docs (APIs are almost identical).

Installation

Pick the build that matches your environment.

Node.js / Bundlers

Full TypeScript typings included, works out-of-the-box with ts-node and standard bundlers.

npm install @hdwallet/core

Browser (no build step)

The bundled library is available in the ./dist/ folder in this repo.

ESM

Modern module build, import … straight in the browser or any ESM-aware bundler.

<script type="module">
  import { hdwallet } from './dist/hdwallet.min.js';
</script>

UDM

Standalone browser build, load via <script> and access as window.hdwallet.

<script src="./dist/hdwallet.udm.min.js" type="text/javascript"></script>

Quick Usage

Example

A simple Bitcoin HDWallet generator:

// SPDX-License-Identifier: MIT

import { HDWallet } from '@hdwallet/core';
import { BIP39_ENTROPY_STRENGTHS, BIP39Entropy } from '@hdwallet/core/entropies';
import { BIP39_MNEMONIC_LANGUAGES } from '@hdwallet/core/mnemonics';
import { Bitcoin as Cryptocurrency } from '@hdwallet/core/cryptocurrencies';
import { CustomDerivation } from '@hdwallet/core/derivations';
import { PUBLIC_KEY_TYPES } from '@hdwallet/core/consts';
import { BIP32HD } from '@hdwallet/core/hds';

const hdwallet: HDWallet = new HDWallet(
  Cryptocurrency, {
    hd: BIP32HD,
    network: Cryptocurrency.NETWORKS.MAINNET,
    language: BIP39_MNEMONIC_LANGUAGES.KOREAN,
    publicKeyType: PUBLIC_KEY_TYPES.COMPRESSED,
    passphrase: 'talonlab'
  }
).fromEntropy(
  new BIP39Entropy(
    BIP39Entropy.generate(
      BIP39_ENTROPY_STRENGTHS.ONE_HUNDRED_TWENTY_EIGHT
    )
  )
).fromDerivation(
  new CustomDerivation({
    path: 'm/0\'/0/0-1'  // Cryptocurrency.DEFAULT_PATH
  })
);

// console.log(JSON.stringify(hdwallet.getDump(['indexes']), null, 4));
console.log(JSON.stringify(hdwallet.getDumps(['indexes']), null, 4));

Explore more Examples

Clients

MetaMask, Ganache-CLI or Hardhat wallet look's like:

// SPDX-License-Identifier: MIT

import { HDWallet } from '@hdwallet/core';
import {
  BIP39Mnemonic, BIP39_MNEMONIC_LANGUAGES, BIP39_MNEMONIC_WORDS
} from '@hdwallet/core/mnemonics';
import { Ethereum as Cryptocurrency } from '@hdwallet/core/cryptocurrencies';
import { BIP44Derivation, CHANGES } from '@hdwallet/core/derivations';
import { BIP44HD } from '@hdwallet/core/hds';

const hdwallet: HDWallet = new HDWallet(
  Cryptocurrency, {
    hd: BIP44HD,
    network: Cryptocurrency.NETWORKS.MAINNET,
    passphrase: null
  }
).fromMnemonic(
  new BIP39Mnemonic(
    BIP39Mnemonic.fromWords(
      BIP39_MNEMONIC_WORDS.TWELVE, 
      BIP39_MNEMONIC_LANGUAGES.ENGLISH
    )
  )
).fromDerivation(
  new BIP44Derivation({
    coinType: Cryptocurrency.COIN_TYPE,
    account: 0,
    change: CHANGES.EXTERNAL_CHAIN,
    address: [0, 10]  // or '0-10'
  })
);

console.log('Mnemonic:', hdwallet.getMnemonic())
console.log('Base HD Path:  m/44\'/60\'/0\'/0/{address}', '\n')

for (const derivation of hdwallet.getDumps(['root', 'indexes'])) {
  console.log(`${derivation['at']['path']} ${derivation['address']} 0x${derivation['private-key']}`)
}

Phantom wallet look's like:

// SPDX-License-Identifier: MIT

import { HDWallet } from '@hdwallet/core';
import { BIP39Mnemonic } from '@hdwallet/core/mnemonics';
import { Cryptocurrency, Bitcoin, Ethereum, Solana } from '@hdwallet/core/cryptocurrencies';
import {
  Derivation, CustomDerivation, BIP44Derivation, BIP49Derivation, BIP84Derivation
} from '@hdwallet/core/derivations';
import { HD, BIP32HD, BIP44HD, BIP49HD, BIP84HD } from '@hdwallet/core/hds';
import { PUBLIC_KEY_TYPES } from '@hdwallet/core/consts';
import { encode } from '@hdwallet/core/libs/base58';
import { getBytes } from '@hdwallet/core/utils';

const mnemonic: BIP39Mnemonic = new BIP39Mnemonic(
  'abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about'
)

const standards: any = {
  'solana': {
    'hd': BIP32HD,
    'derivation': new CustomDerivation({ path: Solana.DEFAULT_PATH })
  },
  'ethereum': {
    'hd': BIP44HD,
    'derivation': new BIP44Derivation({ coinType: Ethereum.COIN_TYPE })
  },
  'bitcoin': {
    'legacy': {
      'hd': BIP44HD,
      'derivation': new BIP44Derivation({ coinType: Bitcoin.COIN_TYPE })
    },
    'nested-segwit': {
      'hd': BIP49HD,
      'derivation': new BIP49Derivation({ coinType: Bitcoin.COIN_TYPE })
    },
    'native-segwit': {
      'hd': BIP84HD,
      'derivation': new BIP84Derivation({ coinType: Bitcoin.COIN_TYPE })
    }
  }
}

function generatePhantomHDWallet(cryptocurrency: typeof Cryptocurrency, hd: typeof HD, network: string, derivation: Derivation, options = { }): HDWallet {
  return new HDWallet(cryptocurrency, { hd: hd, network: network, ...options }).fromMnemonic(mnemonic).fromDerivation(derivation)
}

console.log('Mnemonic:', mnemonic.getMnemonic(), '\n')

const solanaHDWallet: HDWallet = generatePhantomHDWallet(
  Solana, standards['solana']['hd'], Solana.NETWORKS.MAINNET, standards['solana']['derivation']
)
console.log(`${solanaHDWallet.getCryptocurrency()} (${solanaHDWallet.getSymbol()}) wallet:`, JSON.stringify({
  path: solanaHDWallet.getPath(),
  base58: encode(getBytes(
      solanaHDWallet.getPrivateKey() + solanaHDWallet.getPublicKey().slice(2)
  )),
  privateKey: solanaHDWallet.getPrivateKey(),
  publicKey: solanaHDWallet.getPublicKey().slice(2),
  address: solanaHDWallet.getAddress()
}, null, 4))

const ethereumHDWallet: HDWallet = generatePhantomHDWallet(
  Ethereum, standards['ethereum']['hd'], Ethereum.NETWORKS.MAINNET, standards['ethereum']['derivation']
)
console.log(`${ethereumHDWallet.getCryptocurrency()} (${ethereumHDWallet.getSymbol()}) wallet:`, JSON.stringify({
  path: ethereumHDWallet.getPath(),
  privateKey: `0x${ethereumHDWallet.getPrivateKey()}`,
  publicKey: ethereumHDWallet.getPublicKey(),
  address: ethereumHDWallet.getAddress()
}, null, 4))

for (const addressType of ['legacy', 'nested-segwit', 'native-segwit']) {
  let bitcoinHDWallet: HDWallet = generatePhantomHDWallet(
    Bitcoin, standards['bitcoin'][addressType]['hd'], Bitcoin.NETWORKS.MAINNET, standards['bitcoin'][addressType]['derivation'], { publicKeyType: PUBLIC_KEY_TYPES.COMPRESSED }
  )
  console.log(`${bitcoinHDWallet.getCryptocurrency()} (${bitcoinHDWallet.getSymbol()}) ${addressType} wallet:`, JSON.stringify({
    path: bitcoinHDWallet.getPath(),
    wif: bitcoinHDWallet.getWIF(),
    privateKey: bitcoinHDWallet.getPrivateKey(),
    publicKey: bitcoinHDWallet.getPublicKey(),
    address: bitcoinHDWallet.getAddress()
  }, null, 4))
}

Explore more Clients

Contributing

Feel free to open an issue if you find a problem, or a pull request if you've solved an issue. And also any help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels.

For more information, see the CONTRIBUTING.md file.

Donations

If this tool was helpful, support its development with a donation or a ⭐!

• Monero: 47xYi7dw4VchWhbhacY6RZHDmmcxZdzPE9tLk84c7hE72bw6aLSMVFWPXxGMEEYofkjNjxoWfnLSHejS6yzRGnPqEtxfgZi
• EVM-Chains: 0xD3cbCB0B6F82A03C715D665b72dC44CEf54e6D9B | meherett.eth
• Bitcoin: 16c7ajUwHEMaafrceuYSrd35SDjmfVdjoS

We accept a wide range of cryptocurrencies! If you'd like to donate using another coin, generate an address using the following ECC public keys at https://hdwallet.online:

• SLIP10-Secp256k1: 029890465120fb6c4efecdfcfd149f8333b0929b98976722a28ee39f5344d29eee
• SLIP10-Ed25519: 007ff5643c73e46e6c6a0dfd702894610505423e145dc8a93df19ff44eb011323b
• Kholaw-Ed25519: 005a49188ccd3d841dd877d7c00078da5c90452cbd69d4cef7a959f679fcc0e0e3
• SLIP10-Ed25519-Blake2b: 0051e8b29f7d0214dc96843cdbdcc071dc65397016ea6f7381f81bf42d76c7357c
• SLIP10-Nist256p1: 039ee4e2aadd6f4e7938d164b646c4b424114b8dd57252287151398ba0baf25780

License

Distributed under the MIT license. See LICENSE for more information.