mirror of
https://github.com/FlipsideCrypto/dcrd.git
synced 2026-02-06 10:56:47 +00:00
47ade78c1a
This resurrects the regression test network that was removed before initial launch although it really should not have been. The simulation test network and the regression test network do not serve the same purpose. Specifically, the regression test network is intended for unit tests, RPC server tests, and consensus tests. On the other hand, the simulation test network is intended for private use within a group of individuals doing simulation testing and full integration tests between different applications such as wallets, voting service providers, mining pools, block explorers, and other services that build on Decred. Keeping the concerns separate will allow the simulation test network to be modified in ways such as activating consensus changes that have been successfully voted into mainnet without also needing to vote them in on the simulation test network while still preserving the ability for the unit tests to properly test the voting semantics and handling to help prevent regressions. In addition to resurrecting the regression test network, this also fully fleshes out new values for the various addresses prefixes (Rk, Rs, Re, etc), HD key prefixes (rprv, rpub), and treasury multisig details. As a part of resurrecting the network, a new CLI flag `--regnet` is added to allow the RPC test harness connect to a running instance, the areas of the code which involve votes have been modified to allow the votes to apply to the new network, and tests have been added to the relevant modules. This bumps the affected module versions as follows: - github.com/decred/dcrd/wire@v1.2.0 - github.com/decred/dcrd/chaincfg@v1.2.0 - github.com/decred/dcrd/dcrutil@v1.2.0 - github.com/decred/dcrd/hdkeychain@v1.1.1 The blockchain module is also affected, but since its version has already been bumped since the last release tag, it is not bumped again. Finally, this does not include switching unit tests or the RPC test harness over the new network since that will be done in a separate commit. |
||
|---|---|---|
| .. | ||
| 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 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/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.