Skip to content

Commit

Permalink
chore: fix typos (#355)
Browse files Browse the repository at this point in the history
Signed-off-by: snoppy <[email protected]>
Co-authored-by: Alex Johnson <[email protected]>
  • Loading branch information
xiaoxianBoy and Alex Johnson authored Apr 19, 2024
1 parent bafca00 commit 2f960dc
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ $ make stop-oracle

* metrics relevant to the network's (that is running the instance slinky) performance are [here](./service/metrics/README.md)

## Basic Perfomance Analysis
## Basic Performance Analysis

> **Note: These are numbers based on 14 providers and 9 currency pairs over a 24 hour period.**
Expand Down
4 changes: 2 additions & 2 deletions aggregator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The aggregator is a aggregation alias that allows developers to plug and play di
## Configuration

The aggregator is configured by supplimenting a data aggregator strategy.
The aggregator is configured by supplementing a data aggregator strategy.

```golang
// DataAggregator is a simple aggregator for provider data. It is thread-safe since
Expand All @@ -27,7 +27,7 @@ type DataAggregator[K comparable, V any] struct {
}
```

The aggreagtion strategy is defined as follows:
The aggregation strategy is defined as follows:

```golang
// AggregateFn is the function used to aggregate data from each provider. Given a
Expand Down
2 changes: 1 addition & 1 deletion oracle/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ oracle_address = "0.0.0.0:8080"
client_timeout = "1s"

# MetricsEnabled determines whether oracle metrics are enabled. Specifically
# this enables intsrumentation of the oracle client and the interaction between
# this enables instrumentation of the oracle client and the interaction between
# the oracle and the app.
metrics_enabled = "true"

Expand Down
2 changes: 1 addition & 1 deletion pkg/math/oracle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,6 @@ The final price of BTC/USD is the median of the above prices, which is 73_500. I

### Cycle Detection

It is possible to have cycles in the market map. If the price of a ticker is dependent on a different ticker, which in turn is dependent on the first ticker, then we have a cycle. This can affect price liveness and can cause the oracle to be stuck in a loop. To prevent this, we recommend that markets that are dependent on each other have a sufficient amount of providers, have considerable `MinProviderCount`, and have sufficent amounts of direct conversions (i.e. not dependent on other tickers).
It is possible to have cycles in the market map. If the price of a ticker is dependent on a different ticker, which in turn is dependent on the first ticker, then we have a cycle. This can affect price liveness and can cause the oracle to be stuck in a loop. To prevent this, we recommend that markets that are dependent on each other have a sufficient amount of providers, have considerable `MinProviderCount`, and have sufficient amounts of direct conversions (i.e. not dependent on other tickers).

If a cycle does exist, it will likely be resolved after a few iterations of the oracle.

0 comments on commit 2f960dc

Please sign in to comment.