walletmain

package
v1.9.22 Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2021 License: Unlicense, ISC Imports: 31 Imported by: 2

README

pod wallet

Build Status Build status

btcwallet is a daemon handling bitcoin wallet functionality for a single user. It acts as both an RPC client to pod and an RPC server for wallet clients and legacy RPC applications.

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. btcwallet 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, btcwallet 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.

btcwallet is not an SPV client and requires connecting to a local or remote pod instance for asynchronous blockchain queries and notifications over websockets. Full pod installation instructions can be found here. An alternative SPV mode that is compatible with pod and Bitcoin Core is planned for a future release.

Wallet clients can use one of two RPC servers:

  1. A legacy JSON-RPC server mostly compatible with Bitcoin Core

    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.

  2. An experimental gRPC server

    The gRPC server uses a new API built for btcwallet, but the API is not stabilized and the server is feature gated behind a config option (--experimentalrpclisten). 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

Windows - MSIs Available

Install the latest MSIs available here:

https://github.com/p9c/pod/releases

https://github.com/p9c/pod/walletmain/releases

Windows/Linux/BSD/POSIX - Build from source

Building or updating from source requires the following build dependencies:

  • Go 1.5 or 1.6

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

    Note: If you are using Go 1.5, you must manually enable the vendor experiment by setting the GO15VENDOREXPERIMENT environment variable to 1. This step is not required for Go 1.6.

  • Glide

    Glide is used to manage project dependencies and provide reproducible builds. To install:

    go get -u github.com/Masterminds/glide

Unfortunately, the use of glide prevents a handy tool such as go get from automatically downloading, building, and installing the source in a single command. Instead, the latest project and dependency sources must be first obtained manually with git and glide, and then go is used to build and install the project.

Getting the source:

For a first time installation, the project and dependency sources can be obtained manually with git and glide (create directories as needed):

git clone https://github.com/p9c/pod/walletmain $GOPATH/src/github.com/p9c/pod/walletmain
cd $GOPATH/src/github.com/p9c/pod/walletmain
glide install

To update an existing source tree, pull the latest changes and install the matching dependencies:

cd $GOPATH/src/github.com/p9c/pod/walletmain
git pull
glide install

Building/Installing:

The go tool is used to build or install (to GOPATH) the project. Some example build instructions are provided below (all must run from the btcwallet project directory).

To build and install btcwallet and all helper commands (in the cmd directory) to $GOPATH/bin/, as well as installing all compiled packages to $GOPATH/pkg/ (use this if you are unsure which command to run):

go install . ./cmd/...

To build a btcwallet executable and install it to $GOPATH/bin/:

go install

To build a btcwallet executable and place it in the current directory:

go build

Getting Started

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

  • Run the following command to start pod:
pod -u rpcuser -P rpcpass
  • Run the following command to create a wallet:
btcwallet -u rpcuser -P rpcpass --create
  • 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 pod and btcwallet configurations and update with your RPC username and password.

PowerShell (Installed from MSI):

PS> cp "$env:ProgramFiles\Pod Suite\Pod\sample-pod.conf" $env:LOCALAPPDATA\Pod\pod.conf
PS> cp "$env:ProgramFiles\Pod Suite\Btcwallet\sample-btcwallet.conf" $env:LOCALAPPDATA\Btcwallet\btcwallet.conf
PS> $editor $env:LOCALAPPDATA\Pod\pod.conf
PS> $editor $env:LOCALAPPDATA\Btcwallet\btcwallet.conf

PowerShell (Installed from source):

PS> cp $env:GOPATH\src\github.com\btcsuite\pod\sample-pod.conf $env:LOCALAPPDATA\Pod\pod.conf
PS> cp $env:GOPATH\src\github.com\btcsuite\btcwallet\sample-btcwallet.conf $env:LOCALAPPDATA\Btcwallet\btcwallet.conf
PS> $editor $env:LOCALAPPDATA\Pod\pod.conf
PS> $editor $env:LOCALAPPDATA\Btcwallet\btcwallet.conf

Linux/BSD/POSIX (Installed from source):

$ cp $GOPATH/src/github.com/p9c/pod/sample-pod.conf ~/.pod/pod.conf
$ cp $GOPATH/src/github.com/p9c/pod/walletmain/sample-btcwallet.conf ~/.btcwallet/btcwallet.conf
$ $EDITOR ~/.pod/pod.conf
$ $EDITOR ~/.btcwallet/btcwallet.conf

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 the btcsuite developers. 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.

Documentation

Index

Constants

View Source 
const (
	DefaultAppDataDirname   = "wallet"
	DefaultCAFilename       = "wallet.cert"
	DefaultConfigFilename   = "conf.json"
	DefaultLogLevel         = "info"
	DefaultLogDirname       = ""
	DefaultLogFilename      = "wallet/log"
	DefaultRPCMaxClients    = 10
	DefaultRPCMaxWebsockets = 25
	WalletDbName            = "wallet.db"
)

A bunch of constants

Variables

This section is empty.

Functions

func CreateSimulationWallet 

func CreateSimulationWallet(activenet *netparams.Params, cfg *Config) (e error)

CreateSimulationWallet is intended to be called from the rpcclient and used to create a wallet for actors involved in simulations.

func CreateWallet 

func CreateWallet(activenet *netparams.Params, config *pod.Config) (e error)

CreateWallet prompts the user for information needed to generate a new wallet and generates the wallet accordingly. The new wallet will reside at the provided path.

func GenerateRPCKeyPair 

func GenerateRPCKeyPair(config *pod.Config, writeKey bool) (tls.Certificate, error)

GenerateRPCKeyPair generates a new RPC TLS keypair and writes the cert and possibly also the key in PEM format to the paths specified by the config. If successful, the new keypair is returned.

func LoadWallet added in v0.4.14 

func LoadWallet(loader *wallet.Loader, cx *conte.Xt, legacyServer *legacy.Server) (e error)

LoadWallet ...

func Main 

func Main(cx *conte.Xt) (e error)

Main is a work-around main function that is required since deferred functions (such as log flushing) are not called with calls to os.Exit. Instead, main runs this function and checks for a non-nil error, at point any defers have already run, and if the error is non-nil, the program can be exited with an error exit status.

func NetworkDir 

func NetworkDir(dataDir string, chainParams *netparams.Params) string

NetworkDir returns the directory name of a network directory to hold wallet files.

func OpenRPCKeyPair added in v0.4.14 

func OpenRPCKeyPair(config *pod.Config) (tls.Certificate, error)

OpenRPCKeyPair creates or loads the RPC TLS keypair specified by the application config. This function respects the pod.Config.OneTimeTLSKey setting.

func StartChainRPC added in v0.4.14 

func StartChainRPC(config *pod.Config, activeNet *netparams.Params, certs []byte, quit qu.C) (*chain.RPCClient, error)

StartChainRPC opens a RPC client connection to a pod server for blockchain services. This function uses the RPC options from the global config and there is no recovery in case the server is not available or if there is an authentication error. Instead, all requests to the client will simply error.

func Version 

func Version() string

Version returns the application version as a properly formed string per the semantic versioning 2.0.0 spec (http://semver.org/).

Types

type Config 

type Config struct {
	// General application behavior
	ConfigFile    *string `short:"C" long:"configfile" description:"Path to configuration file"`
	ShowVersion   *bool   `short:"V" long:"version" description:"Display version information and exit"`
	LogLevel      *string
	Create        *bool   `long:"create" description:"Create the wallet if it does not exist"`
	CreateTemp    *bool   `` /* 142-byte string literal not displayed */
	AppDataDir    *string `short:"A" long:"appdata" description:"Application data directory for wallet config, databases and logs"`
	TestNet3      *bool   `long:"testnet" description:"Use the test Bitcoin network (version 3) (default mainnet)"`
	SimNet        *bool   `long:"simnet" description:"Use the simulation test network (default mainnet)"`
	NoInitialLoad *bool   `long:"noinitialload" description:"Defer wallet creation/opening on startup and enable loading wallets over RPC"`
	LogDir        *string `long:"logdir" description:"Directory to log output."`
	Profile       *string `long:"profile" description:"Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536"`
	// GUI           *bool   `long:"__OLDgui" description:"Launch GUI"`
	// Wallet options
	WalletPass *string `` /* 127-byte string literal not displayed */
	// RPC client options
	RPCConnect      *string `` /* 171-byte string literal not displayed */
	CAFile          *string `long:"cafile" description:"File containing root certificates to authenticate a TLS connections with pod"`
	EnableClientTLS *bool   `long:"clienttls" description:"Enable TLS for the RPC client"`
	PodUsername     *string `long:"podusername" description:"Username for pod authentication"`
	PodPassword     *string `long:"podpassword" default-mask:"-" description:"Password for pod authentication"`
	Proxy           *string `long:"proxy" description:"Connect via SOCKS5 proxy (eg. 127.0.0.1:9050)"`
	ProxyUser       *string `long:"proxyuser" description:"Username for proxy server"`
	ProxyPass       *string `long:"proxypass" default-mask:"-" description:"Password for proxy server"`
	// SPV client options
	UseSPV       *bool            `long:"usespv" description:"Enables the experimental use of SPV rather than RPC for chain synchronization"`
	AddPeers     *cli.StringSlice `short:"a" long:"addpeer" description:"Add a peer to connect with at startup"`
	ConnectPeers *cli.StringSlice `long:"connect" description:"Connect only to the specified peers at startup"`
	MaxPeers     *int             `long:"maxpeers" description:"Max number of inbound and outbound peers"`
	BanDuration  *time.Duration   `long:"banduration" description:"How long to ban misbehaving peers.  Valid time units are {s, m, h}.  Minimum 1 second"`
	BanThreshold *int             `long:"banthreshold" description:"Maximum allowed ban score before disconnecting and banning misbehaving peers."`
	// RPC server options
	//
	// The legacy server is still enabled by default (and eventually will be replaced with the experimental server) so
	// prepare for that change by renaming the struct fields (but not the configuration options).
	//
	// Usernames can also be used for the consensus RPC client, so they aren't considered legacy.
	RPCCert                *string          `long:"rpccert" description:"File containing the certificate file"`
	RPCKey                 *string          `long:"rpckey" description:"File containing the certificate key"`
	OneTimeTLSKey          *bool            `long:"onetimetlskey" description:"Generate a new TLS certpair at startup, but only write the certificate to disk"`
	EnableServerTLS        *bool            `long:"servertls" description:"Enable TLS for the RPC server"`
	LegacyRPCListeners     *cli.StringSlice `` /* 140-byte string literal not displayed */
	LegacyRPCMaxClients    *int             `long:"rpcmaxclients" description:"Max number of legacy RPC clients for standard connections"`
	LegacyRPCMaxWebsockets *int             `long:"rpcmaxwebsockets" description:"Max number of legacy RPC websocket connections"`
	Username               *string          `short:"u" long:"username" description:"Username for legacy RPC and pod authentication (if podusername is unset)"`
	Password               *string          `` /* 129-byte string literal not displayed */
	// EXPERIMENTAL RPC server options
	//
	// These options will change (and require changes to config files, etc.) when the new gRPC server is enabled.
	ExperimentalRPCListeners *cli.StringSlice `long:"experimentalrpclisten" description:"Listen for RPC connections on this interface/port"`
	// Deprecated options
	DataDir *string `short:"b" long:"datadir" default-mask:"-" description:"DEPRECATED -- use appdata instead"`
}

Config is the main configuration for wallet

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.