@hyperlane-xyz/core 1.3.8 → 1.4.0

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

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

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

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

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

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

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

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

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

@@ -1,55 +0,0 @@
-# IInterchainSecurityModule
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/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 {
-    NULL,
-    ROUTING,
-    AGGREGATION,
-    LEGACY_MULTISIG,
-    MERKLE_ROOT_MULTISIG,
-    MESSAGE_ID_MULTISIG,
-    OPTIMISM
-}
-```
-

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

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

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

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

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

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

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

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