API Version: v0.3.1

MockReportGenerator v0.3.1 API Reference

Integrate Chainlink Local into your project

npm install @chainlink/local@0.3.1

yarn add @chainlink/local@0.3.1

If you use Foundry:

forge install smartcontractkit/chainlink-local@v0.3.1

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

MockReportGenerator

A contract that generates signed Data Streams reports for local testing.

error MockReportGenerator__InvalidBid()

error MockReportGenerator__InvalidAsk()

error MockReportGenerator__CastOverflow()

Initializes the generator with an initial price.

constructor(int192 initialPrice)

Parameter	Type	Description
initialPrice	`int192`	The initial report price

Generates a signed report for a specific schema version.

function generateReportV3() external returns (bytes memory signedReport, ReportV3 memory report)

Parameter	Type	Description
signedReport	`bytes`	The ABI-encoded signed report
report	`ReportVn`	The generated report struct

Updates the price used in generated reports.

function updatePrice(int192 price) public

Updates the price, bid and ask used in generated reports.

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

Updates the report expiry period.

function updateExpiresPeriod(uint32 period) external

Updates the market status used in generated reports.

function updateMarketStatus(uint32 status) external

Updates the native and LINK fees carried in generated reports.

function updateFees(uint192 nativeFee, uint192 linkFee) external