lbcwallet/waddrmgr
Wilmer Paulino 198b0b8dae
waddrmgr: store watch-only accounts under new account type
Watch-only accounts are usually backed by an external signer as they do
not contain any private key information. Some external signers require a
root key fingerprint for identification and signing purposes. In order
to guarantee compatibility with external signers, we need to persist the
root key fingerprint within the database.

Before this change, watch-only accounts used the default account
database structure. In this commit, we introduce a new account type to
store different information for watch-only accounts only. This isn't a
breaking change as watch-only accounts have yet to be supported by the
primary user of the wallet (lnd). With this new account type, we can
avoid the empty private key fields, which are irrelevant to watch-only
accounts, and we can store the root key fingerprint.
2021-03-15 19:27:05 -07:00
..
address.go waddrmgr: use correct DerivationPath for watch-only accounts 2021-03-15 19:27:04 -07:00
common_test.go waddrmgr: use correct DerivationPath for watch-only accounts 2021-03-15 19:27:04 -07:00
cov_report.sh Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
db.go waddrmgr: store watch-only accounts under new account type 2021-03-15 19:27:05 -07:00
db_test.go waddrmgr: maintain a maximum of MaxReorgDepth block hashes stored 2019-06-11 12:02:41 -07:00
doc.go Use LICENSE file and short license headers. 2016-02-28 22:22:34 -05:00
error.go waddrmgr/db: return ErrBlockNotFound if block doesn't exist 2018-11-12 08:56:31 -08:00
error_test.go multi: switch import paths back to upstream 2018-05-23 19:38:56 -07:00
log.go waddrmgr+wallet: add waddrmgr log to the wallet 2018-11-12 08:56:31 -08:00
manager.go waddrmgr: store watch-only accounts under new account type 2021-03-15 19:27:05 -07:00
manager_test.go waddrmgr: use correct DerivationPath for watch-only accounts 2021-03-15 19:27:04 -07:00
migrations.go cmd/dropwtxmgr+waddrmgr: handle constraint when resetting synced state 2019-07-08 13:26:43 -07:00
migrations_test.go cmd/dropwtxmgr+waddrmgr: handle constraint when resetting synced state 2019-07-08 13:26:43 -07:00
README.md waddrmgr: create watch-only address managers and accounts 2020-04-24 17:44:21 -07:00
scoped_manager.go waddrmgr: store watch-only accounts under new account type 2021-03-15 19:27:05 -07:00
sync.go cmd/dropwtxmgr+waddrmgr: handle constraint when resetting synced state 2019-07-08 13:26:43 -07: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/btcsuite/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 start in watching-only mode which does not contain any private key material
    • Ability to convert to watching-only mode
    • 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/btcsuite/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/btcsuite/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/btcsuite/btcwallet/waddrmgr

Installation

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

Package waddrmgr is licensed under the copyfree ISC License.