LBRYCommunity/lbcwallet
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases 14 Packages Wiki Activity
lbcwallet/sample-btcwallet.conf

113 lines
4.5 KiB
Text
Raw Normal View History

Fix sample config file.
2013-10-14 21:32:15 +02:00
[Application Options]
Add simple sample configuration file.
2013-10-04 15:01:04 +02:00
; ------------------------------------------------------------------------------
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; Bitcoin wallet settings
Add simple sample configuration file.
2013-10-04 15:01:04 +02:00
; ------------------------------------------------------------------------------
Default to mainnet. Note that this is a breaking change since it removes the mainnet config option, replacing it with a testnet option. Old configuration files that set mainnet=1 will cause the wallet to error during startup since extraneous flags are treated as errors. Because configuration files will have to be updated for the change regardless, the old deprecated (and unused) options `disallowfree` and `keypoolsize` have also been removed. Closes #383.
2016-03-11 05:21:06 +01:00
; Use testnet (cannot be used with simnet=1).
; testnet=0
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
Default to mainnet. Note that this is a breaking change since it removes the mainnet config option, replacing it with a testnet option. Old configuration files that set mainnet=1 will cause the wallet to error during startup since extraneous flags are treated as errors. Because configuration files will have to be updated for the change regardless, the old deprecated (and unused) options `disallowfree` and `keypoolsize` have also been removed. Closes #383.
2016-03-11 05:21:06 +01:00
; Use simnet (cannot be used with testnet=1).
Add support for the simulation test network.
2014-05-29 23:15:32 +02:00
; simnet=0
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; 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.
Rename datadir/-b options to appdata/-A. This removes an inconsistency with the datadir option from btcd, which only set the directory containing the blockchain data and indexes.
2016-04-13 23:07:58 +02:00
; appdata=~/.btcwallet
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; ------------------------------------------------------------------------------
; RPC client settings
; ------------------------------------------------------------------------------
; Connect via a SOCKS5 proxy. NOTE: Specifying a proxy will disable listening
Rename listen option to rpclisten. This matches the use of the rpclisten option in btcd to specify the listening interfaces and ports for an RPC server.
2014-05-06 19:50:39 +02:00
; for incoming connections unless listen addresses are provided via the
; 'rpclisten' option.
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; proxy=127.0.0.1:9050
; proxyuser=
; proxypass=
Enable TLS support for btcd websocket connections. This adds an additional config option, -cafile, to specify the root certificates checked when verifying a btcd TLC connection. btcd will now automatically generate certs in ~/.btcd/data/{main,test}net/rpc.cert, and this file should be copied to ~/.btcwallet/cert.pem. The -btcdport option is also gone now, and replaced with -connect (or -c), to specify both the hostname/ip and port of the server running btcd.
2013-11-19 18:21:54 +01:00
; The server and port used for btcd websocket connections.
Rename connect option to rpcconnect. The connect option is already used by btcd to force a connection to other full node peers. Wallet does not talk directly with these peers, so the connect option is being renamed to something unique for an RPC client connection.
2014-05-06 20:25:56 +02:00
; rpcconnect=localhost:18334
Add simple sample configuration file.
2013-10-04 15:01:04 +02:00
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; 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
Add option for one time TLS keys. This option prevents the RPC server TLS key from ever being written to disk. This is performed by generating a new certificate pair each startup and writing (possibly overwriting) the certificate but not the key. Closes #359.
2016-02-11 06:00:32 +01:00
; Enable one time TLS keys. This option results in the process generating
; a new certificate pair each startup, writing only the certificate file
; to disk. This is a more secure option for clients that only interact with
; a local wallet process where persistent certs are not needed.
;
; This option will error at startup if the key specified by the rpckey option
; already exists.
; onetimetlskey=0
Rename listen option to rpclisten. This matches the use of the rpclisten option in btcd to specify the listening interfaces and ports for an RPC server.
2014-05-06 19:50:39 +02:00
; 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
Default to mainnet. Note that this is a breaking change since it removes the mainnet config option, replacing it with a testnet option. Old configuration files that set mainnet=1 will cause the wallet to error during startup since extraneous flags are treated as errors. Because configuration files will have to be updated for the change regardless, the old deprecated (and unused) options `disallowfree` and `keypoolsize` have also been removed. Closes #383.
2016-03-11 05:21:06 +01:00
; modified by some options such as 'testnet', so it is recommended to not
Rename listen option to rpclisten. This matches the use of the rpclisten option in btcd to specify the listening interfaces and ports for an RPC server.
2014-05-06 19:50:39 +02:00
; 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
Default to mainnet. Note that this is a breaking change since it removes the mainnet config option, replacing it with a testnet option. Old configuration files that set mainnet=1 will cause the wallet to error during startup since extraneous flags are treated as errors. Because configuration files will have to be updated for the change regardless, the old deprecated (and unused) options `disallowfree` and `keypoolsize` have also been removed. Closes #383.
2016-03-11 05:21:06 +01:00
; rpclisten=:8332 ; all interfaces on port 8332
; rpclisten=0.0.0.0:8332 ; all ipv4 interfaces on port 8332
; rpclisten=[::]:8332 ; all ipv6 interfaces on port 8332
; rpclisten=127.0.0.1:8332 ; only ipv4 localhost on port 8332 (this is a default)
; rpclisten=[::1]:8332 ; only ipv6 localhost on port 8332 (this is a default)
; rpclisten=127.0.0.1:8337 ; only ipv4 localhost on non-standard port 8337
; rpclisten=:8337 ; all interfaces on non-standard port 8337
; rpclisten=0.0.0.0:8337 ; all ipv4 interfaces on non-standard port 8337
; rpclisten=[::]:8337 ; all ipv6 interfaces on non-standard port 8337
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
Modernize the RPC server. 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.
2015-06-01 21:57:50 +02:00
; 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=
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; ------------------------------------------------------------------------------
; RPC settings (both client and server)
; ------------------------------------------------------------------------------
; Username and password to authenticate to btcd a RPC server and authenticate
; new client connections
Add simple sample configuration file.
2013-10-04 15:01:04 +02:00
; username=
; password=
Allow alternative btcd RPC server auth. This change adds the new btcdusername and btcdpassword options which, if set, are used instead of the username and password when authenticating to a btcd RPC server. If these new options are unset, the btcd user and password settings are shared with the client auth settings.
2014-05-16 19:58:33 +02:00
; 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=
Update sample configuration with all options.
2014-01-15 01:20:08 +01:00
; ------------------------------------------------------------------------------
; 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
Reference in a new issue Copy permalink