@hyperlane-xyz/core 1.4.1 → 1.4.2

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)

package/docs/src/contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md

@@ -0,0 +1,231 @@
+# InterchainGasPaymaster
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/igps/InterchainGasPaymaster.sol)
+
+**Inherits:**
+[IInterchainGasPaymaster](/contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md), [IGasOracle](/contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md), OwnableUpgradeable
+
+Manages payments on a source chain to cover gas costs of relaying
+messages to destination chains.
+
+
+## State Variables
+### TOKEN_EXCHANGE_RATE_SCALE
+The scale of gas oracle token exchange rates.
+
+
+```solidity
+uint256 internal constant TOKEN_EXCHANGE_RATE_SCALE = 1e10;
+```
+
+
+### gasOracles
+Keyed by remote domain, the gas oracle to use for the domain.
+
+
+```solidity
+mapping(uint32 => IGasOracle) public gasOracles;
+```
+
+
+### beneficiary
+The benficiary that can receive native tokens paid into this contract.
+
+
+```solidity
+address public beneficiary;
+```
+
+
+## Functions
+### initialize
+
+
+```solidity
+function initialize(address _owner, address _beneficiary) public initializer;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`address`|The owner of the contract.|
+|`_beneficiary`|`address`|The beneficiary.|
+
+
+### payForGas
+
+Deposits msg.value as a payment for the relaying of a message
+to its destination chain.
+
+*Overpayment will result in a refund of native tokens to the _refundAddress.
+Callers should be aware that this may present reentrancy issues.*
+
+
+```solidity
+function payForGas(bytes32 _messageId, uint32 _destinationDomain, uint256 _gasAmount, address _refundAddress)
+    external
+    payable
+    override;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_messageId`|`bytes32`|The ID of the message to pay for.|
+|`_destinationDomain`|`uint32`|The domain of the message's destination chain.|
+|`_gasAmount`|`uint256`|The amount of destination gas to pay for.|
+|`_refundAddress`|`address`|The address to refund any overpayment to.|
+
+
+### claim
+
+Transfers the entire native token balance to the beneficiary.
+
+*The beneficiary must be able to receive native tokens.*
+
+
+```solidity
+function claim() external;
+```
+
+### setGasOracles
+
+Sets the gas oracles for remote domains specified in the config array.
+
+
+```solidity
+function setGasOracles(GasOracleConfig[] calldata _configs) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_configs`|`GasOracleConfig[]`|An array of configs including the remote domain and gas oracles to set.|
+
+
+### setBeneficiary
+
+Sets the beneficiary.
+
+
+```solidity
+function setBeneficiary(address _beneficiary) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_beneficiary`|`address`|The new beneficiary.|
+
+
+### quoteGasPayment
+
+Quotes the amount of native tokens to pay for interchain gas.
+
+
+```solidity
+function quoteGasPayment(uint32 _destinationDomain, uint256 _gasAmount)
+    public
+    view
+    virtual
+    override
+    returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the message's destination chain.|
+|`_gasAmount`|`uint256`|The amount of destination gas to pay for.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The amount of native tokens required to pay for interchain gas.|
+
+
+### getExchangeRateAndGasPrice
+
+Gets the token exchange rate and gas price from the configured gas oracle
+for a given destination domain.
+
+
+```solidity
+function getExchangeRateAndGasPrice(uint32 _destinationDomain)
+    public
+    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.|
+
+
+### _setBeneficiary
+
+Sets the beneficiary.
+
+
+```solidity
+function _setBeneficiary(address _beneficiary) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_beneficiary`|`address`|The new beneficiary.|
+
+
+### _setGasOracle
+
+Sets the gas oracle for a remote domain.
+
+
+```solidity
+function _setGasOracle(uint32 _remoteDomain, address _gasOracle) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_remoteDomain`|`uint32`|The remote domain.|
+|`_gasOracle`|`address`|The gas oracle.|
+
+
+## Events
+### GasOracleSet
+Emitted when the gas oracle for a remote domain is set.
+
+
+```solidity
+event GasOracleSet(uint32 indexed remoteDomain, address gasOracle);
+```
+
+### BeneficiarySet
+Emitted when the beneficiary is set.
+
+
+```solidity
+event BeneficiarySet(address beneficiary);
+```
+
+## Structs
+### GasOracleConfig
+
+```solidity
+struct GasOracleConfig {
+    uint32 remoteDomain;
+    address gasOracle;
+}
+```
+

package/docs/src/contracts/igps/OverheadIgp.sol/contract.OverheadIgp.md

@@ -0,0 +1,161 @@
+# OverheadIgp
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/igps/OverheadIgp.sol)
+
+**Inherits:**
+[IInterchainGasPaymaster](/contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md), Ownable
+
+An IGP that adds configured gas overheads to gas amounts and forwards
+calls to an "inner" IGP.
+
+*The intended use of this contract is to store overhead gas amounts for destination
+domains, e.g. Mailbox and/or ISM gas usage, such that users of this IGP are only required
+to specify the gas amount used by their own applications.*
+
+
+## State Variables
+### innerIgp
+The IGP that is called when paying for or quoting gas
+after applying overhead gas amounts.
+
+
+```solidity
+IInterchainGasPaymaster public immutable innerIgp;
+```
+
+
+### destinationGasOverhead
+Destination domain => overhead gas amount on that domain.
+
+
+```solidity
+mapping(uint32 => uint256) public destinationGasOverhead;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address _innerIgp);
+```
+
+### payForGas
+
+Adds the stored destinationGasOverhead to the _gasAmount and forwards the
+call to the innerIgp's `payForGas` function.
+
+
+```solidity
+function payForGas(bytes32 _messageId, uint32 _destinationDomain, uint256 _gasAmount, address _refundAddress)
+    external
+    payable;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_messageId`|`bytes32`|The ID of the message to pay for.|
+|`_destinationDomain`|`uint32`|The domain of the message's destination chain.|
+|`_gasAmount`|`uint256`|The amount of destination gas to pay for. This should not consider any gas that is accounted for in the stored destinationGasOverhead.|
+|`_refundAddress`|`address`|The address to refund any overpayment to.|
+
+
+### setDestinationGasOverheads
+
+Sets destination gas overheads for multiple domains.
+
+*Only callable by the owner.*
+
+
+```solidity
+function setDestinationGasOverheads(DomainConfig[] calldata configs) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`configs`|`DomainConfig[]`|A list of destination domains and gas overheads.|
+
+
+### quoteGasPayment
+
+Adds the stored destinationGasOverhead to the _gasAmount and forwards the
+call to the innerIgp's `quoteGasPayment` function.
+
+
+```solidity
+function quoteGasPayment(uint32 _destinationDomain, uint256 _gasAmount) public view returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the message's destination chain.|
+|`_gasAmount`|`uint256`|The amount of destination gas to pay for. This should not consider any gas that is accounted for in the stored destinationGasOverhead.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The amount of native tokens required to pay for interchain gas.|
+
+
+### destinationGasAmount
+
+Returns the stored destinationGasOverhead added to the _gasAmount.
+
+*If there is no stored destinationGasOverhead, 0 is used.*
+
+
+```solidity
+function destinationGasAmount(uint32 _destinationDomain, uint256 _gasAmount) public view returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the message's destination chain.|
+|`_gasAmount`|`uint256`|The amount of destination gas to pay for. This should not consider any gas that is accounted for in the stored destinationGasOverhead.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The stored destinationGasOverhead added to the _gasAmount.|
+
+
+### _setDestinationGasOverhead
+
+Sets the destination gas overhead for a single domain.
+
+
+```solidity
+function _setDestinationGasOverhead(DomainConfig calldata config) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`config`|`DomainConfig`|The destination domain and gas overhead.|
+
+
+## Events
+### DestinationGasOverheadSet
+Emitted when an entry in the destinationGasOverhead mapping is set.
+
+
+```solidity
+event DestinationGasOverheadSet(uint32 indexed domain, uint256 gasOverhead);
+```
+
+## Structs
+### DomainConfig
+
+```solidity
+struct DomainConfig {
+    uint32 domain;
+    uint256 gasOverhead;
+}
+```
+

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

@@ -0,0 +1,6 @@
+
+
+# Contents
+- [gas-oracles](/contracts/igps/gas-oracles)
+- [InterchainGasPaymaster](InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md)
+- [OverheadIgp](OverheadIgp.sol/contract.OverheadIgp.md)

package/docs/src/contracts/igps/gas-oracles/README.md

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