@hyperlane-xyz/core 1.3.7 → 1.3.8-beta0

package/docs/src/contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md

@@ -0,0 +1,60 @@
+# AbstractAggregationIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/aggregation/AbstractAggregationIsm.sol)
+
+**Inherits:**
+[IAggregationIsm](/contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md)
+
+Manages per-domain m-of-n ISM sets that are used to verify
+interchain messages.
+
+
+## State Variables
+### moduleType
+
+```solidity
+uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.AGGREGATION);
+```
+
+
+## Functions
+### modulesAndThreshold
+
+Returns the set of ISMs responsible for verifying _message
+and the number of ISMs that must verify
+
+*Can change based on the content of _message*
+
+
+```solidity
+function modulesAndThreshold(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[]`|modules The array of ISM addresses|
+|`<none>`|`uint8`|threshold The number of ISMs needed to verify|
+
+
+### verify
+
+Requires that m-of-n ISMs verify the provided interchain message.
+
+
+```solidity
+function verify(bytes calldata _metadata, bytes calldata _message) public returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded module metadata (see AggregationIsmMetadata.sol)|
+|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
+
+

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

@@ -0,0 +1,6 @@
+
+
+# Contents
+- [AbstractAggregationIsm](AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
+- [StaticAggregationIsm](StaticAggregationIsm.sol/contract.StaticAggregationIsm.md)
+- [StaticAggregationIsmFactory](StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md)

package/docs/src/contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md

@@ -0,0 +1,30 @@
+# StaticAggregationIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/isms/aggregation/StaticAggregationIsm.sol)
+
+**Inherits:**
+[AbstractAggregationIsm](/contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
+
+Manages per-domain m-of-n ISM sets that are used to verify
+interchain messages.
+
+
+## Functions
+### modulesAndThreshold
+
+Returns the set of ISMs responsible for verifying _message
+and the number of ISMs that must verify
+
+*Can change based on the content of _message*
+
+
+```solidity
+function modulesAndThreshold(bytes calldata) public view virtual override returns (address[] memory, uint8);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address[]`|modules The array of ISM addresses|
+|`<none>`|`uint8`|threshold The number of ISMs needed to verify|
+
+

package/docs/src/contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md

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

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

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

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

@@ -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).|
+
+