OlympusPriceConfig
Inherits: Policy, RolesConsumer
State Variables
PRICE
PRICEv1 internal PRICE;
Functions
constructor
constructor(Kernel kernel_) Policy(kernel_);
configureDependencies
function configureDependencies() external override returns (Keycode[] memory dependencies);
requestPermissions
function requestPermissions() external view override returns (Permissions[] memory permissions);
initialize
Initialize the price module
Access restricted to approved policies
This function must be called after the Price module is deployed to activate it and after updating the observationFrequency or movingAverageDuration (in certain cases) in order for the Price module to function properly.
function initialize(uint256[] memory startObservations_, uint48 lastObservationTime_)
external
onlyRole("price_admin");
Parameters
| Name | Type | Description |
|---|---|---|
startObservations_ | uint256[] | Array of observations to initialize the moving average with. Must be of length numObservations. |
lastObservationTime_ | uint48 | Unix timestamp of last observation being provided (in seconds). |
changeMovingAverageDuration
Change the moving average window (duration)
Setting the window to a larger number of observations than the current window will clear the data in the current window and require the initialize function to be called again. Ensure that you have saved the existing data and can re-populate before calling this function with a number of observations larger than have been recorded.
function changeMovingAverageDuration(uint48 movingAverageDuration_) external onlyRole("price_admin");
Parameters
| Name | Type | Description |
|---|---|---|
movingAverageDuration_ | uint48 | Moving average duration in seconds, must be a multiple of observation frequency |
changeObservationFrequency
Change the observation frequency of the moving average (i.e. how often a new observation is taken)
Changing the observation frequency clears existing observation data since it will not be taken at the right time intervals. Ensure that you have saved the existing data and/or can re-populate before calling this function.
function changeObservationFrequency(uint48 observationFrequency_) external onlyRole("price_admin");
Parameters
| Name | Type | Description |
|---|---|---|
observationFrequency_ | uint48 | Observation frequency in seconds, must be a divisor of the moving average duration |
changeUpdateThresholds
Change the update thresholds for the price feeds
The update thresholds should be set based on the update threshold of the chainlink oracles.
function changeUpdateThresholds(uint48 ohmEthUpdateThreshold_, uint48 reserveEthUpdateThreshold_)
external
onlyRole("price_admin");
Parameters
| Name | Type | Description |
|---|---|---|
ohmEthUpdateThreshold_ | uint48 | - Maximum allowed time between OHM/ETH price feed updates |
reserveEthUpdateThreshold_ | uint48 | - Maximum allowed time between Reserve/ETH price feed updates |
changeMinimumTargetPrice
Change the minimum target price
The minimum target price should be set based on liquid backing of OHM.
function changeMinimumTargetPrice(uint256 minimumTargetPrice_) external onlyRole("price_admin");
Parameters
| Name | Type | Description |
|---|---|---|
minimumTargetPrice_ | uint256 | - Minimum target price for the RBS system with 18 decimals, expressed as Reserves per OHM |