MockV3Aggregator v0.2.2 API Reference

If you use NPM, install the @chainlink/local NPM package:

npm install @chainlink/local@0.2.2

If you use Yarn, install the @chainlink/local NPM package:

yarn add @chainlink/local@0.2.2

If you use Foundry:

forge install smartcontractkit/chainlink-local@cd3bfb8c42716cfb791174314eba2c0d178551b9

and then set remappings to: @chainlink/local/=lib/chainlink-local/ in either remappings.txt or foundry.toml file

Import the CCIPLocalSimulator contract from the @chainlink/local package:

import {CCIPLocalSimulator} from "@chainlink/local@0.2.2/src/ccip/CCIPLocalSimulator.sol";

MockV3Aggregator

A mock implementation of the AggregatorV2V3Interface for testing purposes, providing a simulated price feed through interaction with a MockOffchainAggregator.

MockV3Aggregator

Inheritance

This contract inherits from:

AggregatorV2V3Interface - Combined interface that includes both AggregatorInterface and AggregatorV3Interface functionality

Variables

aggregator

address public aggregator

proposedAggregator

address public proposedAggregator

version

uint256 public constant version

Functions

confirmAggregator

Confirms and sets a previously proposed aggregator as the current one.

function confirmAggregator(address _aggregator) external

Parameters

Parameter	Type	Description
_aggregator	address	The address of the proposed aggregator

constructor

Initializes the mock aggregator with specified decimals and initial answer.

constructor(uint8 _decimals, int256 _initialAnswer)

Parameters

Parameter	Type	Description
_decimals	uint8	The number of decimals for the aggregator
_initialAnswer	int256	The initial answer to be set in the mock aggregator

decimals

Retrieves the number of decimal places used by the aggregator.

function decimals() external view returns (uint8)

Returns

Parameter	Type	Description
(unnamed)	uint8	The number of decimals

description

Returns the description of the aggregator.

function description() external pure returns (string memory)

Returns

Parameter	Type	Description
(unnamed)	string	The source file path of the mock aggregator

getAnswer

Retrieves the answer for a specific round.

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

Parameters

Parameter	Type	Description
roundId	uint256	The round ID to get the answer for

Returns

Parameter	Type	Description
(unnamed)	int256	The answer for the given round ID

getRoundData

Retrieves the complete round data for a specific round ID.

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

Parameters

Parameter	Type	Description
_roundId	uint80	The round ID to get the data for

Returns

Parameter	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

Retrieves the timestamp for a specific round.

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

Parameters

Parameter	Type	Description
roundId	uint256	The round ID to get the timestamp for

Returns

Parameter	Type	Description
(unnamed)	uint256	The timestamp for the given round ID

latestAnswer

Retrieves the most recent answer.

function latestAnswer() external view returns (int256)

Returns

Parameter	Type	Description
(unnamed)	int256	The latest answer

latestRound

Retrieves the most recent round ID.

function latestRound() external view returns (uint256)

Returns

Parameter	Type	Description
(unnamed)	uint256	The latest round ID

latestRoundData

Retrieves the complete round data for the most recent round.

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

Returns

Parameter	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

Retrieves the timestamp of the most recent answer.

function latestTimestamp() external view returns (uint256)

Returns

Parameter	Type	Description
(unnamed)	uint256	The timestamp of the latest answer

proposeAggregator

Proposes a new aggregator for future use.

function proposeAggregator(AggregatorV2V3Interface _aggregator) external

Parameters

Parameter	Type	Description
_aggregator	AggregatorV2V3Interface	The address of the proposed aggregator

updateAnswer

Updates the latest answer in the underlying mock aggregator.

function updateAnswer(int256 _answer) public

Parameters

Parameter	Type	Description
_answer	int256	The new answer to be set

updateRoundData

Updates all data for a specific round in the underlying mock aggregator.

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

Parameters

Parameter	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

MockV3Aggregator v0.2.2 API Reference

Get the latest Chainlink content straight to your inbox.