@hyperlane-xyz/core 1.3.8 → 1.4.1

package/docs/src/SUMMARY.md

@@ -1,128 +0,0 @@
-# Summary
-- [Home](README.md)
-# contracts
-  - [❱ hooks](contracts/hooks/README.md)
-    - [OptimismMessageHook](contracts/hooks/OptimismMessageHook.sol/contract.OptimismMessageHook.md)
-  - [❱ igps](contracts/igps/README.md)
-    - [❱ gas-oracles](contracts/igps/gas-oracles/README.md)
-      - [StorageGasOracle](contracts/igps/gas-oracles/StorageGasOracle.sol/contract.StorageGasOracle.md)
-    - [InterchainGasPaymaster](contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md)
-    - [OverheadIgp](contracts/igps/OverheadIgp.sol/contract.OverheadIgp.md)
-  - [❱ interfaces](contracts/interfaces/README.md)
-    - [❱ hooks](contracts/interfaces/hooks/README.md)
-      - [IMessageHook](contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md)
-    - [❱ isms](contracts/interfaces/isms/README.md)
-      - [IAggregationIsm](contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md)
-      - [IMultisigIsm](contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md)
-      - [IRoutingIsm](contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md)
-    - [❱ middleware](contracts/interfaces/middleware/README.md)
-      - [IInterchainAccountRouter](contracts/interfaces/middleware/IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md)
-      - [IInterchainQueryRouter](contracts/interfaces/middleware/IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md)
-    - [IGasOracle](contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md)
-    - [IHyperlaneConnectionClient](contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
-    - [IInterchainGasPaymaster](contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md)
-    - [IInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
-    - [ISpecifiesInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
-    - [ILiquidityLayerMessageRecipient](contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
-    - [ILiquidityLayerRouter](contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md)
-    - [IMailbox](contracts/interfaces/IMailbox.sol/interface.IMailbox.md)
-    - [IMessageRecipient](contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md)
-    - [IRouter](contracts/interfaces/IRouter.sol/interface.IRouter.md)
-    - [IValidatorAnnounce](contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)
-  - [❱ isms](contracts/isms/README.md)
-    - [❱ aggregation](contracts/isms/aggregation/README.md)
-      - [AbstractAggregationIsm](contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
-      - [StaticAggregationIsm](contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md)
-      - [StaticAggregationIsmFactory](contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md)
-    - [❱ multisig](contracts/isms/multisig/README.md)
-      - [AbstractMerkleRootMultisigIsm](contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md)
-      - [AbstractMessageIdMultisigIsm](contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md)
-      - [AbstractMultisigIsm](contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
-      - [LegacyMultisigIsm](contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md)
-      - [AbstractMetaProxyMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
-      - [StaticMerkleRootMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md)
-      - [StaticMessageIdMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md)
-      - [StaticMerkleRootMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md)
-      - [StaticMessageIdMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md)
-    - [❱ native](contracts/isms/native/README.md)
-      - [AbstractNativeISM](contracts/isms/native/AbstractNativeISM.sol/abstract.AbstractNativeISM.md)
-      - [OptimismISM](contracts/isms/native/OptimismISM.sol/contract.OptimismISM.md)
-    - [❱ routing](contracts/isms/routing/README.md)
-      - [AbstractRoutingIsm](contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md)
-      - [DomainRoutingIsm](contracts/isms/routing/DomainRoutingIsm.sol/contract.DomainRoutingIsm.md)
-      - [DomainRoutingIsmFactory](contracts/isms/routing/DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md)
-      - [InterchainAccountIsm](contracts/isms/routing/InterchainAccountIsm.sol/contract.InterchainAccountIsm.md)
-  - [❱ libs](contracts/libs/README.md)
-    - [❱ isms](contracts/libs/isms/README.md)
-      - [AggregationIsmMetadata](contracts/libs/isms/AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md)
-      - [LegacyMultisigIsmMetadata](contracts/libs/isms/LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md)
-      - [MerkleRootMultisigIsmMetadata](contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md)
-      - [MessageIdMultisigIsmMetadata](contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md)
-    - [❱ middleware](contracts/libs/middleware/README.md)
-      - [InterchainAccountMessage](contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md)
-      - [InterchainQueryMessage](contracts/libs/middleware/InterchainQueryMessage.sol/library.InterchainQueryMessage.md)
-    - [CallLib](contracts/libs/Call.sol/library.CallLib.md)
-    - [CheckpointLib](contracts/libs/CheckpointLib.sol/library.CheckpointLib.md)
-    - [EnumerableMapExtended](contracts/libs/EnumerableMapExtended.sol/library.EnumerableMapExtended.md)
-    - [LegacyCheckpointLib](contracts/libs/LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md)
-    - [MerkleLib](contracts/libs/Merkle.sol/library.MerkleLib.md)
-    - [Message](contracts/libs/Message.sol/library.Message.md)
-    - [MetaProxy](contracts/libs/MetaProxy.sol/library.MetaProxy.md)
-    - [MinimalProxy](contracts/libs/MinimalProxy.sol/library.MinimalProxy.md)
-    - [StaticMOfNAddressSetFactory](contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
-    - [TypeCasts](contracts/libs/TypeCasts.sol/library.TypeCasts.md)
-    - [ValidatorAnnouncements](contracts/libs/ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md)
-  - [❱ middleware](contracts/middleware/README.md)
-    - [❱ liquidity-layer](contracts/middleware/liquidity-layer/README.md)
-      - [❱ adapters](contracts/middleware/liquidity-layer/adapters/README.md)
-        - [CircleBridgeAdapter](contracts/middleware/liquidity-layer/adapters/CircleBridgeAdapter.sol/contract.CircleBridgeAdapter.md)
-        - [PortalAdapter](contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol/contract.PortalAdapter.md)
-      - [❱ interfaces](contracts/middleware/liquidity-layer/interfaces/README.md)
-        - [❱ circle](contracts/middleware/liquidity-layer/interfaces/circle/README.md)
-          - [ICircleMessageTransmitter](contracts/middleware/liquidity-layer/interfaces/circle/ICircleMessageTransmitter.sol/interface.ICircleMessageTransmitter.md)
-          - [ITokenMessenger](contracts/middleware/liquidity-layer/interfaces/circle/ITokenMessenger.sol/interface.ITokenMessenger.md)
-        - [❱ portal](contracts/middleware/liquidity-layer/interfaces/portal/README.md)
-          - [IPortalTokenBridge](contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md)
-        - [ILiquidityLayerAdapter](contracts/middleware/liquidity-layer/interfaces/ILiquidityLayerAdapter.sol/interface.ILiquidityLayerAdapter.md)
-      - [LiquidityLayerRouter](contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol/contract.LiquidityLayerRouter.md)
-    - [InterchainAccountRouter](contracts/middleware/InterchainAccountRouter.sol/contract.InterchainAccountRouter.md)
-    - [InterchainQueryRouter](contracts/middleware/InterchainQueryRouter.sol/contract.InterchainQueryRouter.md)
-  - [❱ mock](contracts/mock/README.md)
-    - [MockCircleMessageTransmitter](contracts/mock/MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md)
-    - [MockCircleTokenMessenger](contracts/mock/MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md)
-    - [MockHyperlaneEnvironment](contracts/mock/MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md)
-    - [MockMailbox](contracts/mock/MockMailbox.sol/contract.MockMailbox.md)
-    - [MockPortalBridge](contracts/mock/MockPortalBridge.sol/contract.MockPortalBridge.md)
-    - [MockToken](contracts/mock/MockToken.sol/contract.MockToken.md)
-  - [❱ test](contracts/test/README.md)
-    - [❱ bad-recipient](contracts/test/bad-recipient/README.md)
-      - [BadRecipient1](contracts/test/bad-recipient/BadRecipient1.sol/contract.BadRecipient1.md)
-      - [BadRecipient2](contracts/test/bad-recipient/BadRecipient2.sol/contract.BadRecipient2.md)
-      - [BadRecipient3](contracts/test/bad-recipient/BadRecipient3.sol/contract.BadRecipient3.md)
-      - [BadRecipient5](contracts/test/bad-recipient/BadRecipient5.sol/contract.BadRecipient5.md)
-      - [BadRecipient6](contracts/test/bad-recipient/BadRecipient6.sol/contract.BadRecipient6.md)
-    - [LightTestRecipient](contracts/test/LightTestRecipient.sol/contract.LightTestRecipient.md)
-    - [TestGasRouter](contracts/test/TestGasRouter.sol/contract.TestGasRouter.md)
-    - [TestHyperlaneConnectionClient](contracts/test/TestHyperlaneConnectionClient.sol/contract.TestHyperlaneConnectionClient.md)
-    - [TestInterchainGasPaymaster](contracts/test/TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md)
-    - [TestLegacyMultisigIsm](contracts/test/TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md)
-    - [TestLiquidityLayerMessageRecipient](contracts/test/TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md)
-    - [TestMailbox](contracts/test/TestMailbox.sol/contract.TestMailbox.md)
-    - [TestMerkle](contracts/test/TestMerkle.sol/contract.TestMerkle.md)
-    - [TestMessage](contracts/test/TestMessage.sol/contract.TestMessage.md)
-    - [TestMultisigIsm](contracts/test/TestMultisigIsm.sol/contract.TestMultisigIsm.md)
-    - [TestQuery](contracts/test/TestQuery.sol/contract.TestQuery.md)
-    - [TestQuerySender](contracts/test/TestQuerySender.sol/contract.TestQuerySender.md)
-    - [TestRecipient](contracts/test/TestRecipient.sol/contract.TestRecipient.md)
-    - [TestRouter](contracts/test/TestRouter.sol/contract.TestRouter.md)
-    - [TestSendReceiver](contracts/test/TestSendReceiver.sol/contract.TestSendReceiver.md)
-    - [TestTokenRecipient](contracts/test/TestTokenRecipient.sol/contract.TestTokenRecipient.md)
-  - [❱ upgrade](contracts/upgrade/README.md)
-    - [Versioned](contracts/upgrade/Versioned.sol/contract.Versioned.md)
-  - [GasRouter](contracts/GasRouter.sol/abstract.GasRouter.md)
-  - [HyperlaneConnectionClient](contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md)
-  - [Mailbox](contracts/Mailbox.sol/contract.Mailbox.md)
-  - [OwnableMulticall](contracts/OwnableMulticall.sol/contract.OwnableMulticall.md)
-  - [PausableReentrancyGuardUpgradeable](contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md)
-  - [Router](contracts/Router.sol/abstract.Router.md)
-  - [ValidatorAnnounce](contracts/ValidatorAnnounce.sol/contract.ValidatorAnnounce.md)

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

@@ -1,124 +0,0 @@
-# GasRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/GasRouter.sol)
-
-**Inherits:**
-[Router](/contracts/Router.sol/abstract.Router.md)
-
-
-## State Variables
-### destinationGas
-
-```solidity
-mapping(uint32 => uint256) public destinationGas;
-```
-
-
-## Functions
-### setDestinationGas
-
-Sets the gas amount dispatched for each configured domain.
-
-
-```solidity
-function setDestinationGas(GasRouterConfig[] calldata gasConfigs) external onlyOwner;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`gasConfigs`|`GasRouterConfig[]`|The array of GasRouterConfig structs|
-
-
-### quoteGasPayment
-
-Returns the gas payment required to dispatch a message to the given domain's router.
-
-
-```solidity
-function quoteGasPayment(uint32 _destinationDomain) external view returns (uint256 _gasPayment);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_destinationDomain`|`uint32`|The domain of the router.|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_gasPayment`|`uint256`|Payment computed by the registered InterchainGasPaymaster.|
-
-
-### _setDestinationGas
-
-
-```solidity
-function _setDestinationGas(uint32 domain, uint256 gas) internal;
-```
-
-### _dispatchWithGas
-
-Dispatches a message to an enrolled router via the local router's Mailbox
-and pays for it to be relayed to the destination.
-
-*Uses the destinationGas mapping to populate the gas amount for the message.*
-
-*Reverts if there is no enrolled router for _destinationDomain.*
-
-
-```solidity
-function _dispatchWithGas(
-    uint32 _destinationDomain,
-    bytes memory _messageBody,
-    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.|
-|`_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.|
-
-
-### _dispatchWithGas
-
-*Passes `msg.value` as gas payment and `msg.sender` as gas payment refund address.*
-
-*Uses the destinationGas mapping to populate the gas amount for the message.*
-
-
-```solidity
-function _dispatchWithGas(uint32 _destinationDomain, bytes memory _messageBody) internal returns (bytes32 _messageId);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_destinationDomain`|`uint32`|The domain of the chain to send the message.|
-|`_messageBody`|`bytes`|Raw bytes content of message.|
-
-
-## Events
-### DestinationGasSet
-Emitted when a domain's destination gas is set.
-
-
-```solidity
-event DestinationGasSet(uint32 indexed domain, uint256 gas);
-```
-
-## Structs
-### GasRouterConfig
-
-```solidity
-struct GasRouterConfig {
-    uint32 domain;
-    uint256 gas;
-}
-```
-

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

@@ -1,191 +0,0 @@
-# HyperlaneConnectionClient
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/HyperlaneConnectionClient.sol)
-
-**Inherits:**
-OwnableUpgradeable, [IHyperlaneConnectionClient](/contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
-
-
-## State Variables
-### mailbox
-
-```solidity
-IMailbox public mailbox;
-```
-
-
-### interchainGasPaymaster
-
-```solidity
-IInterchainGasPaymaster public interchainGasPaymaster;
-```
-
-
-### interchainSecurityModule
-
-```solidity
-IInterchainSecurityModule public interchainSecurityModule;
-```
-
-
-### __GAP
-
-```solidity
-uint256[48] private __GAP;
-```
-
-
-## Functions
-### onlyMailbox
-
-Only accept messages from an Hyperlane Mailbox contract
-
-
-```solidity
-modifier onlyMailbox();
-```
-
-### onlyContract
-
-Only accept addresses that at least have contract code
-
-
-```solidity
-modifier onlyContract(address _contract);
-```
-
-### __HyperlaneConnectionClient_initialize
-
-
-```solidity
-function __HyperlaneConnectionClient_initialize(address _mailbox) internal onlyInitializing;
-```
-
-### __HyperlaneConnectionClient_initialize
-
-
-```solidity
-function __HyperlaneConnectionClient_initialize(address _mailbox, address _interchainGasPaymaster)
-    internal
-    onlyInitializing;
-```
-
-### __HyperlaneConnectionClient_initialize
-
-
-```solidity
-function __HyperlaneConnectionClient_initialize(
-    address _mailbox,
-    address _interchainGasPaymaster,
-    address _interchainSecurityModule
-) internal onlyInitializing;
-```
-
-### __HyperlaneConnectionClient_initialize
-
-
-```solidity
-function __HyperlaneConnectionClient_initialize(
-    address _mailbox,
-    address _interchainGasPaymaster,
-    address _interchainSecurityModule,
-    address _owner
-) internal onlyInitializing;
-```
-
-### setMailbox
-
-Sets the address of the application's Mailbox.
-
-
-```solidity
-function setMailbox(address _mailbox) external virtual onlyOwner;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_mailbox`|`address`|The address of the Mailbox contract.|
-
-
-### setInterchainGasPaymaster
-
-Sets the address of the application's InterchainGasPaymaster.
-
-
-```solidity
-function setInterchainGasPaymaster(address _interchainGasPaymaster) external virtual onlyOwner;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
-
-
-### setInterchainSecurityModule
-
-
-```solidity
-function setInterchainSecurityModule(address _module) external virtual onlyOwner;
-```
-
-### _setInterchainGasPaymaster
-
-Sets the address of the application's InterchainGasPaymaster.
-
-
-```solidity
-function _setInterchainGasPaymaster(address _interchainGasPaymaster) internal onlyContract(_interchainGasPaymaster);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
-
-
-### _setMailbox
-
-Modify the contract the Application uses to validate Mailbox contracts
-
-
-```solidity
-function _setMailbox(address _mailbox) internal onlyContract(_mailbox);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_mailbox`|`address`|The address of the mailbox contract|
-
-
-### _setInterchainSecurityModule
-
-
-```solidity
-function _setInterchainSecurityModule(address _module) internal;
-```
-
-## Events
-### MailboxSet
-Emitted when a new mailbox is set.
-
-
-```solidity
-event MailboxSet(address indexed mailbox);
-```
-
-### InterchainGasPaymasterSet
-Emitted when a new Interchain Gas Paymaster is set.
-
-
-```solidity
-event InterchainGasPaymasterSet(address indexed interchainGasPaymaster);
-```
-
-### InterchainSecurityModuleSet
-
-```solidity
-event InterchainSecurityModuleSet(address indexed module);
-```
-

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

@@ -1,251 +0,0 @@
-# Mailbox
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/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();
-```
-