IOracle

Git Source

Title: IOracle

Author: Quantillon Labs - Nicolas Bellengé - @chewbaccoin

Generic interface for Quantillon Protocol oracle contracts

This interface is oracle-agnostic and can work with Chainlink, Stork, or any other oracle implementation The OracleRouter implements this interface and delegates to the active oracle (Chainlink or Stork)

Note: security-contact: team@quantillon.money

Functions

getEurUsdPrice

Gets the current EUR/USD price with validation

Retrieves and validates EUR/USD price from the active oracle with freshness checks

Notes:

• security: Validates price freshness and bounds before returning

• validation: Checks price staleness and circuit breaker state

• state-changes: May update lastValidPrice if price is valid

• events: No events emitted

• errors: No errors thrown, returns isValid=false for invalid prices

• reentrancy: Not protected - read-only operation

• access: Public - no access restrictions

• oracle: Queries active oracle (Chainlink or Stork) for EUR/USD price

function getEurUsdPrice() external returns (uint256 price, bool isValid);

Returns

getUsdcUsdPrice

Gets the current USDC/USD price with validation

Retrieves and validates USDC/USD price from the active oracle with tolerance checks

Notes:

• security: Validates price is within tolerance of $1.00

• validation: Checks price staleness and deviation from $1.00

• state-changes: No state changes - view function

• events: No events emitted

• errors: No errors thrown, returns isValid=false for invalid prices

• reentrancy: Not protected - view function

• access: Public - no access restrictions

• oracle: Queries active oracle (Chainlink or Stork) for USDC/USD price

function getUsdcUsdPrice() external view returns (uint256 price, bool isValid);

Returns

getOracleHealth

Returns overall oracle health signals

Checks the health status of both price feeds and overall oracle state

Notes:

• security: Provides health status for monitoring and circuit breaker decisions

• validation: Checks feed freshness, circuit breaker state, and pause status

• state-changes: May update internal state during health check

• events: No events emitted

• errors: No errors thrown

• reentrancy: Not protected - read-only operation

• access: Public - no access restrictions

• oracle: Queries active oracle health status for both feeds

function getOracleHealth() external returns (bool isHealthy, bool eurUsdFresh, bool usdcUsdFresh);

Returns

getEurUsdDetails

Detailed information about the EUR/USD price

Provides comprehensive EUR/USD price information including validation status

Notes:

• security: Provides detailed price information for debugging and monitoring

• validation: Checks price freshness and bounds validation

• state-changes: May update internal state during price check

• events: No events emitted

• errors: No errors thrown

• reentrancy: Not protected - read-only operation

• access: Public - no access restrictions

• oracle: Queries active oracle for detailed EUR/USD price information

function getEurUsdDetails()
    external
    returns (uint256 currentPrice, uint256 lastValidPrice, uint256 lastUpdate, bool isStale, bool withinBounds);

Returns

getOracleConfig

Current configuration and circuit breaker state

Returns current oracle configuration parameters and circuit breaker status

Notes:

• security: Returns configuration for security monitoring

• validation: No validation - read-only configuration

• state-changes: No state changes - view function

• events: No events emitted

• errors: No errors thrown

• reentrancy: Not protected - view function

• access: Public - no access restrictions

• oracle: Returns configuration from active oracle

function getOracleConfig()
    external
    view
    returns (
        uint256 minPrice,
        uint256 maxPrice,
        uint256 maxStaleness,
        uint256 usdcTolerance,
        bool circuitBreakerActive
    );

Returns

getPriceFeedAddresses

Addresses and decimals of the underlying feeds

Returns the addresses and decimal precision of both price feeds

Notes:

• security: Returns feed addresses for verification

• validation: No validation - read-only information

• state-changes: No state changes - view function

• events: No events emitted

• errors: No errors thrown

• reentrancy: Not protected - view function

• access: Public - no access restrictions

• oracle: Returns feed addresses from active oracle

function getPriceFeedAddresses()
    external
    view
    returns (address eurUsdFeedAddress, address usdcUsdFeedAddress, uint8 eurUsdDecimals, uint8 usdcUsdDecimals);

Returns

checkPriceFeedConnectivity

Connectivity check for both feeds

Tests connectivity to both price feeds and returns latest round information

Notes:

• security: Tests feed connectivity for health monitoring

• validation: No validation - connectivity test only

• state-changes: No state changes - view function

• events: No events emitted

• errors: No errors thrown, returns false for disconnected feeds

• reentrancy: Not protected - view function

• access: Public - no access restrictions

• oracle: Tests connectivity to active oracle feeds

function checkPriceFeedConnectivity()
    external
    view
    returns (bool eurUsdConnected, bool usdcUsdConnected, uint80 eurUsdLatestRound, uint80 usdcUsdLatestRound);

Returns