GraphQL API server for SkyHigh powered blockchain network.
Please check the release tags to get more details and to download previous releases.
This version connects with the Push v.0.7.0-rc1. The SFC contract ABI bundled with the API is version 2.0.2-rc1.
The release brings new fluid delegations and rewards system. Each address is be able to delegate to multiple stakers. Delegation can be locked to certain time, at least 14 days and up to 1 year, to get higher rewards. Please check our website skyhighblockchain.com and the Special Fee Contract repository for more details.
This is the version you want to be able to connect with Push v.0.6.0-rc2. The SFC contract ABI bundled with this API release is the version 1.1.0-rc1. The release uses Push API v0.6.0 which recognizes single delegation per address and no delegation locking.
Building apiserver
requires a Go (version 1.13 or later). You can install
it using your favourite package manager. Once the dependencies are installed, run
make
The build output is build/apiserver
executable.
You don't need to clone the project into $GOPATH, due to use of Go Modules you can use any location.
To run the API Server you need access to a RPC interface of a full Push node. Please follow Push instructions to build and run the node. Alternatively you can obtain access to a remotely running instance of Push.
We recommend using local IPC channel for communication between a Push node and the API Server for performance and security reasons. Please consider security implications of opening Push RPC to outside access, especially if you enable "personal" commands on your node while keeping your account keys in the Push key store.
Persistent data are stored in a MongoDB database. Going through the installation and configuration process of MongoDB is out of scope here, please consult MongoDB manual to install and configure appropriate MongoDB environment for your deployment of the API server.