@hyperlane-xyz/core 1.4.1 → 1.4.2

package/docs/src/contracts/Mailbox.sol/contract.Mailbox.md

@@ -0,0 +1,251 @@
+# Mailbox
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/Mailbox.sol)
+
+**Inherits:**
+[IMailbox](/contracts/interfaces/IMailbox.sol/interface.IMailbox.md), OwnableUpgradeable, [PausableReentrancyGuardUpgradeable](/contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md), [Versioned](/contracts/upgrade/Versioned.sol/contract.Versioned.md)
+
+
+## State Variables
+### MAX_MESSAGE_BODY_BYTES
+
+```solidity
+uint256 public constant MAX_MESSAGE_BODY_BYTES = 2 * 2 ** 10;
+```
+
+
+### localDomain
+
+```solidity
+uint32 public immutable localDomain;
+```
+
+
+### defaultIsm
+
+```solidity
+IInterchainSecurityModule public defaultIsm;
+```
+
+
+### tree
+
+```solidity
+MerkleLib.Tree public tree;
+```
+
+
+### delivered
+
+```solidity
+mapping(bytes32 => bool) public delivered;
+```
+
+
+### __GAP
+
+```solidity
+uint256[47] private __GAP;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _localDomain);
+```
+
+### initialize
+
+
+```solidity
+function initialize(address _owner, address _defaultIsm) external initializer;
+```
+
+### setDefaultIsm
+
+Sets the default ISM for the Mailbox.
+
+
+```solidity
+function setDefaultIsm(address _module) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_module`|`address`|The new default ISM. Must be a contract.|
+
+
+### dispatch
+
+Dispatches a message to the destination domain & recipient.
+
+
+```solidity
+function dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes calldata _messageBody)
+    external
+    override
+    notPaused
+    returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|Domain of destination chain|
+|`_recipientAddress`|`bytes32`|Address of recipient on destination chain as bytes32|
+|`_messageBody`|`bytes`|Raw bytes content of message body|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|The message ID inserted into the Mailbox's merkle tree|
+
+
+### process
+
+Attempts to deliver `_message` to its recipient. Verifies
+`_message` via the recipient's ISM using the provided `_metadata`.
+
+
+```solidity
+function process(bytes calldata _metadata, bytes calldata _message) external override nonReentrantAndNotPaused;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|Metadata used by the ISM to verify `_message`.|
+|`_message`|`bytes`|Formatted Hyperlane message (refer to Message.sol).|
+
+
+### root
+
+Calculates and returns tree's current root
+
+
+```solidity
+function root() public view returns (bytes32);
+```
+
+### count
+
+Returns the number of inserted leaves in the tree
+
+
+```solidity
+function count() public view returns (uint32);
+```
+
+### latestCheckpoint
+
+Returns a checkpoint representing the current merkle tree.
+
+
+```solidity
+function latestCheckpoint() external view returns (bytes32, uint32);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|root The root of the Mailbox's merkle tree.|
+|`<none>`|`uint32`|index The index of the last element in the tree.|
+
+
+### pause
+
+Pauses mailbox and prevents further dispatch/process calls
+
+*Only `owner` can pause the mailbox.*
+
+
+```solidity
+function pause() external onlyOwner;
+```
+
+### unpause
+
+Unpauses mailbox and allows for message processing.
+
+*Only `owner` can unpause the mailbox.*
+
+
+```solidity
+function unpause() external onlyOwner;
+```
+
+### isPaused
+
+Returns whether mailbox is paused.
+
+
+```solidity
+function isPaused() external view returns (bool);
+```
+
+### recipientIsm
+
+Returns the ISM to use for the recipient, defaulting to the
+default ISM if none is specified.
+
+
+```solidity
+function recipientIsm(address _recipient) public view returns (IInterchainSecurityModule);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_recipient`|`address`|The message recipient whose ISM should be returned.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IInterchainSecurityModule`|The ISM to use for `_recipient`.|
+
+
+### _setDefaultIsm
+
+Sets the default ISM for the Mailbox.
+
+
+```solidity
+function _setDefaultIsm(address _module) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_module`|`address`|The new default ISM. Must be a contract.|
+
+
+## Events
+### DefaultIsmSet
+Emitted when the default ISM is updated
+
+
+```solidity
+event DefaultIsmSet(address indexed module);
+```
+
+### Paused
+Emitted when Mailbox is paused
+
+
+```solidity
+event Paused();
+```
+
+### Unpaused
+Emitted when Mailbox is unpaused
+
+
+```solidity
+event Unpaused();
+```
+

package/docs/src/contracts/OwnableMulticall.sol/contract.OwnableMulticall.md

@@ -0,0 +1,41 @@
+# OwnableMulticall
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/OwnableMulticall.sol)
+
+
+## State Variables
+### owner
+
+```solidity
+address public immutable owner;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address _owner);
+```
+
+### onlyOwner
+
+
+```solidity
+modifier onlyOwner();
+```
+
+### multicall
+
+
+```solidity
+function multicall(CallLib.Call[] calldata calls) external onlyOwner;
+```
+
+### receive
+
+
+```solidity
+receive() external payable;
+```
+

package/docs/src/contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md

@@ -0,0 +1,100 @@
+# PausableReentrancyGuardUpgradeable
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/PausableReentrancyGuard.sol)
+
+**Inherits:**
+Initializable
+
+
+## State Variables
+### _ENTERED
+
+```solidity
+uint256 private constant _ENTERED = 0;
+```
+
+
+### _NOT_ENTERED
+
+```solidity
+uint256 private constant _NOT_ENTERED = 1;
+```
+
+
+### _PAUSED
+
+```solidity
+uint256 private constant _PAUSED = 2;
+```
+
+
+### _status
+
+```solidity
+uint256 private _status;
+```
+
+
+### __gap
+*This empty reserved space is put in place to allow future versions to add new
+variables without shifting down storage in the inheritance chain.
+See https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps*
+
+
+```solidity
+uint256[49] private __gap;
+```
+
+
+## Functions
+### __PausableReentrancyGuard_init
+
+*MUST be called for `nonReentrant` to not always revert*
+
+
+```solidity
+function __PausableReentrancyGuard_init() internal onlyInitializing;
+```
+
+### _isPaused
+
+
+```solidity
+function _isPaused() internal view returns (bool);
+```
+
+### _pause
+
+
+```solidity
+function _pause() internal notPaused;
+```
+
+### _unpause
+
+
+```solidity
+function _unpause() internal;
+```
+
+### notPaused
+
+*Prevents a contract from being entered when paused.*
+
+
+```solidity
+modifier notPaused();
+```
+
+### nonReentrantAndNotPaused
+
+*Prevents a contract from calling itself, directly or indirectly.
+Calling a `nonReentrant` function from another `nonReentrant`
+function is not supported. It is possible to prevent this from happening
+by making the `nonReentrant` function external, and making it call a
+`private` function that does the actual work.*
+
+
+```solidity
+modifier nonReentrantAndNotPaused();
+```
+

package/docs/src/contracts/README.md

@@ -0,0 +1,19 @@
+
+
+# Contents
+- [hooks](/contracts/hooks)
+- [igps](/contracts/igps)
+- [interfaces](/contracts/interfaces)
+- [isms](/contracts/isms)
+- [libs](/contracts/libs)
+- [middleware](/contracts/middleware)
+- [mock](/contracts/mock)
+- [test](/contracts/test)
+- [upgrade](/contracts/upgrade)
+- [GasRouter](GasRouter.sol/abstract.GasRouter.md)
+- [HyperlaneConnectionClient](HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md)
+- [Mailbox](Mailbox.sol/contract.Mailbox.md)
+- [OwnableMulticall](OwnableMulticall.sol/contract.OwnableMulticall.md)
+- [PausableReentrancyGuardUpgradeable](PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md)
+- [Router](Router.sol/abstract.Router.md)
+- [ValidatorAnnounce](ValidatorAnnounce.sol/contract.ValidatorAnnounce.md)

package/docs/src/contracts/Router.sol/abstract.Router.md

@@ -0,0 +1,255 @@
+# Router
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/Router.sol)
+
+**Inherits:**
+[HyperlaneConnectionClient](/contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md), [IMessageRecipient](/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md)
+
+
+## State Variables
+### NO_ROUTER_ENROLLED_REVERT_MESSAGE
+
+```solidity
+string private constant NO_ROUTER_ENROLLED_REVERT_MESSAGE =
+    "No router enrolled for domain. Did you specify the right domain ID?";
+```
+
+
+### _routers
+
+```solidity
+EnumerableMapExtended.UintToBytes32Map internal _routers;
+```
+
+
+### __GAP
+
+```solidity
+uint256[49] private __GAP;
+```
+
+
+## Functions
+### onlyRemoteRouter
+
+Only accept messages from a remote Router contract
+
+
+```solidity
+modifier onlyRemoteRouter(uint32 _origin, bytes32 _router);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_origin`|`uint32`|The domain the message is coming from|
+|`_router`|`bytes32`|The address the message is coming from|
+
+
+### __Router_initialize
+
+
+```solidity
+function __Router_initialize(address _mailbox) internal onlyInitializing;
+```
+
+### __Router_initialize
+
+
+```solidity
+function __Router_initialize(address _mailbox, address _interchainGasPaymaster) internal onlyInitializing;
+```
+
+### __Router_initialize
+
+
+```solidity
+function __Router_initialize(address _mailbox, address _interchainGasPaymaster, address _interchainSecurityModule)
+    internal
+    onlyInitializing;
+```
+
+### domains
+
+
+```solidity
+function domains() external view returns (uint32[] memory);
+```
+
+### routers
+
+
+```solidity
+function routers(uint32 _domain) public view returns (bytes32);
+```
+
+### enrollRemoteRouter
+
+Register the address of a Router contract for the same Application on a remote chain
+
+
+```solidity
+function enrollRemoteRouter(uint32 _domain, bytes32 _router) external virtual onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The domain of the remote Application Router|
+|`_router`|`bytes32`|The address of the remote Application Router|
+
+
+### enrollRemoteRouters
+
+Batch version of `enrollRemoteRouter`
+
+
+```solidity
+function enrollRemoteRouters(uint32[] calldata _domains, bytes32[] calldata _addresses) external virtual onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domains`|`uint32[]`|The domaisn of the remote Application Routers|
+|`_addresses`|`bytes32[]`|The addresses of the remote Application Routers|
+
+
+### handle
+
+Handles an incoming message
+
+
+```solidity
+function handle(uint32 _origin, bytes32 _sender, bytes calldata _message)
+    external
+    virtual
+    override
+    onlyMailbox
+    onlyRemoteRouter(_origin, _sender);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_origin`|`uint32`|The origin domain|
+|`_sender`|`bytes32`|The sender address|
+|`_message`|`bytes`|The message|
+
+
+### _handle
+
+
+```solidity
+function _handle(uint32 _origin, bytes32 _sender, bytes calldata _message) internal virtual;
+```
+
+### _enrollRemoteRouter
+
+Set the router for a given domain
+
+
+```solidity
+function _enrollRemoteRouter(uint32 _domain, bytes32 _address) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The domain|
+|`_address`|`bytes32`|The new router|
+
+
+### _isRemoteRouter
+
+Return true if the given domain / router is the address of a remote Application Router
+
+
+```solidity
+function _isRemoteRouter(uint32 _domain, bytes32 _address) internal view returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The domain of the potential remote Application Router|
+|`_address`|`bytes32`|The address of the potential remote Application Router|
+
+
+### _mustHaveRemoteRouter
+
+Assert that the given domain has a Application Router registered and return its address
+
+
+```solidity
+function _mustHaveRemoteRouter(uint32 _domain) internal view returns (bytes32 _router);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The domain of the chain for which to get the Application Router|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_router`|`bytes32`|The address of the remote Application Router on _domain|
+
+
+### _dispatchWithGas
+
+Dispatches a message to an enrolled router via the local router's Mailbox
+and pays for it to be relayed to the destination.
+
+*Reverts if there is no enrolled router for _destinationDomain.*
+
+
+```solidity
+function _dispatchWithGas(
+    uint32 _destinationDomain,
+    bytes memory _messageBody,
+    uint256 _gasAmount,
+    uint256 _gasPayment,
+    address _gasPaymentRefundAddress
+) internal returns (bytes32 _messageId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the chain to which to send the message.|
+|`_messageBody`|`bytes`|Raw bytes content of message.|
+|`_gasAmount`|`uint256`|The amount of destination gas for the message that is requested via the InterchainGasPaymaster.|
+|`_gasPayment`|`uint256`|The amount of native tokens to pay for the message to be relayed.|
+|`_gasPaymentRefundAddress`|`address`|The address to refund any gas overpayment to.|
+
+
+### _dispatch
+
+Dispatches a message to an enrolled router via the provided Mailbox.
+
+*Does not pay interchain gas.*
+
+*Reverts if there is no enrolled router for _destinationDomain.*
+
+
+```solidity
+function _dispatch(uint32 _destinationDomain, bytes memory _messageBody) internal virtual returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the chain to which to send the message.|
+|`_messageBody`|`bytes`|Raw bytes content of message.|
+
+
+## Events
+### RemoteRouterEnrolled
+Emitted when a router is set.
+
+
+```solidity
+event RemoteRouterEnrolled(uint32 indexed domain, bytes32 router);
+```
+