Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for --checkpoint-sync-url #497

Merged
merged 3 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions docs/get-started/checkpoint-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,19 @@ When starting from a recent checkpoint, Teku downloads historic chain data in th

You need access to a beacon node with [REST API enabled] (for example, Teku) to download the finalized checkpoint state file.

Alternatively, you can use a Checkpointz endpoint from [this community-maintained list of checkpoint state endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).

:::

The following command downloads a recent finalized checkpoint state from a beacon node, and starts Teku:

```bash
teku --eth1-endpoint=http://localhost:8545 \
--validator-keys=/Users/me/mainnet/validator/keys:/Users/me/mainnet/validator/passwords \
--initial-state=http://other-node:5051/eth/v2/debug/beacon/states/finalized
--checkpoint-sync-url=https://beaconstate.ethstaker.cc
```

The command uses the [`--initial-state`](../reference/cli/index.md#initial-state) option to download the finalized checkpoint state from the [`/eth/v2/debug/beacon/states/`](https://consensys.github.io/teku/#operation/getEthV1DebugBeaconStatesWithState_id) endpoint on the beacon node (for example, Teku).
The command uses the [`--checkpoint-sync-url`](../reference/cli/index.md#checkpoint-sync-url) option to download the finalized checkpoint state.

:::note

Expand All @@ -34,11 +36,12 @@ You can also download a finalized checkpoint state file, and specify the locatio
curl -o state.ssz -H 'Accept: application/octet-stream' http://other-node:5051/eth/v2/debug/beacon/states/finalized
```

:::

:::tip

See [this community-maintained list of checkpoint state endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).
And to start Teku:
alexandratran marked this conversation as resolved.
Show resolved Hide resolved
```bash
teku --eth1-endpoint=http://localhost:8545 \
--validator-keys=/Users/me/mainnet/validator/keys:/Users/me/mainnet/validator/passwords \
--initial-state=state.ssz
```

:::

Expand Down
40 changes: 40 additions & 0 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,46 @@ See [this community-maintained list of checkpoint state endpoints](https://eth-c

:::

### checkpoint-sync-url

<!--tabs-->

# Syntax

```bash
--checkpoint-sync-url=<URL>
```

# Example

```bash
--checkpoint-sync-url="https://beaconstate.ethstaker.cc"
```

# Environment variable

```bash
TEKU_CHECKPOINT_SYNC_URL="https://beaconstate.ethstaker.cc"
```

# Configuration file

```bash
checkpoint-sync-url: "https://beaconstate.ethstaker.cc"
```

<!--/tabs-->

URL of a Checkpointz endpoint used to boostrap the node.

By default, Teku will try to download the finalized state from the endpoint. If it can't download the finalized state, it will try to download the genesis state.
alexandratran marked this conversation as resolved.
Show resolved Hide resolved

:::tip

See [this community-maintained list of checkpoint state endpoints](https://eth-clients.github.io/checkpoint-sync-endpoints/).

:::

### logging

<!--tabs-->
Expand Down
Loading