API Version: v0.3.1

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

Register

A contract that stores and retrieves network details for various chains.

Contains configuration details for a specific network/chain.

Field	Type	Description
chainSelector	`uint64`	Unique identifier for the chain in CCIP
routerAddress	`address`	Address of the CCIP Router contract
linkAddress	`address`	Address of the LINK token contract
wrappedNativeAddress	`address`	Address of the wrapped native token contract
ccipBnMAddress	`address`	Address of the CCIP BnM token contract
ccipLnMAddress	`address`	Address of the CCIP LnM token contract
rmnProxyAddress	`address`	Address of the RMN proxy contract
registryModuleOwnerCustomAddress	`address`	Address of the registry module owner
tokenAdminRegistryAddress	`address`	Address of the token admin registry contract

mapping(uint256 chainId => NetworkDetails) internal s_networkDetails

mapping(uint256 chainId => bool isOverridden) internal s_isOverridden

Initializes the contract.

constructor()

Retrieves network details for a given chain ID.

function getNetworkDetails(uint256 chainId) external view returns (NetworkDetails memory networkDetails)

Parameter	Type	Description
chainId	`uint256`	The ID of the chain to get the details for

Parameter	Type	Description
networkDetails	`NetworkDetails`	The network details for the specified chain ID

Sets the network details for a given chain ID.

function setNetworkDetails(uint256 chainId, NetworkDetails memory networkDetails) external

Parameter	Type	Description
chainId	`uint256`	The ID of the chain to set the details for
networkDetails	`NetworkDetails`	The network details to set for the specified chain ID

Returns the deterministic address of built-in data shard index.

function shardAddress(uint256 index) public view returns (address)

Parameter	Type	Description
index	`uint256`	The shard index (0 to `_SHARD_COUNT - 1`)