rosetta-fantom

README

Rosetta Fantom

Overview

rosetta-fantom is an implementation of the Rosetta API for Fantom Opera blockchain in Golang. provides an implementation of the Rosetta API for Fantom Opera in Golang.

The implementation wraps a go-opera with the Go app into a docker image. The Go app then connects to the go-opera using RPC API and provides the Rosetta API as an adapter.

Recommended OS Settings

To increase the load rosetta-fantom 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)

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.

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

From GitHub

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

curl -sSfL https://raw.githubusercontent.com/Fantom-foundation/rosetta-fantom/main/install.sh | sh -s

Do not try to install rosetta-fantom using GitHub Packages!

This will work only if this repository is public, if it is private, you need to use following steps.

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>/opera-data with a genesis file 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) - Network to launch and/or communicate with. Options: MAINNET or TESTNET.
• PORT(required) - Which port to use for Rosetta.
• OPERA (optional) - Point to a remote opera node instead of initializing one
• SKIP_ADMIN (optional, default: FALSE) - Instruct Rosetta to not use the opera admin RPC calls. This is typically disabled by hosted blockchain node services.

Mainnet:Online

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

If you cloned the repository, you can run make run-mainnet-online. (Alternatively make run-mainnet-online-var to store Opera data in /var/opera/mainnet directory.)

Mainnet:Online (Remote)

Note: using remote blockchain node is not compliant with the Rosetta spec - the spec requires to use a node running inside the container.

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

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

Mainnet:Offline

docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-fantom: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)/opera-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 5050:5050 rosetta-fantom:latest

If you cloned the repository, you can run make run-testnet-online. (Alternatively make run-testnet-online-var to store Opera data in /var/opera/testnet directory.)

Testnet:Online (Remote)

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

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

Testnet:Offline

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

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

Testing with rosetta-cli

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

• rosetta-cli check:data --configuration-file rosetta-cli-conf/testnet/config.json - This command validates that the Data API implementation is correct using the Opera Testnet node. It also ensures that the implementation does not miss any balance-changing operations.
• rosetta-cli check:construction --configuration-file rosetta-cli-conf/testnet/config.json - This command validates the Construction API implementation. It also verifies transaction construction, signing, and submissions to the Testnet network.
• rosetta-cli check:data --configuration-file rosetta-cli-conf/mainnet/config.json - This command validates that the Data API implementation is correct using the Opera Mainnet node. It also ensures that the implementation does not miss any balance-changing operations.

Note: restarting of an interrupted test requires removing "start_index" field from the config.json file. Otherwise the test will restart from defined block instead of continuing by the last processed block.

Issues

Did you find an issue in this repository? Report it in the Issues section.

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.

This project is based on Rosetta Ethereum, a reference implementation of the Rosetta API by Coinbase.