Skip to content

Commit

Permalink
Unhide DG detection option (#431)
Browse files Browse the repository at this point in the history
* Unhide DG detection option

* Fix capital typo

* minor edits

---------

Co-authored-by: Alexandra Tran <[email protected]>
  • Loading branch information
mehdi-aouadi and alexandratran authored Feb 14, 2023
1 parent 5284fbc commit 2fd4454
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/HowTo/Doppelganger-Detection.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,18 @@ When enabled, doppelganger detection is triggered from two entry points:

:::warning

Doppelganger detection is an **early access** feature. This feature is imperfect and might fail to detect doppelgangers. Use this as a last resort option that might prevent validators from being slashed.
Doppelganger detection is an early access feature. This feature is imperfect and might fail to detect doppelgangers. Use this as a last resort option that might prevent validators from being slashed.

:::

## Enable doppelganger detection

Enable doppelganger detection by setting the `--Xdoppelganger-detection-enabled` option to `true`.
Enable doppelganger detection by setting the
[`--doppelganger-detection-enabled`](../Reference/CLI/CLI-Syntax.md#doppelganger-detection-enabled)
option to `true`.

Your validator client must be connected to a beacon node with liveness tracking enabled. Enable liveness tracking by setting the `--Xbeacon-liveness-tracking-enabled` option to `true`.
Your validator client must be connected to a beacon node with validator liveness tracking enabled.
Enable validator liveness tracking by setting the `--Xbeacon-liveness-tracking-enabled` option to `true`.

## Side effects

Expand Down
32 changes: 32 additions & 0 deletions docs/Reference/CLI/CLI-Syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -322,6 +322,38 @@ data-validator-path: "/home/me/me_validator"

Path to the validator client data. The default is `<data-base-path>/validator` where `<data-base-path>` is specified using [`--data-base-path`](#data-base-path-data-path).

### doppelganger-detection-enabled

<!--tabs-->

# Syntax

```bash
--doppelganger-detection-enabled[=<BOOLEAN>]
```

# Example

```bash
--doppelganger-detection-enabled=true
```

# Environment variable

```bash
TEKU_DOPPELGANGER_DETECTION_ENABLED=true
```

# Configuration file

```bash
doppelganger-detection-enabled: true
```

<!--/tabs-->

Enables or disables [doppelganger detection](../../HowTo/Doppelganger-Detection.md). The default is `false`.

### ee-endpoint

<!--tabs-->
Expand Down

1 comment on commit 2fd4454

@vercel
Copy link

@vercel vercel bot commented on 2fd4454 Feb 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

doc-teku – ./

doc-teku-git-main-infura-web.vercel.app
docs.teku.consensys.net
doc-teku-infura-web.vercel.app

Please sign in to comment.