Skip to content

Commit a02d003

Browse files
committed
docs: clarify validator bootstrap path arguments
1 parent 77cfb29 commit a02d003

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- [BREAKING] Renamed `SubmitProvenBatch` RPC endpoint to `SubmitProvenTxBatch` ([#2094](https://github.com/0xMiden/node/pull/2094)).
3535
- Fixed block producer mempool panic when selecting transactions that depend on notes created by pruned committed transactions ([#2097](https://github.com/0xMiden/node/pull/2097)).
3636
- Implemented filtering based on the network account note script root allowlist in ntx-builder ([#2042](https://github.com/0xMiden/node/issues/2042)).
37+
- Clarified validator bootstrap CLI help text for input files and output directories ([#1807](https://github.com/0xMiden/node/issues/1807)).
3738

3839
- [BREAKING] Renamed `ExplorerStatusDetails` fields in the network monitor's `/status` payload from `number_of_*` to `total_*` (`total_transactions`, `total_nullifiers`, `total_notes`, `total_account_updates`). The values now represent network-wide cumulative totals from the explorer's `overviewStats` query instead of last-block counts.
3940
- [BREAKING] Removed `--wallet-filepath` / `--counter-filepath` flags and the `MIDEN_MONITOR_WALLET_FILEPATH` / `MIDEN_MONITOR_COUNTER_FILEPATH` env vars from the network monitor. The monitor now keeps wallet and counter accounts fully in memory and regenerates them on every startup; the dashboard's counter value resets to zero on restart.

bin/validator/src/commands/mod.rs

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,18 @@ pub enum ValidatorCommand {
3434
/// and writes the signed block and account secret files to disk. Also initializes the
3535
/// validator's database with the genesis block as the chain tip.
3636
Bootstrap {
37-
/// Directory in which to write the genesis block file.
38-
#[arg(long, value_name = "DIR")]
37+
/// Output directory for the generated genesis block file.
38+
#[arg(long, value_name = "OUTPUT_DIR")]
3939
genesis_block_directory: PathBuf,
40-
/// Directory to write the account secret files (.mac) to.
41-
#[arg(long, value_name = "DIR")]
40+
41+
/// Output directory for the generated account secret files (.mac).
42+
#[arg(long, value_name = "OUTPUT_DIR")]
4243
accounts_directory: PathBuf,
43-
/// Directory in which to store the validator's database.
44-
#[arg(long, env = ENV_DATA_DIRECTORY, value_name = "DIR")]
44+
45+
/// Output directory for the validator database created during bootstrap.
46+
#[arg(long, env = ENV_DATA_DIRECTORY, value_name = "OUTPUT_DIR")]
4547
data_directory: PathBuf,
48+
4649
/// Maximum number of SQLite connections in the validator database connection pool.
4750
#[arg(
4851
long = "sqlite.connection_pool_size",
@@ -51,9 +54,11 @@ pub enum ValidatorCommand {
5154
value_name = "NUM"
5255
)]
5356
sqlite_connection_pool_size: NonZeroUsize,
54-
/// Use the given configuration file to construct the genesis state from.
55-
#[arg(long, env = ENV_GENESIS_CONFIG_FILE, value_name = "GENESIS_CONFIG")]
57+
58+
/// Input configuration file used to construct the genesis state.
59+
#[arg(long, env = ENV_GENESIS_CONFIG_FILE, value_name = "INPUT_FILE")]
5660
genesis_config_file: Option<PathBuf>,
61+
5762
/// Configuration for the Validator key used to sign the genesis block.
5863
#[command(flatten)]
5964
validator_key: ValidatorKey,

0 commit comments

Comments
 (0)