Skip to content

Latest commit

 

History

History
180 lines (125 loc) · 6.86 KB

README.md

File metadata and controls

180 lines (125 loc) · 6.86 KB
Raw



Reverse proxy for Ethereum nodes that stores logs information for a faster retrieval.

version 1.0.0-beta


Status · Description · Features · Install · DAppNode · Example · Security · Contributing

Status

EthLogSpy is currently in beta version.

Description

EthLogSpy is a Golang Reverse Proxy for an Ethereum Node.

It exposes the given node to the world by just reverse proxying every JSON RPC call, except for the eth_getLogs one: on this method EthLogSpy retrieves the logs stored in the database (MongoDB) or in the cache (Redis) and returns it in the same format that the Ethereum Node would use, basically faking its response.

It is fully compatible with the web3js library, so your dApp can easily retrieve the logs just by using the web3 instance (thus avoiding making any specific HTTP request to EthLogSpy).

The yaml configuration file is layed out as follows:

mongo:
  connection: "mongodb://localhost:27017" # mongodb connection string
  db_name: "ethlogspy" # mongodb database name
redis:
  host: "localhost" # redis host 
  port: 6379 # redis port
  password: "" # redis password
  db: 0 # redis db

The following environment variables are used:

NODE_HOST = # host name of the ethereum node (default: "localhost")
NODE_PORT = # port of the ethereum node (default: 8545)
CORS_ORIGIN = # allowed cors origins (default: "*")
BLOCK_NUMBER = # block number where to start the retrieval (default: 0)

Features

  • HTTP JSON RPC API;
  • WebSocket JSON RPC API;
  • Support for eth_subscribe JSON RPC method;
  • CORS;
  • Intel mode for analytics;
  • Disable/enable Redis cache via configuration;
  • Disable/enable in-memory cache via configuration;
  • Logs integrity check (via routine or after every call?).

Install

Standalone

If you have golang installed on your machine you can simply build the executable by running the following command inside the cloned directory:

go build -o ethlogspy *.go

This will create the ethlogspy executable that you can run using this commands:

./ethlogspy # default configuration file must be found in /usr/local/ethlogspy/configs/config.yml
./ethlogspy -c CONFIG_PATH # retrieves the config file from the given CONFIG_PATH

Docker

In order to install ethlogspy using Docker you need to have a running MongoDB and Redis instance. After you've cloned this repo, you need to go and update your desired config in the configs/ folder based on your environment.

Finally, build the docker image and run it:

docker build -t ethlogspy .
docker run -it --rm -d -p 8080:8080 --name ethlogspy ethlogspy:latest

If you're also running MongoDB and Redis on a container, make sure to link them to the ethlogspy one. If your Ethereum Node is running locally, make sure also to allow the ethlogspy container to contact it by using the proper Docker configuration.

For MacOS and Windows just use the host.docker.internal instead of localhost in the configuration to reach your node; on Linux you need to update the docker run command and add the host network flag (--network="host").

Docker Compose

If you want to run everyting using docker-compose, you simply just clone this repo and then run inside the folder:

docker-compose build
nohup docker-compose up &

This will build and run a local instance of MongoDB, Redis and EthLogSpy, ready for use.

DAppNode

EthLogSpy can be installed on a DAppNode with one the following architectures:

  • linux/amd64
  • linux/arm64

The package is not available yet on the official DAppStore, but soon it will be. In order to install it on a DAppNode you must be connected either to the DAppNode Wi-Fi or its VPN and have the @dappnode/dappnodesdk installed on your computer; you can follow the instructions at the link or simply run on your terminal the following line:

npm install -g @dappnode/dappnodesdk

After you've installed the SDK, clone this repository and run the dappnodesdk build command. After everything it's finished, you'll receive an IPFS link to install the EthLogSpy (+ MongoDB + Redis) containers on your node.

Example

These are just few examples of how you easily you can use web3js in conjunction with a running EthLogSpy instance:

const Web3 = require('web3');

const web3 = new Web3("http://localhost:8545"); // no ethlogspy and node on 8545
const web3 = new Web3("http://localhost:8080"); // with ethlogspy on 8080 pointing to node on 8545

const result = await web3.eth.getPastLogs({ fromBlock: 0 }); // retrieve the logs

Having a EthLogSpy instance in front of your node doesn't mean, of course, that you can't use all the other RPC APIs:

const accounts = await web3.eth.getAccounts(); // can you retrieve the accounts? yes.
const receipt = await web3.eth.sendTransaction(accounts[0], accounts[1], 1000000000); // can you send a transaction? yes.
const contract = new web3.eth.Contract(jsonInterface, address); // can you get a contract? yes.

What kind of spy doesn't allow all of this?

Security considerations

Please, if you're running EthLogSpy with MongoDB and Redis on the same machine, do not expose to the public the 27017 and 6379 ports (or whatever ports you did choose for MongoDB and Redis) or at least, if you do, make sure to edit the docker-compose.yml properly and the config.yml file and add some authentication to both the db and the cache.

MongoDB becomes the source of truth for all the logs that can be retrieved through your node, so make sure the following:

  • Do not expose its port publicly without any security mechanism;
  • Do not delete the persistent volume where the db is stored if you don't want to sync again;
  • Do not manually edit any of the logs inside of the database: this could cause some inconsistency between the real Ethereum Blockchain state and your EthLogSpy instance.

Contributing

We welcome community contributions!

Please check out our open issues to get started.

If you discover something that could potentially impact security, please notify us immediately by sending an e-mail at [email protected]. We'll get in touch with you as fast as we can!