mirror of
https://github.com/romanz/electrs.git
synced 2024-11-19 09:54:09 +01:00
f1d611fe19
The '-blocksdir' startup option allows one to store blk*.dat on an external disk, while keeping the index (blocks/index/) on the same disk. This makes electrs aware of such an option, while still keeping the same default behaviour (blk*.dat in '<config_dir>/blocks/'). Signed-off-by: Antoine Poinsot <darosior@protonmail.com>
118 lines
3.9 KiB
TOML
118 lines
3.9 KiB
TOML
[general]
|
|
env_prefix = "ELECTRS"
|
|
conf_file_param = "conf"
|
|
conf_dir_param = "conf_dir"
|
|
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"
|
|
|
|
[[param]]
|
|
name = "db_dir"
|
|
type = "std::path::PathBuf"
|
|
doc = "Directory to store index database (default: ./db/)"
|
|
default = "\"./db\".into()"
|
|
|
|
[[param]]
|
|
name = "daemon_dir"
|
|
type = "std::path::PathBuf"
|
|
doc = "Data directory of Bitcoind (default: ~/.bitcoin/)"
|
|
default = "crate::config::default_daemon_dir()"
|
|
|
|
[[param]]
|
|
name = "blocks_dir"
|
|
type = "std::path::PathBuf"
|
|
doc = "Analogous to bitcoind's -blocksdir option, this specifies the directory containing the raw blocks files (blk*.dat)"
|
|
|
|
[[param]]
|
|
name = "cookie"
|
|
type = "String"
|
|
doc = "JSONRPC authentication cookie ('USER:PASSWORD', default: read from cookie file)"
|
|
# Force the user to use config file in order to avoid password leaks
|
|
argument = false
|
|
env_var = false
|
|
|
|
[[param]]
|
|
name = "cookie_file"
|
|
type = "std::path::PathBuf"
|
|
doc = "JSONRPC authentication cookie file (default: ~/.bitcoin/.cookie)"
|
|
# This is safe to configure on command line.
|
|
|
|
[[param]]
|
|
name = "network"
|
|
type = "crate::config::BitcoinNetwork"
|
|
convert_into = "::bitcoin::network::constants::Network"
|
|
doc = "Select Bitcoin network type ('bitcoin', 'testnet' or 'regtest')"
|
|
default = "Default::default()"
|
|
|
|
[[param]]
|
|
name = "electrum_rpc_addr"
|
|
type = "crate::config::ResolvAddr"
|
|
doc = "Electrum server JSONRPC 'addr:port' to listen on (default: '127.0.0.1:50001' for mainnet, '127.0.0.1:60001' for testnet and '127.0.0.1:60401' for regtest)"
|
|
|
|
[[param]]
|
|
name = "daemon_rpc_addr"
|
|
type = "crate::config::ResolvAddr"
|
|
doc = "Bitcoin daemon JSONRPC 'addr:port' to connect (default: 127.0.0.1:8332 for mainnet, 127.0.0.1:18332 for testnet and 127.0.0.1:18443 for regtest)"
|
|
|
|
[[param]]
|
|
name = "monitoring_addr"
|
|
type = "crate::config::ResolvAddr"
|
|
doc = "Prometheus monitoring 'addr:port' to listen on (default: 127.0.0.1:4224 for mainnet, 127.0.0.1:14224 for testnet and 127.0.0.1:24224 for regtest)"
|
|
|
|
[[switch]]
|
|
name = "jsonrpc_import"
|
|
doc = "Use JSONRPC instead of directly importing blk*.dat files. Useful for remote full node or low memory system"
|
|
|
|
[[param]]
|
|
name = "wait_duration_secs"
|
|
type = "u64"
|
|
doc = "Duration to wait between bitcoind polling"
|
|
default = "5"
|
|
|
|
[[param]]
|
|
name = "index_batch_size"
|
|
type = "usize"
|
|
doc = "Number of blocks to get in one JSONRPC request from bitcoind"
|
|
default = "100"
|
|
|
|
[[param]]
|
|
name = "bulk_index_threads"
|
|
type = "usize"
|
|
doc = "Number of threads used for bulk indexing (default: use the # of CPUs)"
|
|
default = "0"
|
|
|
|
[[param]]
|
|
name = "tx_cache_size_mb"
|
|
type = "f32"
|
|
doc = "Total size of transactions to cache (MB)"
|
|
default = "10.0"
|
|
|
|
[[param]]
|
|
name = "blocktxids_cache_size_mb"
|
|
type = "f32"
|
|
doc = "Total size of block transactions IDs to cache (in MB)"
|
|
default = "10.0"
|
|
|
|
[[param]]
|
|
name = "txid_limit"
|
|
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)"
|
|
default = "100"
|
|
|
|
[[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()"
|