MockV3Aggregator v0.3.0 API Reference
MockV3Aggregator
Mock implementation of V3 aggregator.
Variables
aggregator
The address of the current aggregator.
address public aggregator
proposedAggregator
The address of the proposed aggregator.
address public proposedAggregator
version
The version of the aggregator.
uint256 public constant override version = 0
Functions
confirmAggregator
Confirms the proposed aggregator.
function confirmAggregator(address _aggregator) external;
Parameters
| Name | Type | Description |
|---|---|---|
_aggregator | address | - The address of the proposed aggregator. |
constructor
Constructor to initialize the MockV3Aggregator contract with initial parameters.
constructor(uint8 _decimals, int256 _initialAnswer) ;
Parameters
| Name | Type | Description |
|---|---|---|
_decimals | uint8 | - The number of decimals for the aggregator. |
_initialAnswer | int256 | - The initial answer to be set in the mock aggregator. |
decimals
Gets the number of decimals used by the aggregator.
function decimals() external view override returns (uint8);
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint8 | uint8 - The number of decimals. |
description
Gets the description of the aggregator.
function description() external pure override returns (string memory);
Returns
| Name | Type | Description |
|---|---|---|
<none> | string | string memory - The description of the aggregator. |
getAnswer
Gets the answer for a specific round ID.
function getAnswer(uint256 roundId) external view override returns (int256);
Parameters
| Name | Type | Description |
|---|---|---|
roundId | uint256 | - The round ID to get the answer for. |
Returns
| Name | Type | Description |
|---|---|---|
<none> | int256 | int256 - The answer for the given round ID. |
getRoundData
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.
function getRoundData(uint80 _roundId)
external
view
override
returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
Parameters
| Name | Type | Description |
|---|---|---|
_roundId | uint80 | - The round ID to get the data for. |
Returns
| Name | Type | Description |
|---|---|---|
roundId | uint80 | - The round ID. |
answer | int256 | - The answer for the round. |
startedAt | uint256 | - The timestamp when the round started. |
updatedAt | uint256 | - The timestamp when the round was updated. |
answeredInRound | uint80 | - The round ID in which the answer was computed. |
getTimestamp
Gets the timestamp for a specific round ID.
function getTimestamp(uint256 roundId) external view override returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
roundId | uint256 | - The round ID to get the timestamp for. |
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 - The timestamp for the given round ID. |
latestAnswer
Gets the latest answer from the aggregator.
function latestAnswer() external view override returns (int256);
Returns
| Name | Type | Description |
|---|---|---|
<none> | int256 | int256 - The latest answer. |
latestRound
Gets the latest round ID from the aggregator.
function latestRound() external view override returns (uint256);
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 - The latest round ID. |
latestRoundData
Gets the latest round data.
This function should raise "No data present" if no data is available.
function latestRoundData()
external
view
override
returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound);
Returns
| Name | Type | Description |
|---|---|---|
roundId | uint80 | - The latest round ID. |
answer | int256 | - The latest answer. |
startedAt | uint256 | - The timestamp when the latest round started. |
updatedAt | uint256 | - The timestamp when the latest round was updated. |
answeredInRound | uint80 | - The round ID in which the latest answer was computed. |
latestTimestamp
Gets the timestamp of the latest answer from the aggregator.
function latestTimestamp() external view override returns (uint256);
Returns
| Name | Type | Description |
|---|---|---|
<none> | uint256 | uint256 - The timestamp of the latest answer. |
proposeAggregator
Proposes a new aggregator.
function proposeAggregator(AggregatorV2V3Interface _aggregator) external;
Parameters
| Name | Type | Description |
|---|---|---|
_aggregator | AggregatorV2V3Interface | - The address of the proposed aggregator. |
updateAnswer
Updates the answer in the mock aggregator.
function updateAnswer(int256 _answer) public;
Parameters
| Name | Type | Description |
|---|---|---|
_answer | int256 | - The new answer to be set. |
updateRoundData
Updates the round data in the mock aggregator.
function updateRoundData(uint80 _roundId, int256 _answer, uint256 _timestamp, uint256 _startedAt) public;
Parameters
| Name | Type | Description |
|---|---|---|
_roundId | uint80 | - The round ID to be updated. |
_answer | int256 | - The new answer to be set. |
_timestamp | uint256 | - The timestamp to be set. |
_startedAt | uint256 | - The timestamp when the round started. |