@hyperlane-xyz/core 1.3.7 → 1.3.8

package/docs/src/contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md

@@ -0,0 +1,131 @@
+# IPortalTokenBridge
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol)
+
+
+## Functions
+### transferTokensWithPayload
+
+
+```solidity
+function transferTokensWithPayload(
+    address token,
+    uint256 amount,
+    uint16 recipientChain,
+    bytes32 recipient,
+    uint32 nonce,
+    bytes memory payload
+) external payable returns (uint64 sequence);
+```
+
+### completeTransferWithPayload
+
+
+```solidity
+function completeTransferWithPayload(bytes memory encodedVm) external returns (bytes memory);
+```
+
+### parseTransferWithPayload
+
+
+```solidity
+function parseTransferWithPayload(bytes memory encoded) external pure returns (TransferWithPayload memory transfer);
+```
+
+### wrappedAsset
+
+
+```solidity
+function wrappedAsset(uint16 tokenChainId, bytes32 tokenAddress) external view returns (address);
+```
+
+### isWrappedAsset
+
+
+```solidity
+function isWrappedAsset(address token) external view returns (bool);
+```
+
+## Events
+### ContractUpgraded
+
+```solidity
+event ContractUpgraded(address indexed oldContract, address indexed newContract);
+```
+
+## Structs
+### Transfer
+
+```solidity
+struct Transfer {
+    uint8 payloadID;
+    uint256 amount;
+    bytes32 tokenAddress;
+    uint16 tokenChain;
+    bytes32 to;
+    uint16 toChain;
+    uint256 fee;
+}
+```
+
+### TransferWithPayload
+
+```solidity
+struct TransferWithPayload {
+    uint8 payloadID;
+    uint256 amount;
+    bytes32 tokenAddress;
+    uint16 tokenChain;
+    bytes32 to;
+    uint16 toChain;
+    bytes32 fromAddress;
+    bytes payload;
+}
+```
+
+### AssetMeta
+
+```solidity
+struct AssetMeta {
+    uint8 payloadID;
+    bytes32 tokenAddress;
+    uint16 tokenChain;
+    uint8 decimals;
+    bytes32 symbol;
+    bytes32 name;
+}
+```
+
+### RegisterChain
+
+```solidity
+struct RegisterChain {
+    bytes32 module;
+    uint8 action;
+    uint16 chainId;
+    uint16 emitterChainID;
+    bytes32 emitterAddress;
+}
+```
+
+### UpgradeContract
+
+```solidity
+struct UpgradeContract {
+    bytes32 module;
+    uint8 action;
+    uint16 chainId;
+    bytes32 newContract;
+}
+```
+
+### RecoverChainId
+
+```solidity
+struct RecoverChainId {
+    bytes32 module;
+    uint8 action;
+    uint256 evmChainId;
+    uint16 newChainId;
+}
+```
+

package/docs/src/contracts/middleware/liquidity-layer/interfaces/portal/README.md

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

package/docs/src/contracts/mock/MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md

@@ -0,0 +1,58 @@
+# MockCircleMessageTransmitter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockCircleMessageTransmitter.sol)
+
+**Inherits:**
+[ICircleMessageTransmitter](/contracts/middleware/liquidity-layer/interfaces/circle/ICircleMessageTransmitter.sol/interface.ICircleMessageTransmitter.md)
+
+
+## State Variables
+### processedNonces
+
+```solidity
+mapping(bytes32 => bool) processedNonces;
+```
+
+
+### token
+
+```solidity
+MockToken token;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(MockToken _token);
+```
+
+### receiveMessage
+
+
+```solidity
+function receiveMessage(bytes memory, bytes calldata) external pure returns (bool success);
+```
+
+### hashSourceAndNonce
+
+
+```solidity
+function hashSourceAndNonce(uint32 _source, uint64 _nonce) public pure returns (bytes32);
+```
+
+### process
+
+
+```solidity
+function process(bytes32 _nonceId, address _recipient, uint256 _amount) public;
+```
+
+### usedNonces
+
+
+```solidity
+function usedNonces(bytes32 _nonceId) external view returns (bool);
+```
+

package/docs/src/contracts/mock/MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md

@@ -0,0 +1,44 @@
+# MockCircleTokenMessenger
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockCircleTokenMessenger.sol)
+
+**Inherits:**
+[ITokenMessenger](/contracts/middleware/liquidity-layer/interfaces/circle/ITokenMessenger.sol/interface.ITokenMessenger.md)
+
+
+## State Variables
+### nextNonce
+
+```solidity
+uint64 public nextNonce = 0;
+```
+
+
+### token
+
+```solidity
+MockToken token;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(MockToken _token);
+```
+
+### depositForBurn
+
+
+```solidity
+function depositForBurn(uint256 _amount, uint32, bytes32, address _burnToken) external returns (uint64 _nonce);
+```
+
+### depositForBurnWithCaller
+
+
+```solidity
+function depositForBurnWithCaller(uint256, uint32, bytes32, address, bytes32) external returns (uint64 _nonce);
+```
+

package/docs/src/contracts/mock/MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md

@@ -0,0 +1,69 @@
+# MockHyperlaneEnvironment
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockHyperlaneEnvironment.sol)
+
+
+## State Variables
+### originDomain
+
+```solidity
+uint32 originDomain;
+```
+
+
+### destinationDomain
+
+```solidity
+uint32 destinationDomain;
+```
+
+
+### mailboxes
+
+```solidity
+mapping(uint32 => MockMailbox) public mailboxes;
+```
+
+
+### igps
+
+```solidity
+mapping(uint32 => TestInterchainGasPaymaster) public igps;
+```
+
+
+### isms
+
+```solidity
+mapping(uint32 => IInterchainSecurityModule) public isms;
+```
+
+
+### queryRouters
+
+```solidity
+mapping(uint32 => InterchainQueryRouter) public queryRouters;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _originDomain, uint32 _destinationDomain);
+```
+
+### processNextPendingMessage
+
+
+```solidity
+function processNextPendingMessage() public;
+```
+
+### processNextPendingMessageFromDestination
+
+
+```solidity
+function processNextPendingMessageFromDestination() public;
+```
+

package/docs/src/contracts/mock/MockMailbox.sol/contract.MockMailbox.md

@@ -0,0 +1,137 @@
+# MockMailbox
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockMailbox.sol)
+
+**Inherits:**
+[Versioned](/contracts/upgrade/Versioned.sol/contract.Versioned.md)
+
+
+## State Variables
+### localDomain
+
+```solidity
+uint32 public immutable localDomain;
+```
+
+
+### MAX_MESSAGE_BODY_BYTES
+
+```solidity
+uint256 public constant MAX_MESSAGE_BODY_BYTES = 2 * 2 ** 10;
+```
+
+
+### outboundNonce
+
+```solidity
+uint32 public outboundNonce = 0;
+```
+
+
+### inboundUnprocessedNonce
+
+```solidity
+uint32 public inboundUnprocessedNonce = 0;
+```
+
+
+### inboundProcessedNonce
+
+```solidity
+uint32 public inboundProcessedNonce = 0;
+```
+
+
+### defaultIsm
+
+```solidity
+IInterchainSecurityModule public defaultIsm;
+```
+
+
+### remoteMailboxes
+
+```solidity
+mapping(uint32 => MockMailbox) public remoteMailboxes;
+```
+
+
+### inboundMessages
+
+```solidity
+mapping(uint256 => MockMessage) public inboundMessages;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(uint32 _domain);
+```
+
+### setDefaultIsm
+
+
+```solidity
+function setDefaultIsm(IInterchainSecurityModule _module) external;
+```
+
+### addRemoteMailbox
+
+
+```solidity
+function addRemoteMailbox(uint32 _domain, MockMailbox _mailbox) external;
+```
+
+### dispatch
+
+
+```solidity
+function dispatch(uint32 _destinationDomain, bytes32 _recipientAddress, bytes calldata _messageBody)
+    external
+    returns (bytes32);
+```
+
+### addInboundMessage
+
+
+```solidity
+function addInboundMessage(uint32 _nonce, uint32 _origin, address _sender, address _recipient, bytes calldata _body)
+    external;
+```
+
+### processNextInboundMessage
+
+
+```solidity
+function processNextInboundMessage() public;
+```
+
+### _encode
+
+
+```solidity
+function _encode(MockMessage memory _message) private view returns (bytes memory);
+```
+
+### _recipientIsm
+
+
+```solidity
+function _recipientIsm(address _recipient) private view returns (IInterchainSecurityModule);
+```
+
+## Structs
+### MockMessage
+
+```solidity
+struct MockMessage {
+    uint32 nonce;
+    uint32 origin;
+    address sender;
+    address recipient;
+    bytes body;
+}
+```
+

package/docs/src/contracts/mock/MockPortalBridge.sol/contract.MockPortalBridge.md

@@ -0,0 +1,82 @@
+# MockPortalBridge
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockPortalBridge.sol)
+
+**Inherits:**
+[IPortalTokenBridge](/contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md)
+
+
+## State Variables
+### nextNonce
+
+```solidity
+uint256 nextNonce = 0;
+```
+
+
+### token
+
+```solidity
+MockToken token;
+```
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor(MockToken _token);
+```
+
+### transferTokensWithPayload
+
+
+```solidity
+function transferTokensWithPayload(address, uint256 amount, uint16, bytes32, uint32, bytes memory)
+    external
+    payable
+    returns (uint64 sequence);
+```
+
+### wrappedAsset
+
+
+```solidity
+function wrappedAsset(uint16, bytes32) external view returns (address);
+```
+
+### isWrappedAsset
+
+
+```solidity
+function isWrappedAsset(address) external pure returns (bool);
+```
+
+### completeTransferWithPayload
+
+
+```solidity
+function completeTransferWithPayload(bytes memory encodedVm) external returns (bytes memory);
+```
+
+### parseTransferWithPayload
+
+
+```solidity
+function parseTransferWithPayload(bytes memory encoded) external pure returns (TransferWithPayload memory transfer);
+```
+
+### adapterData
+
+
+```solidity
+function adapterData(uint32 _originDomain, uint224 _nonce, address _token) public pure returns (bytes memory);
+```
+
+### mockPortalVaa
+
+
+```solidity
+function mockPortalVaa(uint32 _originDomain, uint224 _nonce, uint256 _amount) public pure returns (bytes memory);
+```
+

package/docs/src/contracts/mock/MockToken.sol/contract.MockToken.md

@@ -0,0 +1,22 @@
+# MockToken
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/mock/MockToken.sol)
+
+**Inherits:**
+ERC20Upgradeable
+
+
+## Functions
+### mint
+
+
+```solidity
+function mint(address account, uint256 amount) external;
+```
+
+### burn
+
+
+```solidity
+function burn(uint256 _amount) external;
+```
+

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

@@ -0,0 +1,9 @@
+
+
+# Contents
+- [MockCircleMessageTransmitter](MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md)
+- [MockCircleTokenMessenger](MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md)
+- [MockHyperlaneEnvironment](MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md)
+- [MockMailbox](MockMailbox.sol/contract.MockMailbox.md)
+- [MockPortalBridge](MockPortalBridge.sol/contract.MockPortalBridge.md)
+- [MockToken](MockToken.sol/contract.MockToken.md)

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

@@ -0,0 +1,15 @@
+# LightTestRecipient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/test/LightTestRecipient.sol)
+
+**Inherits:**
+[TestRecipient](/contracts/test/TestRecipient.sol/contract.TestRecipient.md)
+
+
+## Functions
+### handle
+
+
+```solidity
+function handle(uint32 _origin, bytes32 _sender, bytes calldata _data) external override;
+```
+

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

@@ -0,0 +1,20 @@
+
+
+# Contents
+- [bad-recipient](/contracts/test/bad-recipient)
+- [LightTestRecipient](LightTestRecipient.sol/contract.LightTestRecipient.md)
+- [TestGasRouter](TestGasRouter.sol/contract.TestGasRouter.md)
+- [TestHyperlaneConnectionClient](TestHyperlaneConnectionClient.sol/contract.TestHyperlaneConnectionClient.md)
+- [TestInterchainGasPaymaster](TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md)
+- [TestLegacyMultisigIsm](TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md)
+- [TestLiquidityLayerMessageRecipient](TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md)
+- [TestMailbox](TestMailbox.sol/contract.TestMailbox.md)
+- [TestMerkle](TestMerkle.sol/contract.TestMerkle.md)
+- [TestMessage](TestMessage.sol/contract.TestMessage.md)
+- [TestMultisigIsm](TestMultisigIsm.sol/contract.TestMultisigIsm.md)
+- [TestQuery](TestQuery.sol/contract.TestQuery.md)
+- [TestQuerySender](TestQuerySender.sol/contract.TestQuerySender.md)
+- [TestRecipient](TestRecipient.sol/contract.TestRecipient.md)
+- [TestRouter](TestRouter.sol/contract.TestRouter.md)
+- [TestSendReceiver](TestSendReceiver.sol/contract.TestSendReceiver.md)
+- [TestTokenRecipient](TestTokenRecipient.sol/contract.TestTokenRecipient.md)

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

@@ -0,0 +1,27 @@
+# TestGasRouter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/test/TestGasRouter.sol)
+
+**Inherits:**
+[TestRouter](/contracts/test/TestRouter.sol/contract.TestRouter.md), [GasRouter](/contracts/GasRouter.sol/abstract.GasRouter.md)
+
+
+## Functions
+### dispatchWithGas
+
+
+```solidity
+function dispatchWithGas(
+    uint32 _destinationDomain,
+    bytes memory _messageBody,
+    uint256 _gasPayment,
+    address _gasPaymentRefundAddress
+) external payable;
+```
+
+### dispatchWithGas
+
+
+```solidity
+function dispatchWithGas(uint32 _destinationDomain, bytes memory _messageBody) external payable;
+```
+

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

@@ -0,0 +1,29 @@
+# TestHyperlaneConnectionClient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/test/TestHyperlaneConnectionClient.sol)
+
+**Inherits:**
+[HyperlaneConnectionClient](/contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md)
+
+
+## Functions
+### constructor
+
+
+```solidity
+constructor();
+```
+
+### initialize
+
+
+```solidity
+function initialize(address _mailbox) external initializer;
+```
+
+### localDomain
+
+
+```solidity
+function localDomain() external view returns (uint32);
+```
+

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