@hyperlane-xyz/core 1.4.2 → 1.4.3-beta0

package/docs/src/contracts/isms/hook/CrossChainEnabled.sol/abstract.CrossChainEnabled.md

@@ -1,74 +0,0 @@
-# CrossChainEnabled
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/CrossChainEnabled.sol)
-
-**Author:**
-OpenZeppelin
-
-*LibOptimism was removed from the OpenZeppelin Contracts library as of v4.7.0*
-
-*Provides information for building cross-chain aware contracts. This
-abstract contract provides accessors and modifiers to control the execution
-flow when receiving cross-chain messages.
-Actual implementations of cross-chain aware contracts, which are based on
-this abstraction, will  have to inherit from a bridge-specific
-specialization. Such specializations are provided under
-`crosschain/<chain>/CrossChainEnabled<chain>.sol`.
-_Available since v4.6._*
-
-
-## Functions
-### onlyCrossChain
-
-*Throws if the current function call is not the result of a
-cross-chain execution.*
-
-
-```solidity
-modifier onlyCrossChain();
-```
-
-### onlyCrossChainSender
-
-*Throws if the current function call is not the result of a
-cross-chain execution initiated by `account`.*
-
-
-```solidity
-modifier onlyCrossChainSender(address expected);
-```
-
-### _isCrossChain
-
-*Returns whether the current function call is the result of a
-cross-chain message.*
-
-
-```solidity
-function _isCrossChain() internal view virtual returns (bool);
-```
-
-### _crossChainSender
-
-*Returns the address of the sender of the cross-chain message that
-triggered the current function call.
-IMPORTANT: Should revert with `NotCrossChainCall` if the current function
-call is not the result of a cross-chain message.*
-
-
-```solidity
-function _crossChainSender() internal view virtual returns (address);
-```
-
-## Errors
-### NotCrossChainCall
-
-```solidity
-error NotCrossChainCall();
-```
-
-### InvalidCrossChainSender
-
-```solidity
-error InvalidCrossChainSender(address actual, address expected);
-```
-

package/docs/src/contracts/isms/hook/ERC5164ISM.sol/contract.ERC5164ISM.md

@@ -1,57 +0,0 @@
-# ERC5164ISM
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/ERC5164ISM.sol)
-
-**Inherits:**
-[AbstractHookISM](/contracts/isms/hook/AbstractHookISM.sol/abstract.AbstractHookISM.md)
-
-Uses the generic eip-5164 standard to verify interchain messages.
-
-
-## State Variables
-### moduleType
-
-```solidity
-uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.NULL);
-```
-
-
-### executor
-
-```solidity
-address public immutable executor;
-```
-
-
-## Functions
-### isAuthorized
-
-Check if sender is authorized to message `verifyMessageId`.
-
-
-```solidity
-modifier isAuthorized();
-```
-
-### constructor
-
-
-```solidity
-constructor(address _executor);
-```
-
-### verifyMessageId
-
-Receive a message from the executor.
-
-
-```solidity
-function verifyMessageId(bytes32 _sender, bytes32 _messageId) external isAuthorized;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_sender`|`bytes32`|Left-padded address of the sender.|
-|`_messageId`|`bytes32`|Hyperlane ID for the message.|
-
-

package/docs/src/contracts/isms/hook/README.md

@@ -1,7 +0,0 @@
-
-
-# Contents
-- [optimism](/contracts/isms/hook/optimism)
-- [AbstractHookISM](AbstractHookISM.sol/abstract.AbstractHookISM.md)
-- [CrossChainEnabled](CrossChainEnabled.sol/abstract.CrossChainEnabled.md)
-- [ERC5164ISM](ERC5164ISM.sol/contract.ERC5164ISM.md)

package/docs/src/contracts/isms/hook/optimism/CrossChainEnabledOptimism.sol/abstract.CrossChainEnabledOptimism.md

@@ -1,53 +0,0 @@
-# CrossChainEnabledOptimism
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/optimism/CrossChainEnabledOptimism.sol)
-
-**Inherits:**
-[CrossChainEnabled](/contracts/isms/hook/CrossChainEnabled.sol/abstract.CrossChainEnabled.md)
-
-**Author:**
-OpenZeppelin
-
-*CrossChainEnabledOptimism was removed from the OpenZeppelin Contracts library as of v4.7.0*
-
-*https://www.optimism.io/[Optimism] specialization or the
-{CrossChainEnabled} abstraction.
-The messenger (`CrossDomainMessenger`) contract is provided and maintained by
-the optimism team. You can find the address of this contract on mainnet and
-kovan in the https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/deployments[deployments section of Optimism monorepo].
-_Available since v4.6._*
-
-
-## State Variables
-### _messenger
-
-```solidity
-address private immutable _messenger;
-```
-
-
-## Functions
-### constructor
-
-
-```solidity
-constructor(address messenger);
-```
-
-### _isCrossChain
-
-*see {CrossChainEnabled-_isCrossChain}*
-
-
-```solidity
-function _isCrossChain() internal view virtual override returns (bool);
-```
-
-### _crossChainSender
-
-*see {CrossChainEnabled-_crossChainSender}*
-
-
-```solidity
-function _crossChainSender() internal view virtual override onlyCrossChain returns (address);
-```
-

package/docs/src/contracts/isms/hook/optimism/LibOptimism.sol/library.LibOptimism.md

@@ -1,39 +0,0 @@
-# LibOptimism
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/optimism/LibOptimism.sol)
-
-*Primitives for cross-chain aware contracts for https://www.optimism.io/[Optimism].
-See the https://community.optimism.io/docs/developers/bridge/messaging/#accessing-msg-sender[documentation]
-for the functionality used here.*
-
-
-## Functions
-### isCrossChain
-
-*Returns whether the current function call is the result of a
-cross-chain message relayed by `messenger`.*
-
-
-```solidity
-function isCrossChain(address messenger) internal view returns (bool);
-```
-
-### crossChainSender
-
-*Returns the address of the sender that triggered the current
-cross-chain message through `messenger`.
-NOTE: {isCrossChain} should be checked before trying to recover the
-sender, as it will revert with `NotCrossChainCall` if the current
-function call is not the result of a cross-chain message.*
-
-
-```solidity
-function crossChainSender(address messenger) internal view returns (address);
-```
-
-## Errors
-### NotCrossChainCall
-
-```solidity
-error NotCrossChainCall();
-```
-

package/docs/src/contracts/isms/hook/optimism/OptimismISM.sol/contract.OptimismISM.md

@@ -1,66 +0,0 @@
-# OptimismISM
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/optimism/OptimismISM.sol)
-
-**Inherits:**
-[CrossChainEnabledOptimism](/contracts/isms/hook/optimism/CrossChainEnabledOptimism.sol/abstract.CrossChainEnabledOptimism.md), [AbstractHookISM](/contracts/isms/hook/AbstractHookISM.sol/abstract.AbstractHookISM.md)
-
-Uses the native Optimism bridge to verify interchain messages.
-
-
-## State Variables
-### moduleType
-
-```solidity
-uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.NULL);
-```
-
-
-### l1Hook
-
-```solidity
-address public l1Hook;
-```
-
-
-## Functions
-### isAuthorized
-
-Check if sender is authorized to message `verifyMessageId`.
-
-
-```solidity
-modifier isAuthorized();
-```
-
-### constructor
-
-
-```solidity
-constructor(address _l2Messenger) CrossChainEnabledOptimism(_l2Messenger);
-```
-
-### setOptimismHook
-
-
-```solidity
-function setOptimismHook(address _l1Hook) external initializer;
-```
-
-### verifyMessageId
-
-Receive a message from the L2 messenger.
-
-*Only callable by the L2 messenger.*
-
-
-```solidity
-function verifyMessageId(bytes32 _sender, bytes32 _messageId) external isAuthorized;
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_sender`|`bytes32`|Left-padded address of the sender.|
-|`_messageId`|`bytes32`|Hyperlane ID for the message.|
-
-

package/docs/src/contracts/isms/hook/optimism/README.md

@@ -1,6 +0,0 @@
-
-
-# Contents
-- [CrossChainEnabledOptimism](CrossChainEnabledOptimism.sol/abstract.CrossChainEnabledOptimism.md)
-- [LibOptimism](LibOptimism.sol/library.LibOptimism.md)
-- [OptimismISM](OptimismISM.sol/contract.OptimismISM.md)

package/docs/src/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md

@@ -1,78 +0,0 @@
-# AbstractMerkleRootMultisigIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol)
-
-**Inherits:**
-[AbstractMultisigIsm](/contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
-
-This ISM allows using a newer signed checkpoint (say #33) to prove existence of an older message (#22) in the validators' MerkleTree.
-This guarantees censorship resistance as validators cannot hide a message
-by refusing to sign its checkpoint but later signing a checkpoint for a newer message.
-If validators decide to censor a message, they are left with only one option — to not produce checkpoints at all.
-Otherwise, the very next signed checkpoint (#33) can be used by any relayer to prove the previous message inclusion using this ISM.
-This is censorship resistance is missing in the sibling implementation `AbstractMessageIdMultisigIsm`,
-since it can only verify messages having the corresponding checkpoints.
-
-*Provides the default implementation of verifying signatures over a checkpoint and the message inclusion in that checkpoint.
-This abstract contract can be overridden for customizing the `validatorsAndThreshold()` (static or dynamic).*
-
-*May be adapted in future to support batch message verification against a single root.*
-
-
-## State Variables
-### moduleType
-
-```solidity
-uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.MERKLE_ROOT_MULTISIG);
-```
-
-
-## Functions
-### digest
-
-Returns the digest to be used for signature verification.
-
-
-```solidity
-function digest(bytes calldata _metadata, bytes calldata _message) internal pure override returns (bytes32);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|digest The digest to be signed by validators|
-
-
-### signatureAt
-
-Returns the signature at a given index from the metadata.
-
-
-```solidity
-function signatureAt(bytes calldata _metadata, uint256 _index)
-    internal
-    pure
-    virtual
-    override
-    returns (bytes memory signature);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_index`|`uint256`|The index of the signature to return|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`signature`|`bytes`|Packed encoding of signature (65 bytes)|
-
-

package/docs/src/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md

@@ -1,69 +0,0 @@
-# AbstractMessageIdMultisigIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol)
-
-**Inherits:**
-[AbstractMultisigIsm](/contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
-
-This ISM minimizes gas/performance overhead of the checkpoints verification by compromising on the censorship resistance.
-For censorship resistance consider using `AbstractMerkleRootMultisigIsm`.
-If the validators (`validatorsAndThreshold`) skip messages by not sign checkpoints for them,
-the relayers will not be able to aggregate a quorum of signatures sufficient to deliver these messages via this ISM.
-Integrations are free to choose the trade-off between the censorship resistance and the gas/processing overhead.
-
-*Provides the default implementation of verifying signatures over a checkpoint related to a specific message ID.
-This abstract contract can be customized to change the `validatorsAndThreshold()` (static or dynamic).*
-
-
-## State Variables
-### moduleType
-
-```solidity
-uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.MESSAGE_ID_MULTISIG);
-```
-
-
-## Functions
-### digest
-
-Returns the digest to be used for signature verification.
-
-
-```solidity
-function digest(bytes calldata _metadata, bytes calldata _message) internal pure override returns (bytes32);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|digest The digest to be signed by validators|
-
-
-### signatureAt
-
-Returns the signature at a given index from the metadata.
-
-
-```solidity
-function signatureAt(bytes calldata _metadata, uint256 _index) internal pure virtual override returns (bytes memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_index`|`uint256`|The index of the signature to return|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|signature Packed encoding of signature (65 bytes)|
-
-

package/docs/src/contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md

@@ -1,102 +0,0 @@
-# AbstractMultisigIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/multisig/AbstractMultisigIsm.sol)
-
-**Inherits:**
-[IMultisigIsm](/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md)
-
-Manages per-domain m-of-n Validator sets that are used to verify
-interchain messages.
-
-*See ./AbstractMerkleRootMultisigIsm.sol and ./AbstractMessageIdMultisigIsm.sol
-for concrete implementations of `digest` and `signatureAt`.*
-
-*See ./StaticMultisigIsm.sol for concrete implementations.*
-
-
-## 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) public view virtual returns (address[] memory, uint8);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|Hyperlane formatted interchain message|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address[]`|validators The array of validator addresses|
-|`<none>`|`uint8`|threshold The number of validator signatures needed|
-
-
-### digest
-
-Returns the digest to be used for signature verification.
-
-
-```solidity
-function digest(bytes calldata _metadata, bytes calldata _message) internal view virtual returns (bytes32);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|digest The digest to be signed by validators|
-
-
-### signatureAt
-
-Returns the signature at a given index from the metadata.
-
-
-```solidity
-function signatureAt(bytes calldata _metadata, uint256 _index) internal pure virtual returns (bytes memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_index`|`uint256`|The index of the signature to return|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`|signature Packed encoding of signature (65 bytes)|
-
-
-### verify
-
-Requires that m-of-n validators verify a merkle root,
-and verifies a me∑rkle proof of `_message` against that root.
-
-
-```solidity
-function verify(bytes calldata _metadata, bytes calldata _message) public view returns (bool);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-
-