CCTPBridgeAdapter

Git Source

Inherits: ICCTPBridgeAdapter

Title: CCTPBridgeAdapter

Authors: David Dada <daveproxy80@gmail.com> (https://github.com/dadadave80), Modified from Circle CCTP v2 (https://github.com/circlefin/evm-cctp-contracts)

Circle CCTP v2 USDC token-bridge facet: depositForBurn burns USDC on this chain toward an ERC-7930 recipient, relayMessage forwards an Iris-attested inbound message to the CCTP transmitter for minting. CCTP is a TOKEN BRIDGE (burn-and-mint), NOT an ERC-7786 message gateway — this facet is deliberately not an IERC7786GatewaySource and never routes through OpenBridge.

Notes:

• lattice-version: 0.1.0
• lattice-source: Circle

Functions

depositForBurn

Burns amount USDC (pulled from msg.sender) for minting to the ERC-7930 recipient on its destination chain via CCTP. Approves the TokenMessenger for EXACTLY amount, then resets to 0.

function depositForBurn(uint256 amount, bytes calldata recipient) external virtual;

Parameters

depositForBurnWithHook

Like depositForBurn but attaches CCTP v2 hookData to the burn message (via TokenMessengerV2.depositForBurnWithHook) for the destination recipient to execute. Reverts CCTPEmptyHookData if hookData is empty (use depositForBurn for a hook-less burn). When hookData is a Lattice envelope (HOOK_MAGIC ‖ target ‖ payload) it also reverts CCTPHookWithoutDestinationCaller unless the destination domain's destinationCaller is set: it MUST be the destination diamond, or anyone could mint via Circle's transmitter and skip the hook. Other hookData is not guarded (the destination relays it plainly). The lock is PER DOMAIN, so it also routes plain depositForBurn burns to that domain through the destination diamond.

function depositForBurnWithHook(uint256 amount, bytes calldata recipient, bytes calldata hookData)
        external
        virtual;

Parameters

relayMessage

PERMISSIONLESS passthrough: forwards an Iris-attested CCTP message to the transmitter, which mints USDC directly to the recipient. Reverts CCTPRelayFailed if the transmitter returns false. A burn carrying a valid Lattice hook envelope (one relayMessageWithHook accepts) reverts CCTPHookRelayRequired BEFORE minting unless the caller is its attested mintRecipient (an escape hatch that delivers the funds without running the hook).

function relayMessage(bytes calldata message, bytes calldata attestation) external virtual;

Parameters

relayMessageWithHook

PERMISSIONLESS relay that ALSO executes a Lattice hook envelope carried in the burn message: it validates the message is a BurnMessageV2 addressed to this adapter's TokenMessenger carrying a valid Lattice hookData envelope, mints via the transmitter, THEN calls the decoded hook target through the CCTPHookExecutor with Circle-ATTESTED context. Hook execution is LENIENT — a reverting/return-bombing target does NOT revert the relay (the mint stands, nonce consumed) — but a target whose OWN frame runs out of gas reverts the whole relay with ICCTPHookExecutor.CCTPHookOutOfGas, leaving the nonce live for a retry with more gas. A sub-call out-of-gas reads as an ordinary revert unless the target re-raises it (ICCTPHookReceiver). Reverts CCTPNotBurnMessage / CCTPInvalidHookData on a non-conforming message BEFORE minting, and CCTPRelayFailed if the transmitter returns false.

function relayMessageWithHook(bytes calldata message, bytes calldata attestation) external virtual;

Parameters

registerChainDomain

Registers chainId ⇒ CCTP domain. Admin only. Verify the domain table at deploy.

function registerChainDomain(uint256 chainId, uint32 domain) external virtual;

Parameters

configureDomain

Sets the per-domain maxFee, minFinalityThreshold and destinationCaller. Admin only.

function configureDomain(uint32 domain, uint256 maxFee, uint32 minFinalityThreshold, bytes32 destinationCaller)
        external
        virtual;

Parameters

tokenMessenger

The CCTP v2 TokenMessengerV2 this adapter burns through.

function tokenMessenger() external view virtual returns (address);

Returns

messageTransmitter

The CCTP v2 MessageTransmitterV2 this adapter relays inbound messages to.

function messageTransmitter() external view virtual returns (address);

Returns

usdc

The bridged USDC token (burn source of funds is msg.sender, not the Diamond balance).

function usdc() external view virtual returns (address);

Returns

getDomain

The CCTP domain registered for chainId (meaningless unless isChainRegistered is true).

function getDomain(uint256 chainId) external view virtual returns (uint32);

Parameters

Returns

domainOwner

The chainId that registered domain (0 = unregistered).

function domainOwner(uint32 domain) external view virtual returns (uint256);

Parameters

Returns

isChainRegistered

Whether chainId has a registered CCTP domain (distinguishes domain 0 = Ethereum from unset).

function isChainRegistered(uint256 chainId) external view virtual returns (bool);

Parameters

Returns

getDomainConfig

The per-domain config used when burning toward domain.

function getDomainConfig(uint32 domain)
        external
        view
        virtual
        returns (uint256 maxFee, uint32 minFinalityThreshold, bytes32 destinationCaller);

Parameters

Returns

hookExecutor

The role-less, fund-less CCTPHookExecutor this diamond routes inbound hooks through (deployed once at init, immutable — no setter). Never the zero address on an initialized adapter.

function hookExecutor() external view virtual returns (address);

Returns

exportSelectors

ERC-8153 selector export: this facet's cuttable selectors, tightly packed (4 bytes each).

function exportSelectors() external pure virtual returns (bytes memory selectors);

Returns