npm - @hyperlane-xyz/core - Versions diffs - 1.4.2 → 1.4.3-beta0 - Mend

@hyperlane-xyz/core 1.4.2 → 1.4.3-beta0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1233) hide show

package/docs/src/contracts/isms/routing/InterchainAccountIsm.sol/contract.InterchainAccountIsm.md DELETED Viewed

@@ -1,44 +0,0 @@
-# InterchainAccountIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/routing/InterchainAccountIsm.sol)
-**Inherits:**
-[AbstractRoutingIsm](/contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md)
-## State Variables
-### mailbox
-```solidity
-IMailbox private immutable mailbox;
-```
-## Functions
-### constructor
-```solidity
-constructor(address _mailbox);
-```
-### route
-Returns the ISM responsible for verifying _message
-```solidity
-function route(bytes calldata _message) public view virtual override returns (IInterchainSecurityModule);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`IInterchainSecurityModule`|module The ISM to use to verify _message|

package/docs/src/contracts/isms/routing/README.md DELETED Viewed

@@ -1,7 +0,0 @@
-# Contents
-- [AbstractRoutingIsm](AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md)
-- [DomainRoutingIsm](DomainRoutingIsm.sol/contract.DomainRoutingIsm.md)
-- [DomainRoutingIsmFactory](DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md)
-- [InterchainAccountIsm](InterchainAccountIsm.sol/contract.InterchainAccountIsm.md)

package/docs/src/contracts/libs/Call.sol/library.CallLib.md DELETED Viewed

@@ -1,124 +0,0 @@
-# CallLib
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/Call.sol)
-## Functions
-### call
-```solidity
-function call(Call memory _call) internal returns (bytes memory returnData);
-```
-### staticcall
-```solidity
-function staticcall(StaticCall memory _call) private view returns (bytes memory);
-```
-### staticcall
-```solidity
-function staticcall(StaticCallWithCallback memory _call) internal view returns (bytes memory callback);
-```
-### multicall
-```solidity
-function multicall(Call[] memory calls) internal;
-```
-### multistaticcall
-```solidity
-function multistaticcall(StaticCallWithCallback[] memory _calls) internal view returns (bytes[] memory);
-```
-### multicallto
-```solidity
-function multicallto(address to, bytes[] memory calls) internal;
-```
-### build
-```solidity
-function build(bytes32 to, bytes memory data) internal pure returns (StaticCall memory);
-```
-### build
-```solidity
-function build(address to, bytes memory data) internal pure returns (StaticCall memory);
-```
-### build
-```solidity
-function build(bytes32 to, uint256 value, bytes memory data) internal pure returns (Call memory);
-```
-### build
-```solidity
-function build(address to, uint256 value, bytes memory data) internal pure returns (Call memory);
-```
-### build
-```solidity
-function build(bytes32 to, bytes memory data, bytes memory callback)
-    internal
-    pure
-    returns (StaticCallWithCallback memory);
-```
-### build
-```solidity
-function build(address to, bytes memory data, bytes memory callback)
-    internal
-    pure
-    returns (StaticCallWithCallback memory);
-```
-## Structs
-### StaticCall
-```solidity
-struct StaticCall {
-    bytes32 to;
-    bytes data;
-}
-```
-### Call
-```solidity
-struct Call {
-    bytes32 to;
-    uint256 value;
-    bytes data;
-}
-```
-### StaticCallWithCallback
-```solidity
-struct StaticCallWithCallback {
-    StaticCall _call;
-    bytes callback;
-}
-```

package/docs/src/contracts/libs/CheckpointLib.sol/library.CheckpointLib.md DELETED Viewed

@@ -1,61 +0,0 @@
-# CheckpointLib
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/CheckpointLib.sol)
-## Functions
-### digest
-Returns the digest validators are expected to sign when signing checkpoints.
-*Message ID must match leaf content of checkpoint root at index.*
-```solidity
-function digest(
-    uint32 _origin,
-    bytes32 _originMailbox,
-    bytes32 _checkpointRoot,
-    uint32 _checkpointIndex,
-    bytes32 _messageId
-) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_origin`|`uint32`|The origin domain of the checkpoint.|
-|`_originMailbox`|`bytes32`|The address of the origin mailbox as bytes32.|
-|`_checkpointRoot`|`bytes32`|The root of the checkpoint.|
-|`_checkpointIndex`|`uint32`|The index of the checkpoint.|
-|`_messageId`|`bytes32`|The message ID of the checkpoint.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The digest of the checkpoint.|
-### domainHash
-Returns the domain hash that validators are expected to use
-when signing checkpoints.
-```solidity
-function domainHash(uint32 _origin, bytes32 _originMailbox) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_origin`|`uint32`|The origin domain of the checkpoint.|
-|`_originMailbox`|`bytes32`|The address of the origin mailbox as bytes32.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The domain hash.|

package/docs/src/contracts/libs/EnumerableMapExtended.sol/library.EnumerableMapExtended.md DELETED Viewed

@@ -1,63 +0,0 @@
-# EnumerableMapExtended
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/EnumerableMapExtended.sol)
-## Functions
-### keys
-```solidity
-function keys(UintToBytes32Map storage map) internal view returns (bytes32[] storage);
-```
-### set
-```solidity
-function set(UintToBytes32Map storage map, uint256 key, bytes32 value) internal;
-```
-### get
-```solidity
-function get(UintToBytes32Map storage map, uint256 key) internal view returns (bytes32);
-```
-### remove
-```solidity
-function remove(UintToBytes32Map storage map, uint256 key) internal returns (bool);
-```
-### contains
-```solidity
-function contains(UintToBytes32Map storage map, uint256 key) internal view returns (bool);
-```
-### length
-```solidity
-function length(UintToBytes32Map storage map) internal view returns (uint256);
-```
-### at
-```solidity
-function at(UintToBytes32Map storage map, uint256 index) internal view returns (uint256, bytes32);
-```
-## Structs
-### UintToBytes32Map
-```solidity
-struct UintToBytes32Map {
-    EnumerableMap.Bytes32ToBytes32Map _inner;
-}
-```

package/docs/src/contracts/libs/LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md DELETED Viewed

@@ -1,55 +0,0 @@
-# LegacyCheckpointLib
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/libs/LegacyCheckpointLib.sol)
-## Functions
-### digest
-Returns the digest validators are expected to sign when signing legacy checkpoints.
-```solidity
-function digest(uint32 _origin, bytes32 _originMailbox, bytes32 _checkpointRoot, uint32 _checkpointIndex)
-    internal
-    pure
-    returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_origin`|`uint32`|The origin domain of the checkpoint.|
-|`_originMailbox`|`bytes32`|The address of the origin mailbox as bytes32.|
-|`_checkpointRoot`|`bytes32`||
-|`_checkpointIndex`|`uint32`||
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The digest of the legacy checkpoint.|
-### domainHash
-Returns the domain hash that validators are expected to use
-when signing checkpoints.
-```solidity
-function domainHash(uint32 _origin, bytes32 _originMailbox) internal pure returns (bytes32);
-```
-**Parameters**
-|Name|Type|Description|
-|----|----|-----------|
-|`_origin`|`uint32`|The origin domain of the checkpoint.|
-|`_originMailbox`|`bytes32`|The address of the origin mailbox as bytes32.|
-**Returns**
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes32`|The domain hash.|

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

@@ -1,354 +0,0 @@
-# MerkleLib
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/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;
-}
-```