b9fd527d33
This commit is the result of several big changes being made to the wallet. In particular, the "handshake" (initial sync to the chain server) was quite racy and required proper synchronization. To make fixing this race easier, several other changes were made to the internal wallet data structures and much of the RPC server ended up being rewritten. First, all account support has been removed. The previous Account struct has been replaced with a Wallet structure, which includes a keystore for saving keys, and a txstore for storing relevant transactions. This decision has been made since it is the opinion of myself and other developers that bitcoind accounts are fundamentally broken (as accounts implemented by bitcoind support both arbitrary address groupings as well as moving balances between accounts -- these are fundamentally incompatible features), and since a BIP0032 keystore is soon planned to be implemented (at which point, "accounts" can return as HD extended keys). With the keystore handling the grouping of related keys, there is no reason have many different Account structs, and the AccountManager has been removed as well. All RPC handlers that take an account option will only work with "" (the default account) or "*" if the RPC allows specifying all accounts. Second, much of the RPC server has been cleaned up. The global variables for the RPC server and chain server client have been moved to part of the rpcServer struct, and the handlers for each RPC method that are looked up change depending on which components have been set. Passthrough requests are also no longer handled specially, but when the chain server is set, a handler to perform the passthrough will be returned if the method is not otherwise a wallet RPC. The notification system for websocket clients has also been rewritten so wallet components can send notifications through channels, rather than requiring direct access to the RPC server itself, or worse still, sending directly to a websocket client's send channel. In the future, this will enable proper registration of notifications, rather than unsolicited broadcasts to every connected websocket client (see issue #84). Finally, and the main reason why much of this cleanup was necessary, the races during intial sync with the chain server have been fixed. Previously, when the 'Handshake' was run, a rescan would occur which would perform modifications to Account data structures as notifications were received. Synchronization was provided with a single binary semaphore which serialized all access to wallet and account data. However, the Handshake itself was not able to run with this lock (or else notifications would block), and many data races would occur as both notifications were being handled. If GOMAXPROCS was ever increased beyond 1, btcwallet would always immediately crash due to invalid addresses caused by the data races on startup. To fix this, the single lock for all wallet access has been replaced with mutexes for both the keystore and txstore. Handling of btcd notifications and client requests may now occur simultaneously. GOMAXPROCS has also been set to the number of logical CPUs at the beginning of main, since with the data races fixed, there's no reason to prevent the extra parallelism gained by increasing it. Closes #78. Closes #101. Closes #110. |
||
---|---|---|
chain | ||
keystore | ||
rename | ||
txstore | ||
.gitignore | ||
.travis.yml | ||
btcwallet.go | ||
chainntfns.go | ||
CHANGES | ||
config.go | ||
createtx.go | ||
createtx_test.go | ||
deps.txt | ||
disksync.go | ||
log.go | ||
params.go | ||
README.md | ||
rescan.go | ||
rpcserver.go | ||
rpcserver_test.go | ||
sample-btcwallet.conf | ||
signal.go | ||
version.go | ||
wallet.go |
btcwallet
[] (https://travis-ci.org/conformal/btcwallet)
btcwallet is a daemon handling bitcoin wallet functionality for a single user. It acts as both an RPC client to btcd and an RPC server for wallet clients and legacy RPC applications.
The wallet file format is based on Armory and provides a deterministic wallet where all future generated private keys can be recovered from a previous wallet backup. Unencrypted wallets are unsupported and are never written to disk. This design decision has the consequence of generating new wallets on the fly impossible: a client is required to provide a wallet encryption passphrase.
btcwallet is not an SPV client and requires connecting to a local or remote btcd instance for asynchronous blockchain queries and notifications over websockets. Full btcd installation instructions can be found here.
As a daemon, btcwallet provides no user interface and an additional graphical or command line client is required for normal, personal wallet usage. Conformal has written btcgui as a graphical client to btcwallet.
This project is currently under active development is not production ready yet. Support for creating and using wallets the main Bitcoin network is currently disabled by default.
Installation
Windows - MSI Available
Install the btcd suite MSI here:
https://opensource.conformal.com/packages/windows/btcdsuite/
Linux/BSD/POSIX - Build from Source
-
Install Go according to the installation instructions here: http://golang.org/doc/install
-
Run the following commands to obtain and install btcwallet and all dependencies:
$ go get -u -v github.com/conformal/btcd/...
$ go get -u -v github.com/conformal/btcwallet/...
- btcd and btcwallet will now be installed in either
$GOROOT/bin
or$GOPATH/bin
depending on your configuration. If you did not already add to your system path during the installation, we recommend you do so now.
Updating
Windows
Install a newer btcd suite MSI here:
https://opensource.conformal.com/packages/windows/btcdsuite/
Linux/BSD/POSIX - Build from Source
- Run the following commands to update btcwallet, all dependencies, and install it:
$ go get -u -v github.com/conformal/btcd/...
$ go get -u -v github.com/conformal/btcwallet/...
Getting Started
The follow instructions detail how to get started with btcwallet connecting to a localhost btcd.
Windows (Installed from MSI)
Open Btcd Suite
from the Btcd Suite
menu in the Start
Menu. This will also open btcgui, which can be closed if you only
want btcd and btcwallet running.
Linux/BSD/POSIX/Source
- Run the following command to start btcd:
$ btcd --testnet -u rpcuser -P rpcpass
- Run the following command to start btcwallet:
$ btcwallet -u rpcuser -P rpcpass
If everything appears to be working, it is recommended at this point to copy the sample btcd and btcwallet configurations and update with your RPC username and password.
$ cp $GOPATH/src/github.com/conformal/btcd/sample-btcd.conf ~/.btcd/btcd.conf
$ cp $GOPATH/src/github.com/conformal/btcwallet/sample-btcwallet.conf ~/.btcwallet/btcwallet.conf
$ $EDITOR ~/.btcd/btcd.conf
$ $EDITOR ~/.btcwallet/btcwallet.conf
Client Usage
Clients wishing to use btcwallet must connect to the ws
endpoint
over a websocket connection. Messages sent to btcwallet over this
websocket are expected to follow the standard Bitcoin JSON API
(partially documented
here).
Websocket connections also enable additional API extensions and
JSON-RPC notifications (currently undocumented). The btcd packages
btcjson
and btcws
provide types and functions for creating and
JSON (un)marshaling these requests and notifications.
Issue Tracker
The integrated github issue tracker is used for this project.
GPG Verification Key
All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from Conformal. To verify the signature perform the following:
-
Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
-
Import the public key into your GPG keyring:
gpg --import GIT-GPG-KEY-conformal.txt
-
Verify the release tag with the following command where
TAG_NAME
is a placeholder for the specific tag:git tag -v TAG_NAME
License
btcwallet is licensed under the liberal ISC License.