diff --git a/docs/node/guide/beacon/_partials/_install_cl_lodestar.md b/docs/node/guide/beacon/_partials/_install_cl_lodestar.md new file mode 100644 index 00000000..8d6d7f35 --- /dev/null +++ b/docs/node/guide/beacon/_partials/_install_cl_lodestar.md @@ -0,0 +1,168 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + + + + +- Go to the [lodestar releases page](https://github.com/ChainSafe/lodestar/releases/tag/v1.2.2) and copy the url of the latest release. + +- Download the lodestar VERSION-ARQ.tar.gz binary. + ```bash + wget [URL_FROM_PREVIOUS_STEP] + ``` + +- Extract the downloaded file and move under consensus directory. + ```bash + tar -xvf VERSION-ARQ.tar.gz --directory consensus + ``` + +Your repo will look like this +``` +πŸ“‚gnosis +β”œβ”€β”€ πŸ“‚ jwtsecret/ +β”œβ”€β”€ πŸ“‚ execution/ +└── πŸ“‚ consensus/ + β”œβ”€β”€ πŸ“‚ lodestar-${version}/ + β”œβ”€β”€ πŸ“‚ data/ + β”œβ”€β”€ πŸ“‚ keystores/ + └── πŸ“‚ validators/ +``` + +- Get into the lodestar folder + ```bash + cd consensus && cd lodestar-${version} + ``` +- Install and build across all packages + ```bash + yarn install --ignore-optional + yarn run build + ``` + +:::tip +Check that you are install correctly by running `./lodestar --help' +::: + + - Execute Lodestar Beacon Chain + ```bash + ./lodestar \ + --network=gnosis \ + --dataDir=/data \ + --preset=gnosis \ + --eth1=true \ + --execution.urls=http://execution:8551 \ + --jwt-secret=../../jwtsecret/jwt.hex \ + --logFile=/data/logs/beacon.log \ + --logFileLevel=info \ + --port=9000 \ + --rest=true \ + --rest.address=0.0.0.0 \ + --rest.port=4000 \ + --rest.cors=* \ + --discv5=true \ + --targetPeers=50 \ + --metrics=true \ + --metrics.port=5054 \ + --checkpointSyncUrl=https://checkpoint.gnosischain.com/ + ``` + + + + + + +Lodestar only runs on Linux. To run it on Windows, [Install Linux on Windows with WSL](https://learn.microsoft.com/en-us/windows/wsl/install), and follow the instructions on the WSL terminal. + +- Go to the [lodestar releases page](https://github.com/ChainSafe/lodestar/releases/tag/v1.2.2) and copy the url of the latest release, currently v1.2.2. + +- Download the lodestar VERSION-ARQ.tar.gz binary. + ```bash + wget [URL_FROM_PREVIOUS_STEP] + ``` + +- Extract the downloaded file and move under consensus directory + ```bash + tar -xvf VERSION-ARQ.tar.gz --directory consensus + ``` +Your repo will look like this +``` +πŸ“‚gnosis +β”œβ”€β”€ πŸ“‚ jwtsecret/ +β”œβ”€β”€ πŸ“‚ execution/ +└── πŸ“‚ consensus/ + β”œβ”€β”€ πŸ“‚ lodestar-${version}/ + β”œβ”€β”€ πŸ“‚ data/ + β”œβ”€β”€ πŸ“‚ keystores/ + └── πŸ“‚ validators/ +``` + +- Get into the lodestar folder + ```bash + cd consensus && cd lodestar-${version} + ``` +- Install and build across all packages + ```bash + yarn install --ignore-optional + yarn run build + ``` + +:::tip +Check that you are install correctly by running `./lodestar --help' +::: + + - Execute Lodestar Beacon Chain + ```bash + ./lodestar \ + --network=gnosis \ + --dataDir=/data \ + --preset=gnosis \ + --eth1=true \ + --execution.urls=http://execution:8551 \ + --jwt-secret=../../jwtsecret/jwt.hex \ + --logFile=/data/logs/beacon.log \ + --logFileLevel=info \ + --port=9000 \ + --rest=true \ + --rest.address=0.0.0.0 \ + --rest.port=4000 \ + --rest.cors=* \ + --discv5=true \ + --targetPeers=50 \ + --metrics=true \ + --metrics.port=5054 \ + --checkpointSyncUrl=https://checkpoint.gnosischain.com/ + ``` + + + + + + + + + + +Lodestar doesn't support Chiado at the moment. + + + + +Lodestar doesn't support Chiado at the moment. + + + + + + \ No newline at end of file diff --git a/docs/node/guide/beacon/_partials/_install_cl_teku.md b/docs/node/guide/beacon/_partials/_install_cl_teku.md new file mode 100644 index 00000000..ed643cbe --- /dev/null +++ b/docs/node/guide/beacon/_partials/_install_cl_teku.md @@ -0,0 +1,160 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + + + + +## Prerequisites +1. Java 11+ + + +## Install and Run + +- Go to the [Teku release page](https://github.com/ConsenSys/teku/releases) and copy the url of the binary distribution under **Downloads** section. + + +- Download the teku Source code .tar.gz binary. + ```bash + wget [URL_FROM_PREVIOUS_STEP] + ``` + +- Extract the downloaded file and move under consensus directory + ```bash + tar -xvf VERSION.tar.gz --directory consensus + ``` + +- Get into the teku folder + ```bash + cd consensus && cd teku-${version} + ``` + +Your repo will look like this + + + +``` +πŸ“‚gnosis +β”œβ”€β”€ πŸ“‚ jwtsecret/ +β”œβ”€β”€ πŸ“‚ execution/ +└── πŸ“‚ consensus/ + β”œβ”€β”€ πŸ“‚ teku-${version}/ + β”œβ”€β”€ πŸ“‚ data/ + β”œβ”€β”€ πŸ“‚ keystores/ + └── πŸ“‚ validators/ +``` + +If you're installing on macOS with Homebrew, check out [here](https://docs.teku.consensys.net/en/latest/HowTo/Get-Started/Installation-Options/Install-Binaries/#macos-with-homebrew). + +Check that you are installing correctly by running `./bin/teku --help' + + +:::tip +You can run both beacon and validator with a single command. If you wish to run with a single command, skip to [step 4: Run a validator](../../README.md#step-4-run-a-validator). +::: + +- Execute beacon node(Optional) + +``` +./bin/teku \ + --ee-endpoint=http://localhost:8551 \ + --ee-jwt-secret-file=../../jwtsecret/jwt.hex \ + --metrics-enabled=true \ + --rest-api-enabled=true +``` + + + + + +## Prerequisites +1. Java 11+ +2. [Microsoft Visual C++ 2010 security update](https://www.microsoft.com/en-us/download/details.aspx?id=26999) + +## Install and Run + +- Go to the [Teku release page](https://github.com/ConsenSys/teku/releases) and copy the url of the binary distribution under **Downloads** section. + + +- Download the teku Source code .tar.gz binary. + ```bash + wget [URL_FROM_PREVIOUS_STEP] + ``` + +- Extract the downloaded file and move under consensus directory + ```bash + tar -xvf VERSION.tar.gz --directory consensus + ``` + +- Get into the teku folder + ```bash + cd consensus && cd teku-${version} + ``` + +Your repo will look like this + + + +``` +πŸ“‚gnosis +β”œβ”€β”€ πŸ“‚ jwtsecret/ +β”œβ”€β”€ πŸ“‚ execution/ +└── πŸ“‚ consensus/ + β”œβ”€β”€ πŸ“‚ teku-${version}/ + β”œβ”€β”€ πŸ“‚ data/ + β”œβ”€β”€ πŸ“‚ keystores/ + └── πŸ“‚ validators/ +``` + +If you're installing on macOS with Homebrew, check out [here](https://docs.teku.consensys.net/en/latest/HowTo/Get-Started/Installation-Options/Install-Binaries/#macos-with-homebrew). + +Check that you are installing correctly by running `bin\teku --help' + + +:::tip +You can run both beacon and validator with a single command. If you wish to run with a single command, skip to [step 4: Run a validator](../../README.md#step-4-run-a-validator). +::: + +- Execute beacon node(Optional) + +``` +./bin/teku \ + --ee-endpoint=http://localhost:8551 \ + --ee-jwt-secret-file=../jwtsecret/jwt.hex \ + --metrics-enabled=true \ + --rest-api-enabled=true +``` + + + + + + + + + + +Teku doesn't support Chiado at the moment. + + + + +Teku doesn't support Chiado at the moment. + + + + + + \ No newline at end of file diff --git a/docs/node/guide/beacon/_partials/_run-consensus-client.md b/docs/node/guide/beacon/_partials/_run-consensus-client.md index 27ea31ea..85cfc4d0 100644 --- a/docs/node/guide/beacon/_partials/_run-consensus-client.md +++ b/docs/node/guide/beacon/_partials/_run-consensus-client.md @@ -1,6 +1,9 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import InstallLighthousePartial from '@site/docs/node/guide/beacon/_partials/_install_cl_lighthouse.md'; +import InstallLodestarPartial from '@site/docs/node/guide/beacon/_partials/_install_cl_lodestar.md'; +import InstallTekuPartial from '@site/docs/node/guide/beacon/_partials/_install_cl_teku.md'; + ```mdx-code-block @@ -27,6 +30,8 @@ Please refer to [Run a Beacon Node: Lodestar](../lodestar.md) ::: + + ```mdx-code-block @@ -37,8 +42,12 @@ Please refer to [Run a Beacon Node: Lodestar](../lodestar.md) Please refer to [Run a Beacon Node: Teku](../teku.md) + ::: + + + ```mdx-code-block diff --git a/docs/node/guide/validator/_partials/_install-validator.md b/docs/node/guide/validator/_partials/_install-validator.md index 3915e2a2..9dd4ddc9 100644 --- a/docs/node/guide/validator/_partials/_install-validator.md +++ b/docs/node/guide/validator/_partials/_install-validator.md @@ -1,6 +1,8 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import InstallTekuValidatorPartial from '@site/docs/node/guide/validator/_partials/clients/_install_validator_teku.md'; + ```mdx-code-block @@ -20,12 +23,19 @@ import InstallLighthouseValidatorPartial from '@site/docs/node/guide/validator/_ ``` +import InstallLodestarValidatorPartial from '@site/docs/node/guide/validator/_partials/clients/_install_validator_lodestar.md'; + + :::info + Please refer to [Run a Beacon Node: Lodestar](../../beacon/lodestar.md) + ::: + + ```mdx-code-block @@ -62,6 +72,8 @@ Please refer to [Run a Beacon Node: Teku](../../beacon/teku.md) ::: + + ```mdx-code-block diff --git a/docs/node/guide/validator/_partials/clients/_install_validator_lodestar.md b/docs/node/guide/validator/_partials/clients/_install_validator_lodestar.md new file mode 100644 index 00000000..21307a0f --- /dev/null +++ b/docs/node/guide/validator/_partials/clients/_install_validator_lodestar.md @@ -0,0 +1,65 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + +:::info +Lodestar only runs on Linux. To run it on Windows, [Install Linux on Windows with WSL](https://learn.microsoft.com/en-us/windows/wsl/install), and follow the instructions on the WSL terminal. +::: + + + + + + + +To run a validator, we need to first import the keys generated in the previous step. + +* In a new command line window, navigate to the `consensus` folder and execute Lodestar validator client +* To ease the import process, we will create a `password.txt` file containing the password used to encrypt the validator keys. + +```shell +echo 'PLACE_HERE_YOUR_PASSWORD' > keystores/password.txt +``` + +You can import the keys when starting the validator. + +* Import the validator keys using lighthouse: + +```shell +./lodestar validator \ + --network=gnosis \ + --importKeystores=/keystores \ + --importKeystoresPassword=keystores/password.txt \ + --directory keystores \ + --dataDir=/data/validators \ +# highlight-start + --suggestedFeeRecipient=$FEE_RECIPIENT \ # Change this value +# highlight-end +# highlight-start + --graffiti=$GRAFFITI # Change this value +# highlight-end +``` + +* Start your lighhouse validator: + + + +Replace `$GRAFFITI` with your [graffiti](https://lighthouse-book.sigmaprime.io/graffiti.html)and `$FEE_RECIPIENT` with your fee recipient address. Make sure to delete `# Change this value` before running this command. Learn more about the CLI commands and their options [here](https://chainsafe.github.io/lodestar/reference/cli/) + + + + + +
+
+ +
diff --git a/docs/node/guide/validator/_partials/clients/_install_validator_teku.md b/docs/node/guide/validator/_partials/clients/_install_validator_teku.md new file mode 100644 index 00000000..80e50928 --- /dev/null +++ b/docs/node/guide/validator/_partials/clients/_install_validator_teku.md @@ -0,0 +1,78 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + + +:::info +If you're using Windows, please [Install Linux on Windows with WSL](https://learn.microsoft.com/en-us/windows/wsl/install), and follow the instructions on the WSL terminal. +::: + + + + + + + +To run a validator, we need to first import the keys generated in the previous step. + +* In a new command line window, navigate to the `consensus` folder and execute Teku validator client +* To ease the import process, we will create a password txt file containing the password used to encrypt the validator keys. + + + +```shell +echo 'PLACE_HERE_YOUR_PASSWORD' > keystores/keystore-${m_...}.json.txt +``` + +If the Launchpad creates a key named keystore-m_12381_3600_0_0_0-1596485378.json, then the password file must be named keystore-m_12381_3600_0_0_0-1596485378.txt to comply with [EIP-2335](https://docs.teku.consensys.net/en/latest/HowTo/Get-Started/Connect/Connect-To-Mainnet/#create-a-password-file-for-each-validator-key) + +You can import the keys when starting the validator. + +* navigate to teku folder + +```shell +cd teku-${version} +``` + +* Execute Teku Beacon Chain and Validator(s): + +```shell +./bin/teku \ + --ee-endpoint=http://localhost:8551 \ + --ee-jwt-secret-file=../../jwtsecret/jwt.hex \ + --metrics-enabled=true \ + --rest-api-enabled=true \ +# highlight-start + --validators-proposer-default-fee-recipient=${Fee Recipient Address} \ + --validator-keys=${path to key file}:${path to password file} +# highlight-end +``` + +If you wish to run validator only, run the following command: + +```shell +./bin/teku validator-client \ +# highlight-start + --beacon-node-api-endpoint=${endpoint} \ + --validator-keys=${path to key file}:${path to password file} +# highlight-end +``` + +Replace `$FEE_RECIPIENT` with your fee recipient address, `${path to key file}` and `{path to password file}`with the location where `keystores- *.json` and `keystore- *.txt` are stored, and `${endpoint}` with the endpoint of the beacon node’s REST API (default is http://127.0.0.1:5051). Learn more about the CLI commands and their options [here](https://docs.teku.consensys.net/en/latest/Reference/CLI/CLI-Syntax/). + + + + + +
+
+ +