@hyperlane-xyz/core 1.4.0 → 1.4.2

package/docs/src/contracts/libs/Message.sol/library.Message.md

@@ -0,0 +1,304 @@
+# Message
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/Message.sol)
+
+Library for formatted messages used by Mailbox
+
+
+## State Variables
+### VERSION_OFFSET
+
+```solidity
+uint256 private constant VERSION_OFFSET = 0;
+```
+
+
+### NONCE_OFFSET
+
+```solidity
+uint256 private constant NONCE_OFFSET = 1;
+```
+
+
+### ORIGIN_OFFSET
+
+```solidity
+uint256 private constant ORIGIN_OFFSET = 5;
+```
+
+
+### SENDER_OFFSET
+
+```solidity
+uint256 private constant SENDER_OFFSET = 9;
+```
+
+
+### DESTINATION_OFFSET
+
+```solidity
+uint256 private constant DESTINATION_OFFSET = 41;
+```
+
+
+### RECIPIENT_OFFSET
+
+```solidity
+uint256 private constant RECIPIENT_OFFSET = 45;
+```
+
+
+### BODY_OFFSET
+
+```solidity
+uint256 private constant BODY_OFFSET = 77;
+```
+
+
+## Functions
+### formatMessage
+
+Returns formatted (packed) Hyperlane message with provided fields
+
+*This function should only be used in memory message construction.*
+
+
+```solidity
+function formatMessage(
+    uint8 _version,
+    uint32 _nonce,
+    uint32 _originDomain,
+    bytes32 _sender,
+    uint32 _destinationDomain,
+    bytes32 _recipient,
+    bytes calldata _messageBody
+) internal pure returns (bytes memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_version`|`uint8`|The version of the origin and destination Mailboxes|
+|`_nonce`|`uint32`|A nonce to uniquely identify the message on its origin chain|
+|`_originDomain`|`uint32`|Domain of origin chain|
+|`_sender`|`bytes32`|Address of sender as bytes32|
+|`_destinationDomain`|`uint32`|Domain of destination chain|
+|`_recipient`|`bytes32`|Address of recipient on destination chain as bytes32|
+|`_messageBody`|`bytes`|Raw bytes of message body|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|Formatted message|
+
+
+### id
+
+Returns the message ID.
+
+
+```solidity
+function id(bytes memory _message) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|ID of `_message`|
+
+
+### version
+
+Returns the message version.
+
+
+```solidity
+function version(bytes calldata _message) internal pure returns (uint8);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint8`|Version of `_message`|
+
+
+### nonce
+
+Returns the message nonce.
+
+
+```solidity
+function nonce(bytes calldata _message) internal pure returns (uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|Nonce of `_message`|
+
+
+### origin
+
+Returns the message origin domain.
+
+
+```solidity
+function origin(bytes calldata _message) internal pure returns (uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|Origin domain of `_message`|
+
+
+### sender
+
+Returns the message sender as bytes32.
+
+
+```solidity
+function sender(bytes calldata _message) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Sender of `_message` as bytes32|
+
+
+### senderAddress
+
+Returns the message sender as address.
+
+
+```solidity
+function senderAddress(bytes calldata _message) internal pure returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|Sender of `_message` as address|
+
+
+### destination
+
+Returns the message destination domain.
+
+
+```solidity
+function destination(bytes calldata _message) internal pure returns (uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|Destination domain of `_message`|
+
+
+### recipient
+
+Returns the message recipient as bytes32.
+
+
+```solidity
+function recipient(bytes calldata _message) internal pure returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|Recipient of `_message` as bytes32|
+
+
+### recipientAddress
+
+Returns the message recipient as address.
+
+
+```solidity
+function recipientAddress(bytes calldata _message) internal pure returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|Recipient of `_message` as address|
+
+
+### body
+
+Returns the message body.
+
+
+```solidity
+function body(bytes calldata _message) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_message`|`bytes`|ABI encoded Hyperlane message.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|Body of `_message`|
+
+

package/docs/src/contracts/libs/MetaProxy.sol/library.MetaProxy.md

@@ -0,0 +1,36 @@
+# MetaProxy
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/MetaProxy.sol)
+
+*Adapted from https://eips.ethereum.org/EIPS/eip-3448*
+
+
+## State Variables
+### PREFIX
+
+```solidity
+bytes32 private constant PREFIX = hex"600b380380600b3d393df3363d3d373d3d3d3d60368038038091363936013d73";
+```
+
+
+### SUFFIX
+
+```solidity
+bytes13 private constant SUFFIX = hex"5af43d3d93803e603457fd5bf3";
+```
+
+
+## Functions
+### bytecode
+
+
+```solidity
+function bytecode(address _implementation, bytes memory _metadata) internal pure returns (bytes memory);
+```
+
+### metadata
+
+
+```solidity
+function metadata() internal pure returns (bytes memory);
+```
+

package/docs/src/contracts/libs/MinimalProxy.sol/library.MinimalProxy.md

@@ -0,0 +1,34 @@
+# MinimalProxy
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/MinimalProxy.sol)
+
+
+## State Variables
+### PREFIX
+
+```solidity
+bytes20 private constant PREFIX = hex"3d602d80600a3d3981f3363d3d373d3d3d363d73";
+```
+
+
+### SUFFIX
+
+```solidity
+bytes15 private constant SUFFIX = hex"5af43d82803e903d91602b57fd5bf3";
+```
+
+
+## Functions
+### create
+
+
+```solidity
+function create(address implementation) internal returns (address proxy);
+```
+
+### bytecode
+
+
+```solidity
+function bytecode(address implementation) internal pure returns (bytes memory);
+```
+

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

@@ -0,0 +1,16 @@
+
+
+# Contents
+- [isms](/contracts/libs/isms)
+- [middleware](/contracts/libs/middleware)
+- [CallLib](Call.sol/library.CallLib.md)
+- [CheckpointLib](CheckpointLib.sol/library.CheckpointLib.md)
+- [EnumerableMapExtended](EnumerableMapExtended.sol/library.EnumerableMapExtended.md)
+- [LegacyCheckpointLib](LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md)
+- [MerkleLib](Merkle.sol/library.MerkleLib.md)
+- [Message](Message.sol/library.Message.md)
+- [MetaProxy](MetaProxy.sol/library.MetaProxy.md)
+- [MinimalProxy](MinimalProxy.sol/library.MinimalProxy.md)
+- [StaticMOfNAddressSetFactory](StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
+- [TypeCasts](TypeCasts.sol/library.TypeCasts.md)
+- [ValidatorAnnouncements](ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md)

package/docs/src/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md

@@ -0,0 +1,123 @@
+# StaticMOfNAddressSetFactory
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/StaticMOfNAddressSetFactory.sol)
+
+
+## State Variables
+### _implementation
+
+```solidity
+address private immutable _implementation;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### _deployImplementation
+
+
+```solidity
+function _deployImplementation() internal virtual returns (address);
+```
+
+### deploy
+
+Deploys a StaticMOfNAddressSet contract address for the given
+values
+
+*Consider sorting addresses to ensure contract reuse*
+
+
+```solidity
+function deploy(address[] calldata _values, uint8 _threshold) external returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_values`|`address[]`|An array of addresses|
+|`_threshold`|`uint8`|The threshold value to use|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
+
+
+### getAddress
+
+Returns the StaticMOfNAddressSet contract address for the given
+values
+
+*Consider sorting addresses to ensure contract reuse*
+
+
+```solidity
+function getAddress(address[] calldata _values, uint8 _threshold) external view returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_values`|`address[]`|An array of addresses|
+|`_threshold`|`uint8`|The threshold value to use|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
+
+
+### _getAddress
+
+Returns the StaticMOfNAddressSet contract address for the given
+values
+
+
+```solidity
+function _getAddress(bytes32 _salt, bytes memory _bytecode) private view returns (address);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_salt`|`bytes32`|The salt used in Create2|
+|`_bytecode`|`bytes`|The metaproxy bytecode used in Create2|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`address`|set The contract address representing this StaticMOfNAddressSet|
+
+
+### _saltAndBytecode
+
+Returns the create2 salt and bytecode for the given values
+
+
+```solidity
+function _saltAndBytecode(address[] calldata _values, uint8 _threshold) private view returns (bytes32, bytes memory);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_values`|`address[]`|An array of addresses|
+|`_threshold`|`uint8`|The threshold value to use|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|_salt The salt used in Create2|
+|`<none>`|`bytes`|_bytecode The metaproxy bytecode used in Create2|
+
+

package/docs/src/contracts/libs/TypeCasts.sol/library.TypeCasts.md

@@ -0,0 +1,19 @@
+# TypeCasts
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/TypeCasts.sol)
+
+
+## Functions
+### addressToBytes32
+
+
+```solidity
+function addressToBytes32(address _addr) internal pure returns (bytes32);
+```
+
+### bytes32ToAddress
+
+
+```solidity
+function bytes32ToAddress(bytes32 _buf) internal pure returns (address);
+```
+

package/docs/src/contracts/libs/ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md

@@ -0,0 +1,31 @@
+# ValidatorAnnouncements
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/ValidatorAnnouncements.sol)
+
+
+## Functions
+### getAnnouncementDigest
+
+Returns the digest validators are expected to sign when signing announcements.
+
+
+```solidity
+function getAnnouncementDigest(address _mailbox, uint32 _localDomain, string memory _storageLocation)
+    internal
+    pure
+    returns (bytes32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_mailbox`|`address`|Address of the mailbox being validated|
+|`_localDomain`|`uint32`|Domain of chain on which the contract is deployed|
+|`_storageLocation`|`string`|Storage location string.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes32`|The digest of the announcement.|
+
+

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

@@ -0,0 +1,97 @@
+# AggregationIsmMetadata
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/isms/AggregationIsmMetadata.sol)
+
+Format of metadata:
+[????:????] Metadata start/end uint32 ranges, packed as uint64
+[????:????] ISM metadata, packed encoding
+
+
+## State Variables
+### RANGE_SIZE
+
+```solidity
+uint256 private constant RANGE_SIZE = 4;
+```
+
+
+## Functions
+### hasMetadata
+
+Returns whether or not metadata was provided for the ISM at
+`_index`
+
+*Callers must ensure _index is less than the number of metadatas
+provided*
+
+
+```solidity
+function hasMetadata(bytes calldata _metadata, uint8 _index) internal pure returns (bool);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
+|`_index`|`uint8`|The index of the ISM to check for metadata for|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bool`|Whether or not metadata was provided for the ISM at `_index`|
+
+
+### metadataAt
+
+Returns the metadata provided for the ISM at `_index`
+
+*Callers must ensure _index is less than the number of metadatas
+provided*
+
+*Callers must ensure `hasMetadata(_metadata, _index)`*
+
+
+```solidity
+function metadataAt(bytes calldata _metadata, uint8 _index) internal pure returns (bytes calldata);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
+|`_index`|`uint8`|The index of the ISM to return metadata for|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`bytes`|The metadata provided for the ISM at `_index`|
+
+
+### _metadataRange
+
+Returns the range of the metadata provided for the ISM at
+`_index`, or zeroes if not provided
+
+*Callers must ensure _index is less than the number of metadatas
+provided*
+
+
+```solidity
+function _metadataRange(bytes calldata _metadata, uint8 _index) private pure returns (uint32, uint32);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_metadata`|`bytes`|Encoded Aggregation ISM metadata|
+|`_index`|`uint8`|The index of the ISM to return metadata range for|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`<none>`|`uint32`|The range of the metadata provided for the ISM at `_index`, or zeroes if not provided|
+|`<none>`|`uint32`||
+
+