azbuky / rosetta-vite Goto Github PK

ROSETTA-VITE IS CONSIDERED ALPHA SOFTWARE. USE AT YOUR OWN RISK! THE AUTHORS ASSUME NO RESPONSIBILITY NOR LIABILITY IF THERE IS A BUG IN THIS IMPLEMENTATION.

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

• Full support for rosetta data and construction apis

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

• MODE (required) - Determines if Rosetta can make outbound connections. Options: ONLINE or OFFLINE.
• NETWORK (required) - Vite network to launch and/or communicate with. Options: MAINNET, TESTNET.
• PORT(required) - Which port to use for Rosetta.
• GVITE (optional) - Point to a remote gvite node instead of initializing one

docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/vite-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-vite: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 "GVITE=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-vite:latest

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

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

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

docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/vite-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-vite: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 "GVITE=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-vite:latest

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

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

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

To validate rosetta-vite, 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

• 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

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