API Version: v0.3.1

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

CCIPLocalSimulatorFork JS

Hardhat 3 helpers for routing CCIP messages between forked networks: the JavaScript counterpart of the Solidity CCIPLocalSimulatorFork. Supports pre-1.6 (EVM2EVMOnRamp), 1.6 and CCIP 2.0 (CCV-based) lanes.

CCIPLocalSimulatorFork.js

Constants

CCIP_V2_ROUTERS

export const CCIP_V2_ROUTERS = Object.freeze({
  11155111: "0x784d49a71BB4C48eB7dA4cD7e6Ecb424f9b5EAB1", // Ethereum Sepolia
  43113: "0x7C9B8B4e8024e5Ee8A630F6FCe9015e470dA5763", // Avalanche Fuji
})

Types

CCIPSentMessage

Represents a CCIP message sent in a transaction, for any supported protocol version.

Property	Type	Description
era	`"PRE_V1_6" \| "V1_6" \| "V2"`	CCIP protocol version of the lane the message was sent on
onRamp	`string`	Source OnRamp that emitted the message
messageId	`string`	The message ID
sourceChainSelector	`bigint`	The source chain selector
destChainSelector	`bigint`	The destination chain selector (`undefined` for pre-1.6)
message	`object`	Era-specific payload: the pre-1.6 `EVM2EVMMessage`, the 1.6 `EVM2AnyRampMessage`, or for CCIP 2.0 `{ encodedMessage, receipts }`

Functions

getCCIPMessages

Extracts every CCIP message sent in a transaction, for all supported protocol versions.

function getCCIPMessages(connection, receipt) => CCIPSentMessage[]

Parameters

Parameter	Type	Description
connection	`object`	Network connection of the source chain
receipt	`object`	Transaction receipt of the `ccipSend` call

Returns

Type	Description
`CCIPSentMessage[]`	The sent messages, in log order (empty if none)

requestLinkFromTheFaucet

Requests LINK tokens from the testnet faucet by impersonating it.

async function requestLinkFromTheFaucet(connection, linkAddress, to, amount) => Promise<string>

Parameters

Parameter	Type	Description
connection	`object`	Network connection from `network.connect()`
linkAddress	`string`	The address of the LINK contract on the connected network
to	`string`	The address to send LINK to
amount	`bigint`	The amount of LINK to request

Returns

Type	Description
`Promise<string>`	Promise resolving to the transaction hash of the fund transfer

routeMessage

Routes a sent message on the destination (connected) network, as the destination OffRamp would execute it.

async function routeMessage(connection, routerAddresses, sent, options = {}) => Promise<Object>

Parameters

Parameter	Type	Description
connection	`object`	Network connection of the destination chain
routerAddresses	`string \| string[]`	Destination router address(es) whose OffRamps are searched, e.g. the default router and `CCIP_V2_ROUTERS[chainId]`
sent	`CCIPSentMessage`	A message returned by `getCCIPMessages`
options	`Object`	Optional: `forceExecution` (default `false`) executes CCIP 2.0 messages whose executor is `NO_EXECUTION_ADDRESS` (manual execution)

Returns

Type	Description
`Object`	`{ offRamp, executed, reason }`: `executed` is `false` only for a CCIP 2.0 `NO_EXECUTION` message routed without `forceExecution` (`reason` is then `"NO_EXECUTION_ADDRESS"`)

CCIPLocalSimulatorFork JS v0.3.1 API Reference

Get the latest Chainlink content straight to your inbox.