ucwallet

command module
v0.0.0-...-9e8562e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2019 License: ISC Imports: 51 Imported by: 0

README

ucwallet

ucwallet is a daemon handling Utopia 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. ucwallet 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, ucwallet 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.

ucwallet provides two modes of operation to connect to the Utopia network. The first (and default) is to communicate with a single trusted ucd 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:

  1. 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.

  2. A gRPC server

    The gRPC server uses a new API built for ucwallet, 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 here.

Installation and updating

Binaries (Windows/Linux/macOS)

Binary releases are provided for common operating systems and architectures:

https://github.com/UtopiaCoinOrg/Utopia-binaries/releases

Build from source (all platforms)

Building or updating from source requires the following build dependencies:

  • Go 1.11 or 1.12

    Installation instructions can be found here: https://golang.org/doc/install. It is recommended to add $GOPATH/bin to your PATH at this point.

To build and install from a checked-out repo, run go install in the repo's root directory. Some notes:

  • Set the GO111MODULE=on environment variable if building from within GOPATH.

  • The ucwallet executable will be installed to $GOPATH/bin. GOPATH defaults to $HOME/go (or %USERPROFILE%\go on Windows) if unset.

Docker

All tests and linters may be run in a docker container using the script run_tests.sh. This script defaults to using the current supported version of go. You can run it with the major version of go you would like to use as the only argument to test a previous on a previous version of go (generally utopia supports the current version of go and the previous one).

./run_tests.sh 1.11

To run the tests locally without docker:

./run_tests.sh local

Getting Started

The following instructions detail how to get started with ucwallet connecting to a localhost ucd. Commands should be run in cmd.exe or PowerShell on Windows, or any terminal emulator on *nix.

  • Run the following command to start ucd:
ucd -u rpcuser -P rpcpass
  • Run the following command to create a wallet:
ucwallet -u rpcuser -P rpcpass --create
  • Run the following command to start ucwallet:
ucwallet -u rpcuser -P rpcpass

If everything appears to be working, it is recommended at this point to copy the sample ucd and ucwallet configurations and update with your RPC username and password.

PowerShell (Installed from source):

PS> cp $env:GOPATH\src\github.com\utopia\ucd\sample-ucd.conf $env:LOCALAPPDATA\Ucd\ucd.conf
PS> cp $env:GOPATH\src\github.com\utopia\ucwallet\sample-ucwallet.conf $env:LOCALAPPDATA\Ucwallet\ucwallet.conf
PS> $editor $env:LOCALAPPDATA\Ucd\ucd.conf
PS> $editor $env:LOCALAPPDATA\Ucwallet\ucwallet.conf

Linux/BSD/POSIX (Installed from source):

$ cp $GOPATH/src/github.com/UtopiaCoinOrg/ucd/sample-ucd.conf ~/.ucd/ucd.conf
$ cp $GOPATH/src/github.com/UtopiaCoinOrg/ucwallet/sample-ucwallet.conf ~/.ucwallet/ucwallet.conf
$ $EDITOR ~/.ucd/ucd.conf
$ $EDITOR ~/.ucwallet/ucwallet.conf

Issue Tracker

The integrated github issue tracker is used for this project.

License

ucwallet is licensed under the liberal ISC License.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
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
jsonrpc/types
Package types implements concrete types for the ucwallet JSON-RPC API.
Package types implements concrete types for the ucwallet JSON-RPC API.
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 rpctest contains tests for ucwallet's RPC server and a harness used to facilitate the tests by setting up a temporary Simnet node and wallet.
Package rpctest contains tests for ucwallet's RPC server and a harness used to facilitate the tests by setting up a temporary Simnet node and 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.
udb
walletdb
Package walletdb provides a namespaced database interface for ucwallet.
Package walletdb provides a namespaced database interface for ucwallet.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL