Skip to content

Files

Latest commit

dajohijrick
dajohi
and
jrick
Drop fastsha256 in favor of crypto/sha256 (#468)
Jan 12, 2017
1563502 · Jan 12, 2017

History

History

waddrmgr

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
Jan 17, 2015
address.go
address.go
Feb 29, 2016
common_test.go
common_test.go
Mar 21, 2016
cov_report.sh
cov_report.sh
Oct 13, 2014
db.go
db.go
Jan 12, 2017
doc.go
doc.go
Feb 29, 2016
error.go
error.go
Feb 29, 2016
error_test.go
error_test.go
Feb 29, 2016
internal_test.go
internal_test.go
Feb 29, 2016
manager.go
manager.go
Dec 13, 2016
manager_test.go
manager_test.go
Aug 8, 2016
sync.go
sync.go
Aug 8, 2016
test_coverage.txt
test_coverage.txt
Oct 13, 2014

README.md

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.