lbcwallet/waddrmgr
Wilmer Paulino 51b362d7c5
waddrmgr+wallet: only watch addresses within default key scopes
It was discovered that the wallet can scan the chain for unnecessary
additional addresses that are derived by higher-level applications using
custom key scopes. This isn't much of an issue for full nodes, but it
can cause light clients to scan more than what's required, triggering
more false positive matches which lead to block retrieval.

Now, we'll only scan the chain for addresses that exist within the
default key scopes, as those are the only ones the wallet should be
concerned about.
2020-01-24 17:12:23 -08:00
..
address.go waddrmgr: add new DerivationInfo method to managedAddress, update ScopedKeyManager 2018-08-14 18:17:46 -07:00
common_test.go multi: extend walletdb bolt driver with NoFreelistSync option 2019-10-03 13:28:04 -04:00
cov_report.sh Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
db.go cmd/dropwtxmgr+waddrmgr: handle constraint when resetting synced state 2019-07-08 13:26:43 -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+wallet: only watch addresses within default key scopes 2020-01-24 17:12:23 -08:00
manager_test.go multi: extend walletdb bolt driver with NoFreelistSync option 2019-10-03 13:28:04 -04: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 multi: switch import paths back to upstream 2018-05-23 19:38:56 -07:00
scoped_manager.go waddrmgr: use methods that do not hold the manager's lock 2019-03-18 15:47:48 -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 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/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.