Register v0.3.0 API Reference

Register

CCIP network configuration registry.

Register

Structs

NetworkDetails

struct NetworkDetails {
    uint64 chainSelector;
    address routerAddress;
    address linkAddress;
    address wrappedNativeAddress;
    address ccipBnMAddress;
    address ccipLnMAddress;
    address rmnProxyAddress;
    address registryModuleOwnerCustomAddress;
    address tokenAdminRegistryAddress;
}

Variables

_SHARD_COUNT

Number of generated data shards in RegisterData.sol.

uint256 internal constant _SHARD_COUNT = 4

s_isOverridden

Whether setNetworkDetails was called for a chain ID.

mapping(uint256 chainId => bool isOverridden) internal s_isOverridden

s_networkDetails

Network details set with setNetworkDetails, overriding the built-in ones.

mapping(uint256 chainId => NetworkDetails) internal s_networkDetails

Functions

_defaultNetworkDetails

Built-in network details for chainId, or an all-zero struct for an unknown chain.

Decodes the generated data shards; shard addresses without code are skipped, so a bare new Register() (no shards placed) only serves setNetworkDetails overrides.

function _defaultNetworkDetails(uint256 chainId) internal view returns (NetworkDetails memory);

getNetworkDetails

Retrieves network details for a given chain ID.

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

Parameters

Returns

setNetworkDetails

Sets the network details for a given chain ID.

function setNetworkDetails(uint256 chainId, NetworkDetails memory networkDetails) external;

Parameters

shardAddress

Deterministic address of built-in data shard index; the simulator places each shard there.

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