History

Dave Collins 76f80ba180 txscript: Break dcrutil dependency. Now that the addresses have all been converted over to use the stdaddr package, this removes only remaining dependencies on dcrutil which are in the tests in order to avoid cyclic dependencies when updating the dcrutil code to the use the stdaddr package.		2021-04-12 11:21:01 -05:00
..
bench_test.go	hdkeychain: Use mock net params in tests.	2019-03-29 11:26:40 -05:00
doc.go	hdkeychain: Fix references to methods in package docs	2020-03-11 11:34:50 -05:00
example_test.go	hdkeychain: Convert to use new stdaddr package.	2021-04-09 13:39:19 -05:00
extendedkey_test.go	multi: Start dcrec/secp256k1 v4 module dev cycle.	2020-12-16 16:30:24 -06:00
extendedkey.go	multi: Start dcrec/secp256k1 v4 module dev cycle.	2020-12-16 16:30:24 -06:00
go.mod	hdkeychain: Convert to use new stdaddr package.	2021-04-09 13:39:19 -05:00
go.sum	txscript: Break dcrutil dependency.	2021-04-12 11:21:01 -05:00
README.md	multi: Update README.md files for go modules.	2021-01-22 14:39:23 -06:00

hdkeychain

Package hdkeychain provides an API for Decred hierarchical deterministic extended keys (based on BIP0032).

A comprehensive suite of tests is provided to ensure proper functionality.

Feature Overview

Full BIP0032 implementation
Single type for private and public extended keys
Convenient cryptographically secure seed generation
Simple creation of master nodes
Support for multi-layer derivation
Easy serialization and deserialization for both private and public extended keys
Support for custom networks by accepting a network parameters interface
Allows obtaining the underlying serialized secp256k1 pubkeys and privkeys directly so they can either be used directly or optionally converted to the secp256k1 types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts
Uses the highly-optimized secp256k1 package
Code examples including:
- Generating a cryptographically secure random seed and deriving a master node from it
- Default HD wallet layout as described by BIP0032
- Audits use case as described by BIP0032
Comprehensive test coverage including the BIP0032 test vectors
Benchmarks

This package is part of the github.com/decred/dcrd/hdkeychain/v3 module. Use the standard go tooling for working with modules to incorporate it.

NewMaster Example Demonstrates how to generate a cryptographically random seed then use it to create a new master node (extended key).
Default Wallet Layout Example Demonstrates the default hierarchical deterministic wallet layout as described in BIP0032.
Audits Use Case Example Demonstrates the audits use case in BIP0032.

Package hdkeychain is licensed under the copyfree ISC License.