IMailbox

Git Source

is imported from (https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/main/solidity/contracts/interfaces/IMailbox.sol)

Functions

localDomain

function localDomain() external view returns (uint32);

delivered

function delivered(bytes32 messageId) external view returns (bool);

dispatch

function dispatch(
    uint32 _destinationDomain,
    bytes32 _recipientAddress,
    bytes calldata _messageBody
)
    external
    returns (bytes32);

process

function process(bytes calldata _metadata, bytes calldata _message) external;

count

function count() external view returns (uint32);

root

function root() external view returns (bytes32);

latestCheckpoint

function latestCheckpoint() external view returns (bytes32, uint32);

Events

Dispatch

Emitted when a new message is dispatched via Hyperlane

event Dispatch(address indexed sender, uint32 indexed destination, bytes32 indexed recipient, bytes message);

Parameters

Name	Type	Description
`sender`	`address`	The address that dispatched the message
`destination`	`uint32`	The destination domain of the message
`recipient`	`bytes32`	The message recipient address on `destination`
`message`	`bytes`	Raw bytes of message

DispatchId

Emitted when a new message is dispatched via Hyperlane

event DispatchId(bytes32 indexed messageId);

Parameters

Name	Type	Description
`messageId`	`bytes32`	The unique message identifier

ProcessId

Emitted when a Hyperlane message is processed

event ProcessId(bytes32 indexed messageId);

Parameters

Name	Type	Description
`messageId`	`bytes32`	The unique message identifier

Process

Emitted when a Hyperlane message is delivered

event Process(uint32 indexed origin, bytes32 indexed sender, address indexed recipient);

Parameters

Name	Type	Description
`origin`	`uint32`	The origin domain of the message
`sender`	`bytes32`	The message sender address on `origin`
`recipient`	`address`	The address that handled the message