e052b9cbf2
This modifies all of the modules, with the exception of the root module, to remove all replacement directives from their go.mod files and update the requirements and module sums accordingly. While it is nice to be able to build and test directly from each module directory and have it pull in the latest untagged changes when developing, having all of the overrides in each module makes it infeasible to use the module tools to help maintain the modules and thus makes it quite difficult to ensure they are all independently accurate for external consumers. By maintaining all of the overrides in the root module and invoking all builds and tests from it, the overrides will apply to ensure the latest code is being built and tested. This also modifies the tests script used with in CI to run all of the tests from the root module accordingly. |
||
|---|---|---|
| .. | ||
| bench_test.go | ||
| doc.go | ||
| example_test.go | ||
| extendedkey_test.go | ||
| extendedkey.go | ||
| go.mod | ||
| go.sum | ||
| README.md | ||
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 transactions 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/decred/dcrd/hdkeychain
Examples
- 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.
License
Package hdkeychain is licensed under the copyfree ISC License.