cuprated: config & args

[Boog900]

What

Starts the config and arguments to cuprated.

[Boog900]

Example generated config file:

#     ____                      _
#    / ___|   _ _ __  _ __ __ _| |_ ___
#   | |  | | | | '_ \| '__/ _` | __/ _ \
#   | |__| |_| | |_) | | | (_| | ||  __/
#    \____\__,_| .__/|_|  \__,_|\__\___|
#              |_|
#

## The network to run on, valid values: "Mainnet", "Testnet", "Stagenet".
network = "Mainnet"

## Tracing config.
[tracing]
## The minimum level for log events to be displayed.
level = "info"

## Clear-net config.
[p2p.clear_net]
## The number of outbound connections we should make and maintain.
outbound_connections = 64
## The number of extra connections we should make under load from the rest of Cuprate, i.e. when syncing.
extra_outbound_connections = 8
## The maximum number of incoming we should allow.
max_inbound_connections = 128
## The percent of outbound connections that should be to nodes we have not connected to before.
gray_peers_percent = 0.7
## The port to accept connections on, if left `0` no connections will be accepted.
p2p_port = 0
## The IP address to listen to connections on.
server.ip = "0.0.0.0"

## The Clear-net addressbook config.
[p2p.clear_net.address_book_config]
## The size of the white peer list, which contains peers we have made a connection to before.
max_white_list_length = 1_000
## The size of the gray peer list, which contains peers we have not made a connection to before.
max_gray_list_length = 5_000
## The folder to store the address book.
peer_store_folder = "/home/user/.cache/cuprate"
## The amount of time between address book saves.
peer_save_period = { secs = 90, nanos = 0 }

## The block downloader config.
[p2p.block_downloader]
## The size of the buffer of sequential blocks waiting to be verified and added to the chain (bytes).
buffer_size = 50_000_000
## The size of the queue of blocks which are waiting for a parent block to be downloaded (bytes).
in_progress_queue_size = 50_000_000
## The target size of a batch of blocks (bytes), must not exceed 100MB.
target_batch_size = 5_000_000
## The number of blocks in the first bacth (you probably shouldn't change this).
initial_batch_len = 1
## The amount of time between checking the pool of connected peers for free peers to download blocks.
check_client_pool_interval = { secs = 30, nanos = 0 }

## Storage config
[storage]
## The amount of reader threads to spawn.
reader_threads = "OnePerThread"

## Txpool storage config.
[storage.txpool]
## The txpool storage location.
path = "/home/user/.local/share/cuprate/txpool"
## The database sync mode for the txpool.
sync_mode = "Async"
## The maximum size of all the txs in the pool (bytes).
max_txpool_size = 100_000_000

## Blockchain storage config.
[storage.blockchain]
## The blockchain storage location.
path = "/home/user/.local/share/cuprate/blockchain"
## The database sync mode for the blockchain.
sync_mode = "Async"

[hinto-janai]

nits only, will leave other review

[hinto-janai]

Can you move this to cuprate_types? strum can automatically implement the FromStr/Display and lots of other stuff.

Also please add a doc-test asserting the string representations since we rely on it for PATHs now, something like this:

cuprate/rpc/types/src/misc/status.rs

Lines 31 to 65 in 63216ae

	/// ## Serialization and string formatting
	/// ```rust
	/// use cuprate_rpc_types::{
	/// misc::Status,
	/// CORE_RPC_STATUS_BUSY, CORE_RPC_STATUS_NOT_MINING, CORE_RPC_STATUS_OK,
	/// CORE_RPC_STATUS_PAYMENT_REQUIRED
	/// };
	/// use serde_json::to_string;
	///
	/// let other = Status::Other("OTHER".into());
	///
	/// assert_eq!(to_string(&Status::Ok).unwrap(), r#""OK""#);
	/// assert_eq!(to_string(&Status::Busy).unwrap(), r#""BUSY""#);
	/// assert_eq!(to_string(&Status::NotMining).unwrap(), r#""NOT MINING""#);
	/// assert_eq!(to_string(&Status::PaymentRequired).unwrap(), r#""PAYMENT REQUIRED""#);
	/// assert_eq!(to_string(&other).unwrap(), r#""OTHER""#);
	///
	/// assert_eq!(Status::Ok.as_ref(), CORE_RPC_STATUS_OK);
	/// assert_eq!(Status::Busy.as_ref(), CORE_RPC_STATUS_BUSY);
	/// assert_eq!(Status::NotMining.as_ref(), CORE_RPC_STATUS_NOT_MINING);
	/// assert_eq!(Status::PaymentRequired.as_ref(), CORE_RPC_STATUS_PAYMENT_REQUIRED);
	/// assert_eq!(other.as_ref(), "OTHER");
	///
	/// assert_eq!(format!("{}", Status::Ok), CORE_RPC_STATUS_OK);
	/// assert_eq!(format!("{}", Status::Busy), CORE_RPC_STATUS_BUSY);
	/// assert_eq!(format!("{}", Status::NotMining), CORE_RPC_STATUS_NOT_MINING);
	/// assert_eq!(format!("{}", Status::PaymentRequired), CORE_RPC_STATUS_PAYMENT_REQUIRED);
	/// assert_eq!(format!("{}", other), "OTHER");
	///
	/// assert_eq!(format!("{:?}", Status::Ok), "Ok");
	/// assert_eq!(format!("{:?}", Status::Busy), "Busy");
	/// assert_eq!(format!("{:?}", Status::NotMining), "NotMining");
	/// assert_eq!(format!("{:?}", Status::PaymentRequired), "PaymentRequired");
	/// assert_eq!(format!("{:?}", other), r#"Other("OTHER")"#);
	/// ```

[Boog900]

Will do in another PR this is used in a lot of places so don't really want to do it here.

[hinto-janai]

1 thing + 2 nits, there's other nits too but this needs to be merged and I don't want to hold it up any longer.

[hinto-janai]

A few notes:

1. Programs often output this type of stuff to std{out,err} such that users can redirect (program > output.txt, program | other_program) ^{1 2 3} although it has to be correctly handled when logging gets involved (op-reth config --default > config.txt gets it wrong and includes a log line... lol).

2. With initial CLI control flow / logging, I think they should be in the same local area for clarity, in this case, I think they should be in apply_args, called functions contain only logic.

3. Considering 1/2 and since create_default_config_file won't be used elsewhere, binaries/cuprated/src/config/default.rs could be removed, the test in it could goto src/config/constants.rs.

Suggested change

	// This will create the config file and exit.
	create_default_config_file(config_folder)
	println!("{EXAMPLE_CONFIG}");
	exit(0);

Footnotes

1. https://doc.rust-lang.org/book/ch12-06-writing-to-stderr-instead-of-stdout.html#checking-where-errors-are-written ↩

2. https://reth.rs/cli/reth/config.html ↩

3. https://nginx.org/en/docs/switches.html ↩

[hinto-janai]

I think _bytes over _size on these variables would make things more obvious but this can be done later.

[hinto-janai]

nit: this is AddressBook/address_book in all other code.

Suggested change

	pub fn addressbook_path(cache_dir: &Path, network: Network) -> PathBuf {
	pub fn address_book_path(cache_dir: &Path, network: Network) -> PathBuf {