From 27002994aacafe23a44a7e2f611c7f5ad0683abb Mon Sep 17 00:00:00 2001 From: Willian Mitsuda Date: Mon, 29 Aug 2022 17:11:27 -0300 Subject: [PATCH] Update instructions for current erigon 2 alpha series, where erigon runs an embedded rpcdaemon because of the merge --- docs/install.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/install.md b/docs/install.md index e092834..089d151 100644 --- a/docs/install.md +++ b/docs/install.md @@ -6,43 +6,41 @@ It depends heavily on a working Erigon installation with Otterscan patches appli ## Install Erigon -You will need an Erigon executing node (`erigon`). Also you will need Erigon RPC daemon (`rpcdaemon`) with Otterscan patches. Since setting up an Erigon environment itself can take some work, make sure to follow their instructions and have a working archive node before continuing. +You will need an Erigon executing node (`erigon`) with Otterscan patches. Since setting up an Erigon environment itself can take some work, make sure to follow their instructions and have a working archive node before continuing. -My personal experience: at the moment of this writing (~block 14,000,000), setting up an archive node takes over 5-6 days and ~1.7 TB of SSD. +My personal experience: at the moment of this writing (~block 15,000,000), setting up an archive node takes over 3-7 days (depending on your hardware) and ~1.6 TB of SSD. -They have weekly stable releases, make sure you are running on of them, not development ones. +They have weekly alpha releases, make sure you are running one of them, not development ones. -## Install Otterscan-patched rpcdaemon +## Install Otterscan-patched erigon We rely on custom JSON-RPC APIs which are not available in a standard ETH node. We keep a separated repository containing an Erigon fork here: https://github.com/wmitsuda/erigon. -Please follow the instructions in the repository `README` and replace the original Erigon `rpcdaemon` with our patched one. +Please follow the instructions in the repository `README` and replace the original Erigon `erigon` with our patched one. -## Enable Otterscan namespace on rpcdaemon +## Enable Otterscan namespace on erigon -When running `rpcdaemon`, make sure to enable the `erigon`, `ots`, `eth` APIs in addition to whatever cli options you are using to start `rpcdaemon`. +When running `erigon`, make sure to enable the `erigon`, `ots`, `eth` APIs in addition to whatever cli options you are using to start `erigon`. `ots` stands for Otterscan and it is the namespace we use for our own custom APIs. ``` -/rpcdaemon --http.api "eth,erigon,ots," --private.api.addr 127.0.0.1:9090 --datadir --http.corsdomain "*" +/erigon --http.api "eth,erigon,ots," --datadir --http.corsdomain "*" ``` -Be sure to include both `--private.api.addr` and `--datadir` parameter so you run it in dual mode, otherwise the performance will be much worse. +Pay attention to the `--http.corsdomain` parameter, CORS is **required** for the browser to call the node directly. -Also pay attention to the `--http.corsdomain` parameter, CORS is **required** for the browser to call the node directly. - -Now you should have an Erigon node with Otterscan JSON-RPC APIs enabled, running in dual mode with CORS enabled. +Now you should have an Erigon node with Otterscan JSON-RPC APIs and CORS enabled. ## Run Otterscan docker image from Docker Hub The Otterscan official repo on Docker Hub is [here](https://hub.docker.com/orgs/otterscan/repositories). ``` -docker run --rm -p 5000:80 --name otterscan -d otterscan/otterscan: +docker run --rm -p 5100:80 --name otterscan -d otterscan/otterscan: ``` -This will download the Otterscan image from Docker Hub, run it locally using the default parameters, binding it to port 5000 (see the `-p` docker run parameter). +This will download the Otterscan image from Docker Hub, run it locally using the default parameters, binding it to port 5100 (see the `-p` docker run parameter). To stop Otterscan service, run: @@ -53,7 +51,7 @@ docker stop otterscan By default it assumes your Erigon node is at `http://127.0.0.1:8545`. You can override the URL by setting the `ERIGON_URL` env variable on `docker run`: ``` -docker run --rm -p 5000:80 --name otterscan -d --env ERIGON_URL="" otterscan/otterscan: +docker run --rm -p 5100:80 --name otterscan -d --env ERIGON_URL="" otterscan/otterscan: ``` This is the preferred way to run Otterscan. You can read about other ways [here](./other-ways-to-run-otterscan.md).