mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-06-10 08:06:44 +00:00
1cd2eb9308
* [NOD-494] Updated main README.md * [NOD-494] Updated blockdag/README.md * [NOD-494] Aligned text length in main README.md * [NOD-494] Updated most remaining packages READMEs + deleted util/coinset * [NOD-494] Update integration README * [NOD-494] Did a final pass over all readmes * [NOD-494] Updated README for DNSSeeder with more info on how to create a functioning setup * [NOD-494] Remove all double spaces from readmes * [NOD-494] Minor fixes in READMEs + update license to kaspanet developers * [NOD-494] Add backtick around ecc and util in hdkeychain README
44 lines
1.9 KiB
Markdown
44 lines
1.9 KiB
Markdown
hdkeychain
|
|
==========
|
|
|
|
[](http://copyfree.org)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad/util/hdkeychain)
|
|
|
|
Package hdkeychain provides an API for kaspa hierarchical deterministic
|
|
extended keys.
|
|
|
|
## Feature Overview
|
|
|
|
- Full BIP0032-compatible 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 dagconfig
|
|
- Obtaining the underlying EC pubkeys, EC privkeys, and associated kaspa
|
|
addresses ties in seamlessly with existing `ecc` and `util` types which provide
|
|
powerful tools for working with them to do things like sign transations and
|
|
generate payment scripts
|
|
- Uses the `ecc` 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
|
|
|
|
## Examples
|
|
|
|
* [NewMaster Example](http://godoc.org/github.com/kaspanet/kaspad/util/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/kaspanet/kaspad/util/hdkeychain#example-package--DefaultWalletLayout)
|
|
Demonstrates the default hierarchical deterministic wallet layout as described
|
|
in BIP0032.
|
|
* [Audits Use Case Example](http://godoc.org/github.com/kaspanet/kaspad/util/hdkeychain#example-package--Audits)
|
|
Demonstrates the audits use case in BIP0032.
|
|
|