Quasar EVM is a backend part of the Quasar project (see Quasar-Contract repository). Quasar-EVM service is used to listen to the token average prices and write them to the oracle smart-contract. It provides solid stabilized write-send flow where write and send actions are independent of each other. Service will resubscribe if needed and keep the same send frequency even if the prices are outdated.
To run the service firstly you need to deploy the Quasar-Contract with the same wallet address that you will use in this project deploy. After fill the env variables and run the service local or deploy it remotely.
Config scheme can be found in the scheme.go file. There is 3 main config blocks - the WEB3 for
the blockchain configs, the WS for the web socket connection and demon work configs and TOKENS for the list of
token symbols you want to write and send to the smart-contract. Read more in the
Env variables readme block
Shortcuts for all main service commands such as run, test, build etc. are implement in the Malefile.
To run commands use make syntax, for example:
make runDocker file can be found in the project route. When project deployed on the remote environment the docker file can be used in the CI/CD flows.
Smart-contract package implementation can be found in the contractsAPI directory. The
oracle directory contains smart-contract API implementation generated with the abigen CLI
util.
The ABI for the code generation is stored in the abis directory.
ContractAPI.go implements only needed methods to communicate with the oracle
smart-contract. See the IOracleAPI interface
WS Client package is implementing methods to communicate with the currency price demon using WS connection. Example of the wsClient usage can be fond in the example directory. Also see the IWSClient interface for more information.
Service is a main internal package. It is managing the write and send flow independently of each other using the oracle and ws client packages and provides reconnections if needed.
For default values see config/init.go
| Name | Example / Default value | Description | Default |
|---|---|---|---|
| WEB3_ORACLEADDRESS | 0x078413b8b5a2614081813619c594fE84Ef839535 | Deployed oracle address | ❌ |
| WEB3_RPCURL | https://jesterfair-rpc.eu-north-2.gateway.fm | Rollup RPC-provider URL | ❌ |
| WEB3_CHAINID | 1413045109 | Rollup chain ID | ❌ |
| WEB3_SIGNERPK | Deployed oracle owner wallet private key | ❌ | |
| TOKENS | "SOL", "USDC", "USDT", ... | Tokens data for which will be send to the oracle contract | ✅ |
| WS_URL | wss://oracle.gateway.fm | Demon ws URL | ✅ |
| WS_WRITEFREQUENCYMS | 5000 | Frequancy for write flow in milliseconds. Better to be less or equal to the send flow requancy | ✅ |
| WEB3_SENDFREQUENCYMS | 10000 | Frequancy for send flow in milliseconds. Better to be more or equal to the write flow requancy | ✅ |
Before you deploy this service, you need to create a rollup and deploy the
Quasar-Contract to the rollup with the same wallet, that you will be
using in this service as a WEB3_SIGNERPK variable.
To deploy the service you need to set the env variables, after that you can use the Dockerfile, no
additional service are needed to be deployed. Or you can run service locally using the make run command.
You can also build the binary using the make build command and run the binary using quasar-evm serve command.