API Version: v0.3.1

Register (Data Streams) 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 (Data Streams)

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

Contains Data Streams configuration details for a specific network/chain.

Field	Type	Description
verifierProxyAddress	`address`	The address of the Verifier Proxy contract
linkAddress	`address`	The address of the LINK token contract

Initializes the contract with predefined network details.

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