API Version: v0.2.4 Not using latest version (v0.3.1)

MockReportGenerator v0.2.4 API Reference

Integrate Chainlink Local into your project

npm install @chainlink/local@0.2.4

yarn add @chainlink/local@0.2.4

If you use Foundry:

forge install smartcontractkit/chainlink-local@v0.2.4

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

MockReportGenerator

Signed report generator for every report schema.

address i_donAddress

uint256 i_donDigest

bytes32 i_reportV2MockFeedId

bytes32 i_reportV3MockFeedId

bytes32 i_reportV4MockFeedId

int192 s_ask

int192 s_bid

uint32 s_expiresPeriod

uint192 s_linkFee

uint32 s_marketStatus

uint192 s_nativeFee

int192 s_price

error MockReportGenerator__CastOverflow()

error MockReportGenerator__InvalidAsk()

error MockReportGenerator__InvalidBid()

constructor(int192 initialPrice) public

function generateReport(struct ReportVersions.ReportV2 report) external returns (bytes signedReport)

function generateReport(struct ReportVersions.ReportV3 report) external returns (bytes signedReport)

function generateReport(struct ReportVersions.ReportV4 report) external returns (bytes signedReport)

function generateReportV2() external returns (bytes signedReport, struct ReportVersions.ReportV2 report)

function generateReportV3() external returns (bytes signedReport, struct ReportVersions.ReportV3 report)

function generateReportV4() external returns (bytes signedReport, struct ReportVersions.ReportV4 report)

function getMockDonAddress() external view returns (address)

function updateExpiresPeriod(uint32 period) external

function updateFees(uint192 nativeFee, uint192 linkFee) external

function updateMarketStatus(uint32 status) external

function updatePrice(int192 price) public

function updatePriceBidAndAsk(int192 price, int192 bid, int192 ask) external