README.md

December 30, 2020 ยท View on GitHub

Overview

rosetta-ethereum-2.0 provides a reference implementation of the Rosetta API for Ethereum in Golang. If you haven't heard of the Rosetta API, you can find more information here.

Features

  • Rosetta API implementation

Usage

As specified in the Rosetta API Principles, all Rosetta implementations must be deployable via Docker and support running via either an online or offline mode.

YOU MUST INSTALL DOCKER FOR THE FOLLOWING INSTRUCTIONS TO WORK. YOU CAN DOWNLOAD DOCKER HERE.

Install

Running the following commands will create a Docker image called rosetta-ethereum-2.0:latest.

From Source

After cloning this repository, run:

make build-local

Run

Running the following commands will start a Docker container in detached mode with a data directory at <working directory>/beacon-data and the Rosetta API accessible at port 8080.

It is possible to run rosetta-ethereum-2.0 using a remote node by adding -e "BEACON_RPC=<node url>" to any online command.

Mainnet:Online

docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/beacon-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -e "WEB3PROVIDER=<ETHEREUM URL>"  -p 8080:8080 -p 30303:30303 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-mainnet-online ethereumRPC=<NODE URL>.

Mainnet:Online (Remote)

docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -e "WEB3PROVIDER=<ETHEREUM URL>"  -e "BEACON_RPC=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-mainnet-remote ethereumRPC=<NODE URL> beaconRPC=<NODE URL>.

Mainnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -e "WEB3PROVIDER=<ETHEREUM URL>" -p 8081:8081 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-mainnet-offline ethereumRPC=<NODE URL>.

Testnet:Online

docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/beacon-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -e "WEB3PROVIDER=<ETHEREUM URL>"  -p 8080:8080 -p 30303:30303 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-testnet-online ethereumRPC=<NODE URL>.

Testnet:Online (Remote)

docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -e "WEB3PROVIDER=<ETHEREUM URL>"  -e "BEACON_RPC=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-testnet-remote ethereumRPC=<NODE URL> beaconRPC=<NODE URL>.

Testnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -e "WEB3PROVIDER=<ETHEREUM URL>" -p 8081:8081 rosetta-ethereum-2.0:latest

If you cloned the repository, you can run make run-testnet-offline ethereumRPC=<NODE URL>.

System Requirements

rosetta-ethereum-2.0 has been tested on an AWS c5.2xlarge instance. This instance type has 8 vCPU and 16 GB of RAM. If you use a computer with less than 16 GB of RAM, it is possible that rosetta-ethereum-2.0 will exit with an OOM error.

To increase the load rosetta-ethereum-2.0 can handle, it is recommended to tune your OS settings to allow for more connections. On a linux-based OS, you can run the following commands (source):

sysctl -w net.ipv4.tcp_tw_reuse=1
sysctl -w net.core.rmem_max=16777216
sysctl -w net.core.wmem_max=16777216
sysctl -w net.ipv4.tcp_max_syn_backlog=10000
sysctl -w net.core.somaxconn=10000
sysctl -p (when done)

We have not tested rosetta-ethereum-2.0 with net.ipv4.tcp_tw_recycle and do not recommend enabling it.

You should also modify your open file settings to 100000. This can be done on a linux-based OS with the command: ulimit -n 100000.

Testing with rosetta-cli

To validate rosetta-ethereum-2.0, install rosetta-cli and run one of the following commands:

  • rosetta-cli check:data --configuration-file rosetta-cli-conf/testnet/config.json
  • rosetta-cli check:data --configuration-file rosetta-cli-conf/mainnet/config.json

Future Work

Development

  • make deps to install dependencies
  • make test to run tests
  • make build-local to build a Docker image from the local context