Skip to content

Commit 2f960dc

Browse files
xiaoxianBoyAlex Johnson
and
Alex Johnson
authored
chore: fix typos (#355)
Signed-off-by: snoppy <[email protected]> Co-authored-by: Alex Johnson <[email protected]>
1 parent bafca00 commit 2f960dc

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ $ make stop-oracle
8282

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

85-
## Basic Perfomance Analysis
85+
## Basic Performance Analysis
8686

8787
> **Note: These are numbers based on 14 providers and 9 currency pairs over a 24 hour period.**
8888

aggregator/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The aggregator is a aggregation alias that allows developers to plug and play di
88
99
## Configuration
1010

11-
The aggregator is configured by supplimenting a data aggregator strategy.
11+
The aggregator is configured by supplementing a data aggregator strategy.
1212

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

30-
The aggreagtion strategy is defined as follows:
30+
The aggregation strategy is defined as follows:
3131

3232
```golang
3333
// AggregateFn is the function used to aggregate data from each provider. Given a

oracle/config/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ oracle_address = "0.0.0.0:8080"
9090
client_timeout = "1s"
9191

9292
# MetricsEnabled determines whether oracle metrics are enabled. Specifically
93-
# this enables intsrumentation of the oracle client and the interaction between
93+
# this enables instrumentation of the oracle client and the interaction between
9494
# the oracle and the app.
9595
metrics_enabled = "true"
9696

pkg/math/oracle/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,6 @@ The final price of BTC/USD is the median of the above prices, which is 73_500. I
177177

178178
### Cycle Detection
179179

180-
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).
180+
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).
181181

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

0 commit comments

Comments
 (0)