History

Dave Collins 1fb0120cc6 hdkeychain: Consolidate tests into package. Putting the test code in the same package makes it easier for forks since they don't have to change the import paths as much. Also, address a few style and consistent nits while here: - Prefer t.Fatalf over t.Errorf followed by a return - Use the consistent style of starting a test function comments with the test name - Prefix test errors by the function being called instead of the one doing the calling since the caller itself is already logged by the test framework - Check err in max depth test before checking the returned key is nil		2017-05-09 12:09:02 -05:00
..
bench_test.go	Relicense to the btcsuite developers.	2015-05-01 12:41:58 -05:00
cov_report.sh	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00
doc.go	Relicense to the btcsuite developers.	2015-05-01 12:41:58 -05:00
example_test.go	hdkeychain: Update NewMaster to accept network.	2015-11-10 11:31:41 -06:00
extendedkey.go	hdkeychain: Consolidate tests into package.	2017-05-09 12:09:02 -05:00
extendedkey_test.go	hdkeychain: Consolidate tests into package.	2017-05-09 12:09:02 -05:00
README.md	docs: Make various README.md files consistent.	2015-10-23 17:17:38 -05:00
test_coverage.txt	Update hdkeychain test coverage report.	2014-08-18 18:18:16 -05:00

README.md

hdkeychain

[] (https://travis-ci.org/btcsuite/btcutil) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [] (http://godoc.org/github.com/btcsuite/btcutil/hdkeychain)

Package hdkeychain provides an API for bitcoin hierarchical deterministic extended keys (BIP0032).

A comprehensive suite of tests is provided to ensure proper functionality. See test_coverage.txt for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report.

Feature Overview

Full BIP0032 implementation
Single type for private and public extended keys
Convenient cryptograpically 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 registering them with chaincfg
Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transations and generate payment scripts
Uses the btcec package which is highly optimized for secp256k1
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

Installation and Updating

$ go get -u github.com/btcsuite/btcutil/hdkeychain

Examples

[NewMaster Example] (http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-NewMaster)
Demonstrates how to generate a cryptographically random seed then use it to create a new master node (extended key).
[Default Wallet Layout Example] (http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--DefaultWalletLayout)
Demonstrates the default hierarchical deterministic wallet layout as described in BIP0032.
[Audits Use Case Example] (http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--Audits)
Demonstrates the audits use case in BIP0032.

License

Package hdkeychain is licensed under the copyfree ISC License.