ROSETTA-VERTCOIN IS UNDER INITIAL DEVELOPMENT AND IF IT IS NOT BROKEN, THIS IS ACCIDENTAL. DO NOT USE THIS SOFTWARE, YET.
rosetta-vertcoin provides an implementation of the Rosetta API for
Vertcoin in golang, based off the rosetta-bitcoin
reference implementation provided by Coinbase. If you haven't heard of the
Rosetta API, you can find more information here.
- Rosetta API implementation (both Data API and Construction API)
- UTXO cache for all accounts (accessible using
/account/balance) - Stateless, offline, curve-based transaction construction from any SegWit-Bech32 Address
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.
Running the following commands will create a Docker image called rosetta-vertcoin:latest.
To download the pre-built Docker image from the latest release, run:
curl -sSfL https://raw.githubusercontent.com/rosetta-vertcoin/rosetta-vertcoin/master/install.sh | sh -s
Do not try to install rosetta-vertcoin using GitHub Packages!
After cloning this repository, run:
make build-local
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.
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 5889:5889 rosetta-vertcoin:latest
If you cloned the repository, you can run make run-mainnet-online.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-vertcoin:latest
If you cloned the repository, you can run make run-mainnet-offline.
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 15889:15889 rosetta-vertcoin:latest
If you cloned the repository, you can run make run-testnet-online.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-vertcoin:latest
If you cloned the repository, you can run make run-testnet-offline.
rosetta-vertcoin has been tested on an AWS c5.2xlarge instance.
This instance type has 8 vCPU and 16 GB of RAM.
To increase the load rosetta-vertcoin 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-vertcoin 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.
rosetta-vertcoin uses memory-mapped files to
persist data in the indexer. As a result, you must run rosetta-vertcoin 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.
rosetta-vertcoin uses the syncer, storage, parser, and server package
from rosetta-sdk-go instead
of a new Vertcoin-specific implementation of packages of similar functionality. Below
you can find a high-level overview of how everything fits together:
+------------------------------------------------------------------+
| |
| +--------------------------------------+ |
| | | |
| | indexer | |
| | | |
| | +--------+ | |
+-------------------+ pruner <----------+ | |
| | +--------+ | | |
+-----v----+ | | | |
| vertcoind| | +------+--------+ | |
+-----+----+ | +--------> block_storage <----+ | |
| | | +---------------+ | | |
| | +---+----+ | | |
+-------------------> syncer | | | |
| +---+----+ | | |
| | +--------------+ | | |
| +--------> coin_storage | | | |
| +------^-------+ | | |
| | | | |
+--------------------------------------+ |
| | |
+-------------------------------------------------------------------------------------------+ |
| | | | |
| +------------------------------------------------------------+ | | |
| | | | |
| | +---------------------+-----------------------+------+ | |
| | | | | | |
| +-------+---------+ +-------+---------+ +-------+-------+ +-----------+----------+ | |
| | account_service | | network_service | | block_service | | construction_service +--------+
| +-----------------+ +-----------------+ +---------------+ +----------------------+ |
| |
| server |
| |
+-------------------------------------------------------------------------------------------+
- Automatically prune vertcoind while indexing blocks
- Reduce sync time with concurrent block indexing
- Use Zstandard compression to reduce the size of data stored on disk without needing to write a manual byte-level encoding
To speed up indexing, rosetta-vertcoin uses concurrent block processing
with a "wait free" design (using channels instead of sleeps to signal
which threads are unblocked). This allows rosetta-vertcoin to fetch
multiple inputs from disk while it waits for inputs that appeared
in recently processed blocks to save to disk.
+----------+
| vertcoind|
+-----+----+
|
|
+---------+ fetch block data / unpopulated txs |
| block 1 <------------------------------------+
+---------+ |
+--> tx 1 | |
| +---------+ |
| | tx 2 | |
| +----+----+ |
| | |
| | +---------+ |
| | | block 2 <-------------------+
| | +---------+ |
| +-----------> tx 3 +--+ |
| +---------+ | |
+-------------------> tx 4 | | |
| +---------+ | |
| | |
| retrieve previously synced | +---------+ |
| inputs needed for future | | block 3 <--+
| blocks while waiting for | +---------+
| populated blocks to save to +---> tx 5 |
| disk +---------+
+------------------------------------> tx 6 |
| +---------+
|
|
+------+--------+
| coin_storage |
+---------------+
To validate rosetta-vertcoin, install rosetta-cli
and run one of the following commands:
rosetta-cli check:data --configuration-file rosetta-cli-conf/testnet/config.jsonrosetta-cli check:construction --configuration-file rosetta-cli-conf/testnet/config.jsonrosetta-cli check:data --configuration-file rosetta-cli-conf/mainnet/config.json
- Publish benchamrks for sync speed, storage usage, and load testing
- Rosetta API
/mempool/transactionimplementation - Add CI test using
rosetta-clito run on each PR (likely on a regtest network) - Add performance mode to use unlimited RAM (implementation currently optimized to use <= 16 GB of RAM)
- Support Multi-Sig Sends
Please reach out on our community if you want to tackle anything on this list!
make depsto install dependenciesmake testto run testsmake lintto lint the source codemake salusto check for security concernsmake build-localto build a Docker image from the local contextmake coverage-localto generate a coverage report
This project is available open source under the terms of the Apache 2.0 License.
rosetta-bitcoin is © 2020 Coinbase