Run a Taiko node
This guide will help you start up a Taiko RPC node using simple-taiko-node.
Prerequisites
- Docker is installed and running.
- Git is installed.
- If using Windows, you should install Git BASH or WSL to use as your terminal.
- Meet the Geth minimum hardware requirements except for the storage requirement because Taiko nodes will require less storage (at the time of writing).
Run a Taiko node with simple-taiko-node
1. Clone simple-taiko-node
2. Copy the sample .env files
3. Set the L1 archive node endpoint
First, open the .env
in your preferred text editor:
Next, you will set the L1 node endpoints. If you are running a local Holesky node, you cannot reference the L1 endpoints as http://127.0.0.1:8545
, ws://127.0.0.1:8546
and http://127.0.0.1:5052
because that is local to inside the simple-taiko-node Docker networking. Instead you can try:
- Using
host.docker.internal
(see: stack overflow). - Using the private ip address of your machine (use something like
ip addr show
to get this ip address).
After getting the address of the Holesky node, set the following L1 node endpoints in your .env
file. Here is an example:
L1_ENDPOINT_HTTP=http://192.168.1.15:8545
L1_ENDPOINT_WS=ws://192.168.1.15:8546
L1_BEACON_HTTP=http://192.168.1.15:5052
4. Remove old testnet volumes
If you ran a testnet node previously, make sure to first remove the old volumes:
5. Start the node
Make sure Docker is running and then run the following command to start the node (you may need to use sudo docker compose up -d
if your user is not in the docker
group):
6. Verify node is running
Option 1: Check with the node dashboard
A node dashboard will be running on localhost
on the GRAFANA_PORT
you set in your .env
file, which defaults to 3001
: http://localhost:3001/d/L2ExecutionEngine/l2-execution-engine-overview.
You can verify that your node is syncing by checking that the chain head on the dashboard is increasing. Once the chain head matches what’s on the block explorer, you are fully synced.
Option 2: Check with curl commands
- Check if the Execution Layer client is connected to Taiko L2:
which should return the chainId as 0x28c61
(167009):
- Check if the Execution Layer client is synced by requesting the latest Taiko L2 / L3 block from the Execution Layer client:
- If the blockNumber response value is
0
or not growing, check the Taiko L2 logs here:
Note: You may need to use
sudo docker compose logs -f
if you are not in thedocker
group.
Video tutorial
See the video tutorial Run a Taiko L2 node (YouTube). It’s for a previous testnet but the overall steps are the same!
Full simple-taiko-node CLI reference
Start node
Stop node
Restart node
Update node
Remove node
Start and remove orphan containers
This command will start and remove containers that are not part of the current docker compose file.
View grafana dashboard
View logs
View execution logs
View client driver logs
View client proposer logs
View system resource usage stats
Compare .env and .env.sample
Troubleshooting
- Visit the Discord for help on any common error codes / issues.
- View the logs of the node (see above).