Skip to content

Commit

Permalink
address review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandratran committed Nov 20, 2023
1 parent e63930b commit 2a68047
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/concepts/weak-subjectivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Teku provides three methods to safely sync a node that is new to the network or
3. Use [`--ws-checkpoint`](../reference/cli/index.md#ws-checkpoint) to supply a weak subjectivity
checkpoint by which a node can securely validate its view of the current state.

We recommend using `--checkpoint-sync-url` or `--initial-state`.
They provide the same security benefits as `--ws-checkpoint`, but sync faster.
We recommend using `--checkpoint-sync-url` on Mainnet.
It provides the same security benefits as `--ws-checkpoint`, but syncs faster.
The only exception is when syncing an archive node, in which case, use `--ws-checkpoint`.

:::tip
Expand All @@ -52,7 +52,7 @@ up-to-date, the concerns associated with weak subjectivity are cleared.

Originally, Teku's default behavior was to sync from any point in the chain without the weak
subjectivity check, including syncing all the way from the genesis of the chain.
However, this is not considered safe.
However, this is considered unsafe.

If you want to allow Teku to sync outside the weak subjectivity period, you can use the
[`--ignore-weak-subjectivity-period-enabled`](../reference/cli/index.md#ignore-weak-subjectivity-period-enabled)
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/checkpoint-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ sidebar_position: 4

# Start Teku from a recent state

To get Teku up and running in only a few minutes, you can start Teku from a recent finalized
checkpoint state rather than syncing from genesis.
To get Teku up and running in only a few minutes, start Teku from a recent finalized checkpoint
state rather than syncing from genesis.
Using a checkpoint state enables Teku to sync within the
[weak subjectivity](../concepts/weak-subjectivity.md) period.

Expand Down
3 changes: 2 additions & 1 deletion docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -882,9 +882,10 @@ ignore-weak-subjectivity-period-enabled: true

Ignores the [weak subjectivity](../../concepts/weak-subjectivity.md) period verification that Teku
performs at startup.
The default is `false`.

:::caution
Syncing outside the weak subjectivity period is not considered safe.
Syncing from outside the weak subjectivity period is considered unsafe.
:::

### logging
Expand Down

0 comments on commit 2a68047

Please sign in to comment.