Rosetta RSK

Overview

rosetta-rsk provides a WIP implementation of the Rosetta API for RSK in Golang. If you haven't heard of the Rosetta API, you can find more information here.

Features

• Comprehensive tracking of all rBTC balance changes
• Stateless, offline, curve-based transaction construction (with address checksum validation)
• 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-rsk:latest.

From GitHub

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

curl -sSfL https://raw.githubusercontent.com/rsksmart/rosetta-rsk/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>/rsk-data and the Rosetta API accessible at port 8080.

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

Mainnet:Online

docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/rsk-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 4444:4444 rosetta-rsk: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 "RSKJ=<NODE URL>" -p 8080:8080 -p 4444:4444 rosetta-rsk:latest

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

Mainnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-rsk: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)/rsk-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 4444:4444 rosetta-rsk: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 "RSKJ=<NODE URL>" -p 8080:8080 -p 4444:4444 rosetta-rsk:latest

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

Testnet:Offline

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

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

Running in Goland

Assuming you have a RSK node running in your own machine at port 4444, you could import the following Run Configuration and run it directly (or even debug it):

<component name="ProjectRunConfigurationManager">
  <configuration default="false" name="Development localhost node" type="GoApplicationRunConfiguration" factoryName="Go Application">
    <module name="rosetta-rsk" />
    <working_directory value="$PROJECT_DIR$" />
    <parameters value="run" />
    <envs>
      <env name="MODE" value="ONLINE" />
      <env name="NETWORK" value="MAINNET" />
      <env name="PORT" value="8080" />
      <env name="RSKJ" value="http://localhost:4444" />
    </envs>
    <kind value="PACKAGE" />
    <package value="github.com/rsksmart/rosetta-rsk" />
    <directory value="$PROJECT_DIR$" />
    <filePath value="$PROJECT_DIR$/main.go" />
    <method v="2" />
  </configuration>
</component>

System Requirements

rosetta-ethereum (the origin of this fork) 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-rsk will exit with an OOM error.

Recommended OS Settings

To increase the load rosetta-rsk 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-rsk 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-rsk, 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

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