lbcwallet/waddrmgr
Dave Collins 454d290b68 Convert waddrmgr to new walletdb package.
This commit converts the waddrmgr package to use the new walletdb package
semantics.

Since waddrmgr no longer controls the database, it is unable to make a
copy of the database and return it as the old ExportWatchingOnly function
required.  As a result, it has been renamed to ConvertToWatchingOnly and
it now modifies the namespace provided to it.  The idea is that the caller
which does control the database can now make a copy of the database, get
the waddrmgr namespace in the database copy and invoke the new function
to modify it.  This also works well with other packages that might also
need to make modifications for watching-only mode.

In addition, the following changes are made:

- All places that worked with database paths now work with the
  walletdb.Namespace interface
- The managerTx code is replaced to use the walletdb.Tx interface
- The code which checks if the manager already exists is updated to work
  with the walletdb.Namespace interface
- The LatestDbVersion constant is now LatestMgrVersion since it no longer
  controls the database
2014-11-11 15:07:16 -06:00
..
address.go Allow injection of crypto keys into the manager. 2014-10-13 16:19:11 -05:00
common_test.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
cov_report.sh Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
db.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
doc.go Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
error.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
error_test.go Add the new ErrInvalidKeyType to the stringer map. 2014-10-31 10:20:58 -05:00
internal_test.go Cleanup recent encrypt/decrypt test additions. 2014-11-10 21:39:57 -06:00
manager.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
manager_test.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
README.md Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
sync.go Convert waddrmgr to new walletdb package. 2014-11-11 15:07:16 -06:00
test_coverage.txt Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00

waddrmgr

[Build Status] (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

[GoDoc] (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

$ go get github.com/conformal/btcwallet/waddrmgr

Package waddrmgr is licensed under the copyfree ISC License.