LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
lbcutil/hdkeychain/README.md

60 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
hdkeychain
==========
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
2017-05-25 19:56:27 +02:00
[![Build Status](http://img.shields.io/travis/btcsuite/btcutil.svg)](https://travis-ci.org/btcsuite/btcutil)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain)
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
Package hdkeychain provides an API for bitcoin hierarchical deterministic
extended keys (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
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent.
2015-10-24 00:10:35 +02:00
report.
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
## 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
Update btcnet path import paths to new location.
2015-02-06 05:04:58 +01:00
- Support for custom networks by registering them with chaincfg
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
- Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin
addresses ties in seamlessly with existing btcec and btcutil 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
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent.
2015-10-24 00:10:35 +02:00
## Installation and Updating
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
```bash
docs: Make various README.md files consistent. First, it removes the documentation section from all the README.md files and instead puts a web-based godoc badge and link at the top with the other badges. This is being done since the local godoc tool no longer ships with Go by default, so the instructions no longer work without first installing godoc. Due to this, pretty much everyone uses the web-based godoc these days anyways. Anyone who has manually installed godoc won't need instructions. Second, it makes sure the ISC license badge is at the top with the other badges and removes the textual reference in the overview section. Third, it's modifies the Installation section to Installation and Updating and adds a -u to the go get command since it works for both and thus is simpler. Finally, it replaces the badges with SVG versions from shields.io so they are consistent.
2015-10-24 00:10:35 +02:00
$ go get -u github.com/btcsuite/btcutil/hdkeychain
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
```
## Examples
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
2017-05-25 19:56:27 +02:00
* [NewMaster Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-NewMaster)
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
Demonstrates how to generate a cryptographically random seed then use it to
create a new master node (extended key).
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
2017-05-25 19:56:27 +02:00
* [Default Wallet Layout Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--DefaultWalletLayout)
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
Demonstrates the default hierarchical deterministic wallet layout as described
in BIP0032.
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project.
2017-05-25 19:56:27 +02:00
* [Audits Use Case Example](http://godoc.org/github.com/btcsuite/btcutil/hdkeychain#example-package--Audits)
Implement hdkeychain BIP0032 API. This commit adds a new sub-package named hdkeychain which can be used to derive hierarchical deterministic key chains which form the foundation of hd wallets. - Support 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 registering them with btcnet - Obtaining the underlying EC pubkeys, EC privkeys, and associated bitcoin addresses ties in seamlessly with existing btcec and btcutil types which provide powerful tools for working with them to do things like sign transactions and generate payment scripts - Makes use of 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
2014-07-19 09:13:00 +02:00
Demonstrates the audits use case in BIP0032.
## License
Package hdkeychain is licensed under the [copyfree](http://copyfree.org) ISC
License.
Reference in a new issue Copy permalink