@hyperlane-xyz/core 1.4.0 → 1.4.2

package/docs/src/contracts/test/TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md

@@ -0,0 +1,30 @@
+# TestInterchainGasPaymaster
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestInterchainGasPaymaster.sol)
+
+**Inherits:**
+[InterchainGasPaymaster](/contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md)
+
+
+## State Variables
+### gasPrice
+
+```solidity
+uint256 public constant gasPrice = 10;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address _beneficiary);
+```
+
+### quoteGasPayment
+
+
+```solidity
+function quoteGasPayment(uint32, uint256 gasAmount) public pure override returns (uint256);
+```
+

package/docs/src/contracts/test/TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md

@@ -0,0 +1,15 @@
+# TestLegacyMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestLegacyMultisigIsm.sol)
+
+**Inherits:**
+[LegacyMultisigIsm](/contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md)
+
+
+## Functions
+### getDomainHash
+
+
+```solidity
+function getDomainHash(uint32 _origin, bytes32 _originMailbox) external pure returns (bytes32);
+```
+

package/docs/src/contracts/test/TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md

@@ -0,0 +1,23 @@
+# TestLiquidityLayerMessageRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestLiquidityLayerMessageRecipient.sol)
+
+**Inherits:**
+[ILiquidityLayerMessageRecipient](/contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
+
+
+## Functions
+### handleWithTokens
+
+
+```solidity
+function handleWithTokens(uint32 _origin, bytes32 _sender, bytes calldata _message, address _token, uint256 _amount)
+    external;
+```
+
+## Events
+### HandledWithTokens
+
+```solidity
+event HandledWithTokens(uint32 origin, bytes32 sender, bytes message, address token, uint256 amount);
+```
+

package/docs/src/contracts/test/TestMailbox.sol/contract.TestMailbox.md

@@ -0,0 +1,29 @@
+# TestMailbox
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestMailbox.sol)
+
+**Inherits:**
+[Mailbox](/contracts/Mailbox.sol/contract.Mailbox.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _localDomain) Mailbox(_localDomain);
+```
+
+### proof
+
+
+```solidity
+function proof() external view returns (bytes32[32] memory);
+```
+
+### testHandle
+
+
+```solidity
+function testHandle(uint32 _origin, bytes32 _sender, bytes32 _recipient, bytes calldata _body) external;
+```
+

package/docs/src/contracts/test/TestMerkle.sol/contract.TestMerkle.md

@@ -0,0 +1,50 @@
+# TestMerkle
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestMerkle.sol)
+
+
+## State Variables
+### tree
+
+```solidity
+MerkleLib.Tree public tree;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### insert
+
+
+```solidity
+function insert(bytes32 _node) external;
+```
+
+### branchRoot
+
+
+```solidity
+function branchRoot(bytes32 _leaf, bytes32[32] calldata _proof, uint256 _index) external pure returns (bytes32 _node);
+```
+
+### count
+
+Returns the number of inserted leaves in the tree
+
+
+```solidity
+function count() public view returns (uint256);
+```
+
+### root
+
+
+```solidity
+function root() public view returns (bytes32);
+```
+

package/docs/src/contracts/test/TestMessage.sol/contract.TestMessage.md

@@ -0,0 +1,68 @@
+# TestMessage
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestMessage.sol)
+
+
+## Functions
+### version
+
+
+```solidity
+function version(bytes calldata _message) external pure returns (uint32 _version);
+```
+
+### nonce
+
+
+```solidity
+function nonce(bytes calldata _message) external pure returns (uint256 _nonce);
+```
+
+### body
+
+
+```solidity
+function body(bytes calldata _message) external pure returns (bytes calldata _body);
+```
+
+### origin
+
+
+```solidity
+function origin(bytes calldata _message) external pure returns (uint32 _origin);
+```
+
+### sender
+
+
+```solidity
+function sender(bytes calldata _message) external pure returns (bytes32 _sender);
+```
+
+### destination
+
+
+```solidity
+function destination(bytes calldata _message) external pure returns (uint32 _destination);
+```
+
+### recipient
+
+
+```solidity
+function recipient(bytes calldata _message) external pure returns (bytes32 _recipient);
+```
+
+### recipientAddress
+
+
+```solidity
+function recipientAddress(bytes calldata _message) external pure returns (address _recipient);
+```
+
+### id
+
+
+```solidity
+function id(bytes calldata _message) external pure returns (bytes32);
+```
+

package/docs/src/contracts/test/TestMultisigIsm.sol/contract.TestMultisigIsm.md

@@ -0,0 +1,51 @@
+# TestMultisigIsm
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestMultisigIsm.sol)
+
+**Inherits:**
+[IMultisigIsm](/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md)
+
+
+## State Variables
+### moduleType
+
+```solidity
+uint8 public constant moduleType = uint8(IInterchainSecurityModule.Types.MERKLE_ROOT_MULTISIG);
+```
+
+
+### accept
+
+```solidity
+bool public accept;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### validatorsAndThreshold
+
+
+```solidity
+function validatorsAndThreshold(bytes calldata) external pure returns (address[] memory, uint8);
+```
+
+### setAccept
+
+
+```solidity
+function setAccept(bool _val) external;
+```
+
+### verify
+
+
+```solidity
+function verify(bytes calldata, bytes calldata) external view returns (bool);
+```
+

package/docs/src/contracts/test/TestQuery.sol/contract.TestQuery.md

@@ -0,0 +1,45 @@
+# TestQuery
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestQuery.sol)
+
+
+## State Variables
+### router
+
+```solidity
+InterchainQueryRouter public router;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(address _router);
+```
+
+### queryRouterOwner
+
+*Fetches owner of InterchainQueryRouter on provided domain and passes along with provided secret to `this.receiveRouterOwner`*
+
+
+```solidity
+function queryRouterOwner(uint32 domain, uint256 secret) external;
+```
+
+### receiveRouterOwner
+
+*`msg.sender` must be restricted to `this.router` to prevent any local account from spoofing query data.*
+
+
+```solidity
+function receiveRouterOwner(uint256 secret, address owner) external;
+```
+
+## Events
+### Owner
+
+```solidity
+event Owner(uint256, address);
+```
+

package/docs/src/contracts/test/TestQuerySender.sol/contract.TestQuerySender.md

@@ -0,0 +1,128 @@
+# TestQuerySender
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestQuerySender.sol)
+
+
+## State Variables
+### queryRouter
+
+```solidity
+IInterchainQueryRouter queryRouter;
+```
+
+
+### interchainGasPaymaster
+
+```solidity
+IInterchainGasPaymaster interchainGasPaymaster;
+```
+
+
+### lastAddressResult
+
+```solidity
+address public lastAddressResult;
+```
+
+
+### lastUint256Result
+
+```solidity
+uint256 public lastUint256Result;
+```
+
+
+### lastBytes32Result
+
+```solidity
+bytes32 public lastBytes32Result;
+```
+
+
+## Functions
+### initialize
+
+
+```solidity
+function initialize(address _queryRouterAddress, address _interchainGasPaymaster) external;
+```
+
+### queryAddress
+
+
+```solidity
+function queryAddress(uint32 _destinationDomain, address _target, bytes calldata _targetData, uint256 _gasAmount)
+    external
+    payable;
+```
+
+### handleQueryAddressResult
+
+
+```solidity
+function handleQueryAddressResult(address _result) external;
+```
+
+### queryUint256
+
+
+```solidity
+function queryUint256(uint32 _destinationDomain, address _target, bytes calldata _targetData, uint256 _gasAmount)
+    external
+    payable;
+```
+
+### handleQueryUint256Result
+
+
+```solidity
+function handleQueryUint256Result(uint256 _result) external;
+```
+
+### queryBytes32
+
+
+```solidity
+function queryBytes32(uint32 _destinationDomain, address _target, bytes calldata _targetData, uint256 _gasAmount)
+    external
+    payable;
+```
+
+### handleQueryBytes32Result
+
+
+```solidity
+function handleQueryBytes32Result(bytes32 _result) external;
+```
+
+### queryAndPayFor
+
+
+```solidity
+function queryAndPayFor(
+    uint32 _destinationDomain,
+    address _target,
+    bytes calldata _targetData,
+    bytes4 _callbackSelector,
+    uint256 _gasAmount
+) internal;
+```
+
+## Events
+### ReceivedAddressResult
+
+```solidity
+event ReceivedAddressResult(address result);
+```
+
+### ReceivedUint256Result
+
+```solidity
+event ReceivedUint256Result(uint256 result);
+```
+
+### ReceivedBytes32Result
+
+```solidity
+event ReceivedBytes32Result(bytes32 result);
+```
+

package/docs/src/contracts/test/TestRecipient.sol/contract.TestRecipient.md

@@ -0,0 +1,78 @@
+# TestRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestRecipient.sol)
+
+**Inherits:**
+Ownable, [IMessageRecipient](/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md), [ISpecifiesInterchainSecurityModule](/contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
+
+
+## State Variables
+### interchainSecurityModule
+
+```solidity
+IInterchainSecurityModule public interchainSecurityModule;
+```
+
+
+### lastSender
+
+```solidity
+bytes32 public lastSender;
+```
+
+
+### lastData
+
+```solidity
+bytes public lastData;
+```
+
+
+### lastCaller
+
+```solidity
+address public lastCaller;
+```
+
+
+### lastCallMessage
+
+```solidity
+string public lastCallMessage;
+```
+
+
+## Functions
+### handle
+
+
+```solidity
+function handle(uint32 _origin, bytes32 _sender, bytes calldata _data) external virtual override;
+```
+
+### fooBar
+
+
+```solidity
+function fooBar(uint256 amount, string calldata message) external;
+```
+
+### setInterchainSecurityModule
+
+
+```solidity
+function setInterchainSecurityModule(address _ism) external onlyOwner;
+```
+
+## Events
+### ReceivedMessage
+
+```solidity
+event ReceivedMessage(uint32 indexed origin, bytes32 indexed sender, string message);
+```
+
+### ReceivedCall
+
+```solidity
+event ReceivedCall(address indexed caller, uint256 amount, string message);
+```
+

package/docs/src/contracts/test/TestRouter.sol/contract.TestRouter.md

@@ -0,0 +1,63 @@
+# TestRouter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestRouter.sol)
+
+**Inherits:**
+[Router](/contracts/Router.sol/abstract.Router.md)
+
+
+## Functions
+### initialize
+
+
+```solidity
+function initialize(address _mailbox, address _interchainGasPaymaster) external initializer;
+```
+
+### _handle
+
+
+```solidity
+function _handle(uint32, bytes32, bytes calldata) internal pure override;
+```
+
+### isRemoteRouter
+
+
+```solidity
+function isRemoteRouter(uint32 _domain, bytes32 _potentialRemoteRouter) external view returns (bool);
+```
+
+### mustHaveRemoteRouter
+
+
+```solidity
+function mustHaveRemoteRouter(uint32 _domain) external view returns (bytes32);
+```
+
+### dispatch
+
+
+```solidity
+function dispatch(uint32 _destination, bytes memory _msg) external;
+```
+
+### dispatchWithGas
+
+
+```solidity
+function dispatchWithGas(
+    uint32 _destinationDomain,
+    bytes memory _messageBody,
+    uint256 _gasAmount,
+    uint256 _gasPayment,
+    address _gasPaymentRefundAddress
+) external payable;
+```
+
+## Events
+### InitializeOverload
+
+```solidity
+event InitializeOverload();
+```
+

package/docs/src/contracts/test/TestSendReceiver.sol/contract.TestSendReceiver.md

@@ -0,0 +1,49 @@
+# TestSendReceiver
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestSendReceiver.sol)
+
+**Inherits:**
+[IMessageRecipient](/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md)
+
+
+## State Variables
+### HANDLE_GAS_AMOUNT
+
+```solidity
+uint256 public constant HANDLE_GAS_AMOUNT = 50_000;
+```
+
+
+## Functions
+### dispatchToSelf
+
+
+```solidity
+function dispatchToSelf(
+    IMailbox _mailbox,
+    IInterchainGasPaymaster _paymaster,
+    uint32 _destinationDomain,
+    bytes calldata _messageBody
+) external payable;
+```
+
+### handle
+
+
+```solidity
+function handle(uint32, bytes32, bytes calldata) external override;
+```
+
+### previousBlockHash
+
+
+```solidity
+function previousBlockHash() internal view returns (bytes32);
+```
+
+## Events
+### Handled
+
+```solidity
+event Handled(bytes32 blockHash);
+```
+

package/docs/src/contracts/test/TestTokenRecipient.sol/contract.TestTokenRecipient.md

@@ -0,0 +1,80 @@
+# TestTokenRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/test/TestTokenRecipient.sol)
+
+**Inherits:**
+[ILiquidityLayerMessageRecipient](/contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
+
+
+## State Variables
+### lastSender
+
+```solidity
+bytes32 public lastSender;
+```
+
+
+### lastData
+
+```solidity
+bytes public lastData;
+```
+
+
+### lastToken
+
+```solidity
+address public lastToken;
+```
+
+
+### lastAmount
+
+```solidity
+uint256 public lastAmount;
+```
+
+
+### lastCaller
+
+```solidity
+address public lastCaller;
+```
+
+
+### lastCallMessage
+
+```solidity
+string public lastCallMessage;
+```
+
+
+## Functions
+### handleWithTokens
+
+
+```solidity
+function handleWithTokens(uint32 _origin, bytes32 _sender, bytes calldata _data, address _token, uint256 _amount)
+    external
+    override;
+```
+
+### fooBar
+
+
+```solidity
+function fooBar(uint256 amount, string calldata message) external;
+```
+
+## Events
+### ReceivedMessage
+
+```solidity
+event ReceivedMessage(uint32 indexed origin, bytes32 indexed sender, string message, address token, uint256 amount);
+```
+
+### ReceivedCall
+
+```solidity
+event ReceivedCall(address indexed caller, uint256 amount, string message);
+```
+