History

Dave Collins e8bab6bc19 docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent.		2015-10-23 17:17:38 -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	Fix tiny typo in docs.	2015-07-24 06:59:43 +00:00
extendedkey.go	Relicense to the btcsuite developers.	2015-05-01 12:41:58 -05:00
extendedkey_test.go	Fix typo in test.	2015-06-11 16:39:44 -04: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.