OBTC Rosetta

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

Overview

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

obtc-rosetta is fully based on rosetta-bitcoin (https://github.com/coinbase/rosetta-bitcoin) - Rosetta API implementation for Bitcoin.

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 obtc-rosetta.

From Docker Hub

After installing Docker, run:

docker pull powx/obtc-rosetta

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

Mainnet:Online

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

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

Mainnet:Offline

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

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

Testnet:Online

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

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

Testnet:Offline

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

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

System Requirements

obtc-rosetta has been tested on an AWS c5.9xlarge instance. This instance type has 32 vCPU and 68 GB of RAM. Much less powerful can be used but perfomance is not guaranteed.

Network Settings

To increase the load obtc-rosetta 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 obtc-rosetta 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.

Memory-Mapped Files

obtc-rosetta uses memory-mapped files to persist data in the indexer. As a result, you must run rosetta-bitcoin on a 64-bit architecture (the virtual address space easily exceeds 100s of GBs).

If you receive a kernel OOM, you may need to increase the allocated size of swap space on your OS. There is a great tutorial for how to do this on Linux here.

Testing with rosetta-cli

To validate obtc-rosetta, 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
• rosetta-cli check:construction --configuration-file rosetta-cli-conf/mainnet/config.json

License

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