ROSETTA-WEMIX IS CONSIDERED ALPHA SOFTWARE. USE AT YOUR OWN RISK!
rosetta-wemix provides a reference implementation of the Rosetta API for Wemix in Golang. If you haven't heard of the Rosetta API, you can find more information here.
- Comprehensive tracking of all WEMIX balance changes
- Atomic balance lookups using go-ethereum's GraphQL Endpoint
- Idempotent access to all transaction traces and receipts
rosetta-wemix 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-wemix will exit with an OOM error.
To increase the load rosetta-wemix 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-wemix 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.
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-wemix:latest.
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>/wemix-data and the Rosetta API accessible
at port 8080.
MODE(required) - Determines if Rosetta can make outbound connections. Options:ONLINEorOFFLINE.NETWORK(required) - Ethereum network to launch and/or communicate with. Options:MAINNETorTESTNET(which defaults toTESTNETfor backwards compatibility).PORT(required) - Which port to use for Rosetta.GWEMIX(optional) - Point to a remotegwemixnode instead of initializing oneSKIP_GWEMIX_ADMIN(optional, default:FALSE) - Instruct Rosetta to not use thegwemixadminRPC calls. This is typically disabled by hosted blockchain node services.
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/wemix-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-wemix: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 "GWEMIX=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-wemix:latest
If you cloned the repository, you can run make run-mainnet-remote gwemix=<NODE URL>.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-wemix:latest
If you cloned the repository, you can run make run-mainnet-offline.
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/wemix-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-wemix:latest
If you cloned the repository, you can run make run-testnet-online.
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -e "GWEMIX=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-wemix:latest
If you cloned the repository, you can run make run-testnet-remote gwemix=<NODE URL>.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-wemix:latest
If you cloned the repository, you can run make run-testnet-offline.
This project is available open source under the terms of the Apache 2.0 License.
© 2022 Wemix