497ffc11f0
This is a rather monolithic commit that moves the old RPC server to its own package (rpc/legacyrpc), introduces a new RPC server using gRPC (rpc/rpcserver), and provides the ability to defer wallet loading until request at a later time by an RPC (--noinitialload). The legacy RPC server remains the default for now while the new gRPC server is not enabled by default. Enabling the new server requires setting a listen address (--experimenalrpclisten). This experimental flag is used to effectively feature gate the server until it is ready to use as a default. Both RPC servers can be run at the same time, but require binding to different listen addresses. In theory, with the legacy RPC server now living in its own package it should become much easier to unit test the handlers. This will be useful for any future changes to the package, as compatibility with Core's wallet is still desired. Type safety has also been improved in the legacy RPC server. Multiple handler types are now used for methods that do and do not require the RPC client as a dependency. This can statically help prevent nil pointer dereferences, and was very useful for catching bugs during refactoring. To synchronize the wallet loading process between the main package (the default) and through the gRPC WalletLoader service (with the --noinitialload option), as well as increasing the loose coupling of packages, a new wallet.Loader type has been added. All creating and loading of existing wallets is done through a single Loader instance, and callbacks can be attached to the instance to run after the wallet has been opened. This is how the legacy RPC server is associated with a loaded wallet, even after the wallet is loaded by a gRPC method in a completely unrelated package. Documentation for the new RPC server has been added to the rpc/documentation directory. The documentation includes a specification for the new RPC API, addresses how to make changes to the server implementation, and provides short example clients in several different languages. Some of the new RPC methods are not implementated exactly as described by the specification. These are considered bugs with the implementation, not the spec. Known bugs are commented as such.
110 lines
4.3 KiB
Text
110 lines
4.3 KiB
Text
[Application Options]
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; Bitcoin wallet settings
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Use mainnet (cannot be used with simnet=1).
|
|
; mainnet=0
|
|
|
|
; Use simnet (cannot be used with mainnet=1).
|
|
; simnet=0
|
|
|
|
; The directory to open and save wallet, transaction, and unspent transaction
|
|
; output files. Two directories, `mainnet` and `testnet` are used in this
|
|
; directory for mainnet and testnet wallets, respectively.
|
|
; datadir=~/.btcwallet
|
|
|
|
; Maximum number of addresses to generate for the keypool (DEPRECATED)
|
|
; keypoolsize=100
|
|
|
|
; Whether transactions must be created with some minimum fee, even if the
|
|
; calculated transaction priority is high enough to allow a free tx
|
|
; disallowfree = false
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; RPC client settings
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Connect via a SOCKS5 proxy. NOTE: Specifying a proxy will disable listening
|
|
; for incoming connections unless listen addresses are provided via the
|
|
; 'rpclisten' option.
|
|
; proxy=127.0.0.1:9050
|
|
; proxyuser=
|
|
; proxypass=
|
|
|
|
; The server and port used for btcd websocket connections.
|
|
; rpcconnect=localhost:18334
|
|
|
|
; File containing root certificates to authenticate a TLS connections with btcd
|
|
; cafile=~/.btcwallet/btcd.cert
|
|
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; RPC server settings
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; TLS certificate and key file locations
|
|
; rpccert=~/.btcwallet/rpc.cert
|
|
; rpckey=~/.btcwallet/rpc.key
|
|
|
|
; Specify the interfaces for the RPC server listen on. One rpclisten address
|
|
; per line. Multiple rpclisten options may be set in the same configuration,
|
|
; and each will be used to listen for connections. NOTE: The default port is
|
|
; modified by some options such as 'mainnet', so it is recommended to not
|
|
; specify a port and allow a proper default to be chosen unless you have a
|
|
; specific reason to do otherwise.
|
|
; rpclisten= ; all interfaces on default port
|
|
; rpclisten=0.0.0.0 ; all ipv4 interfaces on default port
|
|
; rpclisten=:: ; all ipv6 interfaces on default port
|
|
; rpclisten=:18332 ; all interfaces on port 18332
|
|
; rpclisten=0.0.0.0:18332 ; all ipv4 interfaces on port 18332
|
|
; rpclisten=[::]:18332 ; all ipv6 interfaces on port 18332
|
|
; rpclisten=127.0.0.1:18332 ; only ipv4 localhost on port 18332 (this is a default)
|
|
; rpclisten=[::1]:18332 ; only ipv6 localhost on port 18332 (this is a default)
|
|
; rpclisten=127.0.0.1:18337 ; only ipv4 localhost on non-standard port 18337
|
|
; rpclisten=:18337 ; all interfaces on non-standard port 18337
|
|
; rpclisten=0.0.0.0:18337 ; all ipv4 interfaces on non-standard port 18337
|
|
; rpclisten=[::]:18337 ; all ipv6 interfaces on non-standard port 18337
|
|
|
|
; Legacy (Bitcoin Core-compatible) RPC listener addresses. Addresses without a
|
|
; port specified use the same default port as the new server. Listeners cannot
|
|
; be shared between both RPC servers.
|
|
;
|
|
; Adding any legacy RPC listen addresses disable all default rpclisten options.
|
|
; If both servers must run, all listen addresses must be manually specified for
|
|
; each.
|
|
; legacyrpclisten=
|
|
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; RPC settings (both client and server)
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Username and password to authenticate to btcd a RPC server and authenticate
|
|
; new client connections
|
|
; username=
|
|
; password=
|
|
|
|
; Alternative username and password for btcd. If set, these will be used
|
|
; instead of the username and password set above for authentication to a
|
|
; btcd RPC server.
|
|
; btcdusername=
|
|
; btcdpassword=
|
|
|
|
|
|
; ------------------------------------------------------------------------------
|
|
; Debug
|
|
; ------------------------------------------------------------------------------
|
|
|
|
; Debug logging level.
|
|
; Valid options are {trace, debug, info, warn, error, critical}
|
|
; debuglevel=info
|
|
|
|
; The port used to listen for HTTP profile requests. The profile server will
|
|
; be disabled if this option is not specified. The profile information can be
|
|
; accessed at http://localhost:<profileport>/debug/pprof once running.
|
|
; profile=6062
|