This is a standalone version of Kujira's superb port of Umee's fantastic work migrating Terra's oracle-feeder app to Go, allowing it to submit price updates to HCS.
- TODO: work on tick() function
- TODO: fix tests.
- TODO: change hash to base64 in messages
tbd
The list of current supported providers:
- Binance
- BinanceUS
- Bitfinex
- Bitget
- BKEX
- Bybit
- Coinbase
- Crypto.com
- FIN
- Gate.io
- HitBTC
- Huobi
- Kraken
- Kucoin
- LBank
- MEXC
- Okx
- Osmosis
- Phemex
- Poloniex
- XT.COM
The price-feeder tool runs off of a single configuration file. This configuration
file defines what exchange rates to fetch and what providers to get them from.
In addition, it defines the oracle's keyring and feeder account information.
The keyring's password is defined via environment variables or user input.
More information on the keyring can be found here
Please see the example configuration for more details.
$ price-feeder /path/to/price_feeder_config.tomlA set of options for the application's telemetry, which is disabled by default. An in-memory sink is the default, but Prometheus is also supported. We use the cosmos sdk telemetry package.
Deviation allows validators to set a custom amount of standard deviations around the median which is helpful if any providers become faulty. It should be noted that the default for this option is 1 standard deviation.
The provider_endpoints option enables validators to setup their own API endpoints for a given provider.
The server section contains configuration pertaining to the API served by the
price-feeder process such the listening address and various HTTP timeouts.
The currency_pairs sections contains one or more exchange rates along with the
providers from which to get market data from. It is important to note that the
providers supplied in each currency_pairs must support the given exchange rate.
For example, to get multiple price points on ATOM, you could define currency_pairs
as follows:
[[currency_pairs]]
base = "ATOM"
providers = [
"binance",
]
quote = "USDT"
[[currency_pairs]]
base = "ATOM"
providers = [
"kraken",
"osmosis",
]
quote = "USD"Providing multiple providers is beneficial in case any provider fails to return market data. Prices per exchange rate are submitted on-chain via pre-vote and vote messages using a time-weighted average price (TVWAP).
The account section contains the oracle's feeder and validator account information.
These are used to sign and populate data in pre-vote and vote oracle messages.
The keyring section contains Keyring related material used to fetch the key pair
associated with the oracle account that signs pre-vote and vote oracle messages.
The rpc section contains the Tendermint and Cosmos application gRPC endpoints.
These endpoints are used to query for on-chain data that pertain to oracle
functionality and for broadcasting signed pre-vote and vote oracle messages.
The healthchecks section defines optional healthcheck endpoints to ping on successful
oracle votes. This provides a simple alerting solution which can integrate with a service
like healthchecks.io. It's recommended to configure additional
monitoring since third-party services can be unreliable.
Our keyring must be set up to sign transactions before running the price feeder.
Additional info on the different keyring modes is available here.
Please note that the test and memory modes are only for testing purposes.
Do not use these modes for running the price feeder against mainnet.
The keyring dir and backend are defined in the config file.
You may use the PRICE_FEEDER_PASS environment variable to set up the keyring password.
Ex :
export PRICE_FEEDER_PASS=keyringPassword
If this environment variable is not set, the price feeder will prompt the user for input.