@hyperlane-xyz/core 1.4.0 → 1.4.2

package/docs/src/contracts/libs/isms/LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md

@@ -0,0 +1,296 @@
+# LegacyMultisigIsmMetadata
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/isms/LegacyMultisigIsmMetadata.sol)
+
+Format of metadata:
+[   0:  32] Merkle root
+[  32:  36] Root index
+[  36:  68] Origin mailbox address
+[  68:1092] Merkle proof
+[1092:1093] Threshold
+[1093:????] Validator signatures, 65 bytes each, length == Threshold
+[????:????] Addresses of the entire validator set, left padded to bytes32
+
+
+## State Variables
+### MERKLE_ROOT_OFFSET
+
+```solidity
+uint256 private constant MERKLE_ROOT_OFFSET = 0;
+```
+
+
+### MERKLE_INDEX_OFFSET
+
+```solidity
+uint256 private constant MERKLE_INDEX_OFFSET = 32;
+```
+
+
+### ORIGIN_MAILBOX_OFFSET
+
+```solidity
+uint256 private constant ORIGIN_MAILBOX_OFFSET = 36;
+```
+
+
+### MERKLE_PROOF_OFFSET
+
+```solidity
+uint256 private constant MERKLE_PROOF_OFFSET = 68;
+```
+
+
+### THRESHOLD_OFFSET
+
+```solidity
+uint256 private constant THRESHOLD_OFFSET = 1092;
+```
+
+
+### SIGNATURES_OFFSET
+
+```solidity
+uint256 private constant SIGNATURES_OFFSET = 1093;
+```
+
+
+### SIGNATURE_LENGTH
+
+```solidity
+uint256 private constant SIGNATURE_LENGTH = 65;
+```
+
+
+## Functions
+### root
+
+Returns the merkle root of the signed checkpoint.
+
+
+```solidity
+function root(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Merkle root of the signed checkpoint|
+
+
+### index
+
+Returns the index of the signed checkpoint.
+
+
+```solidity
+function index(bytes calldata _metadata) internal pure returns (uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|Index of the signed checkpoint|
+
+
+### originMailbox
+
+Returns the origin mailbox of the signed checkpoint as bytes32.
+
+
+```solidity
+function originMailbox(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Origin mailbox of the signed checkpoint as bytes32|
+
+
+### proof
+
+Returns the merkle proof branch of the message.
+
+*This appears to be more gas efficient than returning a calldata
+slice and using that.*
+
+
+```solidity
+function proof(bytes calldata _metadata) internal pure returns (bytes32[32] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32[32]`|Merkle proof branch of the message.|
+
+
+### threshold
+
+Returns the number of required signatures. Verified against
+the commitment stored in the module.
+
+
+```solidity
+function threshold(bytes calldata _metadata) internal pure returns (uint8);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint8`|The number of required signatures.|
+
+
+### signatureAt
+
+Returns the validator ECDSA signature at `_index`.
+
+*Assumes signatures are sorted by validator*
+
+*Assumes `_metadata` encodes `threshold` signatures.*
+
+*Assumes `_index` is less than `threshold`*
+
+
+```solidity
+function signatureAt(bytes calldata _metadata, uint256 _index) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+|`_index`|`uint256`|The index of the signature to return.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|The validator ECDSA signature at `_index`.|
+
+
+### validatorAt
+
+Returns the validator address at `_index`.
+
+*Assumes `_index` is less than the number of validators*
+
+
+```solidity
+function validatorAt(bytes calldata _metadata, uint256 _index) internal pure returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+|`_index`|`uint256`|The index of the validator to return.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|The validator address at `_index`.|
+
+
+### validators
+
+Returns the validator set encoded as bytes. Verified against the
+commitment stored in the module.
+
+*Validator addresses are encoded as tightly packed array of bytes32,
+sorted to match the enumerable set stored by the module.*
+
+
+```solidity
+function validators(bytes calldata _metadata) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|The validator set encoded as bytes.|
+
+
+### validatorCount
+
+Returns the size of the validator set encoded in the metadata
+
+*Validator addresses are encoded as tightly packed array of bytes32,
+sorted to match the enumerable set stored by the module.*
+
+
+```solidity
+function validatorCount(bytes calldata _metadata) internal pure returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The size of the validator set encoded in the metadata|
+
+
+### _validatorsOffset
+
+Returns the offset in bytes of the list of validators within
+`_metadata`.
+
+
+```solidity
+function _validatorsOffset(bytes calldata _metadata) private pure returns (uint256);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint256`|The index at which the list of validators starts|
+
+

package/docs/src/contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md

@@ -0,0 +1,177 @@
+# MerkleRootMultisigIsmMetadata
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol)
+
+Format of metadata:
+[   0:  32] Origin mailbox address
+[  32:  36] Signed checkpoint index
+[  36:  68] Signed checkpoint message ID
+[  68:1092] Merkle proof
+[1092:????] Validator signatures (length := threshold * 65)
+
+
+## State Variables
+### ORIGIN_MAILBOX_OFFSET
+
+```solidity
+uint8 private constant ORIGIN_MAILBOX_OFFSET = 0;
+```
+
+
+### CHECKPOINT_INDEX_OFFSET
+
+```solidity
+uint8 private constant CHECKPOINT_INDEX_OFFSET = 32;
+```
+
+
+### CHECKPOINT_MESSAGE_ID_OFFSET
+
+```solidity
+uint8 private constant CHECKPOINT_MESSAGE_ID_OFFSET = 36;
+```
+
+
+### MERKLE_PROOF_OFFSET
+
+```solidity
+uint8 private constant MERKLE_PROOF_OFFSET = 68;
+```
+
+
+### MERKLE_PROOF_LENGTH
+
+```solidity
+uint16 private constant MERKLE_PROOF_LENGTH = 32 * 32;
+```
+
+
+### SIGNATURES_OFFSET
+
+```solidity
+uint16 private constant SIGNATURES_OFFSET = 1092;
+```
+
+
+### SIGNATURE_LENGTH
+
+```solidity
+uint8 private constant SIGNATURE_LENGTH = 65;
+```
+
+
+## Functions
+### originMailbox
+
+Returns the origin mailbox of the signed checkpoint as bytes32.
+
+
+```solidity
+function originMailbox(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Origin mailbox of the signed checkpoint as bytes32|
+
+
+### index
+
+Returns the index of the signed checkpoint.
+
+
+```solidity
+function index(bytes calldata _metadata) internal pure returns (uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|Index of the signed checkpoint|
+
+
+### messageId
+
+Returns the message ID of the signed checkpoint.
+
+
+```solidity
+function messageId(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Message ID of the signed checkpoint|
+
+
+### proof
+
+Returns the merkle proof branch of the message.
+
+*This appears to be more gas efficient than returning a calldata
+slice and using that.*
+
+
+```solidity
+function proof(bytes calldata _metadata) internal pure returns (bytes32[32] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32[32]`|Merkle proof branch of the message.|
+
+
+### signatureAt
+
+Returns the validator ECDSA signature at `_index`.
+
+*Assumes signatures are sorted by validator*
+
+*Assumes `_metadata` encodes `threshold` signatures.*
+
+*Assumes `_index` is less than `threshold`*
+
+
+```solidity
+function signatureAt(bytes calldata _metadata, uint256 _index) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+|`_index`|`uint256`|The index of the signature to return.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|The validator ECDSA signature at `_index`.|
+
+

package/docs/src/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md

@@ -0,0 +1,109 @@
+# MessageIdMultisigIsmMetadata
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol)
+
+Format of metadata:
+[   0:  32] Origin mailbox address
+[  32:  64] Signed checkpoint root
+[  64:????] Validator signatures (length := threshold * 65)
+
+
+## State Variables
+### ORIGIN_MAILBOX_OFFSET
+
+```solidity
+uint8 private constant ORIGIN_MAILBOX_OFFSET = 0;
+```
+
+
+### MERKLE_ROOT_OFFSET
+
+```solidity
+uint8 private constant MERKLE_ROOT_OFFSET = 32;
+```
+
+
+### SIGNATURES_OFFSET
+
+```solidity
+uint8 private constant SIGNATURES_OFFSET = 64;
+```
+
+
+### SIGNATURE_LENGTH
+
+```solidity
+uint8 private constant SIGNATURE_LENGTH = 65;
+```
+
+
+## Functions
+### originMailbox
+
+Returns the origin mailbox of the signed checkpoint as bytes32.
+
+
+```solidity
+function originMailbox(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Origin mailbox of the signed checkpoint as bytes32|
+
+
+### root
+
+Returns the merkle root of the signed checkpoint.
+
+
+```solidity
+function root(bytes calldata _metadata) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Merkle root of the signed checkpoint|
+
+
+### signatureAt
+
+Returns the validator ECDSA signature at `_index`.
+
+*Assumes signatures are sorted by validator*
+
+*Assumes `_metadata` encodes `threshold` signatures.*
+
+*Assumes `_index` is less than `threshold`*
+
+
+```solidity
+function signatureAt(bytes calldata _metadata, uint256 _index) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|ABI encoded Multisig ISM metadata.|
+|`_index`|`uint256`|The index of the signature to return.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|The validator ECDSA signature at `_index`.|
+
+

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

@@ -0,0 +1,7 @@
+
+
+# Contents
+- [AggregationIsmMetadata](AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md)
+- [LegacyMultisigIsmMetadata](LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md)
+- [MerkleRootMultisigIsmMetadata](MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md)
+- [MessageIdMultisigIsmMetadata](MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md)

package/docs/src/contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md

@@ -0,0 +1,134 @@
+# InterchainAccountMessage
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/middleware/InterchainAccountMessage.sol)
+
+Format of message:
+[   0:  32] ICA owner
+[  32:  64] ICA ISM
+[  64:????] Calls, abi encoded
+
+
+## Functions
+### encode
+
+Returns formatted (packed) InterchainAccountMessage
+
+*This function should only be used in memory message construction.*
+
+
+```solidity
+function encode(address _owner, bytes32 _ism, address _to, uint256 _value, bytes memory _data)
+    internal
+    pure
+    returns (bytes memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`address`|The owner of the interchain account|
+|`_ism`|`bytes32`|The address of the remote ISM|
+|`_to`|`address`|The address of the contract to call|
+|`_value`|`uint256`|The value to include in the call|
+|`_data`|`bytes`|The calldata|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|Formatted message body|
+
+
+### encode
+
+Returns formatted (packed) InterchainAccountMessage
+
+*This function should only be used in memory message construction.*
+
+
+```solidity
+function encode(bytes32 _owner, bytes32 _ism, CallLib.Call[] calldata _calls) internal pure returns (bytes memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`bytes32`|The owner of the interchain account|
+|`_ism`|`bytes32`|The address of the remote ISM|
+|`_calls`|`CallLib.Call[]`|The sequence of calls to make|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|Formatted message body|
+
+
+### encode
+
+Returns formatted (packed) InterchainAccountMessage
+
+*This function should only be used in memory message construction.*
+
+
+```solidity
+function encode(address _owner, bytes32 _ism, CallLib.Call[] calldata _calls) internal pure returns (bytes memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`address`|The owner of the interchain account|
+|`_ism`|`bytes32`|The address of the remote ISM|
+|`_calls`|`CallLib.Call[]`|The sequence of calls to make|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|Formatted message body|
+
+
+### decode
+
+Parses and returns the calls from the provided message
+
+
+```solidity
+function decode(bytes calldata _message) internal pure returns (bytes32, bytes32, CallLib.Call[] memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|The interchain account message|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|The array of calls|
+|`<none>`|`bytes32`||
+|`<none>`|`CallLib.Call[]`||
+
+
+### ism
+
+Parses and returns the ISM address from the provided message
+
+
+```solidity
+function ism(bytes calldata _message) internal pure returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|The interchain account message|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|The ISM encoded in the message|
+
+