Skip to content

Commit a1a59b3

Browse files
committed
docs: update operator doppelgänger CLI help text
Update flag descriptions to accurately reflect current behavior: - Mentions grace period and message blocking - Clarifies QBFT protocol violation prevention - Describes monitoring phase behavior The previous help text was outdated and didn't mention the grace period or that messages are blocked during the entire protection window.
1 parent 0fda8d4 commit a1a59b3

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

anchor/client/src/cli.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -494,9 +494,10 @@ pub struct Node {
494494
// Operator Doppelgänger Protection
495495
#[clap(
496496
long,
497-
help = "Enable operator doppelgänger protection. When enabled, the node will monitor \
498-
for messages signed by its operator ID on startup and shut down if a twin \
499-
(duplicate operator) is detected. Enabled by default.",
497+
help = "Enable operator doppelgänger protection. When enabled, the node blocks all \
498+
outgoing messages during a grace period (to let old messages expire), then \
499+
monitors for messages with its operator ID. Shuts down if a twin is detected \
500+
to prevent QBFT protocol violations. Enabled by default.",
500501
display_order = 0,
501502
default_value_t = true,
502503
help_heading = FLAG_HEADER,
@@ -507,9 +508,9 @@ pub struct Node {
507508
#[clap(
508509
long,
509510
value_name = "EPOCHS",
510-
help = "Number of epochs to wait in monitor mode before starting normal operation. \
511-
During this period, the node listens for messages from its own operator ID \
512-
to detect if another instance is running.",
511+
help = "Number of epochs to monitor for twin operators after the grace period. \
512+
During monitoring, outgoing messages remain blocked and the node listens \
513+
for messages with its operator ID to detect duplicate instances.",
513514
display_order = 0,
514515
default_value_t = 2,
515516
requires = "operator_dg"

anchor/client/src/config.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ pub struct Config {
7272
pub prefer_builder_proposals: bool,
7373
/// Controls whether the latency measurement service is enabled
7474
pub disable_latency_measurement_service: bool,
75-
/// Enable operator doppelgänger protection
75+
/// Enable operator doppelgänger protection (blocks messages and monitors for twins)
7676
pub operator_dg: bool,
77-
/// Number of epochs to wait in monitor mode
77+
/// Number of epochs to monitor for twins after grace period
7878
pub operator_dg_wait_epochs: u64,
7979
}
8080

0 commit comments

Comments
 (0)