@hyperlane-xyz/core 1.4.2 → 1.4.3-beta0

package/docs/src/contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md

@@ -1,19 +0,0 @@
-# ILiquidityLayerRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/ILiquidityLayerRouter.sol)
-
-
-## Functions
-### dispatchWithTokens
-
-
-```solidity
-function dispatchWithTokens(
-    uint32 _destinationDomain,
-    bytes32 _recipientAddress,
-    address _token,
-    uint256 _amount,
-    string calldata _bridge,
-    bytes calldata _messageBody
-) external returns (bytes32);
-```
-

package/docs/src/contracts/interfaces/IMailbox.sol/interface.IMailbox.md

@@ -1,103 +0,0 @@
-# IMailbox
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IMailbox.sol)
-
-
-## Functions
-### localDomain
-
-
-```solidity
-function localDomain() external view returns (uint32);
-```
-
-### delivered
-
-
-```solidity
-function delivered(bytes32 messageId) external view returns (bool);
-```
-
-### defaultIsm
-
-
-```solidity
-function defaultIsm() external view returns (IInterchainSecurityModule);
-```
-
-### dispatch
-
-
-```solidity
-function dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes calldata _messageBody)
-    external
-    returns (bytes32);
-```
-
-### process
-
-
-```solidity
-function process(bytes calldata _metadata, bytes calldata _message) external;
-```
-
-### count
-
-
-```solidity
-function count() external view returns (uint32);
-```
-
-### root
-
-
-```solidity
-function root() external view returns (bytes32);
-```
-
-### latestCheckpoint
-
-
-```solidity
-function latestCheckpoint() external view returns (bytes32, uint32);
-```
-
-### recipientIsm
-
-
-```solidity
-function recipientIsm(address _recipient) external view returns (IInterchainSecurityModule);
-```
-
-## Events
-### Dispatch
-Emitted when a new message is dispatched via Hyperlane
-
-
-```solidity
-event Dispatch(address indexed sender, uint32 indexed destination, bytes32 indexed recipient, bytes message);
-```
-
-### DispatchId
-Emitted when a new message is dispatched via Hyperlane
-
-
-```solidity
-event DispatchId(bytes32 indexed messageId);
-```
-
-### ProcessId
-Emitted when a Hyperlane message is processed
-
-
-```solidity
-event ProcessId(bytes32 indexed messageId);
-```
-
-### Process
-Emitted when a Hyperlane message is delivered
-
-
-```solidity
-event Process(uint32 indexed origin, bytes32 indexed sender, address indexed recipient);
-```
-

package/docs/src/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md

@@ -1,12 +0,0 @@
-# IMessageRecipient
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IMessageRecipient.sol)
-
-
-## Functions
-### handle
-
-
-```solidity
-function handle(uint32 _origin, bytes32 _sender, bytes calldata _message) external;
-```
-

package/docs/src/contracts/interfaces/IRouter.sol/interface.IRouter.md

@@ -1,33 +0,0 @@
-# IRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IRouter.sol)
-
-
-## Functions
-### domains
-
-
-```solidity
-function domains() external view returns (uint32[] memory);
-```
-
-### routers
-
-
-```solidity
-function routers(uint32 _domain) external view returns (bytes32);
-```
-
-### enrollRemoteRouter
-
-
-```solidity
-function enrollRemoteRouter(uint32 _domain, bytes32 _router) external;
-```
-
-### enrollRemoteRouters
-
-
-```solidity
-function enrollRemoteRouters(uint32[] calldata _domains, bytes32[] calldata _routers) external;
-```
-

package/docs/src/contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md

@@ -1,78 +0,0 @@
-# IValidatorAnnounce
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/IValidatorAnnounce.sol)
-
-
-## Functions
-### localDomain
-
-Returns the local domain for validator announcements
-
-
-```solidity
-function localDomain() external view returns (uint32);
-```
-
-### mailbox
-
-Returns the mailbox contract for validator announcements
-
-
-```solidity
-function mailbox() external view returns (address);
-```
-
-### getAnnouncedValidators
-
-Returns a list of validators that have made announcements
-
-
-```solidity
-function getAnnouncedValidators() external view returns (address[] memory);
-```
-
-### getAnnouncedStorageLocations
-
-Returns a list of all announced storage locations for `validators`
-
-
-```solidity
-function getAnnouncedStorageLocations(address[] calldata _validators) external view returns (string[][] memory);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_validators`|`address[]`|The list of validators to get storage locations for|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`string[][]`|A list of announced storage locations|
-
-
-### announce
-
-Announces a validator signature storage location
-
-
-```solidity
-function announce(address _validator, string calldata _storageLocation, bytes calldata _signature)
-    external
-    returns (bool);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_validator`|`address`||
-|`_storageLocation`|`string`|Information encoding the location of signed checkpoints|
-|`_signature`|`bytes`|The signed validator announcement|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bool`|True upon success|
-
-

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

@@ -1,17 +0,0 @@
-
-
-# Contents
-- [hooks](/contracts/interfaces/hooks)
-- [isms](/contracts/interfaces/isms)
-- [middleware](/contracts/interfaces/middleware)
-- [IGasOracle](IGasOracle.sol/interface.IGasOracle.md)
-- [IHyperlaneConnectionClient](IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
-- [IInterchainGasPaymaster](IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md)
-- [IInterchainSecurityModule](IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
-- [ISpecifiesInterchainSecurityModule](IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
-- [ILiquidityLayerMessageRecipient](ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
-- [ILiquidityLayerRouter](ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md)
-- [IMailbox](IMailbox.sol/interface.IMailbox.md)
-- [IMessageRecipient](IMessageRecipient.sol/interface.IMessageRecipient.md)
-- [IRouter](IRouter.sol/interface.IRouter.md)
-- [IValidatorAnnounce](IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)

package/docs/src/contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md

@@ -1,12 +0,0 @@
-# IMessageHook
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/hooks/IMessageHook.sol)
-
-
-## Functions
-### postDispatch
-
-
-```solidity
-function postDispatch(uint32 _destination, bytes32 _messageId) external payable returns (uint256);
-```
-

package/docs/src/contracts/interfaces/hooks/README.md

@@ -1,4 +0,0 @@
-
-
-# Contents
-- [IMessageHook](IMessageHook.sol/interface.IMessageHook.md)

package/docs/src/contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md

@@ -1,36 +0,0 @@
-# IAggregationIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IAggregationIsm.sol)
-
-**Inherits:**
-[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
-
-
-## Functions
-### modulesAndThreshold
-
-Returns the set of modules responsible for verifying _message
-and the number of modules that must verify
-
-*Can change based on the content of _message*
-
-
-```solidity
-function modulesAndThreshold(bytes calldata _message)
-    external
-    view
-    returns (address[] memory modules, uint8 threshold);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|Hyperlane formatted interchain message|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`modules`|`address[]`|The array of ISM addresses|
-|`threshold`|`uint8`|The number of modules needed to verify|
-
-

package/docs/src/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md

@@ -1,36 +0,0 @@
-# IMultisigIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IMultisigIsm.sol)
-
-**Inherits:**
-[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
-
-
-## Functions
-### validatorsAndThreshold
-
-Returns the set of validators responsible for verifying _message
-and the number of signatures required
-
-*Can change based on the content of _message*
-
-
-```solidity
-function validatorsAndThreshold(bytes calldata _message)
-    external
-    view
-    returns (address[] memory validators, uint8 threshold);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|Hyperlane formatted interchain message|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`validators`|`address[]`|The array of validator addresses|
-|`threshold`|`uint8`|The number of validator signatures needed|
-
-

package/docs/src/contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md

@@ -1,31 +0,0 @@
-# IRoutingIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/isms/IRoutingIsm.sol)
-
-**Inherits:**
-[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
-
-
-## Functions
-### route
-
-Returns the ISM responsible for verifying _message
-
-*Can change based on the content of _message*
-
-
-```solidity
-function route(bytes calldata _message) external view 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/interfaces/isms/README.md

@@ -1,6 +0,0 @@
-
-
-# Contents
-- [IAggregationIsm](IAggregationIsm.sol/interface.IAggregationIsm.md)
-- [IMultisigIsm](IMultisigIsm.sol/interface.IMultisigIsm.md)
-- [IRoutingIsm](IRoutingIsm.sol/interface.IRoutingIsm.md)

package/docs/src/contracts/interfaces/middleware/IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md

@@ -1,64 +0,0 @@
-# IInterchainAccountRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/middleware/IInterchainAccountRouter.sol)
-
-
-## Functions
-### callRemote
-
-
-```solidity
-function callRemote(uint32 _destination, address _to, uint256 _value, bytes calldata _data)
-    external
-    returns (bytes32);
-```
-
-### callRemote
-
-
-```solidity
-function callRemote(uint32 _destination, CallLib.Call[] calldata calls) external returns (bytes32);
-```
-
-### callRemoteWithOverrides
-
-
-```solidity
-function callRemoteWithOverrides(uint32 _destination, bytes32 _router, bytes32 _ism, CallLib.Call[] calldata calls)
-    external
-    returns (bytes32);
-```
-
-### getLocalInterchainAccount
-
-
-```solidity
-function getLocalInterchainAccount(uint32 _origin, bytes32 _router, bytes32 _owner, address _ism)
-    external
-    view
-    returns (OwnableMulticall);
-```
-
-### getLocalInterchainAccount
-
-
-```solidity
-function getLocalInterchainAccount(uint32 _origin, address _router, address _owner, address _ism)
-    external
-    view
-    returns (OwnableMulticall);
-```
-
-### getRemoteInterchainAccount
-
-
-```solidity
-function getRemoteInterchainAccount(address _router, address _owner, address _ism) external view returns (address);
-```
-
-### getRemoteInterchainAccount
-
-
-```solidity
-function getRemoteInterchainAccount(uint32 _destination, address _owner) external view returns (address);
-```
-

package/docs/src/contracts/interfaces/middleware/IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md

@@ -1,21 +0,0 @@
-# IInterchainQueryRouter
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/interfaces/middleware/IInterchainQueryRouter.sol)
-
-
-## Functions
-### query
-
-
-```solidity
-function query(uint32 _destination, address _to, bytes memory _data, bytes memory _callback)
-    external
-    returns (bytes32);
-```
-
-### query
-
-
-```solidity
-function query(uint32 _destination, CallLib.StaticCallWithCallback[] calldata calls) external returns (bytes32);
-```
-

package/docs/src/contracts/interfaces/middleware/README.md

@@ -1,5 +0,0 @@
-
-
-# Contents
-- [IInterchainAccountRouter](IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md)
-- [IInterchainQueryRouter](IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md)

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

@@ -1,7 +0,0 @@
-
-
-# Contents
-- [aggregation](/contracts/isms/aggregation)
-- [hook](/contracts/isms/hook)
-- [multisig](/contracts/isms/multisig)
-- [routing](/contracts/isms/routing)

package/docs/src/contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md

@@ -1,60 +0,0 @@
-# AbstractAggregationIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/aggregation/AbstractAggregationIsm.sol)
-
-**Inherits:**
-[IAggregationIsm](/contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md)
-
-Manages per-domain m-of-n ISM sets that are used to verify
-interchain messages.
-
-
-## State Variables
-### moduleType
-
-```solidity
-uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.AGGREGATION);
-```
-
-
-## Functions
-### modulesAndThreshold
-
-Returns the set of ISMs responsible for verifying _message
-and the number of ISMs that must verify
-
-*Can change based on the content of _message*
-
-
-```solidity
-function modulesAndThreshold(bytes calldata _message) public view virtual returns (address[] memory, uint8);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_message`|`bytes`|Hyperlane formatted interchain message|
-
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address[]`|modules The array of ISM addresses|
-|`<none>`|`uint8`|threshold The number of ISMs needed to verify|
-
-
-### verify
-
-Requires that m-of-n ISMs verify the provided interchain message.
-
-
-```solidity
-function verify(bytes calldata _metadata, bytes calldata _message) public returns (bool);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`_metadata`|`bytes`|ABI encoded module metadata (see AggregationIsmMetadata.sol)|
-|`_message`|`bytes`|Formatted Hyperlane message (see Message.sol).|
-
-

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

@@ -1,6 +0,0 @@
-
-
-# Contents
-- [AbstractAggregationIsm](AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
-- [StaticAggregationIsm](StaticAggregationIsm.sol/contract.StaticAggregationIsm.md)
-- [StaticAggregationIsmFactory](StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md)

package/docs/src/contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md

@@ -1,30 +0,0 @@
-# StaticAggregationIsm
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/aggregation/StaticAggregationIsm.sol)
-
-**Inherits:**
-[AbstractAggregationIsm](/contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
-
-Manages per-domain m-of-n ISM sets that are used to verify
-interchain messages.
-
-
-## Functions
-### modulesAndThreshold
-
-Returns the set of ISMs responsible for verifying _message
-and the number of ISMs that must verify
-
-*Can change based on the content of _message*
-
-
-```solidity
-function modulesAndThreshold(bytes calldata) public view virtual override returns (address[] memory, uint8);
-```
-**Returns**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`address[]`|modules The array of ISM addresses|
-|`<none>`|`uint8`|threshold The number of ISMs needed to verify|
-
-

package/docs/src/contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md

@@ -1,15 +0,0 @@
-# StaticAggregationIsmFactory
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/aggregation/StaticAggregationIsmFactory.sol)
-
-**Inherits:**
-[StaticMOfNAddressSetFactory](/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
-
-
-## Functions
-### _deployImplementation
-
-
-```solidity
-function _deployImplementation() internal virtual override returns (address);
-```
-

package/docs/src/contracts/isms/hook/AbstractHookISM.sol/abstract.AbstractHookISM.md

@@ -1,44 +0,0 @@
-# AbstractHookISM
-[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/isms/hook/AbstractHookISM.sol)
-
-**Inherits:**
-[IInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md), Initializable
-
-Uses the native bridges to verify interchain messages.
-
-*In the future, the hook might be moved inside the Mailbox which doesn't require storage mappings for senders.
-for more details see https://github.com/hyperlane-xyz/hyperlane-monorepo/issues/2381*
-
-
-## State Variables
-### verifiedMessageIds
-
-```solidity
-mapping(bytes32 => mapping(bytes32 => bool)) public verifiedMessageIds;
-```
-
-
-## Functions
-### verify
-
-Verify a message was received by ISM.
-
-
-```solidity
-function verify(bytes calldata, bytes calldata _message) external view returns (bool);
-```
-**Parameters**
-
-|Name|Type|Description|
-|----|----|-----------|
-|`<none>`|`bytes`||
-|`_message`|`bytes`|Message to verify.|
-
-
-## Events
-### ReceivedMessage
-
-```solidity
-event ReceivedMessage(bytes32 indexed sender, bytes32 indexed messageId);
-```
-