From 730137e04be65fc8e7ba0288778ffdda0e2cf810 Mon Sep 17 00:00:00 2001 From: d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 25 Sep 2023 18:20:21 +0700 Subject: [PATCH 1/2] docs(website): add prereq for windows users --- packages/website/pages/docs/guides/run-a-sepolia-node.mdx | 1 + packages/website/pages/docs/guides/run-a-taiko-node.mdx | 1 + 2 files changed, 2 insertions(+) diff --git a/packages/website/pages/docs/guides/run-a-sepolia-node.mdx b/packages/website/pages/docs/guides/run-a-sepolia-node.mdx index 0099f0d2be2..c7ca6e02645 100644 --- a/packages/website/pages/docs/guides/run-a-sepolia-node.mdx +++ b/packages/website/pages/docs/guides/run-a-sepolia-node.mdx @@ -8,6 +8,7 @@ This guide will help you get a Sepolia archive node up and running. - [Docker](https://docs.docker.com/engine/install/) is installed and **running**. - [Git](https://github.com/git-guides/install-git/) is installed. +- If using Windows, you should install [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to use as your terminal. - As of `2023-06-21` a full archive node sync takes **326 GB** with geth + lighthouse. Consult the hardware requirements of the execution + consensus clients you are using. ## Steps diff --git a/packages/website/pages/docs/guides/run-a-taiko-node.mdx b/packages/website/pages/docs/guides/run-a-taiko-node.mdx index 7a966bd2dec..04dfc6a8d85 100644 --- a/packages/website/pages/docs/guides/run-a-taiko-node.mdx +++ b/packages/website/pages/docs/guides/run-a-taiko-node.mdx @@ -9,6 +9,7 @@ This guide will help you start up a Taiko RPC node using [simple-taiko-node](htt - [Docker](https://docs.docker.com/engine/install/) is installed and **running**. - [Git](https://github.com/git-guides/install-git/) is installed. +- If using Windows, you should install [Git BASH](https://gitforwindows.org/) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to use as your terminal. - Meet the [Geth minimum hardware requirements](https://github.com/ethereum/go-ethereum#hardware-requirements) except for the storage requirement because Taiko nodes will require less storage. As of `2023-09-18` a node uses less than **10 GB**. **100 GB** should be future proof enough if you intend to run your node for a while. ## Steps From d382d68b2dedbfe99d3d012cc1fb352c6b0578cf Mon Sep 17 00:00:00 2001 From: d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 25 Sep 2023 18:22:56 +0700 Subject: [PATCH 2/2] cleanup sudo --- packages/website/pages/docs/guides/run-a-sepolia-node.mdx | 2 +- packages/website/pages/docs/guides/run-a-taiko-node.mdx | 8 ++++++-- .../website/pages/docs/reference/node-troubleshooting.mdx | 8 ++++---- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/packages/website/pages/docs/guides/run-a-sepolia-node.mdx b/packages/website/pages/docs/guides/run-a-sepolia-node.mdx index c7ca6e02645..a48d25376ed 100644 --- a/packages/website/pages/docs/guides/run-a-sepolia-node.mdx +++ b/packages/website/pages/docs/guides/run-a-sepolia-node.mdx @@ -55,7 +55,7 @@ Complete the [eth-docker quickstart](https://eth-docker.net/Usage/QuickStart/). After setting up the config, start the Execution Layer and Consensus Layer clients with admin permission ```bash -sudo ./ethd up +./ethd up ``` ### Check your connection diff --git a/packages/website/pages/docs/guides/run-a-taiko-node.mdx b/packages/website/pages/docs/guides/run-a-taiko-node.mdx index 04dfc6a8d85..7ec4c2d3b4f 100644 --- a/packages/website/pages/docs/guides/run-a-taiko-node.mdx +++ b/packages/website/pages/docs/guides/run-a-taiko-node.mdx @@ -146,9 +146,11 @@ Take a look at the comments above these values in the `.env.sample` to see how t Make sure Docker is running and then run the following command to start the node: ```sh -sudo docker compose up -d +docker compose up -d ``` +> Note: You may need to use `sudo docker compose up -d` if you are not in the `docker` group. + ### Verify node is running #### Check with the node dashboard @@ -194,9 +196,11 @@ curl http://localhost:8547 \ 3. If the blockNumber response value is `0` or not growing, check the Taiko L2 logs here: ```bash -sudo docker compose logs -f +docker compose logs -f ``` +> Note: You may need to use `sudo docker compose logs -f` if you are not in the `docker` group. + ### Operate the node You can find all node operations (eg. stop node, update node, remove node, view logs) in the [Node runner manual](/docs/manuals/node-runner-manual). diff --git a/packages/website/pages/docs/reference/node-troubleshooting.mdx b/packages/website/pages/docs/reference/node-troubleshooting.mdx index 7f1c0d57a4e..0d85f8fabcc 100644 --- a/packages/website/pages/docs/reference/node-troubleshooting.mdx +++ b/packages/website/pages/docs/reference/node-troubleshooting.mdx @@ -37,7 +37,7 @@ This block has been proven by someone else, but it's not verified yet, you can i #### `error: "failed to propose transactions: unable to find prover"` The proposer is not able to connect with a prover. By default, the prover endpoint is local so check your local prover first. -If you are not running a local prover, select another prover from the [prover market](/docs/reference/prover-market-page). Note: you may need to switch provers if +If you are not running a local prover, select another prover from the [prover market](/docs/reference/prover-market-page). Note: you may need to switch provers if your selected prover hits its max capacity. #### `Fatal: Failed to register the Ethereum service: database contains incompatible genesis` @@ -165,7 +165,7 @@ docker compose -f ./docker-compose.l3.yml --env-file .env.l3 up -d #### `dial tcp: connect: connection refused` -This means that you are not able to connect to the RPC endpoint. Check if you have a firewall up and that you are allowing those ports. For Ubuntu, this would be checked with "sudo ufw status". +This means that you are not able to connect to the RPC endpoint. Check if you have a firewall up and that you are allowing those ports. For Ubuntu, this would be checked with `sudo ufw status`. #### `WARNING: Found orphan containers` @@ -177,5 +177,5 @@ You can safely ignore this "warn" level message, it simply means you just ignore #### `PROPOSE_BLOCK_TX_GAS_TIP_CAP: parameter not set` -A flag might not be set in your .env file. -Copy the default .env file, then reset your RPC node and proposer with the updated flag values. \ No newline at end of file +A flag might not be set in your .env file. +Copy the default .env file, then reset your RPC node and proposer with the updated flag values.