docs: document config argument of set-identity

firedancer-io · Feb 24, 2025 · 50a3d5e · 50a3d5e
1 parent 8bd4c18
commit 50a3d5e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/book/api/cli.md b/book/api/cli.md
@@ -148,6 +148,15 @@ argument is required and must be the path to an Agave style
 `identity.json` keypair file. If the path is specified as `-` the key
 will instead be read from `stdin`.
 
+::: warning WARNING
+
+`set-identity` must be called with the configuration file you started
+the validator with, like `fdctl set-identity --config <config.toml>`,
+if the `config` argument is not provided, the command may not update
+the key on all tiles and your validator may start skipping slots.
+
+:::
+
 It is not generally safe to call `set-identity`, as another validator
 might be running with the same identity, and if they both produce a
 block or vote concurrently, the validator may violate consensus and be

diff --git a/book/snippets/commands/set-identity.ansi b/book/snippets/commands/set-identity.ansi
@@ -1,2 +1,2 @@
-$ sudo fdctl set-identity ~/keys/validator-keypair.json
+$ sudo fdctl set-identity --config ~/config.toml ~/keys/validator-keypair.json
 [32mNOTICE [0m Validator identity key switched to `4UCZB7zfquCVN7GafWETFVLTceNH3nm2mndyHeDuSggC`