IPriceOracle

Overview

License: MIT

interface IPriceOracle

Functions info

MODERATOR_ROLE (0x797669c9)

function MODERATOR_ROLE() external view returns (bytes32)

volatilityCapFixedPercent (0x34bdb935)

function volatilityCapFixedPercent()
    external
    view
    returns (address priceProvider)

minSampleInterval (0x69a7f273)

function minSampleInterval(address token) external view returns (bool)

logMaturingAge (0x89a1e81f)

function logMaturingAge(address token) external view returns (bool)

longTWAPperiod (0x7ccad678)

function longTWAPperiod(address token) external view returns (bool)

grantModerator (0x6981c7ae)

function grantModerator(address newModerator) external

revokeModerator (0x36445636)

function revokeModerator(address moderator) external

setPriceProviderAggregator (0x5ff22c42)

function setPriceProviderAggregator(
    address newPriceProviderAggregator
) external

Set the price provider aggregator contract address

Parameters:

Name	Type	Description
newPriceProviderAggregator	address	The address of the new price provider aggregator contract

setVolatilityCapFixedPercent (0x7eddca25)

function setVolatilityCapFixedPercent(
    uint16 _volatilityCapFixedPercent
) external

Set the volatility cap fixed percent

Parameters:

Name	Type	Description
_volatilityCapFixedPercent	uint16	The new volatility cap fixed percent

setMinSampleInterval (0x7ec0974b)

function setMinSampleInterval(uint256 _minSampleInterval) external

Set the minimum sample interval

Parameters:

Name	Type	Description
_minSampleInterval	uint256	The new minimum sample interval

setLogMaturingAge (0xb7fb9223)

function setLogMaturingAge(uint256 _logMaturingAge) external

Set the log maturing age

Parameters:

Name	Type	Description
_logMaturingAge	uint256	The new log maturing age

setLongTWAPperiod (0x8597bfb5)

function setLongTWAPperiod(uint256 _longTWAPperiod) external

Set the long TWAP period

Parameters:

Name	Type	Description
_longTWAPperiod	uint256	The new long TWAP period

updateFinalPrices (0x8bb6b7f9)

function updateFinalPrices(address token) external

Calculates the final TWAP prices of a token.

Parameters:

Name	Type	Description
token	address	The address of the token.

getMostTWAPprice (0xbc124cfd)

function getMostTWAPprice(
    address token
)
    external
    view
    returns (
        uint8 priceDecimals,
        uint64 timestamp,
        uint256 collateralPrice,
        uint256 capitalPrice
    )

Returns the most recent TWAP price of a token.

Parameters:

Name	Type	Description
token	address	The address of the token.

Return values:

Name	Type	Description
priceDecimals	uint8	The decimals of the price.
timestamp	uint64	The last updated timestamp of the price.
collateralPrice	uint256	The collateral price of the token.
capitalPrice	uint256	The capital price of the token.

getEstimatedTWAPprice (0x29f839b2)

function getEstimatedTWAPprice(
    address token
)
    external
    view
    returns (
        uint8 priceDecimals,
        uint64 timestamp,
        uint256 collateralPrice,
        uint256 capitalPrice
    )

Returns the non-TWAP price of a token.

Parameters:

Name	Type	Description
token	address	The address of the token.

Return values:

Name	Type	Description
priceDecimals	uint8	The decimals of the price.
timestamp	uint64	The last updated timestamp of the price.
collateralPrice	uint256	The collateral price of the token.
capitalPrice	uint256	The capital price of the token.

getEvaluation (0x81fd01ea)

function getEvaluation(
    address token,
    uint256 tokenAmount
)
    external
    view
    returns (uint256 collateralEvaluation, uint256 capitalEvaluation)

returns the most TWAP price in USD evaluation of token by its tokenAmount

Parameters:

Name	Type	Description
token	address	the address of token to evaluate
tokenAmount	uint256	the amount of token to evaluate

Return values:

Name	Type	Description
collateralEvaluation	uint256	the USD evaluation of token by its tokenAmount in collateral price
capitalEvaluation	uint256	the USD evaluation of token by its tokenAmount in capital price

getEstimatedEvaluation (0xebb19c1a)

function getEstimatedEvaluation(
    address token,
    uint256 tokenAmount
)
    external
    view
    returns (uint256 collateralEvaluation, uint256 capitalEvaluation)

returns the non-TWAP price in USD evaluation of token by its tokenAmount

Parameters:

Name	Type	Description
token	address	the address of token to evaluate
tokenAmount	uint256	the amount of token to evaluate

Return values:

Name	Type	Description
collateralEvaluation	uint256	the USD evaluation of token by its tokenAmount in collateral price
capitalEvaluation	uint256	the USD evaluation of token by its tokenAmount in capital price

getReportedPrice (0xdbd57337)

function getReportedPrice(
    address token
) external view returns (uint256 priceMantissa, uint8 priceDecimals)

price = priceMantissa / (10 ** priceDecimals)

returns tuple (priceMantissa, priceDecimals)

Parameters:

Name	Type	Description
token	address	the address of token which price is to return