@bajetech/digitalbits-hd-wallet

digitalbits-hd-wallet

🔐 Key derivation for the DigitalBits blockchain (based on Stellar's SEP-0005) 🚀

IMPORTANT NOTICE

Update to v1.1.0 or higher: Versions of this package prior to v1.1.0 are broken! It is very likely that if you attempt to use a pre-1.1.0 release of this package in your projects, they will NOT run! Please be sure to update to v1.1.0 or higher for a working release.

Installation

yarn add @bajetech/digitalbits-hd-wallet  # or npm i @bajetech/digitalbits-hd-wallet

Usage

import DigitalBitsHDWallet from "@bajetech/digitalbits-hd-wallet";

const mnemonic = DigitalBitsHDWallet.generateMnemonic();
const wallet = DigitalBitsHDWallet.fromMnemonic(mnemonic);

wallet.getPublicKey(0); // => GDKYMXOAJ5MK4EVIHHNWRGAAOUZMNZYAETMHFCD6JCVBPZ77TUAZFPKT
wallet.getSecret(0); // => SCVVKNLBHOWBNJYHD3CNROOA2P3K35I5GNTYUHLLMUHMHWQYNEI7LVED
wallet.getKeypair(0); // => DigitalBitsBase.Keypair for account 0
wallet.derive(`m/44'/148'/0'`); // => raw key for account 0 as a Buffer

// wallet instance from seeds
const seedHex =
  "794fc27373add3ac7676358e868a787bcbf1edfac83edcecdb34d7f1068c645dbadba563f3f3a4287d273ac4f052d2fc650ba953e7af1a016d7b91f4d273378f";
const seedBuffer = Buffer.from(seedHex);
DigitalBitsHDWallet.fromSeed(seedHex);
DigitalBitsHDWallet.fromSeed(seedBuffer);

// mnemonics with different lengths
DigitalBitsHDWallet.generateMnemonic(); // 24 words
DigitalBitsHDWallet.generateMnemonic({ entropyBits: 224 }); // 21 words
DigitalBitsHDWallet.generateMnemonic({ entropyBits: 160 }); // 18 words
DigitalBitsHDWallet.generateMnemonic({ entropyBits: 128 }); // 12 words

// validate a mnemonic
DigitalBitsHDWallet.validateMnemonic("too short and non wordlist words"); // false

Mnemonic Language

Mnemonics can be generated in any language supported by the underlying bip39 npm module.

The full list of language keys are under exports 'wordlists' here.

Usage

import DigitalBitsHDWallet from "@bajetech/digitalbits-hd-wallet";

// traditional chinese - 24 words
DigitalBitsHDWallet.generateMnemonic({
  language: "chinese_traditional",
});
// => '省 从 唯 芽 激 顿 埋 愤 碳 它 炸 如 青 领 涨 骤 度 牲 朱 师 即 姓 讲 蒋'

// french - 12 words
DigitalBitsHDWallet.generateMnemonic({ language: "french", entropyBits: 128 });
// => 'directif terrible légume dérober science vision venimeux exulter abrasif vague mutuel innocent'

Randomness

• NodeJs: crypto.randomBytes
• Browser: window.crypto.getRandomValues

(using randombytes npm module)

TypeScript Support

Many thanks to Kyle Roach for converting this library to TypeScript via the following PR. TypeScript support is now available as of version 1.2.0.

Tests

All SEP-0005 test cases are exercised here against these.

Credits

This package was cloned and adapted from stellar-hd-wallet for use with the DigitalBits blockchain network, which is itself adapted from the Stellar blockchain network.

Specifically the following differences from stellar-hd-wallet are worthy of mention:

• GitHub Actions is used for a CI workflow instead of Travis CI.
• All direct package dependencies and dev dependencies are brought up-to-date and the code modified where necessary to use up-to-date APIs.
• The xdb-digitalbits-base package is used instead of stellar-base.
• As of version 1.2.0 the package is written in TypeScript, with built-in TypeScript definitions exported.
• Yarn is used as the package manager of choice for development of this library.