diff --git a/README.md b/README.md index 2cb89f4d9..4e8786232 100644 --- a/README.md +++ b/README.md @@ -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.** diff --git a/aggregator/README.md b/aggregator/README.md index e5477e1e5..b0af2616c 100644 --- a/aggregator/README.md +++ b/aggregator/README.md @@ -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 @@ -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 diff --git a/oracle/config/README.md b/oracle/config/README.md index 62bc6b1f8..78fef3176 100644 --- a/oracle/config/README.md +++ b/oracle/config/README.md @@ -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" diff --git a/pkg/math/oracle/README.md b/pkg/math/oracle/README.md index 38b6684c5..54be31a43 100644 --- a/pkg/math/oracle/README.md +++ b/pkg/math/oracle/README.md @@ -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.