65001cd49e
This change moves the hdkeychain package outside of the dcrutil directory into its own top-level package. This change is being made since hdkeychain only depends on dcrutil's address code, and if the rpctest integration tests are ever moved outside of the dcrd repo, hdkeychain will no longer be required to remain in dcrd to avoid a cyclic dependency.
60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
hdkeychain
|
|
==========
|
|
|
|
[](https://travis-ci.org/decred/dcrd)
|
|
[](http://copyfree.org)
|
|
[](http://godoc.org/github.com/decred/dcrd/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. 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 decred
|
|
addresses ties in seamlessly with existing btcec and dcrutil 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
|
|
|
|
```bash
|
|
$ go get -u github.com/decred/dcrd/hdkeychain
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [NewMaster Example](http://godoc.org/github.com/decred/dcrd/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/decred/dcrd/hdkeychain#example-package--DefaultWalletLayout)
|
|
Demonstrates the default hierarchical deterministic wallet layout as described
|
|
in BIP0032.
|
|
* [Audits Use Case Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--Audits)
|
|
Demonstrates the audits use case in BIP0032.
|
|
|
|
## License
|
|
|
|
Package hdkeychain is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|