Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 1.3 KB

README.md

File metadata and controls

19 lines (10 loc) · 1.3 KB

RenEx Oracle

A centralised RenEx service used to provide data about the current midpoint price.

Description

The RenEx Oracle retrieves pricing information from the CoinMarketCap API and sends this information to the Bootstrap nodes, which in turn propagate this information throughout the rest of the network. The prices are then used by the Darknodes for determining pricing information for midpoint orders in the RenEx dark pool.

Configuration

The supported currencies are defined in currencies/currencies.json. To add additional currencies, the symbol name, CoinMarketCap ID, as well as valid pairs must be defined. The Oracle will use the multi-addresses defined for the Bootstrap nodes in env/<network>/config.json. The network is specified as an environment variable in the Heroku deployment.

Note: currently, only the nightly network is supported.

The price retrieval process occurs every 10 seconds by default, however this can also be configured using an environment variable.

REST API

The REST API supports GET requests to /prices?fst=<symbol>&snd=<symbol>. This will return the price of the snd currency with respect to fst. For example, a request to /prices?fst=BTC&snd=ETH will return (price of ETH)/(price of BTC). If an invalid pair is specified, the response will be 0.