NEW

CCIP is now live for all developers. See what's new.

MockV3Aggregator API reference

MockV3Aggregator

This contract is a mock implementation of the AggregatorV2V3Interface for testing purposes.

This contract interacts with a MockOffchainAggregator to simulate price feeds.

version

uint256 version

The version of the aggregator.

aggregator

address aggregator

The address of the current aggregator.

proposedAggregator

address proposedAggregator

The address of the proposed aggregator.

constructor

constructor(uint8 _decimals, int256 _initialAnswer) public

Constructor to initialize the MockV3Aggregator contract with initial parameters.

Parameters

NameTypeDescription
_decimalsuint8The number of decimals for the aggregator.
_initialAnswerint256The initial answer to be set in the mock aggregator.

decimals

function decimals() external view returns (uint8)

Gets the number of decimals used by the aggregator.

Return Values

NameTypeDescription
[0]uint8uint8 - The number of decimals.

getAnswer

function getAnswer(uint256 roundId) external view returns (int256)

Gets the answer for a specific round ID.

Parameters

NameTypeDescription
roundIduint256The round ID to get the answer for.

Return Values

NameTypeDescription
[0]int256int256 - The answer for the given round ID.

getRoundData

function getRoundData(uint80 _roundId) external view returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound)

Gets the round data for a specific round ID.

This function should raise "No data present" if no data is available for the given round ID.

Parameters

NameTypeDescription
_roundIduint80The round ID to get the data for.

Return Values

NameTypeDescription
roundIduint80The round ID.
answerint256The answer for the round.
startedAtuint256The timestamp when the round started.
updatedAtuint256The timestamp when the round was updated.
answeredInRounduint80The round ID in which the answer was computed.

latestRoundData

function latestRoundData() external view returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound)

Gets the latest round data.

This function should raise "No data present" if no data is available.

Return Values

NameTypeDescription
roundIduint80The latest round ID.
answerint256The latest answer.
startedAtuint256The timestamp when the latest round started.
updatedAtuint256The timestamp when the latest round was updated.
answeredInRounduint80The round ID in which the latest answer was computed.

getTimestamp

function getTimestamp(uint256 roundId) external view returns (uint256)

Gets the timestamp for a specific round ID.

Parameters

NameTypeDescription
roundIduint256The round ID to get the timestamp for.

Return Values

NameTypeDescription
[0]uint256uint256 - The timestamp for the given round ID.

latestAnswer

function latestAnswer() external view returns (int256)

Gets the latest answer from the aggregator.

Return Values

NameTypeDescription
[0]int256int256 - The latest answer.

latestTimestamp

function latestTimestamp() external view returns (uint256)

Gets the timestamp of the latest answer from the aggregator.

Return Values

NameTypeDescription
[0]uint256uint256 - The timestamp of the latest answer.

latestRound

function latestRound() external view returns (uint256)

Gets the latest round ID from the aggregator.

Return Values

NameTypeDescription
[0]uint256uint256 - The latest round ID.

updateAnswer

function updateAnswer(int256 _answer) public

Updates the answer in the mock aggregator.

Parameters

NameTypeDescription
_answerint256The new answer to be set.

updateRoundData

function updateRoundData(uint80 _roundId, int256 _answer, uint256 _timestamp, uint256 _startedAt) public

Updates the round data in the mock aggregator.

Parameters

NameTypeDescription
_roundIduint80The round ID to be updated.
_answerint256The new answer to be set.
_timestampuint256The timestamp to be set.
_startedAtuint256The timestamp when the round started.

proposeAggregator

function proposeAggregator(contract AggregatorV2V3Interface _aggregator) external

Proposes a new aggregator.

Parameters

NameTypeDescription
_aggregatorcontract AggregatorV2V3InterfaceThe address of the proposed aggregator.

confirmAggregator

function confirmAggregator(address _aggregator) external

Confirms the proposed aggregator.

Parameters

NameTypeDescription
_aggregatoraddressThe address of the proposed aggregator.

description

function description() external pure returns (string)

Gets the description of the aggregator.

Return Values

NameTypeDescription
[0]stringstring memory - The description of the aggregator.

Stay updated on the latest Chainlink news