API Version: v0.3.1

Chainlink Local v0.3.1 API Reference

Integrate Chainlink Local into your project

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

npm install @chainlink/local@0.3.1

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

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";

Chainlink Local v0.3.1 (V3) targets CCIP 2.0: it pins @chainlink/contracts-ccip 2.0.0 and @chainlink/contracts 1.5.0, and the local router applies the CCIP 2.0 OnRamp and OffRamp message rules. Fork routing supports every CCIP era (pre-1.6, 1.6 and CCIP 2.0). Hardhat 2 is not supported in 0.3.x; Hardhat 2 users stay on 0.2.x (see the release notes).

CCIP

These contracts provide Cross-Chain Interoperability Protocol (CCIP) functionality in a local testing environment:

CCIPLocalSimulator - Local CCIP simulator (no-fork mode)
CCIPLocalRouter - The local-mode router with CCIP 2.0 message rules
CCIPLocalSimulatorFork - CCIP simulator for forked networks (all CCIP eras)
CCIPLocalSimulatorFork JS - Hardhat 3 JavaScript helpers for fork routing
Register - CCIP network configuration registry

Data Streams

Contracts for simulating Chainlink Data Streams:

DataStreamsLocalSimulator - Local Data Streams simulator (no-fork mode)
DataStreamsLocalSimulatorFork - Data Streams simulator for forked networks
MockVerifier - Mock Data Streams verifier
MockVerifierProxy - Mock Data Streams verifier proxy
MockReportGenerator - Signed report generator for every report schema
MockFeeManager - Mock verifier fee manager
MockRewardManager - Mock reward manager
ReportVersions - Data Streams report schemas (ReportV1-ReportV13)
Register (Data Streams) - Data Streams network configuration registry

Data Feeds

Contracts for simulating Chainlink Data Feeds:

AggregatorInterface - Basic price feed interface
AggregatorV2V3Interface - Combined V2/V3 price feed interface
AggregatorV3Interface - Extended price feed interface
MockOffchainAggregator - Mock implementation of off-chain aggregator
MockV3Aggregator - Mock implementation of V3 aggregator

Token Contracts

Standard token implementations for testing:

BurnMintERC677Helper - Helper contract for ERC677 token operations
LinkToken - LINK token implementation
WETH9 - Wrapped Ether implementation