@hyperlane-xyz/core 1.4.1 → 1.4.2

package/docs/src/contracts/isms/routing/DomainRoutingIsm.sol/contract.DomainRoutingIsm.md

@@ -0,0 +1,112 @@
+# DomainRoutingIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/routing/DomainRoutingIsm.sol)
+
+**Inherits:**
+[AbstractRoutingIsm](/contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md), OwnableUpgradeable
+
+
+## State Variables
+### modules
+
+```solidity
+mapping(uint32 => IInterchainSecurityModule) public modules;
+```
+
+
+## Functions
+### initialize
+
+
+```solidity
+function initialize(address _owner) public initializer;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`address`|The owner of the contract.|
+
+
+### initialize
+
+Sets the ISMs to be used for the specified origin domains
+
+
+```solidity
+function initialize(address _owner, uint32[] calldata _domains, IInterchainSecurityModule[] calldata _modules)
+    public
+    initializer;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_owner`|`address`|The owner of the contract.|
+|`_domains`|`uint32[]`|The origin domains|
+|`_modules`|`IInterchainSecurityModule[]`|The ISMs to use to verify messages|
+
+
+### set
+
+Sets the ISM to be used for the specified origin domain
+
+
+```solidity
+function set(uint32 _domain, IInterchainSecurityModule _module) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The origin domain|
+|`_module`|`IInterchainSecurityModule`|The ISM to use to verify messages|
+
+
+### route
+
+Returns the ISM responsible for verifying _message
+
+*Can change based on the content of _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|
+
+
+### _set
+
+Sets the ISM to be used for the specified origin domain
+
+
+```solidity
+function _set(uint32 _domain, IInterchainSecurityModule _module) internal;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domain`|`uint32`|The origin domain|
+|`_module`|`IInterchainSecurityModule`|The ISM to use to verify messages|
+
+
+## Events
+### ModuleSet
+Emitted when a module is set for a domain
+
+
+```solidity
+event ModuleSet(uint32 indexed domain, IInterchainSecurityModule module);
+```
+

package/docs/src/contracts/isms/routing/DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md

@@ -0,0 +1,47 @@
+# DomainRoutingIsmFactory
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/routing/DomainRoutingIsmFactory.sol)
+
+
+## State Variables
+### _implementation
+
+```solidity
+address private immutable _implementation;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### deploy
+
+Deploys and initializes a DomainRoutingIsm using a minimal proxy
+
+
+```solidity
+function deploy(uint32[] calldata _domains, IInterchainSecurityModule[] calldata _modules)
+    external
+    returns (DomainRoutingIsm);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_domains`|`uint32[]`|The origin domains|
+|`_modules`|`IInterchainSecurityModule[]`|The ISMs to use to verify messages|
+
+
+## Events
+### ModuleDeployed
+Emitted when a routing module is deployed
+
+
+```solidity
+event ModuleDeployed(DomainRoutingIsm module);
+```
+

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

@@ -0,0 +1,44 @@
+# 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

@@ -0,0 +1,7 @@
+
+
+# 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

@@ -0,0 +1,124 @@
+# 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

@@ -0,0 +1,61 @@
+# 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

@@ -0,0 +1,63 @@
+# 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

@@ -0,0 +1,55 @@
+# 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.|
+
+