IPOR Protocol
Search
K

IPOR Oracle

“Someone’s sitting in the shade today because someone planted a tree a long time ago.”

Warren Buffet

Oracle structure

Oracle structure consists of 2 contracts and an off-chain component.
  1. 1.
    This stateless contract fetches the data from all the protocols supported by IPOR Index and runs all the calculations to compute IPOR Rate.
  2. 2.
    Oracle contract This contract keeps the state of the IPOR rate and IBT. Oracle contract allows for permissionless update of the IPOR rate (as long as requested is willing to cover the gas costs associated with the rate calculation) by invoking updateIndex(asset Address) function.
  3. 3.
    Rate publication off-chain oracle service. This service reads the value calculated in the rate calculation contract are publishes it to the IPOR Oracle contract. This is mainly done due to gas optimization reasons.

Public Functions

Function
Notes
getIndex (address asset)
It returns the most recently published IPOR value for a given asset.
getAccruedIndex(uint256 calcTimestamp, address asset)
It returns the structure with: - the most recent IPOR Index - IBT as calculated to the current timestamp. See calculateAccruedIbtPrice
calculateAccruedIbtPrice (address asset, uint256 calcTimestamp)
For a given asset it calculates the current value of IBT considering the time passed from the last IPOR publication. Change in IBT is made based on the recently published IPOR.
updateIndex (address asset, uint256 value)
Function available only to whitelisted addresses. It allows for IPOR publication. This function will also trigger a recalculation of IBT.
updateIndex (address asset)
Function available only to whitelisted addresses. When invoked, it will make a request to index-calculating smart contract (also used by the off-chain oracle) publish the index, and return value (same sa getIndex)
updateIndexes (address[] assets, uint256[] values)
Allows IPOR updating for multiple assets simultaneously.
addUpdater (address updater)
Available for Owner only. Adds address to whitelist of IPOR index updaters
removeUpdater (address updater)
Available for Owner only. Removes address from the whitelist of IPOR index updaters
addAsset (address asset, uint256 updateTimestamp
Available for Owner only. Adds asset for which IPOR can be compiled.
removeAsset (address asset)
Available for Owner only. It removes asset.