lbcwallet/waddrmgr
Wilmer Paulino a25899eae7
waddrmgr/migrations: add migration to populate birthday block for existing wallets
In this commit, we add a new migration to the waddrmgr to populate the
birthday block for existing wallets. This will deem useful when
performing rescans for whatever reason, as we'll now be able to start
from this point rather than the genesis block, incurring a longer
rescan.

The migration is not as reliable since we do not store block timestamps,
so we'll need to estimate our height by looking at the genesis timestamp
and assuming a block occurs every 10 minutes. This can be unsafe, and
cause us to actually miss on-chain events, so a sanity check will be
added before the wallet attempts to sync itself in a later commit.
2018-11-13 19:37:08 -08:00
..
address.go waddrmgr: add new DerivationInfo method to managedAddress, update ScopedKeyManager 2018-08-14 18:17:46 -07:00
common_test.go waddrmgr: convert unit tests to package-level tests 2018-11-07 00:44:27 -08:00
cov_report.sh Provide new wallet address manager package. 2014-10-13 16:19:09 -05:00
db.go waddrmgr/db: return ErrBlockNotFound if block doesn't exist 2018-11-12 08:56:31 -08: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: remove old migration logic 2018-11-05 17:58:16 -08:00
manager_test.go waddrmgr: remove testing work-around for unexported vars 2018-11-07 04:02:59 -08:00
migrations.go waddrmgr/migrations: add migration to populate birthday block for existing wallets 2018-11-13 19:37:08 -08:00
migrations_test.go waddrmgr/migrations: add migration to populate birthday block for existing wallets 2018-11-13 19:37:08 -08:00
README.md multi: switch import paths back to upstream 2018-05-23 19:38:56 -07:00
scoped_manager.go waddrmgr: add new DerivationInfo method to managedAddress, update ScopedKeyManager 2018-08-14 18:17:46 -07:00
sync.go waddrmgr/sync: add methods to Manager to get/set birthday block 2018-11-11 17:44:10 -08: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.