mirrors/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2024-11-19 01:43:29 +01:00
Code Issues Projects Releases Wiki Activity
master
electrs/internal/config_specification.toml

148 lines
5.0 KiB
TOML
Raw Permalink Normal View History

Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[general]
env_prefix = "ELECTRS"
Support for user-specified onfiguration files/dirs This commit upgrades `configure_me` and adds support for `--conf` and `--conf-dir` parameters, which load the configuration from the specified place.
2019-09-28 22:42:23 +02:00
conf_file_param = "conf"
conf_dir_param = "conf_dir"
Use configure_me to skip default config files This removes the feature for skipping default config files and replaces it with a configure_me implementation. Closes #217
2022-02-17 19:10:45 +01:00
skip_default_conf_files_switch = "skip_default_conf_files"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
doc = """
An efficient re-implementation of Electrum Server, inspired by ElectrumX, Electrum Personal Server and bitcoincore-indexd.
The motivation behind this project is to enable a user to run his own Electrum server, with required hardware resources not much beyond those of a full node. The server indexes the entire Bitcoin blockchain, and the resulting index enables fast queries for any given user wallet, allowing the user to keep real-time track of his balances and his transaction history using the Electrum wallet. Since it runs on the user's own machine, there is no need for the wallet to communicate with external Electrum servers, thus preserving the privacy of the user's addresses and balances."""
[[switch]]
name = "verbose"
abbr = "v"
doc = "Increase logging verbosity"
count = true
[[switch]]
name = "timestamp"
doc = "Prepend log lines with a timestamp"
Auto reindex when old database is detected This implements automatic reindexing of old database, turned on by default. When an old database is detected and `auto_reindex` is turned on the database will be destroyed so that `electrs` can re-sync. The user can still turn this off to check db format. The help message says "or inconsistent" - this is not implemented but we could in the future and it seems reasonable to explicitly state that this option will control that thing as well. Note: 0.8.x versions of `electrs` didn't contain format information - so we check if the database is empty and assuming it's legacy if it's not empty but without format information. The code is also restructured a bit and a few tests are added.
2021-09-13 11:50:21 +02:00
[[switch]]
name = "auto_reindex"
doc = "Automatically reindex the database if it's inconsistent or in old format"
default = true
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "db_dir"
type = "std::path::PathBuf"
doc = "Directory to store index database (default: ./db/)"
default = "\"./db\".into()"
Allow setting RocksDB log directory Following https://github.com/romanz/electrs/issues/680#issuecomment-1824841535.
2023-11-24 13:11:16 +01:00
[[param]]
name = "db_log_dir"
type = "std::path::PathBuf"
doc = "Directory to store index database internal log (default: same as specified by `db_dir`)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "daemon_dir"
type = "std::path::PathBuf"
doc = "Data directory of Bitcoind (default: ~/.bitcoin/)"
default = "crate::config::default_daemon_dir()"
Refactor and sync using p2p protocol
2021-03-26 09:05:58 +01:00
[[param]]
name = "auth"
type = "String"
doc = "JSONRPC authentication ('USER:PASSWORD', default: use cookie file)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
# Force the user to use config file in order to avoid password leaks
argument = false
env_var = false
Implemented custom cookie file This change allows the user to specify a custom cookie file, which is then used instead of `~/.bitcoin/.cookie`. This resolves situations when the user wants to have the cookie file in non-standard path. Aside from that, the code now pre-computes the default path, improving the performance by avoiding allocation (and copying). Unfortunately, due to limitations of Rust, the code doesn't print out cookie configuration anymore. This however might be safer, since the cookie isn't printed, and thus doesn't end up in some readable logs by accident. Closes #176 Closes #189
2019-11-10 12:11:31 +01:00
[[param]]
name = "cookie_file"
type = "std::path::PathBuf"
doc = "JSONRPC authentication cookie file (default: ~/.bitcoin/.cookie)"
# This is safe to configure on command line.
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "network"
type = "crate::config::BitcoinNetwork"
Upgrade `bitcoin` Upgrade dependencies required to use the recently released `rust-bitcoin v0.31.0` release. Co-authored-by: Roman Zeyde <me@romanzey.de>
2023-10-16 09:11:05 +02:00
convert_into = "::bitcoin::Network"
Support `testnet4` (#1104) Following rust-bitcoin/rust-bitcoin#3453
2024-10-29 20:34:00 +01:00
doc = "Select Bitcoin network type ('bitcoin', 'testnet', 'testnet4', 'regtest' or 'signet')"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
default = "Default::default()"
[[param]]
name = "electrum_rpc_addr"
type = "crate::config::ResolvAddr"
Refactor and sync using p2p protocol
2021-03-26 09:05:58 +01:00
doc = "Electrum server JSONRPC 'addr:port' to listen on (default: '127.0.0.1:50001' for mainnet, '127.0.0.1:60001' for testnet, '127.0.0.1:60401' for regtest and '127.0.0.1:60601' for signet)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "daemon_rpc_addr"
type = "crate::config::ResolvAddr"
Refactor and sync using p2p protocol
2021-03-26 09:05:58 +01:00
doc = "Bitcoin daemon JSONRPC 'addr:port' to connect (default: 127.0.0.1:8332 for mainnet, 127.0.0.1:18332 for testnet, 127.0.0.1:18443 for regtest and 127.0.0.1:18554 for signet)"
[[param]]
name = "daemon_p2p_addr"
type = "crate::config::ResolvAddr"
doc = "Bitcoin daemon p2p 'addr:port' to connect (default: 127.0.0.1:8333 for mainnet, 127.0.0.1:18333 for testnet, 127.0.0.1:18444 for regtest and 127.0.0.1:38333 for signet)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "monitoring_addr"
type = "crate::config::ResolvAddr"
Fix typo in config_specification.toml (#883) Changed regtest to signet.
2023-05-29 19:00:06 +02:00
doc = "Prometheus monitoring 'addr:port' to listen on (default: 127.0.0.1:4224 for mainnet, 127.0.0.1:14224 for testnet, 127.0.0.1:24224 for regtest and 127.0.0.1:34224 for signet)"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
Allow configuring wait duration
2020-06-13 17:15:03 +02:00
[[param]]
name = "wait_duration_secs"
type = "u64"
doc = "Duration to wait between bitcoind polling"
Refactor and sync using p2p protocol
2021-03-26 09:05:58 +01:00
default = "10"
Allow configuring wait duration
2020-06-13 17:15:03 +02:00
Allow configuration of JSON-RPC timeout Following https://github.com/romanz/electrs/issues/495. Also, fix https://github.com/romanz/electrs/issues/443.
2021-09-22 10:42:17 +02:00
[[param]]
name = "jsonrpc_timeout_secs"
type = "u64"
doc = "Duration to wait until bitcoind JSON-RPC timeouts (must be greater than wait_duration_secs)."
default = "15"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "index_batch_size"
type = "usize"
Fix description Fix https://github.com/romanz/electrs/issues/516
2021-09-30 12:58:49 +02:00
doc = "Number of blocks to get in a single p2p protocol request from bitcoind"
Refactor and sync using p2p protocol
2021-03-26 09:05:58 +01:00
default = "10"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
Allow disabling mempool sync
2021-05-08 10:14:12 +02:00
[[switch]]
name = "ignore_mempool"
doc = "Don't sync mempool - queries will show only confirmed transactions."
Allow disabling Electrum RPC while continuing indexing
2021-10-09 12:49:56 +02:00
[[switch]]
name = "disable_electrum_rpc"
doc = "Disable Electrum RPC server - only sync and index blocks."
Allow single-sync invocation using --sync-once commandline flag
2021-09-11 10:01:05 +02:00
[[switch]]
name = "sync_once"
doc = "Exit after the initial sync is over (don't start Electrum server)."
Allow not waiting for block download before sync (#888) Fix #410
2023-06-06 19:23:51 +02:00
[[switch]]
name = "skip_block_download_wait"
doc = "Don't wait for block download to finish before starting sync."
Add version command line argument
2021-11-07 21:06:52 +01:00
[[switch]]
name = "version"
doc = "Print out the program version."
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
Limit index lookups to prevent DoS for "popular" addresses
2021-08-17 13:15:16 +02:00
name = "index_lookup_limit"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
type = "usize"
doc = "Number of transactions to lookup before returning an error, to prevent 'too popular' addresses from causing the RPC server to get stuck (0 - disable the limit)"
Disable `index_lookup_limit` by default
2021-12-04 08:02:37 +01:00
default = "0"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
Allow reindexing last blocks, mainly for sync logic testing Also, added clippy exception for: ``` warning: the function has a cognitive complexity of (26/25) --> ./electrs/target/release/build/electrs-600a795995255594/out/configure_me_config.rs:453:9 | 453 | / pub fn merge_args<I: IntoIterator<Item=::std::ffi::OsString>>(&mut self, args: I) -> Result<impl Iterator<Item=::std::ffi::OsString>, super::Error> { 454 | | let mut iter = args.into_iter().fuse(); 455 | | self._program_path = iter.next().map(Into::into); 456 | | ... | 571 | | Ok(None.into_iter().chain(iter)) 572 | | } | |_________^ | = note: `#[warn(clippy::cognitive_complexity)]` on by default = help: you could split it up into multiple smaller functions = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#cognitive_complexity ```
2021-10-11 09:26:27 +02:00
[[param]]
name = "reindex_last_blocks"
type = "usize"
doc = "Number of last blocks to reindex (used for testing)"
default = "0"
Use configure_me instead of clap Since use of configuration files is both mmore secure and more convenient and clap doesn't support config files, this switches to configure_me, which supports config files, env vars and also generating man pages. Closes #151
2019-09-06 11:40:13 +02:00
[[param]]
name = "server_banner"
type = "String"
doc = "The banner to be shown in the Electrum console"
default = "concat!(\"Welcome to electrs \", env!(\"CARGO_PKG_VERSION\"), \" (Electrum Rust Server)!\").to_owned()"
Allow setting logging filters via configuration Similar to `RUST_LOG` environment variable.
2021-11-08 14:03:06 +01:00
[[param]]
name = "log_filters"
type = "String"
doc = "Logging filters, overriding `RUST_LOG` environment variable (see https://docs.rs/env_logger/ for details)"
Add signet-magic to config
2022-08-11 15:42:36 +02:00
[[param]]
name = "signet_magic"
Takes signet magic in hex as in bitcoin core logs
2022-09-04 13:33:48 +02:00
type = "String"
doc = "network magic for custom signet network in hex format, as found in Bitcoin Core logs (signet only)"
Reference in New Issue Copy Permalink