flip/dcrd
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/dcrd.git synced 2026-02-06 10:56:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

hdkeychain: Update README.md.

Browse Source 
This updates the README.md in hdkeychain to account for changes made in
Decred, correct the NewMaster godoc example link, and format the
examples so the description is on the line after the link for
consistency with other packages in the code base.
This commit is contained in:
Dave Collins 2019-03-19 02:18:24 -05:00
parent 598bd32a11
commit e6c9fddbaf
No known key found for this signature in database
GPG Key ID: B8904D9D9C93D1F2
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hdkeychain/README.md
View File

@ -24,13 +24,13 @@ report.
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
addresses ties in seamlessly with existing secp256k1 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
- Uses the highly-optimized secp256k1 package
- Code examples including:
- Generating a cryptographically secure random seed and deriving a
master node from it
- 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
@ -44,13 +44,13 @@ $ go get -u github.com/decred/dcrd/hdkeychain
## Examples
* [NewMaster Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-NewMaster)
* [NewMaster Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--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)
* [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)
* [Audits Use Case Example](http://godoc.org/github.com/decred/dcrd/hdkeychain#example-package--Audits)
Demonstrates the audits use case in BIP0032.
## License