Chainlink Local API Reference

Available Versions

Latest Release

• Chainlink Local v0.3.1 (Current Version)
  • Targets CCIP 2.0: pins @chainlink/contracts-ccip 2.0.0 and @chainlink/contracts 1.5.0
  • New CCIPLocalRouter applies the CCIP 2.0 OnRamp and OffRamp message rules in local mode
  • CCIPLocalSimulatorFork and the Hardhat 3 JavaScript helper route CCIP 2.0 (CCV-based) lanes alongside the pre-1.6 and 1.6 eras
  • New fork-simulator surface: getMessageStatus, setStrictRouting, CCIP 2.0 router lookups (getCCIPV2RouterAddress / setCCIPV2RouterAddress), lane CCV configuration
  • Data Streams contracts: DataStreamsLocalSimulator, DataStreamsLocalSimulatorFork, mock verifier/proxy/fee manager/reward manager, MockReportGenerator, ReportVersions

Previous Versions

• Chainlink Local v0.2.2 (Legacy Version)

  • Added support for CCIP v1.5
  • Enhanced token support functions
  • Updated network configurations
  • Improved testing utilities

• Chainlink Local v0.2.1 (Legacy Version)

  • Added support for Chainlink Data Feeds
  • Introduced mock aggregator contracts
  • Basic testing framework setup

Documentation Structure

Each version includes detailed documentation for:

• CCIP Components (Router, Simulator)
• Data Streams Components (Simulator, Verifier, Report Generator)
• Data Feed Contracts
• Token Implementations
• JavaScript Utilities
• Testing Helpers