@hyperlane-xyz/core 1.4.0 → 1.4.2

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);
+```
+

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

@@ -0,0 +1,117 @@
+# ValidatorAnnounce
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/ValidatorAnnounce.sol)
+
+**Inherits:**
+[IValidatorAnnounce](/contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)
+
+Stores the location(s) of validator signed checkpoints
+
+
+## State Variables
+### mailbox
+
+```solidity
+address public immutable mailbox;
+```
+
+
+### localDomain
+
+```solidity
+uint32 public immutable localDomain;
+```
+
+
+### validators
+
+```solidity
+EnumerableSet.AddressSet private validators;
+```
+
+
+### storageLocations
+
+```solidity
+mapping(address => string[]) private storageLocations;
+```
+
+
+### replayProtection
+
+```solidity
+mapping(bytes32 => bool) private replayProtection;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address _mailbox);
+```
+
+### announce
+
+Announces a validator signature storage location
+
+
+```solidity
+function announce(address _validator, string calldata _storageLocation, bytes calldata _signature)
+    external
+    returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_validator`|`address`||
+|`_storageLocation`|`string`|Information encoding the location of signed checkpoints|
+|`_signature`|`bytes`|The signed validator announcement|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|True upon success|
+
+
+### getAnnouncedStorageLocations
+
+Returns a list of all announced storage locations
+
+
+```solidity
+function getAnnouncedStorageLocations(address[] calldata _validators) external view returns (string[][] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_validators`|`address[]`|The list of validators to get registrations for|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`string[][]`|A list of registered storage metadata|
+
+
+### getAnnouncedValidators
+
+Returns a list of validators that have made announcements
+
+
+```solidity
+function getAnnouncedValidators() external view returns (address[] memory);
+```
+
+## Events
+### ValidatorAnnouncement
+Emitted when a new validator announcement is made
+
+
+```solidity
+event ValidatorAnnouncement(address indexed validator, string storageLocation);
+```
+

package/docs/src/contracts/hooks/ERC5164/ERC5164MessageHook.sol/contract.ERC5164MessageHook.md

@@ -0,0 +1,64 @@
+# ERC5164MessageHook
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/hooks/ERC5164/ERC5164MessageHook.sol)
+
+**Inherits:**
+[IMessageHook](/contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md)
+
+Message hook to inform the 5164 ISM of messages published through
+any of the 5164 adapters.
+
+
+## State Variables
+### destinationDomain
+
+```solidity
+uint32 public immutable destinationDomain;
+```
+
+
+### dispatcher
+
+```solidity
+IMessageDispatcher public immutable dispatcher;
+```
+
+
+### ism
+
+```solidity
+address public immutable ism;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _destinationDomain, address _dispatcher, address _ism);
+```
+
+### postDispatch
+
+Hook to inform the ERC5164ISM of messages published through.
+
+*anyone can call this function, that's why we need to send msg.sender*
+
+
+```solidity
+function postDispatch(uint32 _destinationDomain, bytes32 _messageId) public payable override returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The destination domain of the message.|
+|`_messageId`|`bytes32`|The message ID.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|gasOverhead The gas overhead for the function call on destination.|
+
+

package/docs/src/contracts/hooks/ERC5164/README.md

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [interfaces](/contracts/hooks/ERC5164/interfaces)
+- [ERC5164MessageHook](ERC5164MessageHook.sol/contract.ERC5164MessageHook.md)

package/docs/src/contracts/hooks/ERC5164/interfaces/IMessageDispatcher.sol/interface.IMessageDispatcher.md

@@ -0,0 +1,25 @@
+# IMessageDispatcher
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/hooks/ERC5164/interfaces/IMessageDispatcher.sol)
+
+*See https://eips.ethereum.org/EIPS/eip-5164*
+
+
+## Functions
+### dispatchMessage
+
+
+```solidity
+function dispatchMessage(uint256 toChainId, address to, bytes calldata data) external returns (bytes32);
+```
+
+## Events
+### MessageDispatched
+Emitted when a message has successfully been dispatched to the executor chain.
+
+
+```solidity
+event MessageDispatched(
+    bytes32 indexed messageId, address indexed from, uint256 indexed toChainId, address to, bytes data
+);
+```
+

package/docs/src/contracts/hooks/ERC5164/interfaces/README.md

@@ -0,0 +1,4 @@
+
+
+# Contents
+- [IMessageDispatcher](IMessageDispatcher.sol/interface.IMessageDispatcher.md)

package/docs/src/contracts/hooks/OptimismMessageHook.sol/contract.OptimismMessageHook.md

@@ -0,0 +1,71 @@
+# OptimismMessageHook
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/hooks/OptimismMessageHook.sol)
+
+**Inherits:**
+[IMessageHook](/contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md)
+
+Message hook to inform the Optimism ISM of messages published through
+the native Optimism bridge.
+
+
+## State Variables
+### destinationDomain
+
+```solidity
+uint32 public immutable destinationDomain;
+```
+
+
+### l1Messenger
+
+```solidity
+ICrossDomainMessenger public immutable l1Messenger;
+```
+
+
+### ism
+
+```solidity
+address public immutable ism;
+```
+
+
+### GAS_LIMIT
+
+```solidity
+uint32 internal constant GAS_LIMIT = 1_920_000;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _destinationDomain, address _messenger, address _ism);
+```
+
+### postDispatch
+
+Hook to inform the optimism ISM of messages published through.
+
+*anyone can call this function, that's why we need to send msg.sender*
+
+
+```solidity
+function postDispatch(uint32 _destination, bytes32 _messageId) public payable override returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destination`|`uint32`|The destination domain of the message.|
+|`_messageId`|`bytes32`|The message ID.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|gasOverhead The gas overhead for the function call on L2.|
+
+

package/docs/src/contracts/hooks/README.md

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [ERC5164](/contracts/hooks/ERC5164)
+- [OptimismMessageHook](OptimismMessageHook.sol/contract.OptimismMessageHook.md)