History

Dave Collins f8ad0939a2 Add new function on extended keys to zero them. This commit adds a new function named Zero on the hdkeychain.ExtendedKey which can be used to manually clear the memory used for an extended key. This is useful for enhanced security by allowing the caller to explicitly clear the memory when they're done with a key. Otherwise it might hang around in memory for a while. Once a key has been zeroed it is no longer usable. This commit also contains tests to ensure everything works as expected after a key has been zeroed.		2014-08-18 17:54:20 -05:00
..
bench_test.go	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00
cov_report.sh	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00
doc.go	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00
example_test.go	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00
extendedkey.go	Add new function on extended keys to zero them.	2014-08-18 17:54:20 -05:00
extendedkey_test.go	Add new function on extended keys to zero them.	2014-08-18 17:54:20 -05:00
README.md	Correct DefaultWalletLayout example link.	2014-07-22 17:18:15 -05:00
test_coverage.txt	Implement hdkeychain BIP0032 API.	2014-07-22 17:11:46 -05:00

README.md

hdkeychain

[] (https://travis-ci.org/conformal/btcutil)

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. Package hdkeychain is licensed under the liberal ISC license.

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 btcnet
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

Documentation

[] (http://godoc.org/github.com/conformal/btcutil/hdkeychain)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/conformal/btcutil/hdkeychain

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/conformal/btcutil/hdkeychain

Installation

$ go get github.com/conformal/btcutil/hdkeychain

Examples

[NewMaster Example] (http://godoc.org/github.com/conformal/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/conformal/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/conformal/btcutil/hdkeychain#example-package--Audits)
Demonstrates the audits use case in BIP0032.

License

Package hdkeychain is licensed under the copyfree ISC License.