dcrd/hdkeychain
Dave Collins 79fa2f0c12
hdkeychain: Use secp256k1 privkey to pubkey method.
This makes use of the PubKey method on secp256k1.PrivateKey to convert a
private key to a public key instead of manually performing the
conversion.

This is desirable since secp256k1 provides the method specifically for
this purpose and it also has the benefit of allowing secp256k1 to
perform the task without round tripping through big integers which
results in slightly faster derivation.

The following benchmarks show a before and after comparison of the
affected operations:

benchmark                 old ns/op    new ns/op    delta
----------------------------------------------------------
BenchmarkDeriveHardened   3702         3671         -0.84%
BenchmarkDeriveNormal     4053         3999         -1.33%

benchmark                 old allocs   new allocs   delta
----------------------------------------------------------
BenchmarkDeriveHardened   14           14           +0.00%
BenchmarkDeriveNormal     15           15           +0.00%

benchmark                 old bytes    new bytes    delta
----------------------------------------------------------
BenchmarkDeriveHardened   1360         1360         +0.00%
BenchmarkDeriveNormal     1409         1409         +0.00%
2020-04-06 15:38:41 -05:00
..
bench_test.go hdkeychain: Use mock net params in tests. 2019-03-29 11:26:40 -05:00
doc.go hdkeychain: Fix references to methods in package docs 2020-03-11 11:34:50 -05:00
example_test.go hdkeychain: Remove Neuter error return 2020-03-12 11:37:37 -05:00
extendedkey_test.go hdkeychain: Add child key with leading zeros test. 2020-04-06 14:21:44 -05:00
extendedkey.go hdkeychain: Use secp256k1 privkey to pubkey method. 2020-04-06 15:38:41 -05:00
go.mod hdkeychain: Use direct hashes and remove dcrutil dep 2020-02-16 19:10:26 -06:00
go.sum chaincfg: Start v3 module dev cycle. 2020-01-29 13:24:14 -06:00
README.md multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00

hdkeychain

Build Status ISC License Doc

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.

Feature Overview

  • Full BIP0032 implementation
  • Single type for private and public extended keys
  • Convenient cryptographically 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 accepting a network parameters interface
  • Allows obtaining the underlying serialized secp256k1 pubkeys and privkeys directly so they can either be used directly or optionally converted to the secp256k1 types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts
  • Uses the highly-optimized secp256k1 package
  • 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

License

Package hdkeychain is licensed under the copyfree ISC License.