Skip to content

Latest commit

 

History

History
155 lines (130 loc) · 7.61 KB

README.md

File metadata and controls

155 lines (130 loc) · 7.61 KB
Raw

Rosetta

Rosetta Ethereum

ROSETTA-ETHEREUM IS CONSIDERED ALPHA SOFTWARE. USE AT YOUR OWN RISK! COINBASE ASSUMES NO RESPONSIBILITY NOR LIABILITY IF THERE IS A BUG IN THIS IMPLEMENTATION.

Overview

rosetta-ethereum 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

  • Comprehensive tracking of all ETH balance changes
  • Stateless, offline, curve-based transaction construction (with address checksum validation)
  • Atomic balance lookups using go-ethereum's GraphQL Endpoint
  • Idempotent access to all transaction traces and receipts

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:latest.

From GitHub

To download the pre-built Docker image from the latest release, run:

curl -sSfL https://raw.githubusercontent.com/coinbase/rosetta-ethereum/master/install.sh | sh -s

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>/ethereum-data and the Rosetta API accessible at port 8080.

Configuration Environment Variables

  • MODE (required) - Determines if Rosetta can make outbound connections. Options: ONLINE or OFFLINE.
  • NETWORK (required) - Ethereum network to launch and/or communicate with. Options: MAINNET, ROPSTEN, RINKEBY, GOERLI or TESTNET (which defaults to ROPSTEN for backwards compatibility).
  • PORT(required) - Which port to use for Rosetta.
  • GETH (optional) - Point to a remote geth node instead of initializing one
  • SKIP_GETH_ADMIN (optional, default: FALSE) - Instruct Rosetta to not use the geth admin RPC calls. This is typically disabled by hosted blockchain node services.
  • GETH_HEADERS (optional) - Pass a key:value comma-separated list to be passed to the geth clients. e.g. X-Auth-Token:12345-ABCDE,X-Other-Header:SomeOtherValue

Mainnet:Online

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

If you cloned the repository, you can run make run-mainnet-online.

Mainnet:Online (Remote)

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

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

Mainnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-ethereum:latest

If you cloned the repository, you can run make run-mainnet-offline.

Testnet:Online

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

If you cloned the repository, you can run make run-testnet-online.

Testnet:Online (Remote)

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

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

Testnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-ethereum:latest

If you cloned the repository, you can run make run-testnet-offline.

System Requirements

rosetta-ethereum 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 will exit with an OOM error.

Recommended OS Settings

To increase the load rosetta-ethereum 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 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, 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:construction --configuration-file rosetta-cli-conf/testnet/config.json
  • rosetta-cli check:data --configuration-file rosetta-cli-conf/mainnet/config.json

Future Work

  • Add ERC-20 Rosetta Module to enable reading ERC-20 token transfers and transaction construction
  • Rosetta API /mempool/* implementation
  • Add more methods to the /call endpoint (currently only support eth_getTransactionReceipt)
  • Add CI test using rosetta-cli to run on each PR (likely on a regtest network)

Please reach out on our community if you want to tackle anything on this list!

Development

  • make deps to install dependencies
  • make test to run tests
  • make lint to lint the source code
  • make salus to check for security concerns
  • make build-local to build a Docker image from the local context
  • make coverage-local to generate a coverage report

License

This project is available open source under the terms of the Apache 2.0 License.

© 2020 Coinbase