@hyperlane-xyz/core 1.4.2 → 1.4.3-beta0

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

@@ -1,124 +0,0 @@
-# GasRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/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/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/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/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

@@ -1,41 +0,0 @@
-# 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

@@ -1,100 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-
-
-# 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)