diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md index 28a4105..3d8373b 100644 --- a/docs/reference/cli/subcommands.md +++ b/docs/reference/cli/subcommands.md @@ -23,6 +23,7 @@ Use the Web3Signer subcommands to specify the platform being used: - `web3signer [options] eth2 export [Eth2 export options]` - `web3signer [options] eth2 import [Eth2 import options]` - `web3signer [options] eth1` +- `web3signer [options] watermark-repair [watermark repair options]` :::note This documentation has been updated in line with the name changes [recommended by the Ethereum @@ -52,6 +53,7 @@ To view the command line help for the subcommands: - [`web3signer help eth1`](#eth1) - [`web3signer help eth2`](#eth2) +- [`web3signer help watermark-repair`](#watermark-repair) ## Options @@ -2856,6 +2858,167 @@ eth2.import.from: /Users/me/my_node/interchange.json The file to import the slashing protection database from. The file must be formatted in the [validator client interchange format]. +### `watermark-repair` + +Updates the [slashing protection low or high watermark](https://eips.ethereum.org/EIPS/eip-3076) for all validators. +You can only increase the low watermark, not decrease it. +If you set the high watermark, you should set this to a future epoch and slot. +Setting a high watermark prevents the validator from signing at or beyond this point. + +:::caution +We only recommend this subcommand for advanced users. +::: + +#### `epoch` + + + + + +```bash +--epoch= +``` + + + + +```bash +--epoch=30000 +``` + + + + +```bash +WEB3SIGNER_WATERMARK_REPAIR_EPOCH=30000 +``` + + + + +```bash +watermark-repair.epoch: 30000 +``` + + + + +Low watermark to set the attestation source and target to. +(Sets the high watermark epoch when [`--set-high-watermark`](#set-high-watermark) is `true`.) + +#### `slot` + + + + + +```bash +--slot= +``` + + + + +```bash +--slot=20000 +``` + + + + +```bash +WEB3SIGNER_WATERMARK_REPAIR_SLOT=20000 +``` + + + + +```bash +watermark-repair.slot: 20000 +``` + + + + +Low watermark to set the block slot to. +(Sets the high watermark slot when [`--set-high-watermark`](#set-high-watermark) is `true`.) + +#### `remove-high-watermark` + + + + + +```bash +--remove-high-watermark= +``` + + + + +```bash +--remove-high-watermark=true +``` + + + + +```bash +WEB3SIGNER_REMOVE_HIGH_WATERMARK=true +``` + + + + +```bash +watermark-repair.remove-high-watermark: true +``` + + + + +Removes the high watermark. +When set to `true`, all other `watermark-repair` options are ignored. +The default is `false`. + +#### `set-high-watermark` + + + + + +```bash +--set-high-watermark= +``` + + + + +```bash +--set-high-watermark=true +``` + + + + +```bash +WEB3SIGNER_SET_HIGH_WATERMARK=true +``` + + + + +```bash +watermark-repair.set-high-watermark: true +``` + + + + +Sets the high watermark to the specified [epoch](#epoch) and [slot](#slot). +(Sets the low watermark when [`--set-high-watermark`](#set-high-watermark) is `false`.) +The default is `false`. + [include the port number in the database URL]: https://jdbc.postgresql.org/documentation/head/connect.html