Skip to content

Commit

Permalink
Added back watermark-repair options accidently removed
Browse files Browse the repository at this point in the history
Signed-off-by: madelinemurray <[email protected]>
  • Loading branch information
MadelineMurray committed Dec 8, 2023
1 parent 896afc3 commit d86243d
Showing 1 changed file with 163 additions and 0 deletions.
163 changes: 163 additions & 0 deletions docs/reference/cli/subcommands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--epoch=<LONG>
```

</TabItem>
<TabItem value="Example" label="Example" >

```bash
--epoch=30000
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_WATERMARK_REPAIR_EPOCH=30000
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
watermark-repair.epoch: 30000
```

</TabItem>
</Tabs>

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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--slot=<LONG>
```

</TabItem>
<TabItem value="Example" label="Example" >

```bash
--slot=20000
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_WATERMARK_REPAIR_SLOT=20000
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
watermark-repair.slot: 20000
```

</TabItem>
</Tabs>

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`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--remove-high-watermark=<BOOLEAN>
```

</TabItem>
<TabItem value="Example" label="Example" >

```bash
--remove-high-watermark=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_REMOVE_HIGH_WATERMARK=true
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
watermark-repair.remove-high-watermark: true
```

</TabItem>
</Tabs>

Removes the high watermark.
When set to `true`, all other `watermark-repair` options are ignored.
The default is `false`.

#### `set-high-watermark`

<Tabs>

<TabItem value="Syntax" label="Syntax" default>

```bash
--set-high-watermark=<BOOLEAN>
```

</TabItem>
<TabItem value="Example" label="Example" >

```bash
--set-high-watermark=true
```

</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_SET_HIGH_WATERMARK=true
```

</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
watermark-repair.set-high-watermark: true
```

</TabItem>
</Tabs>

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`.

<!-- links -->

[include the port number in the database URL]: https://jdbc.postgresql.org/documentation/head/connect.html
Expand Down

0 comments on commit d86243d

Please sign in to comment.