MockV3Aggregator v0.2.3 API Reference

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

npm install @chainlink/local@0.2.3

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

yarn add @chainlink/local@0.2.3

If you use Foundry:

forge install smartcontractkit/chainlink-local@7d8b2f888e1f10c8841ccd9e0f4af0f5baf11dab

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.3/src/ccip/CCIPLocalSimulator.sol";

MockV3Aggregator

A mock implementation of the AggregatorV2V3Interface for testing purposes.

MockV3Aggregator

Variables

aggregator

address public aggregator

proposedAggregator

address public proposedAggregator

version

uint256 public constant override version = 0

Functions

confirmAggregator

Confirms the proposed aggregator.

function confirmAggregator(address _aggregator) external

Parameters

Parameter	Type	Description
_aggregator	`address`	The address of the proposed aggregator

Possible Reverts

Reverts if the provided aggregator address does not match the proposed aggregator with "Invalid proposed aggregator"

constructor

Initializes the contract with 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

decimals

Gets the number of decimals used by the aggregator.

function decimals() external view returns (uint8)

Returns

Parameter	Type	Description
(unnamed)	`uint8`	The number of decimals

description

Gets the description of the aggregator.

function description() external pure returns (string memory)

Returns

Parameter	Type	Description
(unnamed)	`string`	The contract path as the description

getAnswer

Gets the answer for a specific round ID.

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

Parameters

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

Returns

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

getRoundData

Gets the 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

Gets the timestamp for a specific round ID.

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

Parameters

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

Returns

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

latestAnswer

Gets the latest answer from the aggregator.

function latestAnswer() external view returns (int256)

Returns

Parameter	Type	Description
(unnamed)	`int256`	The latest answer

latestRound

Gets the latest round ID from the aggregator.

function latestRound() external view returns (uint256)

Returns

Parameter	Type	Description
(unnamed)	`uint256`	The latest round ID

latestRoundData

Gets the latest round data.

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

Gets the timestamp of the latest answer.

function latestTimestamp() external view returns (uint256)

Returns

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

proposeAggregator

Proposes a new aggregator.

function proposeAggregator(AggregatorV2V3Interface _aggregator) external

Parameters

Parameter	Type	Description
_aggregator	`AggregatorV2V3Interface`	The address of the proposed aggregator

Possible Reverts

Reverts if the proposed aggregator is the zero address with "Proposed aggregator cannot be zero address"
Reverts if the proposed aggregator is the current aggregator with "Proposed aggregator cannot be current aggregator"

updateAnswer

Updates the answer in the mock aggregator.

function updateAnswer(int256 _answer) public

Parameters

Parameter	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

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.3 API Reference

Get the latest Chainlink content straight to your inbox.