@hyperlane-xyz/core 1.4.1 → 1.4.2

package/docs/src/contracts/igps/gas-oracles/StorageGasOracle.sol/contract.StorageGasOracle.md

@@ -0,0 +1,114 @@
+# StorageGasOracle
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/igps/gas-oracles/StorageGasOracle.sol)
+
+**Inherits:**
+[IGasOracle](/contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md), Ownable
+
+A gas oracle that uses data stored within the contract.
+
+*This contract is intended to be owned by an address that will
+update the stored remote gas data.*
+
+
+## State Variables
+### remoteGasData
+Keyed by remote domain, gas data on that remote domain.
+
+
+```solidity
+mapping(uint32 => IGasOracle.RemoteGasData) public remoteGasData;
+```
+
+
+## Functions
+### getExchangeRateAndGasPrice
+
+Returns the stored `remoteGasData` for the `_destinationDomain`.
+
+
+```solidity
+function getExchangeRateAndGasPrice(uint32 _destinationDomain)
+    external
+    view
+    override
+    returns (uint128 tokenExchangeRate, uint128 gasPrice);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The destination domain.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`tokenExchangeRate`|`uint128`|The exchange rate of the remote native token quoted in the local native token.|
+|`gasPrice`|`uint128`|The gas price on the remote chain.|
+
+
+### setRemoteGasDataConfigs
+
+Sets the remote gas data for many remotes at a time.
+
+
+```solidity
+function setRemoteGasDataConfigs(RemoteGasDataConfig[] calldata _configs) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_configs`|`RemoteGasDataConfig[]`|The configs to use when setting the remote gas data.|
+
+
+### setRemoteGasData
+
+Sets the remote gas data using the values in `_config`.
+
+
+```solidity
+function setRemoteGasData(RemoteGasDataConfig calldata _config) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_config`|`RemoteGasDataConfig`|The config to use when setting the remote gas data.|
+
+
+### _setRemoteGasData
+
+Sets the remote gas data using the values in `_config`.
+
+
+```solidity
+function _setRemoteGasData(RemoteGasDataConfig calldata _config) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_config`|`RemoteGasDataConfig`|The config to use when setting the remote gas data.|
+
+
+## Events
+### RemoteGasDataSet
+Emitted when an entry in `remoteGasData` is set.
+
+
+```solidity
+event RemoteGasDataSet(uint32 indexed remoteDomain, uint128 tokenExchangeRate, uint128 gasPrice);
+```
+
+## Structs
+### RemoteGasDataConfig
+
+```solidity
+struct RemoteGasDataConfig {
+    uint32 remoteDomain;
+    uint128 tokenExchangeRate;
+    uint128 gasPrice;
+}
+```
+

package/docs/src/contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md

@@ -0,0 +1,25 @@
+# IGasOracle
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IGasOracle.sol)
+
+
+## Functions
+### getExchangeRateAndGasPrice
+
+
+```solidity
+function getExchangeRateAndGasPrice(uint32 _destinationDomain)
+    external
+    view
+    returns (uint128 tokenExchangeRate, uint128 gasPrice);
+```
+
+## Structs
+### RemoteGasData
+
+```solidity
+struct RemoteGasData {
+    uint128 tokenExchangeRate;
+    uint128 gasPrice;
+}
+```
+

package/docs/src/contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md

@@ -0,0 +1,43 @@
+# IHyperlaneConnectionClient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IHyperlaneConnectionClient.sol)
+
+**Inherits:**
+[ISpecifiesInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
+
+
+## Functions
+### mailbox
+
+
+```solidity
+function mailbox() external view returns (IMailbox);
+```
+
+### interchainGasPaymaster
+
+
+```solidity
+function interchainGasPaymaster() external view returns (IInterchainGasPaymaster);
+```
+
+### setMailbox
+
+
+```solidity
+function setMailbox(address) external;
+```
+
+### setInterchainGasPaymaster
+
+
+```solidity
+function setInterchainGasPaymaster(address) external;
+```
+
+### setInterchainSecurityModule
+
+
+```solidity
+function setInterchainSecurityModule(address) external;
+```
+

package/docs/src/contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md

@@ -0,0 +1,33 @@
+# IInterchainGasPaymaster
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IInterchainGasPaymaster.sol)
+
+Manages payments on a source chain to cover gas costs of relaying
+messages to destination chains.
+
+
+## Functions
+### payForGas
+
+
+```solidity
+function payForGas(bytes32 _messageId, uint32 _destinationDomain, uint256 _gasAmount, address _refundAddress)
+    external
+    payable;
+```
+
+### quoteGasPayment
+
+
+```solidity
+function quoteGasPayment(uint32 _destinationDomain, uint256 _gasAmount) external view returns (uint256);
+```
+
+## Events
+### GasPayment
+Emitted when a payment is made for a message's gas costs.
+
+
+```solidity
+event GasPayment(bytes32 indexed messageId, uint256 gasAmount, uint256 payment);
+```
+

package/docs/src/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md

@@ -0,0 +1,55 @@
+# IInterchainSecurityModule
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IInterchainSecurityModule.sol)
+
+
+## Functions
+### moduleType
+
+Returns an enum that represents the type of security model
+encoded by this ISM.
+
+*Relayers infer how to fetch and format metadata.*
+
+
+```solidity
+function moduleType() external view returns (uint8);
+```
+
+### verify
+
+Defines a security model responsible for verifying interchain
+messages based on the provided metadata.
+
+
+```solidity
+function verify(bytes calldata _metadata, bytes calldata _message) external returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|Off-chain metadata provided by a relayer, specific to the security model encoded by the module (e.g. validator signatures)|
+|`_message`|`bytes`|Hyperlane encoded interchain message|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|True if the message was verified|
+
+
+## Enums
+### Types
+
+```solidity
+enum Types {
+    UNUSED,
+    ROUTING,
+    AGGREGATION,
+    LEGACY_MULTISIG,
+    MERKLE_ROOT_MULTISIG,
+    MESSAGE_ID_MULTISIG,
+    NULL
+}
+```
+

package/docs/src/contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md

@@ -0,0 +1,12 @@
+# ISpecifiesInterchainSecurityModule
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IInterchainSecurityModule.sol)
+
+
+## Functions
+### interchainSecurityModule
+
+
+```solidity
+function interchainSecurityModule() external view returns (IInterchainSecurityModule);
+```
+

package/docs/src/contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md

@@ -0,0 +1,13 @@
+# ILiquidityLayerMessageRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/ILiquidityLayerMessageRecipient.sol)
+
+
+## Functions
+### handleWithTokens
+
+
+```solidity
+function handleWithTokens(uint32 _origin, bytes32 _sender, bytes calldata _message, address _token, uint256 _amount)
+    external;
+```
+

package/docs/src/contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md

@@ -0,0 +1,19 @@
+# ILiquidityLayerRouter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/ILiquidityLayerRouter.sol)
+
+
+## Functions
+### dispatchWithTokens
+
+
+```solidity
+function dispatchWithTokens(
+    uint32 _destinationDomain,
+    bytes32 _recipientAddress,
+    address _token,
+    uint256 _amount,
+    string calldata _bridge,
+    bytes calldata _messageBody
+) external returns (bytes32);
+```
+

package/docs/src/contracts/interfaces/IMailbox.sol/interface.IMailbox.md

@@ -0,0 +1,103 @@
+# IMailbox
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IMailbox.sol)
+
+
+## Functions
+### localDomain
+
+
+```solidity
+function localDomain() external view returns (uint32);
+```
+
+### delivered
+
+
+```solidity
+function delivered(bytes32 messageId) external view returns (bool);
+```
+
+### defaultIsm
+
+
+```solidity
+function defaultIsm() external view returns (IInterchainSecurityModule);
+```
+
+### dispatch
+
+
+```solidity
+function dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes calldata _messageBody)
+    external
+    returns (bytes32);
+```
+
+### process
+
+
+```solidity
+function process(bytes calldata _metadata, bytes calldata _message) external;
+```
+
+### count
+
+
+```solidity
+function count() external view returns (uint32);
+```
+
+### root
+
+
+```solidity
+function root() external view returns (bytes32);
+```
+
+### latestCheckpoint
+
+
+```solidity
+function latestCheckpoint() external view returns (bytes32, uint32);
+```
+
+### recipientIsm
+
+
+```solidity
+function recipientIsm(address _recipient) external view returns (IInterchainSecurityModule);
+```
+
+## Events
+### Dispatch
+Emitted when a new message is dispatched via Hyperlane
+
+
+```solidity
+event Dispatch(address indexed sender, uint32 indexed destination, bytes32 indexed recipient, bytes message);
+```
+
+### DispatchId
+Emitted when a new message is dispatched via Hyperlane
+
+
+```solidity
+event DispatchId(bytes32 indexed messageId);
+```
+
+### ProcessId
+Emitted when a Hyperlane message is processed
+
+
+```solidity
+event ProcessId(bytes32 indexed messageId);
+```
+
+### Process
+Emitted when a Hyperlane message is delivered
+
+
+```solidity
+event Process(uint32 indexed origin, bytes32 indexed sender, address indexed recipient);
+```
+

package/docs/src/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md

@@ -0,0 +1,12 @@
+# IMessageRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IMessageRecipient.sol)
+
+
+## Functions
+### handle
+
+
+```solidity
+function handle(uint32 _origin, bytes32 _sender, bytes calldata _message) external;
+```
+

package/docs/src/contracts/interfaces/IRouter.sol/interface.IRouter.md

@@ -0,0 +1,33 @@
+# IRouter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IRouter.sol)
+
+
+## Functions
+### domains
+
+
+```solidity
+function domains() external view returns (uint32[] memory);
+```
+
+### routers
+
+
+```solidity
+function routers(uint32 _domain) external view returns (bytes32);
+```
+
+### enrollRemoteRouter
+
+
+```solidity
+function enrollRemoteRouter(uint32 _domain, bytes32 _router) external;
+```
+
+### enrollRemoteRouters
+
+
+```solidity
+function enrollRemoteRouters(uint32[] calldata _domains, bytes32[] calldata _routers) external;
+```
+

package/docs/src/contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md

@@ -0,0 +1,78 @@
+# IValidatorAnnounce
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IValidatorAnnounce.sol)
+
+
+## Functions
+### localDomain
+
+Returns the local domain for validator announcements
+
+
+```solidity
+function localDomain() external view returns (uint32);
+```
+
+### mailbox
+
+Returns the mailbox contract for validator announcements
+
+
+```solidity
+function mailbox() external view returns (address);
+```
+
+### getAnnouncedValidators
+
+Returns a list of validators that have made announcements
+
+
+```solidity
+function getAnnouncedValidators() external view returns (address[] memory);
+```
+
+### getAnnouncedStorageLocations
+
+Returns a list of all announced storage locations for `validators`
+
+
+```solidity
+function getAnnouncedStorageLocations(address[] calldata _validators) external view returns (string[][] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_validators`|`address[]`|The list of validators to get storage locations for|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`string[][]`|A list of announced storage locations|
+
+
+### 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|
+
+

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

@@ -0,0 +1,17 @@
+
+
+# Contents
+- [hooks](/contracts/interfaces/hooks)
+- [isms](/contracts/interfaces/isms)
+- [middleware](/contracts/interfaces/middleware)
+- [IGasOracle](IGasOracle.sol/interface.IGasOracle.md)
+- [IHyperlaneConnectionClient](IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
+- [IInterchainGasPaymaster](IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md)
+- [IInterchainSecurityModule](IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
+- [ISpecifiesInterchainSecurityModule](IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
+- [ILiquidityLayerMessageRecipient](ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
+- [ILiquidityLayerRouter](ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md)
+- [IMailbox](IMailbox.sol/interface.IMailbox.md)
+- [IMessageRecipient](IMessageRecipient.sol/interface.IMessageRecipient.md)
+- [IRouter](IRouter.sol/interface.IRouter.md)
+- [IValidatorAnnounce](IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)

package/docs/src/contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md

@@ -0,0 +1,12 @@
+# IMessageHook
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/hooks/IMessageHook.sol)
+
+
+## Functions
+### postDispatch
+
+
+```solidity
+function postDispatch(uint32 _destination, bytes32 _messageId) external payable returns (uint256);
+```
+

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

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

package/docs/src/contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md

@@ -0,0 +1,36 @@
+# IAggregationIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IAggregationIsm.sol)
+
+**Inherits:**
+[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
+
+
+## Functions
+### modulesAndThreshold
+
+Returns the set of modules responsible for verifying _message
+and the number of modules that must verify
+
+*Can change based on the content of _message*
+
+
+```solidity
+function modulesAndThreshold(bytes calldata _message)
+    external
+    view
+    returns (address[] memory modules, uint8 threshold);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|Hyperlane formatted interchain message|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`modules`|`address[]`|The array of ISM addresses|
+|`threshold`|`uint8`|The number of modules needed to verify|
+
+

package/docs/src/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md

@@ -0,0 +1,36 @@
+# IMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IMultisigIsm.sol)
+
+**Inherits:**
+[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
+
+
+## Functions
+### validatorsAndThreshold
+
+Returns the set of validators responsible for verifying _message
+and the number of signatures required
+
+*Can change based on the content of _message*
+
+
+```solidity
+function validatorsAndThreshold(bytes calldata _message)
+    external
+    view
+    returns (address[] memory validators, uint8 threshold);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|Hyperlane formatted interchain message|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`validators`|`address[]`|The array of validator addresses|
+|`threshold`|`uint8`|The number of validator signatures needed|
+
+

package/docs/src/contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md

@@ -0,0 +1,31 @@
+# IRoutingIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IRoutingIsm.sol)
+
+**Inherits:**
+[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
+
+
+## Functions
+### route
+
+Returns the ISM responsible for verifying _message
+
+*Can change based on the content of _message*
+
+
+```solidity
+function route(bytes calldata _message) external view returns (IInterchainSecurityModule);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`IInterchainSecurityModule`|module The ISM to use to verify _message|
+
+