ROSETTA-MARO IS CONSIDERED ALPHA SOFTWARE. USE AT YOUR OWN RISK! MARO ASSUMES NO RESPONSIBILITY NOR LIABILITY IF THERE IS A BUG IN THIS IMPLEMENTATION.
rosetta-maro provides a reference implementation of the Rosetta API for
maro in Golang. If you haven't heard of the Rosetta API, you can find more
information here.
- Comprehensive tracking of all maro balance changes
- Stateless, offline, curve-based transaction construction (with address checksum validation)
- Atomic balance lookups using gttc's GraphQL Endpoint (gttc is maro in golang)
- Idempotent access to all transaction traces and receipts
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-maro:latest.
After cloning this repository, run:
make install
export MODE=ONLINE
export NETWORK=MAINNET
export PORT=8080
export GRPC=http://35.189.152.23:8501
export GRAPHQL=http://35.189.152.23:8507
rosetta-maro run
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>/maro-data and the Rosetta API accessible
at port 8080.
MODE(required) - Determines if Rosetta can make outbound connections. Options:ONLINEorOFFLINE.NETWORK(required) - maro network to launch and/or communicate with. Options:MAINNETorTESTNET(which defaults toMAINNETfor backwards compatibility).PORT(required) - Which port to use for Rosetta.GRPC(optional) - Point to a remotegttcnode's RPC address instead of initializing oneGRAPHQL(optional) - Point to a remotegttcnode's GraphQL address instead of initializing one
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/maro-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-maro:latest
If you cloned the repository, you can run make run-mainnet-online.
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -e "GRPC=<NODE RPC URL>" -e "GRAPHQL=<NODE GRAPHQL URL>" -p 8080:8080 -p 30303:30303 rosetta-maro:latest
If you cloned the repository, you can run make run-mainnet-remote grpc=http://35.189.152.23:8501 graphql=http://35.189.152.23:8507.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-maro:latest
If you cloned the repository, you can run make run-mainnet-offline.
rosetta-maro 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-maro will exit with an OOM error.
To increase the load rosetta-maro 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-maro 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.
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.
© 2021 maro