https://github.com/ojo-network/price-feeder
https://github.com/ojo-network/price-feeder
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ojo-network/price-feeder
- Owner: ojo-network
- License: apache-2.0
- Created: 2022-12-05T20:14:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T15:40:51.000Z (about 1 month ago)
- Last Synced: 2025-03-28T16:36:25.746Z (about 1 month ago)
- Language: Go
- Size: 1.32 MB
- Stars: 30
- Watchers: 5
- Forks: 24
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-ccamel - ojo-network/price-feeder - (Go)
README
# Oracle Price Feeder
The `price-feeder` tool is an extension of Ojo's `x/oracle` module, both of
which are based on Terra's [x/oracle](https://github.com/terra-money/classic-core/tree/main/x/oracle)
module and [oracle-feeder](https://github.com/terra-money/oracle-feeder). The
core differences are as follows:
- All exchange rates must be quoted in USD or USD stablecoins.
- No need or use of reference exchange rates (e.g. Luna).
- No need or use of Tobin tax.
- The `price-feeder` combines both `feeder` and `price-server` into a single
Golang-based application for better UX, testability, and integration.
## Forks - Other Projects that use the Ojo Price Feeder
- [Kujira](https://github.com/team-kujira/oracle-price-feeder)
- [Sei](https://github.com/sei-protocol/sei-chain/tree/master/oracle/price-feeder)
## Background
The `price-feeder` tool is responsible for performing the following:
1. Fetching and aggregating exchange rate price data from various providers, e.g.
Binance and Osmosis, based on operator configuration. These exchange rates
are exposed via an API and are used to feed into the main oracle process.
2. Taking aggregated exchange rate price data and submitting those exchange rates
on-chain to Ojo's `x/oracle` module following Ojo's [Oracle](https://github.com/ojo-network/ojo/tree/main/x/oracle#readme)
specification.
## Providers
The list of current supported providers:
- [Binance](https://www.binance.com/en)
- [Bitget](https://www.bitget.com/)
- [Coinbase](https://www.coinbase.com/)
- [Crescent](https://github.com/ojo-network/crescent-api)
- [Crypto](https://crypto.com/)
- [Gate](https://www.gate.io/)
- [Huobi](https://www.huobi.com/en-us/)
- [Kraken](https://www.kraken.com/en-us/)
- [Kujira](https://github.com/ojo-network/kujira-api)
- [Mexc](https://www.mexc.com/)
- [Okx](https://www.okx.com/)
- [Osmosis](https://github.com/ojo-network/osmosis-api)
- [Polygon](https://api.polygon.io)
## Usage
The `price-feeder` tool runs off of one or many configuration files.
The node-config contains 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](#keyring)
Please see the [example configuration](price-feeder.example.toml) for more details. The path to the node-config is required as the first argument. You can optionally add all configuration options to the node-config file or use the config-dir flag to point to a directory containing the other configuration files.
The files in the provider-config folder define what exchange rates to fetch and what providers to get them from. They also contain deviation thresholds and API endpoints. Please see the [example configuration](ojo-provider-config) for more details.
```shell
$ price-feeder /path/to/price_feeder_config.toml
```
Chain rules for checking the free oracle transactions are:
- must be only prevote or vote
- gas is limited to [`MaxMsgGasUsage`](https://github.com/ojo-network/ojo/blob/main/ante/fee.go#L13) constant.
So, if you don't want to pay for gas, TX must be below `MaxMsgGasUsage`. If you set too much gas (which is what is happening when when you set `gas_adjustment` to 2), then the tx will allocate 2x gas, and hence will go above the free quota, so you would need to attach fee to pay for that gas.
The easiest is to just set constant gas. We recommend 10k below the `MaxMsgGasUsage`.
In the PF config file you can set either:
- `gas_adjustment`
- or `gas_prevote` and `gas_vote` - fixed amount of gas used for `MsgAggregateExchangeRatePrevote` and `MsgAggregateExchangeRateVote` transactions respectively.
## Configuration
Copy the `price-feeder.example.toml` file to `price-feeder.toml` and update accordingly.
### `config_dir`
Price Feeder requires instructions what endpoints to use and which currencies to track. The following files must be present in the directory specified by `config_dir`:
- `currencty-pairs.toml`
- `deviation-thresholds.toml`: 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.
- `endpoints.toml`: enables validators to setup their own API endpoints for a given provider.
Depending where you run your validator node, certain locations may block some endpoints. Make sure you read through the comments in the config file.
### `telemetry`
A 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](https://github.com/cosmos/cosmos-sdk/blob/3689d6f41ad8afa6e0f9b4ecb03b4d7f2d3a9e94/docs/docs/core/09-telemetry.md).
### `server`
The `server` section contains configuration pertaining to the API served by the
`price-feeder` process such the listening address and various HTTP timeouts.
### `currency_pairs.toml` file
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:
```toml
[[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).
### `provider_min_override`
At startup the amount of possible providers for a currency is checked by querying the
CoinGecko API to enforce an acceptable minimum providers for a given currency pair. If
this request fails and `provider_min_override` is set to true, the minimum is not enforced
and the `price-feeder` is allowed to run irrespective of how many providers are provided
for a given currency pair. `provider_min_override` will not take effect if CoinGecko
requests are successful.
### `account`
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.
### `keyring`
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.
### `rpc`
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.
## Keyring
Our keyring must be set up to sign transactions before running the price feeder.
Additional info on the different keyring modes is available [here](https://docs.cosmos.network/v0.46/run-node/keyring.html).
**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.**
### Setup
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.
## Integration tests
In order to run the integration price test you need to add the coinmarketcap api environment variable.
Sign up for a free account [here](https://coinmarketcap.com/api/) and export the api key.
Ex :
`export COINMARKETCAP_API_KEY=yourApiKey`
`make test-integration`