Overview
The Inbox contract is the main entry point for fulfilling intents on the destination chain. It validates intent hash authenticity, executes calldata, and enables provers to claim rewards on the source chain by checking the claimants mapping.
Contract Location: contracts/Inbox.sol
Inherits: DestinationSettler, IInbox
State Variables
claimants
mapping(bytes32 => bytes32) public claimants
executor
IExecutor public immutable executor
State-Changing Functions
fulfill
function fulfill(
bytes32 intentHash,
Route memory route,
bytes32 rewardHash,
bytes32 claimant
) external payable returns (bytes[] memory)
The hash of the intent to fulfill
The route of the intent containing execution instructions
The hash of the reward details
Cross-VM compatible claimant identifier
Array of execution results from each call
This function is payable and requires msg.value to be at least route.nativeAmount. Any excess ETH is automatically refunded to the caller.
fulfillAndProve
function fulfillAndProve(
bytes32 intentHash,
Route memory route,
bytes32 rewardHash,
bytes32 claimant,
address prover,
uint64 sourceChainDomainID,
bytes memory data
) public payable returns (bytes[] memory)
The hash of the intent to fulfill
The hash of the reward details
Cross-VM compatible claimant identifier
Address of prover on the destination chain
Domain ID of the source chain where the intent was created
Additional data for message formatting
Array of execution results
WARNING: sourceChainDomainID is NOT necessarily the same as chain ID.Each bridge provider uses their own domain ID mapping system:
- Hyperlane: Uses custom domain IDs that may differ from chain IDs
- LayerZero: Uses endpoint IDs that map to chains differently
- Metalayer: Uses domain IDs specific to their routing system
- Polymer: Uses chain IDs
You MUST consult the specific bridge provider’s documentation to determine the correct domain ID for the source chain.
prove
function prove(
address prover,
uint64 sourceChainDomainID,
bytes32[] memory intentHashes,
bytes memory data
) public payable
Address of prover on the destination chain
Domain ID of the source chain
Array of intent hashes to prove
Additional data for message formatting
WARNING: sourceChainDomainID is NOT necessarily the same as chain ID.Each bridge provider uses their own domain ID mapping system:
- Hyperlane: Uses custom domain IDs that may differ from chain IDs
- LayerZero: Uses endpoint IDs that map to chains differently
- Metalayer: Uses domain IDs specific to their routing system
- Polymer: Uses chain IDs
You MUST consult the specific bridge provider’s documentation to determine the correct domain ID for the source chain. This function can only prove intents that have already been fulfilled. It will revert with IntentNotFulfilled if any of the provided intent hashes have not been fulfilled yet.
Events
IntentFulfilled
event IntentFulfilled(
bytes32 indexed intentHash,
bytes32 indexed claimant
)
IntentProven
event IntentProven(
bytes32 indexed intentHash,
bytes32 indexed claimant
)
Errors
error ChainIdTooLarge(uint256 chainId)
IntentExpired
Thrown when attempting to fulfill an intent after its deadline.
InvalidPortal
error InvalidPortal(address portal)
InvalidHash
error InvalidHash(bytes32 intentHash)
IntentAlreadyFulfilled
error IntentAlreadyFulfilled(bytes32 intentHash)
ZeroClaimant
Thrown when the claimant is bytes32(0).
InsufficientNativeAmount
error InsufficientNativeAmount(uint256 provided, uint256 required)
IntentNotFulfilled
error IntentNotFulfilled(bytes32 intentHash)
Usage Example
// Fulfill an intent
bytes[] memory results = inbox.fulfill{
value: route.nativeAmount
}(
intentHash,
route,
rewardHash,
claimant
);
// Or fulfill and prove in one transaction
bytes[] memory results = inbox.fulfillAndProve{
value: route.nativeAmount + provingFee
}(
intentHash,
route,
rewardHash,
claimant,
proverAddress,
sourceChainDomainID,
proofData
);