README
¶
fistwallet
fistwallet is a daemon handling Fistchain wallet functionality. All interaction with the wallet is performed over RPC.
Public and private keys are derived using the hierarchical
deterministic format described by
BIP0032.
Unencrypted private keys are not supported and are never written to
disk. fistwallet uses the
m/44'/<coin type>'/<account>'/<branch>/<address index>
HD path for all derived addresses, as described by
BIP0044.
Due to the sensitive nature of public data in a BIP0032 wallet, fistwallet provides the option of encrypting not just private keys, but public data as well. This is intended to thwart privacy risks where a wallet file is compromised without exposing all current and future addresses (public keys) managed by the wallet. While access to this information would not allow an attacker to spend or steal coins, it does mean they could track all transactions involving your addresses and therefore know your exact balance. In a future release, public data encryption will extend to transactions as well.
fistwallet provides two modes of operation to connect to the Fistchain
network. The first (and default) is to communicate with a single
trusted fistd instance using JSON-RPC. The second is a
privacy-preserving Simplified Payment Verification (SPV) mode (enabled
with the --spv flag) where the wallet connects either to specified
peers (with --spvconnect) or peers discovered from seeders and other
peers. Both modes can be switched between with just a restart of the
wallet. It is advised to avoid SPV mode for heavily-used wallets
which require downloading most blocks regardless.
Not all functionality is available when running in SPV mode. Some of these features may become available in future versions, but only if a consensus vote passes to activate the required changes. Currently, the following features are disabled or unavailable to SPV wallets:
-
Voting
-
Revoking tickets before expiry
-
Determining exact number of live and missed tickets (as opposed to simply unspent).
Wallet clients interact with the wallet using one of two RPC servers:
-
A legacy JSON-RPC server inspired by the Bitcoin Core rpc server
The JSON-RPC server exists to ease the migration of wallet applications from Core, but complete compatibility is not guaranteed. Some portions of the API (and especially accounts) have to work differently due to other design decisions (mostly due to BIP0044). However, if you find a compatibility issue and feel that it could be reasonably supported, please report an issue. This server is enabled by default as long as a username and password are provided.
-
A gRPC server
The gRPC server uses a new API built for fistwallet, but the API is not stabilized. This server is enabled by default and may be disabled with the config option
--nogrpc. If you don't mind applications breaking due to API changes, don't want to deal with issues of the legacy API, or need notifications for changes to the wallet, this is the RPC server to use. The gRPC server is documented .
Issue Tracker
The integrated github issue tracker is used for this project.
License
fistwallet is licensed under the liberal ISC License.
Documentation
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package errors provides error creation and matching for all wallet systems.
|
Package errors provides error creation and matching for all wallet systems. |
|
internal
|
|
|
helpers
Package helpers provides convenience functions to simplify wallet code.
|
Package helpers provides convenience functions to simplify wallet code. |
|
zero
Package zero contains functions to clear data from byte slices and multi-precision integers.
|
Package zero contains functions to clear data from byte slices and multi-precision integers. |
|
Package loader provides a concurrent safe implementation of a wallet loader.
|
Package loader provides a concurrent safe implementation of a wallet loader. |
|
Package pgpwordlist provides the pgpwordlist for easier hashes/seeds.
|
Package pgpwordlist provides the pgpwordlist for easier hashes/seeds. |
|
rpc
|
|
|
rpcserver
Package rpcserver implements the RPC API and is used by the main package to start gRPC services.
|
Package rpcserver implements the RPC API and is used by the main package to start gRPC services. |
|
Package ticketbuyer provides an implementation of automatic ticket purchasing for a decred wallet.
|
Package ticketbuyer provides an implementation of automatic ticket purchasing for a decred wallet. |
|
Package validate provides context-free consensus validation.
|
Package validate provides context-free consensus validation. |
|
Package wallet provides ...
|
Package wallet provides ... |
|
drivers/bdb
Package bdb registers the bdb driver at init time.
|
Package bdb registers the bdb driver at init time. |
|
internal/bdb
Package bdb implements an instance of walletdb that uses boltdb for the backing datastore.
|
Package bdb implements an instance of walletdb that uses boltdb for the backing datastore. |
|
txauthor
Package txauthor provides transaction creation code for wallets.
|
Package txauthor provides transaction creation code for wallets. |
|
txrules
Package txrules provides functions that are help establish whether or not a transaction abides by non-consensus rules for things like the daemon and stake pool.
|
Package txrules provides functions that are help establish whether or not a transaction abides by non-consensus rules for things like the daemon and stake pool. |
|
walletdb
Package walletdb provides a namespaced database interface for dcrwallet.
|
Package walletdb provides a namespaced database interface for dcrwallet. |