OracleRegistry

Git Source

Inherits: AccessControl, Constants, IOracleRegistry

Author: luoyhang003

Manages prices for vaultToken and other registered tokens, including updates from oracles and cut-off prices.

Uses OpenZeppelin AccessControl for role-based permissioning

Stores historical prices and supports both common and cut-off price updates

Performs deviation checks to prevent extreme price manipulations

State Variables

PRICE_UPDATE_ROLE

Role allowed to update prices

Only addresses with this role can call updatePrices

Calculated as keccak256("PRICE_UPDATE_ROLE").

bytes32 public constant PRICE_UPDATE_ROLE = keccak256("PRICE_UPDATE_ROLE");

ORACLE_MANAGE_ROLE

Role allowed to manage oracles

Only addresses with this role can call addTokenOracle, removeTokenOracle, updateTokenOracle

Calculated as keccak256("ORACLE_MANAGE_ROLE").

bytes32 public constant ORACLE_MANAGE_ROLE = keccak256("ORACLE_MANAGE_ROLE");

paramRegister

Parameter registry contract

Used to fetch tolerances, price update intervals, and validity durations

IParamRegistry public paramRegister;

vaultToken

Vault token address

Core token whose price is specially managed and checked against exchange rate tolerances

address public immutable vaultToken;

tokens

List of all registered tokens

Used for iteration during price updates and retrieving historical prices

address[] public tokens;

commonPriceUpdatedAt

Timestamps of common price updates

Index corresponds to historical versions of price updates

uint256[] public commonPriceUpdatedAt;

cutOffPriceUpdateAt

Timestamps of cut-off price updates

Only updated when _isCutOffPrice is true during updatePrices

uint256[] public cutOffPriceUpdateAt;

prices

Token => Timestamp => Price mapping

Stores all historical prices for each token

mapping(address => mapping(uint256 => uint256)) public prices;

_oracles

Token => OracleFeed mapping

Internal mapping to track which oracle feed is used for each token

mapping(address => IOracleFeed) private _oracles;

Functions

constructor

Initializes OracleRegistry

Performs zero-address checks and ensures token/oracle arrays have the same length

Initializes initial prices and emits PriceUpdated events

constructor(
    address _vaultToken,
    address[] memory _tokens,
    address[] memory _oracleFeeds,
    address _paramRegister,
    address _defaultAdmin,
    address _priceUpdateRole,
    address _oracleManageRole
);

Parameters

updatePrices

Updates prices for vault token and other registered tokens

Reverts if price deviates beyond tolerances or updates are too frequent

Updates all registered tokens based on their oracle feeds

function updatePrices(uint256 _vaultTokenPrice, bool _isCutOffPrice) external onlyRole(PRICE_UPDATE_ROLE);

Parameters

addTokenOracle

Adds a new token and its oracle feed

Only callable by ORACLE_MANAGE_ROLE

Reverts if token already exists or any address is zero

function addTokenOracle(address _token, address _oracle) external onlyRole(ORACLE_MANAGE_ROLE);

Parameters

removeTokenOracle

Removes a token and its oracle feed

Uses swap-and-pop for efficient removal from array

Only callable by ORACLE_MANAGE_ROLE

function removeTokenOracle(address _token) external onlyRole(ORACLE_MANAGE_ROLE);

Parameters

updateTokenOracle

Updates an existing token’s oracle feed

Only callable by ORACLE_MANAGE_ROLE

Reverts if token does not exist or any address is zero

function updateTokenOracle(address _token, address _oracle) external onlyRole(ORACLE_MANAGE_ROLE);

Parameters

getOracle

Returns the oracle feed address for a given token

Returns zero address if token is not registered

function getOracle(address _token) external view returns (address oracle_);

Parameters

Returns

getTokens

Returns all registered token addresses

Useful for iterating over all tokens to fetch historical prices

function getTokens() external view returns (address[] memory tokens_);

Returns

latestPricesUpdatedAt

Returns the timestamp of the latest common price update

Reverts if no updates exist

function latestPricesUpdatedAt() public view returns (uint256 timestamp_);

Returns

latestCutOffPriceUpdatedAt

Returns the timestamp of the latest cut-off price update

Reverts if no cut-off updates exist

function latestCutOffPriceUpdatedAt() external view returns (uint256 timestamp_);

Returns

peek

Returns the latest price of a token from its oracle

Performs deviation check to prevent extreme values

function peek(address _token) public view returns (uint256 price_);

Parameters

Returns

peekAt

Returns historical price for a token at a given index

Checks price validity (time not expired)

function peekAt(address _token, uint256 _index) public view returns (uint256 price_);

Parameters

Returns

onlyPeekAt

Returns historical price without validity check

Useful for auditing or internal calculations

function onlyPeekAt(address _token, uint256 _index) public view returns (uint256 price_);

Parameters

Returns

getVaultTokenPrice

Returns the historical price of the vault token at a given index

Checks price validity

function getVaultTokenPrice(uint256 _index) public view returns (uint256 price_);

Parameters

Returns

onlyGetVaultTokenPrice

Returns the historical price of the vault token without validity check

Useful for internal calculations

function onlyGetVaultTokenPrice(uint256 _index) public view returns (uint256 price_);

Parameters

Returns

getCutOffPrice

Returns token price at a cut-off update

Reverts if price is expired or index out of bounds

function getCutOffPrice(address _token, uint256 _index) external view returns (uint256 price_);

Parameters

Returns

getCutOffPrices

Returns token addresses and prices at a cut-off update

Reverts if price is expired or index out of bounds

function getCutOffPrices(uint256 _index) external view returns (address[] memory tokens_, uint256[] memory prices_);

Parameters

Returns

onlyGetCutOffPrices

Same as getCutOffPrices but does not check validity

Useful for internal auditing or calculation

function onlyGetCutOffPrices(uint256 _index)
    external
    view
    returns (address[] memory tokens_, uint256[] memory prices_);

Parameters

Returns

getVaultTokenCutOffPrice

Returns the vault token cut-off price at a given index

Checks validity

function getVaultTokenCutOffPrice(uint256 _index) external view returns (uint256 price_);

Parameters

Returns

onlyGetVaultTokenCutOffPrice

Returns the vault token cut-off price without validity check

Useful for internal calculations

function onlyGetVaultTokenCutOffPrice(uint256 _index) external view returns (uint256 price_);

Parameters

Returns

_getPrice

Retrieves the historical price of a token at a given index

• Uses commonPriceUpdatedAt array to find the timestamp of the requested price.
• If _checkValidity is true, reverts if the price is older than paramRegister.getPriceValidityDuration().
• Reverts if _index is out of bounds.
• Returns the stored price from prices[token][updatedAt].*

function _getPrice(address _token, uint256 _index, bool _checkValidity) internal view returns (uint256);

Parameters

Returns