micro-ed25519-hdkey
Secure, minimal implementation of SLIP-0010 hierarchical deterministic (HD) wallets.
Uses audited @noble/ed25519 under the hood. Based on audited code from scure-bip32.
Check out scure-bip39 if you also need mnemonic phrases.
Sponsored by the Kin Foundation for Kinetic.
Usage
npm install micro-ed25519-hdkey
Or
yarn add micro-ed25519-hdkey
The module exports a single class HDKey, which should be used like this:
import { HDKey } from 'micro-ed25519-hdkey';
const hdkey1 = HDKey.fromMasterSeed(seed);
// props
[hdkey1.depth, hdkey1.index, hdkey1.chainCode];
console.log(hdkey2.privateKey, hdkey2.publicKey);
console.log(hdkey3.derive("m/0/2147483647'/1'"));
const sig = hdkey3.sign(hash);
hdkey3.verify(hash, sig);
Note: chainCode property is essentially a private part of a secret "master" key, it should be guarded from unauthorized access.
The full API is:
class HDKey {
public static HARDENED_OFFSET: number;
public static fromMasterSeed(seed: Uint8Array | string): HDKey;
readonly depth: number = 0;
readonly index: number = 0;
readonly chainCode: Uint8Array | null = null;
readonly parentFingerprint: number = 0;
public readonly privateKey: Uint8Array;
get fingerprint(): number;
get fingerprintHex(): string;
get parentFingerprintHex(): string;
get pubKeyHash(): Uint8Array;
get publicKey(): Uint8Array;
get publicKeyRaw(): Uint8Array;
derive(path: string, forceHardened = false): HDKey;
deriveChild(index: number): HDKey;
sign(hash: Uint8Array): Uint8Array;
verify(hash: Uint8Array, signature: Uint8Array): boolean;
}
Notes
- SLIP-0010 publicKey is 33 bytes (see this issue), if you want 32-byte publicKey, use
.publicKeyRawgetter - SLIP-0010 vectors fingerprint is actually
parentFingerprint - SLIP-0010 doesn't allow deriving non-hardened keys for Ed25519, however some other libraries treat non-hardened keys (
m/0/1) as hardened (m/0'/1'). If you want this behaviour, there is a flagforceHardenedinderivemethod
License
Copyright (c) 2022 Patricio Palladino, Paul Miller (paulmillr.com)
7 Nov 30, 2022
201 Dec 30, 2022
7 Jun 25, 2022
2 Jan 27, 2022
252 Dec 15, 2022
8k Dec 29, 2022
7 Dec 19, 2022
0 Jan 29, 2022
4 Nov 27, 2022
74 Dec 24, 2022