From d2b841594e0624f1619f7169b8607983e5b5a97c Mon Sep 17 00:00:00 2001 From: dave | d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 25 Sep 2023 22:14:51 +0900 Subject: [PATCH] docs(website): add windows guidance and remove sudo (#14806) --- packages/website/pages/docs/guides/run-a-taiko-node.mdx | 5 +++++ .../pages/docs/reference/node-troubleshooting.mdx | 9 +-------- 2 files changed, 6 insertions(+), 8 deletions(-) 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 e9e93dba0d4..7ec4c2d3b4f 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 @@ -148,6 +149,8 @@ Make sure Docker is running and then run the following command to start the node 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 @@ -196,6 +199,8 @@ curl http://localhost:8547 \ 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 41809ec5f43..e3004265cb3 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` @@ -179,10 +179,3 @@ You can safely ignore this "warn" level message, it simply means you just ignore 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. - -#### `info: Skip an invalid proposed transaction reason="nonce too low` - -Scenario when the mempool is small and proposers are trying to propose the same transactions within an L1 block. -The first proposer included on chain will successfully propose these transactions. -However, all others proposer included transactions will end up with status `propose empty blocks`, -since the proposed transactions will be filtered by nodes.