API Version: v0.3.0 Not using latest version (v0.3.1)

Register (Data Streams) v0.3.0 API Reference

Integrate Chainlink Local into your project

npm install @chainlink/local@0.3.0

yarn add @chainlink/local@0.3.0

If you use Foundry:

forge install smartcontractkit/chainlink-local@v0.3.0

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.0/src/ccip/CCIPLocalSimulator.sol";

Register (Data Streams)

Data Streams network configuration registry.

struct NetworkDetails {
    address verifierProxyAddress;
    address linkAddress;
}

Mapping to store network details based on chain ID.

mapping(uint256 chainId => NetworkDetails) internal s_networkDetails

Constructor to initialize the network details for various chains.

constructor() ;

Retrieves network details for a given chain ID.

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

Parameters

Name	Type	Description
`chainId`	`uint256`	- The ID of the chain to get the details for.

Returns

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

Parameters

Name	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.