@hyperlane-xyz/core 1.3.7 → 1.3.8

package/docs/src/contracts/libs/Merkle.sol/library.MerkleLib.md

@@ -0,0 +1,354 @@
+# MerkleLib
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/libs/Merkle.sol)
+
+**Author:**
+Celo Labs Inc.
+
+An incremental merkle tree modeled on the eth2 deposit contract.
+
+
+## State Variables
+### TREE_DEPTH
+
+```solidity
+uint256 internal constant TREE_DEPTH = 32;
+```
+
+
+### MAX_LEAVES
+
+```solidity
+uint256 internal constant MAX_LEAVES = 2 ** TREE_DEPTH - 1;
+```
+
+
+### Z_0
+
+```solidity
+bytes32 internal constant Z_0 = hex"0000000000000000000000000000000000000000000000000000000000000000";
+```
+
+
+### Z_1
+
+```solidity
+bytes32 internal constant Z_1 = hex"ad3228b676f7d3cd4284a5443f17f1962b36e491b30a40b2405849e597ba5fb5";
+```
+
+
+### Z_2
+
+```solidity
+bytes32 internal constant Z_2 = hex"b4c11951957c6f8f642c4af61cd6b24640fec6dc7fc607ee8206a99e92410d30";
+```
+
+
+### Z_3
+
+```solidity
+bytes32 internal constant Z_3 = hex"21ddb9a356815c3fac1026b6dec5df3124afbadb485c9ba5a3e3398a04b7ba85";
+```
+
+
+### Z_4
+
+```solidity
+bytes32 internal constant Z_4 = hex"e58769b32a1beaf1ea27375a44095a0d1fb664ce2dd358e7fcbfb78c26a19344";
+```
+
+
+### Z_5
+
+```solidity
+bytes32 internal constant Z_5 = hex"0eb01ebfc9ed27500cd4dfc979272d1f0913cc9f66540d7e8005811109e1cf2d";
+```
+
+
+### Z_6
+
+```solidity
+bytes32 internal constant Z_6 = hex"887c22bd8750d34016ac3c66b5ff102dacdd73f6b014e710b51e8022af9a1968";
+```
+
+
+### Z_7
+
+```solidity
+bytes32 internal constant Z_7 = hex"ffd70157e48063fc33c97a050f7f640233bf646cc98d9524c6b92bcf3ab56f83";
+```
+
+
+### Z_8
+
+```solidity
+bytes32 internal constant Z_8 = hex"9867cc5f7f196b93bae1e27e6320742445d290f2263827498b54fec539f756af";
+```
+
+
+### Z_9
+
+```solidity
+bytes32 internal constant Z_9 = hex"cefad4e508c098b9a7e1d8feb19955fb02ba9675585078710969d3440f5054e0";
+```
+
+
+### Z_10
+
+```solidity
+bytes32 internal constant Z_10 = hex"f9dc3e7fe016e050eff260334f18a5d4fe391d82092319f5964f2e2eb7c1c3a5";
+```
+
+
+### Z_11
+
+```solidity
+bytes32 internal constant Z_11 = hex"f8b13a49e282f609c317a833fb8d976d11517c571d1221a265d25af778ecf892";
+```
+
+
+### Z_12
+
+```solidity
+bytes32 internal constant Z_12 = hex"3490c6ceeb450aecdc82e28293031d10c7d73bf85e57bf041a97360aa2c5d99c";
+```
+
+
+### Z_13
+
+```solidity
+bytes32 internal constant Z_13 = hex"c1df82d9c4b87413eae2ef048f94b4d3554cea73d92b0f7af96e0271c691e2bb";
+```
+
+
+### Z_14
+
+```solidity
+bytes32 internal constant Z_14 = hex"5c67add7c6caf302256adedf7ab114da0acfe870d449a3a489f781d659e8becc";
+```
+
+
+### Z_15
+
+```solidity
+bytes32 internal constant Z_15 = hex"da7bce9f4e8618b6bd2f4132ce798cdc7a60e7e1460a7299e3c6342a579626d2";
+```
+
+
+### Z_16
+
+```solidity
+bytes32 internal constant Z_16 = hex"2733e50f526ec2fa19a22b31e8ed50f23cd1fdf94c9154ed3a7609a2f1ff981f";
+```
+
+
+### Z_17
+
+```solidity
+bytes32 internal constant Z_17 = hex"e1d3b5c807b281e4683cc6d6315cf95b9ade8641defcb32372f1c126e398ef7a";
+```
+
+
+### Z_18
+
+```solidity
+bytes32 internal constant Z_18 = hex"5a2dce0a8a7f68bb74560f8f71837c2c2ebbcbf7fffb42ae1896f13f7c7479a0";
+```
+
+
+### Z_19
+
+```solidity
+bytes32 internal constant Z_19 = hex"b46a28b6f55540f89444f63de0378e3d121be09e06cc9ded1c20e65876d36aa0";
+```
+
+
+### Z_20
+
+```solidity
+bytes32 internal constant Z_20 = hex"c65e9645644786b620e2dd2ad648ddfcbf4a7e5b1a3a4ecfe7f64667a3f0b7e2";
+```
+
+
+### Z_21
+
+```solidity
+bytes32 internal constant Z_21 = hex"f4418588ed35a2458cffeb39b93d26f18d2ab13bdce6aee58e7b99359ec2dfd9";
+```
+
+
+### Z_22
+
+```solidity
+bytes32 internal constant Z_22 = hex"5a9c16dc00d6ef18b7933a6f8dc65ccb55667138776f7dea101070dc8796e377";
+```
+
+
+### Z_23
+
+```solidity
+bytes32 internal constant Z_23 = hex"4df84f40ae0c8229d0d6069e5c8f39a7c299677a09d367fc7b05e3bc380ee652";
+```
+
+
+### Z_24
+
+```solidity
+bytes32 internal constant Z_24 = hex"cdc72595f74c7b1043d0e1ffbab734648c838dfb0527d971b602bc216c9619ef";
+```
+
+
+### Z_25
+
+```solidity
+bytes32 internal constant Z_25 = hex"0abf5ac974a1ed57f4050aa510dd9c74f508277b39d7973bb2dfccc5eeb0618d";
+```
+
+
+### Z_26
+
+```solidity
+bytes32 internal constant Z_26 = hex"b8cd74046ff337f0a7bf2c8e03e10f642c1886798d71806ab1e888d9e5ee87d0";
+```
+
+
+### Z_27
+
+```solidity
+bytes32 internal constant Z_27 = hex"838c5655cb21c6cb83313b5a631175dff4963772cce9108188b34ac87c81c41e";
+```
+
+
+### Z_28
+
+```solidity
+bytes32 internal constant Z_28 = hex"662ee4dd2dd7b2bc707961b1e646c4047669dcb6584f0d8d770daf5d7e7deb2e";
+```
+
+
+### Z_29
+
+```solidity
+bytes32 internal constant Z_29 = hex"388ab20e2573d171a88108e79d820e98f26c0b84aa8b2f4aa4968dbb818ea322";
+```
+
+
+### Z_30
+
+```solidity
+bytes32 internal constant Z_30 = hex"93237c50ba75ee485f4c22adf2f741400bdf8d6a9cc7df7ecae576221665d735";
+```
+
+
+### Z_31
+
+```solidity
+bytes32 internal constant Z_31 = hex"8448818bb4ae4562849e949e17ac16e0be16688e156b5cf15e098c627c0056a9";
+```
+
+
+## Functions
+### insert
+
+Inserts `_node` into merkle tree
+
+*Reverts if tree is full*
+
+
+```solidity
+function insert(Tree storage _tree, bytes32 _node) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_tree`|`Tree`||
+|`_node`|`bytes32`|Element to insert into tree|
+
+
+### rootWithCtx
+
+Calculates and returns`_tree`'s current root given array of zero
+hashes
+
+
+```solidity
+function rootWithCtx(Tree storage _tree, bytes32[TREE_DEPTH] memory _zeroes) internal view returns (bytes32 _current);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_tree`|`Tree`||
+|`_zeroes`|`bytes32[TREE_DEPTH]`|Array of zero hashes|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_current`|`bytes32`|Calculated root of `_tree`|
+
+
+### root
+
+Calculates and returns`_tree`'s current root
+
+
+```solidity
+function root(Tree storage _tree) internal view returns (bytes32);
+```
+
+### zeroHashes
+
+Returns array of TREE_DEPTH zero hashes
+
+
+```solidity
+function zeroHashes() internal pure returns (bytes32[TREE_DEPTH] memory _zeroes);
+```
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_zeroes`|`bytes32[TREE_DEPTH]`|Array of TREE_DEPTH zero hashes|
+
+
+### branchRoot
+
+Calculates and returns the merkle root for the given leaf
+`_item`, a merkle branch, and the index of `_item` in the tree.
+
+
+```solidity
+function branchRoot(bytes32 _item, bytes32[TREE_DEPTH] memory _branch, uint256 _index)
+    internal
+    pure
+    returns (bytes32 _current);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_item`|`bytes32`|Merkle leaf|
+|`_branch`|`bytes32[TREE_DEPTH]`|Merkle proof|
+|`_index`|`uint256`|Index of `_item` in tree|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_current`|`bytes32`|Calculated merkle root|
+
+
+## Structs
+### Tree
+Struct representing incremental merkle tree. Contains current
+branch and the number of inserted leaves in the tree.
+
+
+```solidity
+struct Tree {
+    bytes32[TREE_DEPTH] branch;
+    uint256 count;
+}
+```
+

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/60f321f452052881dce4e22999022e11fc117456/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/60f321f452052881dce4e22999022e11fc117456/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/60f321f452052881dce4e22999022e11fc117456/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);
+```
+