@hyperlane-xyz/core 1.3.7 → 1.3.8

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

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

package/docs/src/contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md

@@ -0,0 +1,355 @@
+# LegacyMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/LegacyMultisigIsm.sol)
+
+**Inherits:**
+[IMultisigIsm](/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md), Ownable
+
+Manages an ownable set of validators that ECDSA sign checkpoints to
+reach a quorum.
+
+
+## State Variables
+### moduleType
+
+```solidity
+uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.LEGACY_MULTISIG);
+```
+
+
+### threshold
+The validator threshold for each remote domain.
+
+
+```solidity
+mapping(uint32 => uint8) public threshold;
+```
+
+
+### validatorSet
+The validator set for each remote domain.
+
+
+```solidity
+mapping(uint32 => EnumerableSet.AddressSet) private validatorSet;
+```
+
+
+### commitment
+A succinct commitment to the validator set and threshold for each remote
+domain.
+
+
+```solidity
+mapping(uint32 => bytes32) public commitment;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor() Ownable;
+```
+
+### enrollValidators
+
+Enrolls multiple validators into a validator set.
+
+*Reverts if `_validator` is already in the validator set.*
+
+*_validators[i] are the validators to enroll for _domains[i].*
+
+
+```solidity
+function enrollValidators(uint32[] calldata _domains, address[][] calldata _validators) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domains`|`uint32[]`|The remote domains of the validator sets.|
+|`_validators`|`address[][]`|The validators to add to the validator sets.|
+
+
+### enrollValidator
+
+Enrolls a validator into a validator set.
+
+*Reverts if `_validator` is already in the validator set.*
+
+
+```solidity
+function enrollValidator(uint32 _domain, address _validator) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+|`_validator`|`address`|The validator to add to the validator set.|
+
+
+### unenrollValidator
+
+Unenrolls a validator from a validator set.
+
+*Reverts if `_validator` is not in the validator set.*
+
+
+```solidity
+function unenrollValidator(uint32 _domain, address _validator) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+|`_validator`|`address`|The validator to remove from the validator set.|
+
+
+### setThresholds
+
+Sets the quorum threshold for multiple domains.
+
+
+```solidity
+function setThresholds(uint32[] calldata _domains, uint8[] calldata _thresholds) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domains`|`uint32[]`|The remote domains of the validator sets.|
+|`_thresholds`|`uint8[]`|The new quorum thresholds.|
+
+
+### isEnrolled
+
+Returns whether an address is enrolled in a validator set.
+
+
+```solidity
+function isEnrolled(uint32 _domain, address _address) external view returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+|`_address`|`address`|The address to test for set membership.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|True if the address is enrolled, false otherwise.|
+
+
+### setThreshold
+
+Sets the quorum threshold.
+
+
+```solidity
+function setThreshold(uint32 _domain, uint8 _threshold) public onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+|`_threshold`|`uint8`|The new quorum threshold.|
+
+
+### verify
+
+Verifies that a quorum of the origin domain's validators signed
+a checkpoint, and verifies the merkle proof of `_message` against that
+checkpoint.
+
+
+```solidity
+function verify(bytes calldata _metadata, bytes calldata _message) external view returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded module metadata (see LegacyMultisigIsmMetadata.sol)|
+|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
+
+
+### validators
+
+Gets the current validator set
+
+
+```solidity
+function validators(uint32 _domain) public view returns (address[] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address[]`|The addresses of the validator set.|
+
+
+### 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, 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|
+
+
+### validatorCount
+
+Returns the number of validators enrolled in the validator set.
+
+
+```solidity
+function validatorCount(uint32 _domain) public view returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The number of validators enrolled in the validator set.|
+
+
+### _enrollValidator
+
+Enrolls a validator into a validator set.
+
+*Reverts if `_validator` is already in the validator set.*
+
+
+```solidity
+function _enrollValidator(uint32 _domain, address _validator) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+|`_validator`|`address`|The validator to add to the validator set.|
+
+
+### _updateCommitment
+
+Updates the commitment to the validator set for `_domain`.
+
+
+```solidity
+function _updateCommitment(uint32 _domain) internal returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The remote domain of the validator set.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|The commitment to the validator set for `_domain`.|
+
+
+### _verifyMerkleProof
+
+Verifies the merkle proof of `_message` against the provided
+checkpoint.
+
+
+```solidity
+function _verifyMerkleProof(bytes calldata _metadata, bytes calldata _message) internal pure returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded module metadata (see LegacyMultisigIsmMetadata.sol)|
+|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
+
+
+### _verifyValidatorSignatures
+
+Verifies that a quorum of the origin domain's validators signed
+the provided checkpoint.
+
+
+```solidity
+function _verifyValidatorSignatures(bytes calldata _metadata, bytes calldata _message) internal view returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded module metadata (see LegacyMultisigIsmMetadata.sol)|
+|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
+
+
+## Events
+### ValidatorEnrolled
+Emitted when a validator is enrolled in a validator set.
+
+
+```solidity
+event ValidatorEnrolled(uint32 indexed domain, address indexed validator, uint256 validatorCount);
+```
+
+### ValidatorUnenrolled
+Emitted when a validator is unenrolled from a validator set.
+
+
+```solidity
+event ValidatorUnenrolled(uint32 indexed domain, address indexed validator, uint256 validatorCount);
+```
+
+### ThresholdSet
+Emitted when the quorum threshold is set.
+
+
+```solidity
+event ThresholdSet(uint32 indexed domain, uint8 threshold);
+```
+
+### CommitmentUpdated
+Emitted when the validator set or threshold changes.
+
+
+```solidity
+event CommitmentUpdated(uint32 domain, bytes32 commitment);
+```
+

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

@@ -0,0 +1,12 @@
+
+
+# Contents
+- [AbstractMerkleRootMultisigIsm](AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md)
+- [AbstractMessageIdMultisigIsm](AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md)
+- [AbstractMultisigIsm](AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
+- [LegacyMultisigIsm](LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md)
+- [AbstractMetaProxyMultisigIsm](StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
+- [StaticMerkleRootMultisigIsm](StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md)
+- [StaticMessageIdMultisigIsm](StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md)
+- [StaticMerkleRootMultisigIsmFactory](StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md)
+- [StaticMessageIdMultisigIsmFactory](StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md)

package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md

@@ -0,0 +1,36 @@
+# AbstractMetaProxyMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/StaticMultisigIsm.sol)
+
+**Inherits:**
+[AbstractMultisigIsm](/contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
+
+Manages per-domain m-of-n Validator set that is used
+to verify interchain messages.
+
+
+## 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) public pure override returns (address[] memory, uint8);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`||
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address[]`|validators The array of validator addresses|
+|`<none>`|`uint8`|threshold The number of validator signatures needed|
+
+

package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md

@@ -0,0 +1,11 @@
+# StaticMerkleRootMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/StaticMultisigIsm.sol)
+
+**Inherits:**
+[AbstractMerkleRootMultisigIsm](/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md), [AbstractMetaProxyMultisigIsm](/contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
+
+Manages per-domain m-of-n validator set that is used
+to verify interchain messages using a merkle root signature quorum
+and merkle proof of inclusion.
+
+

package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md

@@ -0,0 +1,15 @@
+# StaticMerkleRootMultisigIsmFactory
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/StaticMultisigIsm.sol)
+
+**Inherits:**
+[StaticMOfNAddressSetFactory](/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
+
+
+## Functions
+### _deployImplementation
+
+
+```solidity
+function _deployImplementation() internal override returns (address);
+```
+

package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md

@@ -0,0 +1,10 @@
+# StaticMessageIdMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/StaticMultisigIsm.sol)
+
+**Inherits:**
+[AbstractMessageIdMultisigIsm](/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md), [AbstractMetaProxyMultisigIsm](/contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
+
+Manages per-domain m-of-n validator set that is used
+to verify interchain messages using a message ID signature quorum.
+
+

package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md

@@ -0,0 +1,15 @@
+# StaticMessageIdMultisigIsmFactory
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/multisig/StaticMultisigIsm.sol)
+
+**Inherits:**
+[StaticMOfNAddressSetFactory](/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
+
+
+## Functions
+### _deployImplementation
+
+
+```solidity
+function _deployImplementation() internal override returns (address);
+```
+

package/docs/src/contracts/isms/native/AbstractNativeISM.sol/abstract.AbstractNativeISM.md

@@ -0,0 +1,44 @@
+# AbstractNativeISM
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/native/AbstractNativeISM.sol)
+
+**Inherits:**
+[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md), Initializable
+
+Uses the native bridges to verify interchain messages.
+
+*In the future, the hook might be moved inside the Mailbox which doesn't require storage mappings for senders.
+for more details see https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/2381*
+
+
+## State Variables
+### verifiedMessageIds
+
+```solidity
+mapping(bytes32 => mapping(address => bool)) public verifiedMessageIds;
+```
+
+
+## Functions
+### verify
+
+Verify a message was received by ISM.
+
+
+```solidity
+function verify(bytes calldata, bytes calldata _message) external view returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`||
+|`_message`|`bytes`|Message to verify.|
+
+
+## Events
+### ReceivedMessage
+
+```solidity
+event ReceivedMessage(address indexed sender, bytes32 indexed messageId);
+```
+

package/docs/src/contracts/isms/native/OptimismISM.sol/contract.OptimismISM.md

@@ -0,0 +1,66 @@
+# OptimismISM
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/native/OptimismISM.sol)
+
+**Inherits:**
+CrossChainEnabledOptimism, [AbstractNativeISM](/contracts/isms/native/AbstractNativeISM.sol/abstract.AbstractNativeISM.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(address _sender, bytes32 _messageId) external isAuthorized;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_sender`|`address`|Address of the sender.|
+|`_messageId`|`bytes32`|Hyperlane ID for the message.|
+
+

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

@@ -0,0 +1,5 @@
+
+
+# Contents
+- [AbstractNativeISM](AbstractNativeISM.sol/abstract.AbstractNativeISM.md)
+- [OptimismISM](OptimismISM.sol/contract.OptimismISM.md)