laminar-protocol/oracle-server

oracle-server

Prerequisite

Install Node.js and Yarn.

• Ensure that you have a LTS Node.js installed, with version 12.x.

Build and run

To start an oracle server

1. Run yarn to install dependencies.
2. Use yarn build to build the project.
3. Use yarn start, with environment variables explained in the following section.

Environment variables

DOTENV is supported, and variables could be configured in a .ENV file.

Common

Common environment variables are needed no matter feeding for Ethereum smart contracts or Substrate based networks.

• ALPHA_VANTAGE_API_KEY: the api key of Alpha Vantage.
• PRICE_FEED_INTERVAL_MS: price feed intervals, by milliseconds.

By default, logs would be saved in error.log and combined.log. To enable logging in console, set environment variable CONSOLE_LOG as true.

Ethereum

For mainnet or Ethereum testnets like Kovan, contract addresses would be fetched from laminar-protocol/flow-protocol-ethereum package. The following environment variables would be needed:

• WEB3_PROVIDER: web3 provider.
• ETH_PRIVATE_KEY: feeder's private key.
• CHAIN: mainnet, kovan etc.
• GAS_LIMIT: gas limit.

For local testnet, additional environment variables would be needed:

• LOCAL_TESTNET_ORACLE_CONTRACT_ADDR: the oracle contract address in local testnet.
• FJPY: fJPY contract address.
• FEUR: fEUR contract address.

Substrate

• SUB_KEY_SEED: key seed.
• SUB_ENDPOINT: node endpoint, could be http/https or ws/wss.

For Laminar Chain, set FEED_LAMINAR as true; For Acala Network, set FEED_ACALA as true.

API Server

With API_KEY set, an API server would be spinned up for querying and modifying oracle server states.

The default port number would be 3000, to use a different one, set the PORT env variable.

oracle-server's Issues

Improve tx state handling in price feed

Fetch gas price from ethgasstation

make dot price $300 for now

for Acala server, make dot price $300 for now

Improve `PriceFeeder` poll

Substasks

• Interval. In the current impl, the price feed interval is not guaranteed, as PriceFeeder would sleep for PRICE_FEED_INTERVAL_MS before executing next round of tasks. It should be improved to maintain a guaranteed interval.

• Concurrency. In each round, price feed tasks should be executed concurrently, instead of waiting for one another.

Integrate warning/err msg to slack

Deployment

Add endpoint to pause / resume oracle

Useful for testnet.
This feature should be disabled by default and needs env to enable those endpoint.

CI pipeline

Pause stock and forex price feed if not in openning hours

use oracle.feed_values to batch oracle update transactions

This avoids multiple transactions per update.

Support laminar-chain

API: wss://testnet-node-1.laminar-chain.laminar.one/ws

Use dotenv to manage development environment variables