Skip to content

Commit

Permalink
supported versions
Browse files Browse the repository at this point in the history
  • Loading branch information
joshuafernandes committed Dec 4, 2023
1 parent ceb5cd5 commit 7be3256
Show file tree
Hide file tree
Showing 34 changed files with 3,798 additions and 2,912 deletions.
672 changes: 225 additions & 447 deletions package-lock.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
"src/**/*.{ts,js,jsx,tsx}": "npm run lint:fix"
},
"dependencies": {
"@docusaurus/core": "^3.0.0",
"@docusaurus/plugin-client-redirects": "^3.0.0",
"@docusaurus/plugin-google-gtag": "^3.0.0",
"@docusaurus/plugin-google-tag-manager": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"@mdx-js/react": "^3.0.0",
"@docusaurus/core": "^3.0.1",
"@docusaurus/plugin-client-redirects": "^3.0.1",
"@docusaurus/plugin-google-gtag": "^3.0.1",
"@docusaurus/plugin-google-tag-manager": "^3.0.1",
"@docusaurus/preset-classic": "^3.0.1",
"@easyops-cn/docusaurus-search-local": "^0.38.1",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.2.1",
"prism-react-renderer": "^2.1.0",
"react": "^18.0.0",
Expand All @@ -43,7 +43,6 @@
"@commitlint/cli": "^18.2.0",
"@commitlint/config-conventional": "^18.1.0",
"@docusaurus/eslint-plugin": "^3.0.0",
"@typescript-eslint/parser":"^6.13.1",
"@docusaurus/module-type-aliases": "^3.0.0",
"@docusaurus/tsconfig": "^3.0.0",
"@docusaurus/types": "^3.0.0",
Expand All @@ -53,6 +52,7 @@
"@semantic-release/github": "^8.0.7",
"@semantic-release/npm": "^10.0.2",
"@semantic-release/release-notes-generator": "^10.0.3",
"@typescript-eslint/parser": "^6.13.1",
"commitizen": "^4.3.0",
"cspell": "^6.31.1",
"cz-conventional-changelog": "^3.3.0",
Expand Down
33 changes: 21 additions & 12 deletions versioned_docs/version-23.10.0/get-started/connect/testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Connect Teku to a testnet.
sidebar_position: 1
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Connect to a testnet

Run Teku as a consensus client with any execution client on a testnet (for example [Goerli](https://github.com/eth-clients/goerli) or
Expand Down Expand Up @@ -85,9 +88,9 @@ Open a new terminal window.

To run Teku as a beacon node only (without validator duties), run the following command or [specify the options in a configuration file](../../how-to/configure/use-config-file.md):

<!--tabs-->
<Tabs>

# Goerli
<TabItem value="Goerli" label="Goerli" default>

```bash
teku \
Expand All @@ -98,7 +101,8 @@ teku \
--rest-api-enabled=true
```

# Sepolia
</TabItem>
<TabItem value="Sepolia" label="Sepolia" >

```bash
teku \
Expand All @@ -109,7 +113,8 @@ teku \
--rest-api-enabled=true
```

<!--/tabs-->
</TabItem>
</Tabs>

Specify the path to the `jwtsecret.hex` file generated in [step 1] using the [`--ee-jwt-secret-file`](../../reference/cli/index.md#ee-jwt-secret-file) option.

Expand All @@ -128,9 +133,9 @@ You can also use [Prometheus and Grafana](../../how-to/monitor/use-metrics.md) t
To run the Teku beacon node and validator client in a single process, run the following command or
[specify the options in the configuration file](../../how-to/configure/use-config-file.md):

<!--tabs-->
<Tabs>

# Goerli
<TabItem value="Goerli" label="Goerli" default>

```bash
teku \
Expand All @@ -143,11 +148,13 @@ teku \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Sepolia
</TabItem>
<TabItem value="Sepolia" label="Sepolia" >

Sepolia is a permissioned network and you can't run a validator client on it without [requesting to become a validator](https://notes.ethereum.org/zvkfSmYnT0-uxwwEegbCqg) first.

<!--/tabs-->
</TabItem>
</Tabs>

Specify:

Expand All @@ -163,9 +170,9 @@ To run the Teku beacon node and validator client as separate processes, first [s

On a separate machine, run Teku using the [`validator-client`](../../reference/cli/subcommands/validator-client.md) subcommand:

<!--tabs-->
<Tabs>

# Goerli
<TabItem value="Goerli" label="Goerli" default>

```bash
teku validator-client \
Expand All @@ -174,11 +181,13 @@ teku validator-client \
--validator-keys=<path to key file>:<path to password file>[,<path to key file>:<path to password file>,...]
```

# Sepolia
</TabItem>
<TabItem value="Sepolia" label="Sepolia" >

Sepolia is a permissioned network and you can't run a validator client on it without [requesting to become a validator](https://notes.ethereum.org/zvkfSmYnT0-uxwwEegbCqg) first.

<!--/tabs-->
</TabItem>
</Tabs>

Specify:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Install Teku from binary distribution.
sidebar_position: 1
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Install binary distribution

## Linux / Unix / macOS / Windows
Expand All @@ -30,21 +33,23 @@ Unpack the downloaded files and change into the `teku-<release>` directory.

Display Teku command line help to confirm installation:

<!--tabs-->
<Tabs>

# Linux/macOS
<TabItem value="Linux/macOS" label="Linux/macOS" default>

```bash
./bin/teku --help
```

# Windows
</TabItem>
<TabItem value="Windows" label="Windows" >

```bat
bin\teku --help
```

<!--/tabs-->
</TabItem>
</Tabs>

## macOS with Homebrew

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Run Teku using the official Docker image.
sidebar_position: 3
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Run Teku from a Docker image

Use the Teku Docker image to run a node without installing Teku.
Expand Down Expand Up @@ -79,9 +82,9 @@ The example assumes the validators specified in [`--validator-keys`](../../refer

Run `docker-compose up` in the directory containing the `docker-compose.yml` file to start the container.

<!--tabs-->
<Tabs>

# Goerli
<TabItem value="Goerli" label="Goerli" default>

```yaml
---
Expand Down Expand Up @@ -138,7 +141,8 @@ services:
- "5051:5051"
```
# Mainnet
</TabItem>
<TabItem value="Mainnet" label="Mainnet" >
```yaml
---
Expand Down Expand Up @@ -192,7 +196,8 @@ services:
- "5051:5051"
```
<!--/tabs-->
</TabItem>
</Tabs>
<!-- Links -->
Expand Down
36 changes: 21 additions & 15 deletions versioned_docs/version-23.10.0/get-started/manage-memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Manage Teku's JVM memory usage.
sidebar_position: 5
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Manage memory

Manage Teku's Java Virtual Machine (JVM) memory usage by setting a maximum heap size using the `JAVA_OPTS` environment variable.
Expand All @@ -12,21 +15,22 @@ We recommend setting the maximum heap size to 5GB or more.

Set the heap size using the environment variable, or using the command line when starting Teku.

<!--tabs-->

# Environment variable
<Tabs>
<TabItem value="Environment variable" label="Environment variable" >

```bash
export JAVA_OPTS=-Xmx5g
```

# Command line
</TabItem>
<TabItem value="Command line" label="Configuration file" >

```bash
JAVA_OPTS=-Xmx5g ./teku [options]
```

<!--/tabs-->
</TabItem>
</Tabs>

:::note

Expand All @@ -38,36 +42,38 @@ The node uses more RAM to perform better if it’s available, especially during

If an out of memory error occurs, the heap dump file is placed in the directory that Teku runs from. The heap dump file is potentially large (1-2GB), to specify the directory to place the file, set the `-XX:HeapDumpPath` Java option to the required path.

<!--tabs-->

# Environment variable
<Tabs>
<TabItem value="Environment variable" label="Environment variable" >

```bash
export TEKU_OPTS="-XX:HeapDumpPath=/home/me/me_node/dumps"
```

# Command line
</TabItem>
<TabItem value="Command line" label="Configuration file" >

```bash
TEKU_OPTS="-XX:HeapDumpPath=/home/me/me_node/dumps" ./teku [options]
```

<!--/tabs-->
</TabItem>
</Tabs>

To disable the heap dump file generation, set the `-XX:-HeapDumpOnOutOfMemoryError` Java option.

<!--/tabs-->

# Environment variable
<Tabs>
<TabItem value="Environment variable" label="Environment variable" >

```bash
export TEKU_OPTS="-XX:-HeapDumpOnOutOfMemoryError"
```

# Command line
</TabItem>
<TabItem value="Command line" label="Configuration file" >

```bash
TEKU_OPTS="-XX:-HeapDumpOnOutOfMemoryError" ./teku [options]
```

<!--/tabs-->
</TabItem>
</Tabs>
14 changes: 10 additions & 4 deletions versioned_docs/version-23.10.0/get-started/start-teku.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Run Teku as a beacon node and/or validator.
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Start Teku

You can run Teku as a beacon node and validator in a single process, or as separate processes.
Expand Down Expand Up @@ -98,15 +101,17 @@ Use the [`/liveness`](https://consensys.github.io/teku/#operation/getTekuV1Admin

The endpoint returns the status `200 OK` if the node is up or syncing.

<!--tabs-->
<Tabs>

<TabItem value="curl HTTP request" label="curl HTTP request" default>

# curl HTTP request

```bash
curl -I -X GET "http://192.10.10.101:5051/teku/v1/admin/liveness"
```

# Result
</TabItem>
<TabItem value="Result" label="Result" >

```bash
HTTP/1.1 200 OK
Expand All @@ -117,7 +122,8 @@ Cache-Control: max-age=0
Content-Length: 0
```

<!--/tabs-->
</TabItem>
</Tabs>

<!-- links -->

Expand Down
14 changes: 10 additions & 4 deletions versioned_docs/version-23.10.0/how-to/update-withdrawal-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ description: Update your BLS withdrawal address to an Ethereum address.
sidebar_position: 12
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';


# Update your withdrawal credentials

When you create a validator, it’s possible to set its
Expand All @@ -24,22 +28,24 @@ Capella upgrade.
The following shell script allows you to determine the withdrawal address of a
given validator ID.

<!--tabs-->
<Tabs>

# Script
<TabItem value="Script" label="Script" default>

```bash
VALIDATOR=<VALIDATOR_INDEX> \
curl http://localhost:5051/eth/v1/beacon/states/finalized/validators/$VALIDATOR | jq '.data | .validator.withdrawal_credentials'
```

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

```
"0x00fc40352b0a186d83267fc1342ec5da49dbb78e1099a4bd8db16d2c0d223594"
```

<!--/tabs-->
</TabItem>
</Tabs>

In the script, specify the `<VALIDATOR_INDEX>` (for example, `1`) that was
provided when you joined the network.
Expand Down
Loading

0 comments on commit 7be3256

Please sign in to comment.