d0938d817f
This commit implements a new secure, scalable, hierarchical deterministic
wallet address manager package.
The following is an overview of features:
- BIP0032 hierarchical deterministic keys
- BIP0043/BIP0044 multi-account hierarchy
- Strong focus on security:
- Fully encrypted database including public information such as
addresses as well as private information such as private keys and
scripts needed to redeem pay-to-script-hash transactions
- Hardened against memory scraping through the use of actively clearing
private material from memory when locked
- Different crypto keys used for public, private, and script data
- Ability for different passphrases for public and private data
- Scrypt-based key derivation
- NaCl-based secretbox cryptography (XSalsa20 and Poly1305)
- Multi-tier scalable key design to allow instant password changes
regardless of the number of addresses stored
- Import WIF keys
- Import pay-to-script-hash scripts for things such as multi-signature
transactions
- Ability to export a watching-only version which does not contain any
private key material
- Programmatically detectable errors, including encapsulation of errors
from packages it relies on
- Address synchronization capabilities
This commit only provides the implementation package. It does not
include integration into to the existing wallet code base or conversion of
existing addresses. That functionality will be provided by future
commits.
62 lines
2.4 KiB
Markdown
62 lines
2.4 KiB
Markdown
waddrmgr
|
|
========
|
|
|
|
[]
|
|
(https://travis-ci.org/conformal/btcwallet)
|
|
|
|
Package waddrmgr provides a secure hierarchical deterministic wallet address
|
|
manager.
|
|
|
|
A 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. Package waddrmgr is licensed under the liberal ISC license.
|
|
|
|
## Feature Overview
|
|
|
|
- BIP0032 hierarchical deterministic keys
|
|
- BIP0043/BIP0044 multi-account hierarchy
|
|
- Strong focus on security:
|
|
- Fully encrypted database including public information such as addresses as
|
|
well as private information such as private keys and scripts needed to
|
|
redeem pay-to-script-hash transactions
|
|
- Hardened against memory scraping through the use of actively clearing
|
|
private material from memory when locked
|
|
- Different crypto keys used for public, private, and script data
|
|
- Ability for different passphrases for public and private data
|
|
- Scrypt-based key derivation
|
|
- NaCl-based secretbox cryptography (XSalsa20 and Poly1305)
|
|
- Scalable design:
|
|
- Multi-tier key design to allow instant password changes regardless of the
|
|
number of addresses stored
|
|
- Import WIF keys
|
|
- Import pay-to-script-hash scripts for things such as multi-signature
|
|
transactions
|
|
- Ability to export a watching-only version which does not contain any private
|
|
key material
|
|
- Programmatically detectable errors, including encapsulation of errors from
|
|
packages it relies on
|
|
- Address synchronization capabilities
|
|
- Comprehensive test coverage
|
|
|
|
## Documentation
|
|
|
|
[]
|
|
(http://godoc.org/github.com/conformal/btcwallet/waddrmgr)
|
|
|
|
Full `go doc` style documentation for the project can be viewed online without
|
|
installing this package by using the GoDoc site here:
|
|
http://godoc.org/github.com/conformal/btcwallet/waddrmgr
|
|
|
|
You can also view the documentation locally once the package is installed with
|
|
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
|
|
http://localhost:6060/pkg/github.com/conformal/btcwallet/waddrmgr
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ go get github.com/conformal/btcwallet/waddrmgr
|
|
```
|
|
|
|
Package waddrmgr is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|