ICCIPGatewayAdapter

Git Source

Title: ICCIPGatewayAdapter

Authors: David Dada <daveproxy80@gmail.com> (https://github.com/dadadave80), Modified from Chainlink CCIP (https://github.com/smartcontractkit/chainlink-ccip)

Admin/read surface of the Chainlink CCIP ERC-7786 gateway adapter. The standard source-gateway ABI (sendMessage/supportsAttribute) is on IERC7786GatewaySource; the inbound callback is IAny2EVMMessageReceiver.ccipReceive. EVM chains only.

Functions

router

function router() external view returns (address);

Returns

feeToken

function feeToken() external view returns (address);

Returns

getChainSelector

function getChainSelector(uint256 chainId) external view returns (uint64);

Parameters

Returns

getChainId

function getChainId(uint64 selector) external view returns (uint256);

Parameters

Returns

getRemoteGateway

function getRemoteGateway(uint256 chainId) external view returns (address);

Parameters

Returns

getDestinationGasLimit

function getDestinationGasLimit(uint256 chainId) external view returns (uint256);

Parameters

Returns

getAllowOutOfOrderExecution

function getAllowOutOfOrderExecution(uint256 chainId) external view returns (bool);

Parameters

Returns

quoteFee

Quotes the CCIP fee (in the configured fee token) to send payload to recipient (ERC-7930).

function quoteFee(bytes calldata recipient, bytes calldata payload) external view returns (uint256);

Parameters

Returns

getCCVConfig

Returns the configured CCV requirements / finality for inbound messages from chainId (all-empty / bytes4(0) ⇒ unconfigured: CCIP defaults, require full finality).

function getCCVConfig(uint256 chainId)
        external
        view
        returns (
            address[] memory requiredCCVs,
            address[] memory optionalCCVs,
            uint8 optionalThreshold,
            bytes4 allowedFinalityConfig
        );

Parameters

Returns

registerChainSelector

Registers an EVM chainId ↔ CCIP chain-selector equivalence (both directions). Admin only.

function registerChainSelector(uint256 chainId, uint64 selector) external;

Parameters

registerRemoteGateway

Registers a trusted remote gateway adapter for a chain. Admin only.

function registerRemoteGateway(uint256 chainId, address remote) external;

Parameters

configureDestination

Configures a destination's delivery gas limit and out-of-order execution flag. Admin only.

function configureDestination(uint256 chainId, uint256 gasLimit, bool allowOutOfOrderExecution) external;

Parameters

setFeeToken

Sets the fee token (address(0) ⇒ native). Admin only.

function setFeeToken(address feeToken) external;

Parameters

configureCCV

Configures the CCV requirements + allowed finality returned to the CCIP router for inbound messages from chainId. optionalThreshold must be ≤ optionalCCVs.length. Admin only.

function configureCCV(
        uint256 chainId,
        address[] calldata requiredCCVs,
        address[] calldata optionalCCVs,
        uint8 optionalThreshold,
        bytes4 allowedFinalityConfig
    ) external;

Parameters

Events

RegisteredChainSelector

Emitted when an EVM chainId ↔ CCIP chain-selector equivalence is registered.

event RegisteredChainSelector(uint256 indexed chainId, uint64 selector);

Parameters

RegisteredRemoteGateway

Emitted when a trusted remote gateway adapter is registered for a chain.

event RegisteredRemoteGateway(uint256 indexed chainId, address remote);

Parameters

ConfiguredDestination

Emitted when a destination's delivery gas limit / ordering flag is configured.

event ConfiguredDestination(uint256 indexed chainId, uint256 gasLimit, bool allowOutOfOrderExecution);

Parameters

SetFeeToken

Emitted when the fee token is set (address(0) ⇒ native).

event SetFeeToken(address indexed feeToken);

Parameters

ConfiguredCCV

Emitted when a source chain's CCV (Cross-Chain Verifier) requirements / finality are configured.

event ConfiguredCCV(
        uint256 indexed chainId,
        address[] requiredCCVs,
        address[] optionalCCVs,
        uint8 optionalThreshold,
        bytes4 allowedFinalityConfig
    );

Parameters

Errors

ChainSelectorAlreadyRegistered

A chain selector equivalence is already registered for this chainId or selector.

error ChainSelectorAlreadyRegistered(uint256 chainId);

Parameters

RemoteGatewayAlreadyRegistered

A remote gateway is already registered for this chain.

error RemoteGatewayAlreadyRegistered(uint256 chainId);

Parameters

UnknownDestinationChain

The destination chain has no selector and/or no remote gateway registered.

error UnknownDestinationChain(uint256 chainId);

Parameters

DestinationNotConfigured

The destination chain has no delivery gas limit configured (call configureDestination).

error DestinationNotConfigured(uint256 chainId);

Parameters

InsufficientFee

The native value supplied was below the quoted CCIP fee.

error InsufficientFee(uint256 provided, uint256 required);

Parameters

RefundFailed

Refunding unspent native value to the sender failed.

error RefundFailed();

InvalidCCVThreshold

The optional-CCV threshold exceeds the number of optional CCVs supplied.

error InvalidCCVThreshold(uint8 threshold, uint256 optionalCount);

Parameters

NotRouter

The inbound callback was not invoked by the configured CCIP router.

error NotRouter(address caller);

Parameters

InvalidOriginGateway

The inbound source did not match the registered remote gateway for its chain.

error InvalidOriginGateway(uint64 sourceChainSelector, bytes sender);

Parameters

MessageAlreadyExecuted

The inbound message (chainId, CCIP messageId) was already delivered (replay).

error MessageAlreadyExecuted(uint256 chainId, bytes32 messageId);

Parameters

RecipientExecutionFailed

The recipient's receiveMessage did not return the ERC-7786 magic value.

error RecipientExecutionFailed();