Skip to main content

IOracleProviderPullBased.sol

IOracleProviderPullBased

extraModule

function extraModule() external pure returns (enum ExtraModule)

Returns the type of automation module that the Keeper will execute, either "None" or "Pyth".

  • Return Values:

    NameTypeDescription
    [0]enum ExtraModuleAutomation module type, which can be "None" or "Pyth".

extraParam

function extraParam() external view returns (bytes)

Retrieves the parameter needed to request data from the Keeper, e.g., the price feed ID in the case of Pyth integration.

  • Return Values:

    NameTypeDescription
    [0]bytesRequired parameter for Keeper requests as bytes

getUpdateFee

function getUpdateFee(bytes offchainData) external view returns (uint256)

Returns the fee required to update the Oracle Provider with the given off-chain data

  • Parameters:

    NameTypeDescription
    offchainDatabytesOff-chain data required for the update
  • Return Values:

    NameTypeDescription
    [0]uint256fee amount

updatePrice

function updatePrice(bytes offchainData) external payable

Updates the Oracle Provider with the provided off-chain data

  • Parameters:

    NameTypeDescription
    offchainDatabytesOff-chain data used for the update

parseExtraData

function parseExtraData(bytes extraData) external view returns (struct IOracleProvider.OracleVersion)

Parses the provided off-chain data received from the Keeper and returns an OracleVersion structure representing the parsed data

  • Parameters:

    NameTypeDescription
    extraDatabytesOff-chain data received from the Keeper
  • Return Values:

    NameTypeDescription
    [0]struct IOracleProvider.OracleVersionParsed OracleVersion structure

lastSyncedVersion

function lastSyncedVersion() external view returns (struct IOracleProvider.OracleVersion)

Retrieves the last synchronized oracle version

  • Return Values:

    NameTypeDescription
    [0]struct IOracleProvider.OracleVersionLast synchronized oracle version