@hyperlane-xyz/core 1.3.6 → 1.3.8-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.
- package/README.md +6 -4
- package/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol +10 -4
- package/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol +8 -3
- package/contracts/upgrade/TimelockController.sol +6 -0
- package/dist/@openzeppelin/contracts/access/AccessControl.d.ts +162 -0
- package/dist/@openzeppelin/contracts/access/AccessControl.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/access/AccessControl.js +4 -0
- package/dist/@openzeppelin/contracts/access/AccessControl.js.map +1 -0
- package/dist/@openzeppelin/contracts/access/IAccessControl.d.ts +146 -0
- package/dist/@openzeppelin/contracts/access/IAccessControl.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/access/IAccessControl.js +4 -0
- package/dist/@openzeppelin/contracts/access/IAccessControl.js.map +1 -0
- package/dist/@openzeppelin/contracts/access/index.d.ts +2 -0
- package/dist/@openzeppelin/contracts/access/index.d.ts.map +1 -1
- package/dist/@openzeppelin/contracts/governance/TimelockController.d.ts +496 -0
- package/dist/@openzeppelin/contracts/governance/TimelockController.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/governance/TimelockController.js +4 -0
- package/dist/@openzeppelin/contracts/governance/TimelockController.js.map +1 -0
- package/dist/@openzeppelin/contracts/governance/index.d.ts +2 -0
- package/dist/@openzeppelin/contracts/governance/index.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/governance/index.js +3 -0
- package/dist/@openzeppelin/contracts/governance/index.js.map +1 -0
- package/dist/@openzeppelin/contracts/index.d.ts +4 -0
- package/dist/@openzeppelin/contracts/index.d.ts.map +1 -1
- package/dist/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.d.ts +75 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.js +4 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.js.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/index.d.ts +2 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/index.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/index.js +3 -0
- package/dist/@openzeppelin/contracts/token/ERC1155/index.js.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC721/IERC721Receiver.d.ts +51 -0
- package/dist/@openzeppelin/contracts/token/ERC721/IERC721Receiver.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC721/IERC721Receiver.js +4 -0
- package/dist/@openzeppelin/contracts/token/ERC721/IERC721Receiver.js.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC721/index.d.ts +2 -0
- package/dist/@openzeppelin/contracts/token/ERC721/index.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/token/ERC721/index.js +3 -0
- package/dist/@openzeppelin/contracts/token/ERC721/index.js.map +1 -0
- package/dist/@openzeppelin/contracts/token/index.d.ts +4 -0
- package/dist/@openzeppelin/contracts/token/index.d.ts.map +1 -1
- package/dist/@openzeppelin/contracts/utils/index.d.ts +3 -0
- package/dist/@openzeppelin/contracts/utils/index.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/utils/index.js +4 -0
- package/dist/@openzeppelin/contracts/utils/index.js.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/ERC165.d.ts +43 -0
- package/dist/@openzeppelin/contracts/utils/introspection/ERC165.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/ERC165.js +4 -0
- package/dist/@openzeppelin/contracts/utils/introspection/ERC165.js.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/IERC165.d.ts +43 -0
- package/dist/@openzeppelin/contracts/utils/introspection/IERC165.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/IERC165.js +4 -0
- package/dist/@openzeppelin/contracts/utils/introspection/IERC165.js.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/index.d.ts +3 -0
- package/dist/@openzeppelin/contracts/utils/introspection/index.d.ts.map +1 -0
- package/dist/@openzeppelin/contracts/utils/introspection/index.js +3 -0
- package/dist/@openzeppelin/contracts/utils/introspection/index.js.map +1 -0
- package/dist/contracts/CheckpointFraudProofs.d.ts +103 -0
- package/dist/contracts/CheckpointFraudProofs.d.ts.map +1 -0
- package/dist/contracts/CheckpointFraudProofs.js +4 -0
- package/dist/contracts/CheckpointFraudProofs.js.map +1 -0
- package/dist/contracts/index.d.ts +1 -0
- package/dist/contracts/index.d.ts.map +1 -1
- package/dist/contracts/libs/TestMerkle.sol/MerkleTree.d.ts +77 -0
- package/dist/contracts/libs/TestMerkle.sol/MerkleTree.d.ts.map +1 -0
- package/dist/contracts/libs/TestMerkle.sol/MerkleTree.js +4 -0
- package/dist/contracts/libs/TestMerkle.sol/MerkleTree.js.map +1 -0
- package/dist/contracts/libs/TestMerkle.sol/index.d.ts +2 -0
- package/dist/contracts/libs/TestMerkle.sol/index.d.ts.map +1 -0
- package/dist/contracts/libs/TestMerkle.sol/index.js +3 -0
- package/dist/contracts/libs/TestMerkle.sol/index.js.map +1 -0
- package/dist/contracts/libs/index.d.ts +2 -0
- package/dist/contracts/libs/index.d.ts.map +1 -1
- package/dist/contracts/libs/index.js +1 -0
- package/dist/contracts/libs/index.js.map +1 -1
- package/dist/factories/@openzeppelin/contracts/access/AccessControl__factory.d.ts +36 -0
- package/dist/factories/@openzeppelin/contracts/access/AccessControl__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/access/AccessControl__factory.js +222 -0
- package/dist/factories/@openzeppelin/contracts/access/AccessControl__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/access/IAccessControl__factory.d.ts +36 -0
- package/dist/factories/@openzeppelin/contracts/access/IAccessControl__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/access/IAccessControl__factory.js +190 -0
- package/dist/factories/@openzeppelin/contracts/access/IAccessControl__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/access/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/access/index.d.ts.map +1 -1
- package/dist/factories/@openzeppelin/contracts/access/index.js +5 -1
- package/dist/factories/@openzeppelin/contracts/access/index.js.map +1 -1
- package/dist/factories/@openzeppelin/contracts/governance/TimelockController__factory.d.ts +66 -0
- package/dist/factories/@openzeppelin/contracts/governance/TimelockController__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/governance/TimelockController__factory.js +911 -0
- package/dist/factories/@openzeppelin/contracts/governance/TimelockController__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/governance/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/governance/index.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/governance/index.js +9 -0
- package/dist/factories/@openzeppelin/contracts/governance/index.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/index.d.ts.map +1 -1
- package/dist/factories/@openzeppelin/contracts/index.js +3 -1
- package/dist/factories/@openzeppelin/contracts/index.js.map +1 -1
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver__factory.d.ts +23 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver__factory.js +115 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/index.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/index.js +9 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC1155/index.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/IERC721Receiver__factory.d.ts +23 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/IERC721Receiver__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/IERC721Receiver__factory.js +52 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/IERC721Receiver__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/index.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/index.js +9 -0
- package/dist/factories/@openzeppelin/contracts/token/ERC721/index.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/token/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/token/index.d.ts.map +1 -1
- package/dist/factories/@openzeppelin/contracts/token/index.js +3 -1
- package/dist/factories/@openzeppelin/contracts/token/index.js.map +1 -1
- package/dist/factories/@openzeppelin/contracts/utils/index.d.ts +2 -0
- package/dist/factories/@openzeppelin/contracts/utils/index.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/index.js +31 -0
- package/dist/factories/@openzeppelin/contracts/utils/index.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/ERC165__factory.d.ts +23 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/ERC165__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/ERC165__factory.js +37 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/ERC165__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/IERC165__factory.d.ts +23 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/IERC165__factory.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/IERC165__factory.js +37 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/IERC165__factory.js.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/index.d.ts +3 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/index.d.ts.map +1 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/index.js +11 -0
- package/dist/factories/@openzeppelin/contracts/utils/introspection/index.js.map +1 -0
- package/dist/factories/contracts/CheckpointFraudProofs__factory.d.ts +45 -0
- package/dist/factories/contracts/CheckpointFraudProofs__factory.d.ts.map +1 -0
- package/dist/factories/contracts/CheckpointFraudProofs__factory.js +231 -0
- package/dist/factories/contracts/CheckpointFraudProofs__factory.js.map +1 -0
- package/dist/factories/contracts/index.d.ts +1 -0
- package/dist/factories/contracts/index.d.ts.map +1 -1
- package/dist/factories/contracts/index.js +3 -1
- package/dist/factories/contracts/index.js.map +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMerkleRootMultisigIsmFactory__factory.d.ts +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMerkleRootMultisigIsmFactory__factory.js +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMerkleRootMultisigIsm__factory.d.ts +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMerkleRootMultisigIsm__factory.js +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMessageIdMultisigIsmFactory__factory.d.ts +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMessageIdMultisigIsmFactory__factory.js +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMessageIdMultisigIsm__factory.d.ts +1 -1
- package/dist/factories/contracts/isms/multisig/StaticMultisigIsm.sol/StaticMessageIdMultisigIsm__factory.js +1 -1
- package/dist/factories/contracts/libs/TestMerkle.sol/MerkleTree__factory.d.ts +41 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/MerkleTree__factory.d.ts.map +1 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/MerkleTree__factory.js +151 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/MerkleTree__factory.js.map +1 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/index.d.ts +2 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/index.d.ts.map +1 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/index.js +9 -0
- package/dist/factories/contracts/libs/TestMerkle.sol/index.js.map +1 -0
- package/dist/factories/contracts/libs/index.d.ts +1 -0
- package/dist/factories/contracts/libs/index.d.ts.map +1 -1
- package/dist/factories/contracts/libs/index.js +25 -1
- package/dist/factories/contracts/libs/index.js.map +1 -1
- package/dist/index.d.ts +18 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +21 -3
- package/dist/index.js.map +1 -1
- package/docs/book.css +13 -0
- package/docs/book.toml +12 -0
- package/docs/solidity.min.js +74 -0
- package/docs/src/README.md +15 -0
- package/docs/src/SUMMARY.md +128 -0
- package/docs/src/contracts/GasRouter.sol/abstract.GasRouter.md +124 -0
- package/docs/src/contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md +191 -0
- package/docs/src/contracts/Mailbox.sol/contract.Mailbox.md +251 -0
- package/docs/src/contracts/OwnableMulticall.sol/contract.OwnableMulticall.md +41 -0
- package/docs/src/contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md +100 -0
- package/docs/src/contracts/README.md +19 -0
- package/docs/src/contracts/Router.sol/abstract.Router.md +255 -0
- package/docs/src/contracts/ValidatorAnnounce.sol/contract.ValidatorAnnounce.md +117 -0
- package/docs/src/contracts/hooks/OptimismMessageHook.sol/contract.OptimismMessageHook.md +71 -0
- package/docs/src/contracts/hooks/README.md +4 -0
- package/docs/src/contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md +231 -0
- package/docs/src/contracts/igps/OverheadIgp.sol/contract.OverheadIgp.md +161 -0
- package/docs/src/contracts/igps/README.md +6 -0
- package/docs/src/contracts/igps/gas-oracles/README.md +4 -0
- package/docs/src/contracts/igps/gas-oracles/StorageGasOracle.sol/contract.StorageGasOracle.md +114 -0
- package/docs/src/contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md +25 -0
- package/docs/src/contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md +43 -0
- package/docs/src/contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md +33 -0
- package/docs/src/contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md +55 -0
- package/docs/src/contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md +12 -0
- package/docs/src/contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md +13 -0
- package/docs/src/contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md +19 -0
- package/docs/src/contracts/interfaces/IMailbox.sol/interface.IMailbox.md +103 -0
- package/docs/src/contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md +12 -0
- package/docs/src/contracts/interfaces/IRouter.sol/interface.IRouter.md +33 -0
- package/docs/src/contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md +78 -0
- package/docs/src/contracts/interfaces/README.md +17 -0
- package/docs/src/contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md +12 -0
- package/docs/src/contracts/interfaces/hooks/README.md +4 -0
- package/docs/src/contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md +36 -0
- package/docs/src/contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md +36 -0
- package/docs/src/contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md +31 -0
- package/docs/src/contracts/interfaces/isms/README.md +6 -0
- package/docs/src/contracts/interfaces/middleware/IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md +64 -0
- package/docs/src/contracts/interfaces/middleware/IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md +21 -0
- package/docs/src/contracts/interfaces/middleware/README.md +5 -0
- package/docs/src/contracts/isms/README.md +7 -0
- package/docs/src/contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md +60 -0
- package/docs/src/contracts/isms/aggregation/README.md +6 -0
- package/docs/src/contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md +30 -0
- package/docs/src/contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md +15 -0
- package/docs/src/contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md +78 -0
- package/docs/src/contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md +69 -0
- package/docs/src/contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md +102 -0
- package/docs/src/contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md +355 -0
- package/docs/src/contracts/isms/multisig/README.md +12 -0
- package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md +36 -0
- package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md +11 -0
- package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md +15 -0
- package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md +10 -0
- package/docs/src/contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md +15 -0
- package/docs/src/contracts/isms/native/AbstractNativeISM.sol/abstract.AbstractNativeISM.md +44 -0
- package/docs/src/contracts/isms/native/OptimismISM.sol/contract.OptimismISM.md +66 -0
- package/docs/src/contracts/isms/native/README.md +5 -0
- package/docs/src/contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md +55 -0
- package/docs/src/contracts/isms/routing/DomainRoutingIsm.sol/contract.DomainRoutingIsm.md +112 -0
- package/docs/src/contracts/isms/routing/DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md +47 -0
- package/docs/src/contracts/isms/routing/InterchainAccountIsm.sol/contract.InterchainAccountIsm.md +44 -0
- package/docs/src/contracts/isms/routing/README.md +7 -0
- package/docs/src/contracts/libs/Call.sol/library.CallLib.md +124 -0
- package/docs/src/contracts/libs/CheckpointLib.sol/library.CheckpointLib.md +61 -0
- package/docs/src/contracts/libs/EnumerableMapExtended.sol/library.EnumerableMapExtended.md +63 -0
- package/docs/src/contracts/libs/LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md +55 -0
- package/docs/src/contracts/libs/Merkle.sol/library.MerkleLib.md +354 -0
- package/docs/src/contracts/libs/Message.sol/library.Message.md +304 -0
- package/docs/src/contracts/libs/MetaProxy.sol/library.MetaProxy.md +36 -0
- package/docs/src/contracts/libs/MinimalProxy.sol/library.MinimalProxy.md +34 -0
- package/docs/src/contracts/libs/README.md +16 -0
- package/docs/src/contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md +123 -0
- package/docs/src/contracts/libs/TestMerkle.sol/contract.MerkleTree.md +66 -0
- package/docs/src/contracts/libs/TypeCasts.sol/library.TypeCasts.md +19 -0
- package/docs/src/contracts/libs/ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md +31 -0
- package/docs/src/contracts/libs/isms/AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md +97 -0
- package/docs/src/contracts/libs/isms/LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md +296 -0
- package/docs/src/contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md +177 -0
- package/docs/src/contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md +109 -0
- package/docs/src/contracts/libs/isms/README.md +7 -0
- package/docs/src/contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md +134 -0
- package/docs/src/contracts/libs/middleware/InterchainQueryMessage.sol/library.InterchainQueryMessage.md +203 -0
- package/docs/src/contracts/libs/middleware/README.md +5 -0
- package/docs/src/contracts/middleware/InterchainAccountRouter.sol/contract.InterchainAccountRouter.md +545 -0
- package/docs/src/contracts/middleware/InterchainQueryRouter.sol/contract.InterchainQueryRouter.md +119 -0
- package/docs/src/contracts/middleware/README.md +6 -0
- package/docs/src/contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol/contract.LiquidityLayerRouter.md +81 -0
- package/docs/src/contracts/middleware/liquidity-layer/README.md +6 -0
- package/docs/src/contracts/middleware/liquidity-layer/adapters/CircleBridgeAdapter.sol/contract.CircleBridgeAdapter.md +197 -0
- package/docs/src/contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol/contract.PortalAdapter.md +189 -0
- package/docs/src/contracts/middleware/liquidity-layer/adapters/README.md +5 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/ILiquidityLayerAdapter.sol/interface.ILiquidityLayerAdapter.md +23 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/README.md +6 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/circle/ICircleMessageTransmitter.sol/interface.ICircleMessageTransmitter.md +54 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/circle/ITokenMessenger.sol/interface.ITokenMessenger.md +92 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/circle/README.md +5 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md +131 -0
- package/docs/src/contracts/middleware/liquidity-layer/interfaces/portal/README.md +4 -0
- package/docs/src/contracts/mock/MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md +58 -0
- package/docs/src/contracts/mock/MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md +44 -0
- package/docs/src/contracts/mock/MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md +69 -0
- package/docs/src/contracts/mock/MockMailbox.sol/contract.MockMailbox.md +137 -0
- package/docs/src/contracts/mock/MockPortalBridge.sol/contract.MockPortalBridge.md +82 -0
- package/docs/src/contracts/mock/MockToken.sol/contract.MockToken.md +22 -0
- package/docs/src/contracts/mock/README.md +9 -0
- package/docs/src/contracts/test/LightTestRecipient.sol/contract.LightTestRecipient.md +15 -0
- package/docs/src/contracts/test/README.md +20 -0
- package/docs/src/contracts/test/TestGasRouter.sol/contract.TestGasRouter.md +27 -0
- package/docs/src/contracts/test/TestHyperlaneConnectionClient.sol/contract.TestHyperlaneConnectionClient.md +29 -0
- package/docs/src/contracts/test/TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md +30 -0
- package/docs/src/contracts/test/TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md +15 -0
- package/docs/src/contracts/test/TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md +23 -0
- package/docs/src/contracts/test/TestMailbox.sol/contract.TestMailbox.md +29 -0
- package/docs/src/contracts/test/TestMerkle.sol/contract.TestMerkle.md +50 -0
- package/docs/src/contracts/test/TestMessage.sol/contract.TestMessage.md +68 -0
- package/docs/src/contracts/test/TestMultisigIsm.sol/contract.TestMultisigIsm.md +51 -0
- package/docs/src/contracts/test/TestQuery.sol/contract.TestQuery.md +45 -0
- package/docs/src/contracts/test/TestQuerySender.sol/contract.TestQuerySender.md +128 -0
- package/docs/src/contracts/test/TestRecipient.sol/contract.TestRecipient.md +78 -0
- package/docs/src/contracts/test/TestRouter.sol/contract.TestRouter.md +63 -0
- package/docs/src/contracts/test/TestSendReceiver.sol/contract.TestSendReceiver.md +49 -0
- package/docs/src/contracts/test/TestTokenRecipient.sol/contract.TestTokenRecipient.md +80 -0
- package/docs/src/contracts/test/bad-recipient/BadRecipient1.sol/contract.BadRecipient1.md +15 -0
- package/docs/src/contracts/test/bad-recipient/BadRecipient2.sol/contract.BadRecipient2.md +12 -0
- package/docs/src/contracts/test/bad-recipient/BadRecipient3.sol/contract.BadRecipient3.md +15 -0
- package/docs/src/contracts/test/bad-recipient/BadRecipient5.sol/contract.BadRecipient5.md +15 -0
- package/docs/src/contracts/test/bad-recipient/BadRecipient6.sol/contract.BadRecipient6.md +15 -0
- package/docs/src/contracts/test/bad-recipient/README.md +8 -0
- package/docs/src/contracts/upgrade/README.md +4 -0
- package/docs/src/contracts/upgrade/Versioned.sol/contract.Versioned.md +14 -0
- package/package.json +8 -5
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../types/index.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAc/C,yDAAyC;AAEzC,sIAAqI;AAA5H,gJAAA,8BAA8B,OAAA;AAEvC,kIAAiI;AAAxH,0IAAA,2BAA2B,OAAA;AAEpC,6HAA4H;AAAnH,gIAAA,sBAAsB,OAAA;AAE/B,mIAAkI;AAAzH,sIAAA,yBAAyB,OAAA;AAElC,gKAA+J;AAAtJ,wJAAA,kCAAkC,OAAA;AAE3C,qIAAoI;AAA3H,wIAAA,0BAA0B,OAAA;AAEnC,iIAAgI;AAAvH,0IAAA,2BAA2B,OAAA;AAEpC,gGAA+F;AAAtF,oHAAA,gBAAgB,OAAA;AAEzB,2IAA0I;AAAjI,wIAAA,0BAA0B,OAAA;AAEnC,sGAAqG;AAA5F,oHAAA,gBAAgB,OAAA;AAEzB,iHAAgH;AAAvG,8HAAA,qBAAqB,OAAA;AAE9B,qHAAoH;AAA3G,kIAAA,uBAAuB,OAAA;AAEhC,2FAA0F;AAAjF,gHAAA,cAAc,OAAA;AAEvB,iHAAgH;AAAvG,0HAAA,mBAAmB,OAAA;AAE5B,mJAAkJ;AAAzI,4JAAA,oCAAoC,OAAA;AAE7C,iJAAgJ;AAAvI,8HAAA,qBAAqB,OAAA;AAE9B,mGAAkG;AAAzF,kHAAA,eAAe,OAAA;AAExB,+EAA8E;AAArE,wHAAA,kBAAkB,OAAA;AAE3B,yGAAwG;AAA/F,4IAAA,4BAA4B,OAAA;AAErC,+GAA8G;AAArG,wJAAA,kCAAkC,OAAA;AAE3C,8GAA6G;AAApG,sIAAA,yBAAyB,OAAA;AAElC,8GAA6G;AAApG,kJAAA,+BAA+B,OAAA;AAExC,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,sGAAqG;AAA5F,8HAAA,qBAAqB,OAAA;AAE9B,4FAA2F;AAAlF,0HAAA,mBAAmB,OAAA;AAE5B,4HAA2H;AAAlH,0JAAA,mCAAmC,OAAA;AAE5C,sHAAqH;AAA5G,oJAAA,gCAAgC,OAAA;AAEzC,wJAAuJ;AAA9I,wJAAA,kCAAkC,OAAA;AAE3C,0KAAyK;AAAhK,0KAAA,2CAA2C,OAAA;AAEpD,sIAAqI;AAA5H,oKAAA,wCAAwC,OAAA;AAEjD,kHAAiH;AAAxG,gJAAA,8BAA8B,OAAA;AAEvC,wFAAuF;AAA9E,sHAAA,iBAAiB,OAAA;AAE1B,0GAAyG;AAAhG,wIAAA,0BAA0B,OAAA;AAEnC,sFAAqF;AAA5E,oHAAA,gBAAgB,OAAA;AAEzB,2GAA0G;AAAjG,oIAAA,wBAAwB,OAAA;AAEjC,qGAAoG;AAA3F,8HAAA,qBAAqB,OAAA;AAE9B,mGAAkG;AAAzF,4HAAA,oBAAoB,OAAA;AAE7B,4GAA2G;AAAlG,0IAAA,2BAA2B,OAAA;AAEpC,mIAAkI;AAAzH,sJAAA,iCAAiC,OAAA;AAE1C,+HAA8H;AAArH,kJAAA,+BAA+B,OAAA;AAExC,0HAAyH;AAAhH,kJAAA,+BAA+B,OAAA;AAExC,sHAAqH;AAA5G,8IAAA,6BAA6B,OAAA;AAEtC,oIAAmI;AAA1H,4JAAA,oCAAoC,OAAA;AAE7C,qIAAoI;AAA3H,gKAAA,sCAAsC,OAAA;AAE/C,mIAAkI;AAAzH,8JAAA,qCAAqC,OAAA;AAE9C,iHAAgH;AAAvG,4IAAA,4BAA4B,OAAA;AAErC,6GAA4G;AAAnG,wIAAA,0BAA0B,OAAA;AAEnC,yJAAwJ;AAA/I,8JAAA,qCAAqC,OAAA;AAE9C,uJAAsJ;AAA7I,4JAAA,oCAAoC,OAAA;AAE7C,qKAAoK;AAA3J,0KAAA,2CAA2C,OAAA;AAEpD,qJAAoJ;AAA3I,0JAAA,mCAAmC,OAAA;AAE5C,mKAAkK;AAAzJ,wKAAA,0CAA0C,OAAA;AAEnD,2GAA0G;AAAjG,wIAAA,0BAA0B,OAAA;AAEnC,+FAA8F;AAArF,4HAAA,oBAAoB,OAAA;AAE7B,8GAA6G;AAApG,0IAAA,2BAA2B,OAAA;AAEpC,0GAAyG;AAAhG,sIAAA,yBAAyB,OAAA;AAElC,wHAAuH;AAA9G,oJAAA,gCAAgC,OAAA;AAEzC,kHAAiH;AAAxG,8IAAA,6BAA6B,OAAA;AAEtC,wHAAuH;AAA9G,4JAAA,oCAAoC,OAAA;AAE7C,2EAA0E;AAAjE,oHAAA,gBAAgB,OAAA;AAEzB,sHAAqH;AAA5G,oJAAA,gCAAgC,OAAA;AAEzC,kHAAiH;AAAxG,gJAAA,8BAA8B,OAAA;AAEvC,uIAAsI;AAA7H,4IAAA,4BAA4B,OAAA;AAErC,2HAA0H;AAAjH,gIAAA,sBAAsB,OAAA;AAE/B,4JAA2J;AAAlJ,wJAAA,kCAAkC,OAAA;AAE3C,wIAAuI;AAA9H,oIAAA,wBAAwB,OAAA;AAEjC,+IAA8I;AAArI,kJAAA,+BAA+B,OAAA;AAExC,8IAA6I;AAApI,0IAAA,2BAA2B,OAAA;AAEpC,gIAA+H;AAAtH,8IAAA,6BAA6B,OAAA;AAEtC,0HAAyH;AAAhH,8JAAA,qCAAqC,OAAA;AAE9C,kHAAiH;AAAxG,sJAAA,iCAAiC,OAAA;AAE1C,kHAAiH;AAAxG,sJAAA,iCAAiC,OAAA;AAE1C,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,kGAAiG;AAAxF,sIAAA,yBAAyB,OAAA;AAElC,oFAAmF;AAA1E,wHAAA,kBAAkB,OAAA;AAE3B,6FAA4F;AAAnF,sIAAA,yBAAyB,OAAA;AAElC,6JAA4J;AAAnJ,0KAAA,2CAA2C,OAAA;AAEpD,yEAAwE;AAA/D,kHAAA,eAAe,OAAA;AAExB,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,sGAAqG;AAA5F,0IAAA,2BAA2B,OAAA;AAEpC,4FAA2F;AAAlF,gIAAA,sBAAsB,OAAA;AAE/B,4HAA2H;AAAlH,gKAAA,sCAAsC,OAAA;AAE/C,sHAAqH;AAA5G,0JAAA,mCAAmC,OAAA;AAE5C,4GAA2G;AAAlG,gJAAA,8BAA8B,OAAA;AAEvC,sIAAqI;AAA5H,0KAAA,2CAA2C,OAAA;AAEpD,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,sFAAqF;AAA5E,0HAAA,mBAAmB,OAAA;AAE5B,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,gGAA+F;AAAtF,oIAAA,wBAAwB,OAAA;AAEjC,oFAAmF;AAA1E,wHAAA,kBAAkB,OAAA;AAE3B,gGAA+F;AAAtF,oIAAA,wBAAwB,OAAA;AAEjC,4FAA2F;AAAlF,gIAAA,sBAAsB,OAAA;AAE/B,sFAAqF;AAA5E,0HAAA,mBAAmB,OAAA;AAE5B,kGAAiG;AAAxF,sIAAA,yBAAyB,OAAA;AAElC,sGAAqG;AAA5F,0IAAA,2BAA2B,OAAA;AAEpC,uFAAsF;AAA7E,wHAAA,kBAAkB,OAAA;AAE3B,+FAA8F;AAArF,wIAAA,0BAA0B,OAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../types/index.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAc/C,yDAAyC;AAEzC,sIAAqI;AAA5H,gJAAA,8BAA8B,OAAA;AAEvC,kIAAiI;AAAxH,0IAAA,2BAA2B,OAAA;AAEpC,6HAA4H;AAAnH,gIAAA,sBAAsB,OAAA;AAE/B,mIAAkI;AAAzH,sIAAA,yBAAyB,OAAA;AAElC,gKAA+J;AAAtJ,wJAAA,kCAAkC,OAAA;AAE3C,qIAAoI;AAA3H,wIAAA,0BAA0B,OAAA;AAEnC,iIAAgI;AAAvH,0IAAA,2BAA2B,OAAA;AAEpC,4GAA2G;AAAlG,gIAAA,sBAAsB,OAAA;AAE/B,8GAA6G;AAApG,kIAAA,uBAAuB,OAAA;AAEhC,gGAA+F;AAAtF,oHAAA,gBAAgB,OAAA;AAEzB,0HAAyH;AAAhH,0IAAA,2BAA2B,OAAA;AAEpC,2IAA0I;AAAjI,wIAAA,0BAA0B,OAAA;AAEnC,sGAAqG;AAA5F,oHAAA,gBAAgB,OAAA;AAEzB,iHAAgH;AAAvG,8HAAA,qBAAqB,OAAA;AAE9B,qHAAoH;AAA3G,kIAAA,uBAAuB,OAAA;AAEhC,2FAA0F;AAAjF,gHAAA,cAAc,OAAA;AAEvB,iHAAgH;AAAvG,0HAAA,mBAAmB,OAAA;AAE5B,mJAAkJ;AAAzI,4JAAA,oCAAoC,OAAA;AAE7C,yHAAwH;AAA/G,sIAAA,yBAAyB,OAAA;AAElC,iJAAgJ;AAAvI,8HAAA,qBAAqB,OAAA;AAE9B,mGAAkG;AAAzF,kHAAA,eAAe,OAAA;AAExB,sHAAqH;AAA5G,oIAAA,wBAAwB,OAAA;AAEjC,2GAA0G;AAAjG,kHAAA,eAAe,OAAA;AAExB,6GAA4G;AAAnG,oHAAA,gBAAgB,OAAA;AAEzB,uGAAsG;AAA7F,gJAAA,8BAA8B,OAAA;AAEvC,+EAA8E;AAArE,wHAAA,kBAAkB,OAAA;AAE3B,yGAAwG;AAA/F,4IAAA,4BAA4B,OAAA;AAErC,+GAA8G;AAArG,wJAAA,kCAAkC,OAAA;AAE3C,8GAA6G;AAApG,sIAAA,yBAAyB,OAAA;AAElC,8GAA6G;AAApG,kJAAA,+BAA+B,OAAA;AAExC,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,sGAAqG;AAA5F,8HAAA,qBAAqB,OAAA;AAE9B,4FAA2F;AAAlF,0HAAA,mBAAmB,OAAA;AAE5B,4HAA2H;AAAlH,0JAAA,mCAAmC,OAAA;AAE5C,sHAAqH;AAA5G,oJAAA,gCAAgC,OAAA;AAEzC,wJAAuJ;AAA9I,wJAAA,kCAAkC,OAAA;AAE3C,0KAAyK;AAAhK,0KAAA,2CAA2C,OAAA;AAEpD,sIAAqI;AAA5H,oKAAA,wCAAwC,OAAA;AAEjD,kHAAiH;AAAxG,gJAAA,8BAA8B,OAAA;AAEvC,wFAAuF;AAA9E,sHAAA,iBAAiB,OAAA;AAE1B,0GAAyG;AAAhG,wIAAA,0BAA0B,OAAA;AAEnC,sFAAqF;AAA5E,oHAAA,gBAAgB,OAAA;AAEzB,2GAA0G;AAAjG,oIAAA,wBAAwB,OAAA;AAEjC,qGAAoG;AAA3F,8HAAA,qBAAqB,OAAA;AAE9B,mGAAkG;AAAzF,4HAAA,oBAAoB,OAAA;AAE7B,4GAA2G;AAAlG,0IAAA,2BAA2B,OAAA;AAEpC,mIAAkI;AAAzH,sJAAA,iCAAiC,OAAA;AAE1C,+HAA8H;AAArH,kJAAA,+BAA+B,OAAA;AAExC,0HAAyH;AAAhH,kJAAA,+BAA+B,OAAA;AAExC,sHAAqH;AAA5G,8IAAA,6BAA6B,OAAA;AAEtC,oIAAmI;AAA1H,4JAAA,oCAAoC,OAAA;AAE7C,qIAAoI;AAA3H,gKAAA,sCAAsC,OAAA;AAE/C,mIAAkI;AAAzH,8JAAA,qCAAqC,OAAA;AAE9C,iHAAgH;AAAvG,4IAAA,4BAA4B,OAAA;AAErC,6GAA4G;AAAnG,wIAAA,0BAA0B,OAAA;AAEnC,yJAAwJ;AAA/I,8JAAA,qCAAqC,OAAA;AAE9C,uJAAsJ;AAA7I,4JAAA,oCAAoC,OAAA;AAE7C,qKAAoK;AAA3J,0KAAA,2CAA2C,OAAA;AAEpD,qJAAoJ;AAA3I,0JAAA,mCAAmC,OAAA;AAE5C,mKAAkK;AAAzJ,wKAAA,0CAA0C,OAAA;AAEnD,2GAA0G;AAAjG,wIAAA,0BAA0B,OAAA;AAEnC,+FAA8F;AAArF,4HAAA,oBAAoB,OAAA;AAE7B,8GAA6G;AAApG,0IAAA,2BAA2B,OAAA;AAEpC,0GAAyG;AAAhG,sIAAA,yBAAyB,OAAA;AAElC,wHAAuH;AAA9G,oJAAA,gCAAgC,OAAA;AAEzC,kHAAiH;AAAxG,8IAAA,6BAA6B,OAAA;AAEtC,wHAAuH;AAA9G,4JAAA,oCAAoC,OAAA;AAE7C,qGAAoG;AAA3F,0HAAA,mBAAmB,OAAA;AAE5B,2EAA0E;AAAjE,oHAAA,gBAAgB,OAAA;AAEzB,sHAAqH;AAA5G,oJAAA,gCAAgC,OAAA;AAEzC,kHAAiH;AAAxG,gJAAA,8BAA8B,OAAA;AAEvC,uIAAsI;AAA7H,4IAAA,4BAA4B,OAAA;AAErC,2HAA0H;AAAjH,gIAAA,sBAAsB,OAAA;AAE/B,4JAA2J;AAAlJ,wJAAA,kCAAkC,OAAA;AAE3C,wIAAuI;AAA9H,oIAAA,wBAAwB,OAAA;AAEjC,+IAA8I;AAArI,kJAAA,+BAA+B,OAAA;AAExC,8IAA6I;AAApI,0IAAA,2BAA2B,OAAA;AAEpC,gIAA+H;AAAtH,8IAAA,6BAA6B,OAAA;AAEtC,0HAAyH;AAAhH,8JAAA,qCAAqC,OAAA;AAE9C,kHAAiH;AAAxG,sJAAA,iCAAiC,OAAA;AAE1C,kHAAiH;AAAxG,sJAAA,iCAAiC,OAAA;AAE1C,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,kGAAiG;AAAxF,sIAAA,yBAAyB,OAAA;AAElC,oFAAmF;AAA1E,wHAAA,kBAAkB,OAAA;AAE3B,6FAA4F;AAAnF,sIAAA,yBAAyB,OAAA;AAElC,6JAA4J;AAAnJ,0KAAA,2CAA2C,OAAA;AAEpD,yEAAwE;AAA/D,kHAAA,eAAe,OAAA;AAExB,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,0GAAyG;AAAhG,gIAAA,sBAAsB,OAAA;AAE/B,sGAAqG;AAA5F,0IAAA,2BAA2B,OAAA;AAEpC,4FAA2F;AAAlF,gIAAA,sBAAsB,OAAA;AAE/B,4HAA2H;AAAlH,gKAAA,sCAAsC,OAAA;AAE/C,sHAAqH;AAA5G,0JAAA,mCAAmC,OAAA;AAE5C,4GAA2G;AAAlG,gJAAA,8BAA8B,OAAA;AAEvC,sIAAqI;AAA5H,0KAAA,2CAA2C,OAAA;AAEpD,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,sFAAqF;AAA5E,0HAAA,mBAAmB,OAAA;AAE5B,wFAAuF;AAA9E,4HAAA,oBAAoB,OAAA;AAE7B,gGAA+F;AAAtF,oIAAA,wBAAwB,OAAA;AAEjC,oFAAmF;AAA1E,wHAAA,kBAAkB,OAAA;AAE3B,gGAA+F;AAAtF,oIAAA,wBAAwB,OAAA;AAEjC,4FAA2F;AAAlF,gIAAA,sBAAsB,OAAA;AAE/B,sFAAqF;AAA5E,0HAAA,mBAAmB,OAAA;AAE5B,kGAAiG;AAAxF,sIAAA,yBAAyB,OAAA;AAElC,sGAAqG;AAA5F,0IAAA,2BAA2B,OAAA;AAEpC,uFAAsF;AAA7E,wHAAA,kBAAkB,OAAA;AAE3B,+FAA8F;AAArF,wIAAA,0BAA0B,OAAA"}
|
package/docs/book.css
ADDED
package/docs/book.toml
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
[book]
|
|
2
|
+
src = "src"
|
|
3
|
+
title = ""
|
|
4
|
+
|
|
5
|
+
[output.html]
|
|
6
|
+
no-section-label = true
|
|
7
|
+
additional-js = ["solidity.min.js"]
|
|
8
|
+
additional-css = ["book.css"]
|
|
9
|
+
git-repository-url = "https://github.com/hyperlane-xyz/hyperlane-monorepo"
|
|
10
|
+
|
|
11
|
+
[output.html.fold]
|
|
12
|
+
enable = true
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
|
|
2
|
+
}catch(e){return!1}}
|
|
3
|
+
var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
|
|
4
|
+
;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
|
|
5
|
+
begin:a,relevance:0},n={
|
|
6
|
+
keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
|
|
7
|
+
built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
|
|
8
|
+
literal:"true false"},i={className:"string",
|
|
9
|
+
begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
|
|
10
|
+
begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
|
|
11
|
+
return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
|
|
12
|
+
return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
|
|
13
|
+
SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
|
|
14
|
+
var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
|
|
15
|
+
begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
|
|
16
|
+
begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
|
|
17
|
+
contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
|
|
18
|
+
className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
|
|
19
|
+
contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
|
|
20
|
+
className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
|
|
21
|
+
contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
|
|
22
|
+
solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
|
|
23
|
+
HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
|
|
24
|
+
;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
|
|
25
|
+
;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
|
|
26
|
+
;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
|
|
27
|
+
;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
|
|
28
|
+
keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
|
|
29
|
+
literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
|
|
30
|
+
built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
|
|
31
|
+
},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
|
|
32
|
+
},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
|
|
33
|
+
excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
|
|
34
|
+
contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
|
|
35
|
+
begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
|
|
36
|
+
built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
|
|
37
|
+
},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
|
|
38
|
+
lexemes:C,keywords:p}),w={className:"built_in",
|
|
39
|
+
begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
|
|
40
|
+
begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
|
|
41
|
+
excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
|
|
42
|
+
contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
|
|
43
|
+
contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
|
|
44
|
+
excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
|
|
45
|
+
relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
|
|
46
|
+
keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
|
|
47
|
+
keywords:p,lexemes:C,
|
|
48
|
+
contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
|
|
49
|
+
className:"function",lexemes:C,
|
|
50
|
+
beginKeywords:"function modifier event constructor fallback receive error",
|
|
51
|
+
end:/[{;]/,excludeEnd:!0,
|
|
52
|
+
contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
|
|
53
|
+
},x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
|
|
54
|
+
className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
|
|
55
|
+
excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
|
|
56
|
+
},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
|
|
57
|
+
beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
|
|
58
|
+
contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
|
|
59
|
+
beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
|
|
60
|
+
contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
|
|
61
|
+
beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
|
|
62
|
+
contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
|
|
63
|
+
beginKeywords:"pragma",end:";",lexemes:C,keywords:{
|
|
64
|
+
keyword:"pragma solidity experimental abicoder",
|
|
65
|
+
built_in:"ABIEncoderV2 SMTChecker v1 v2"},
|
|
66
|
+
contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
|
|
67
|
+
className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
|
|
68
|
+
beginKeywords:"assembly",end:/\b\B/,
|
|
69
|
+
contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
|
|
70
|
+
end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
|
|
71
|
+
end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
|
|
72
|
+
|
|
73
|
+
// Ugly hack to reload HLJS
|
|
74
|
+
hljs.initHighlightingOnLoad();
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Summary
|
|
2
|
+
- [Home](README.md)
|
|
3
|
+
# contracts
|
|
4
|
+
- [❱ hooks](contracts/hooks/README.md)
|
|
5
|
+
- [OptimismMessageHook](contracts/hooks/OptimismMessageHook.sol/contract.OptimismMessageHook.md)
|
|
6
|
+
- [❱ igps](contracts/igps/README.md)
|
|
7
|
+
- [❱ gas-oracles](contracts/igps/gas-oracles/README.md)
|
|
8
|
+
- [StorageGasOracle](contracts/igps/gas-oracles/StorageGasOracle.sol/contract.StorageGasOracle.md)
|
|
9
|
+
- [InterchainGasPaymaster](contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md)
|
|
10
|
+
- [OverheadIgp](contracts/igps/OverheadIgp.sol/contract.OverheadIgp.md)
|
|
11
|
+
- [❱ interfaces](contracts/interfaces/README.md)
|
|
12
|
+
- [❱ hooks](contracts/interfaces/hooks/README.md)
|
|
13
|
+
- [IMessageHook](contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md)
|
|
14
|
+
- [❱ isms](contracts/interfaces/isms/README.md)
|
|
15
|
+
- [IAggregationIsm](contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md)
|
|
16
|
+
- [IMultisigIsm](contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md)
|
|
17
|
+
- [IRoutingIsm](contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md)
|
|
18
|
+
- [❱ middleware](contracts/interfaces/middleware/README.md)
|
|
19
|
+
- [IInterchainAccountRouter](contracts/interfaces/middleware/IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md)
|
|
20
|
+
- [IInterchainQueryRouter](contracts/interfaces/middleware/IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md)
|
|
21
|
+
- [IGasOracle](contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md)
|
|
22
|
+
- [IHyperlaneConnectionClient](contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
|
|
23
|
+
- [IInterchainGasPaymaster](contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md)
|
|
24
|
+
- [IInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
|
|
25
|
+
- [ISpecifiesInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
|
|
26
|
+
- [ILiquidityLayerMessageRecipient](contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
|
|
27
|
+
- [ILiquidityLayerRouter](contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md)
|
|
28
|
+
- [IMailbox](contracts/interfaces/IMailbox.sol/interface.IMailbox.md)
|
|
29
|
+
- [IMessageRecipient](contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md)
|
|
30
|
+
- [IRouter](contracts/interfaces/IRouter.sol/interface.IRouter.md)
|
|
31
|
+
- [IValidatorAnnounce](contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)
|
|
32
|
+
- [❱ isms](contracts/isms/README.md)
|
|
33
|
+
- [❱ aggregation](contracts/isms/aggregation/README.md)
|
|
34
|
+
- [AbstractAggregationIsm](contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
|
|
35
|
+
- [StaticAggregationIsm](contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md)
|
|
36
|
+
- [StaticAggregationIsmFactory](contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md)
|
|
37
|
+
- [❱ multisig](contracts/isms/multisig/README.md)
|
|
38
|
+
- [AbstractMerkleRootMultisigIsm](contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md)
|
|
39
|
+
- [AbstractMessageIdMultisigIsm](contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md)
|
|
40
|
+
- [AbstractMultisigIsm](contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
|
|
41
|
+
- [LegacyMultisigIsm](contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md)
|
|
42
|
+
- [AbstractMetaProxyMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
|
|
43
|
+
- [StaticMerkleRootMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md)
|
|
44
|
+
- [StaticMessageIdMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md)
|
|
45
|
+
- [StaticMerkleRootMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md)
|
|
46
|
+
- [StaticMessageIdMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md)
|
|
47
|
+
- [❱ native](contracts/isms/native/README.md)
|
|
48
|
+
- [AbstractNativeISM](contracts/isms/native/AbstractNativeISM.sol/abstract.AbstractNativeISM.md)
|
|
49
|
+
- [OptimismISM](contracts/isms/native/OptimismISM.sol/contract.OptimismISM.md)
|
|
50
|
+
- [❱ routing](contracts/isms/routing/README.md)
|
|
51
|
+
- [AbstractRoutingIsm](contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md)
|
|
52
|
+
- [DomainRoutingIsm](contracts/isms/routing/DomainRoutingIsm.sol/contract.DomainRoutingIsm.md)
|
|
53
|
+
- [DomainRoutingIsmFactory](contracts/isms/routing/DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md)
|
|
54
|
+
- [InterchainAccountIsm](contracts/isms/routing/InterchainAccountIsm.sol/contract.InterchainAccountIsm.md)
|
|
55
|
+
- [❱ libs](contracts/libs/README.md)
|
|
56
|
+
- [❱ isms](contracts/libs/isms/README.md)
|
|
57
|
+
- [AggregationIsmMetadata](contracts/libs/isms/AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md)
|
|
58
|
+
- [LegacyMultisigIsmMetadata](contracts/libs/isms/LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md)
|
|
59
|
+
- [MerkleRootMultisigIsmMetadata](contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md)
|
|
60
|
+
- [MessageIdMultisigIsmMetadata](contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md)
|
|
61
|
+
- [❱ middleware](contracts/libs/middleware/README.md)
|
|
62
|
+
- [InterchainAccountMessage](contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md)
|
|
63
|
+
- [InterchainQueryMessage](contracts/libs/middleware/InterchainQueryMessage.sol/library.InterchainQueryMessage.md)
|
|
64
|
+
- [CallLib](contracts/libs/Call.sol/library.CallLib.md)
|
|
65
|
+
- [CheckpointLib](contracts/libs/CheckpointLib.sol/library.CheckpointLib.md)
|
|
66
|
+
- [EnumerableMapExtended](contracts/libs/EnumerableMapExtended.sol/library.EnumerableMapExtended.md)
|
|
67
|
+
- [LegacyCheckpointLib](contracts/libs/LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md)
|
|
68
|
+
- [MerkleLib](contracts/libs/Merkle.sol/library.MerkleLib.md)
|
|
69
|
+
- [Message](contracts/libs/Message.sol/library.Message.md)
|
|
70
|
+
- [MetaProxy](contracts/libs/MetaProxy.sol/library.MetaProxy.md)
|
|
71
|
+
- [MinimalProxy](contracts/libs/MinimalProxy.sol/library.MinimalProxy.md)
|
|
72
|
+
- [StaticMOfNAddressSetFactory](contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
|
|
73
|
+
- [TypeCasts](contracts/libs/TypeCasts.sol/library.TypeCasts.md)
|
|
74
|
+
- [ValidatorAnnouncements](contracts/libs/ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md)
|
|
75
|
+
- [❱ middleware](contracts/middleware/README.md)
|
|
76
|
+
- [❱ liquidity-layer](contracts/middleware/liquidity-layer/README.md)
|
|
77
|
+
- [❱ adapters](contracts/middleware/liquidity-layer/adapters/README.md)
|
|
78
|
+
- [CircleBridgeAdapter](contracts/middleware/liquidity-layer/adapters/CircleBridgeAdapter.sol/contract.CircleBridgeAdapter.md)
|
|
79
|
+
- [PortalAdapter](contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol/contract.PortalAdapter.md)
|
|
80
|
+
- [❱ interfaces](contracts/middleware/liquidity-layer/interfaces/README.md)
|
|
81
|
+
- [❱ circle](contracts/middleware/liquidity-layer/interfaces/circle/README.md)
|
|
82
|
+
- [ICircleMessageTransmitter](contracts/middleware/liquidity-layer/interfaces/circle/ICircleMessageTransmitter.sol/interface.ICircleMessageTransmitter.md)
|
|
83
|
+
- [ITokenMessenger](contracts/middleware/liquidity-layer/interfaces/circle/ITokenMessenger.sol/interface.ITokenMessenger.md)
|
|
84
|
+
- [❱ portal](contracts/middleware/liquidity-layer/interfaces/portal/README.md)
|
|
85
|
+
- [IPortalTokenBridge](contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md)
|
|
86
|
+
- [ILiquidityLayerAdapter](contracts/middleware/liquidity-layer/interfaces/ILiquidityLayerAdapter.sol/interface.ILiquidityLayerAdapter.md)
|
|
87
|
+
- [LiquidityLayerRouter](contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol/contract.LiquidityLayerRouter.md)
|
|
88
|
+
- [InterchainAccountRouter](contracts/middleware/InterchainAccountRouter.sol/contract.InterchainAccountRouter.md)
|
|
89
|
+
- [InterchainQueryRouter](contracts/middleware/InterchainQueryRouter.sol/contract.InterchainQueryRouter.md)
|
|
90
|
+
- [❱ mock](contracts/mock/README.md)
|
|
91
|
+
- [MockCircleMessageTransmitter](contracts/mock/MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md)
|
|
92
|
+
- [MockCircleTokenMessenger](contracts/mock/MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md)
|
|
93
|
+
- [MockHyperlaneEnvironment](contracts/mock/MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md)
|
|
94
|
+
- [MockMailbox](contracts/mock/MockMailbox.sol/contract.MockMailbox.md)
|
|
95
|
+
- [MockPortalBridge](contracts/mock/MockPortalBridge.sol/contract.MockPortalBridge.md)
|
|
96
|
+
- [MockToken](contracts/mock/MockToken.sol/contract.MockToken.md)
|
|
97
|
+
- [❱ test](contracts/test/README.md)
|
|
98
|
+
- [❱ bad-recipient](contracts/test/bad-recipient/README.md)
|
|
99
|
+
- [BadRecipient1](contracts/test/bad-recipient/BadRecipient1.sol/contract.BadRecipient1.md)
|
|
100
|
+
- [BadRecipient2](contracts/test/bad-recipient/BadRecipient2.sol/contract.BadRecipient2.md)
|
|
101
|
+
- [BadRecipient3](contracts/test/bad-recipient/BadRecipient3.sol/contract.BadRecipient3.md)
|
|
102
|
+
- [BadRecipient5](contracts/test/bad-recipient/BadRecipient5.sol/contract.BadRecipient5.md)
|
|
103
|
+
- [BadRecipient6](contracts/test/bad-recipient/BadRecipient6.sol/contract.BadRecipient6.md)
|
|
104
|
+
- [LightTestRecipient](contracts/test/LightTestRecipient.sol/contract.LightTestRecipient.md)
|
|
105
|
+
- [TestGasRouter](contracts/test/TestGasRouter.sol/contract.TestGasRouter.md)
|
|
106
|
+
- [TestHyperlaneConnectionClient](contracts/test/TestHyperlaneConnectionClient.sol/contract.TestHyperlaneConnectionClient.md)
|
|
107
|
+
- [TestInterchainGasPaymaster](contracts/test/TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md)
|
|
108
|
+
- [TestLegacyMultisigIsm](contracts/test/TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md)
|
|
109
|
+
- [TestLiquidityLayerMessageRecipient](contracts/test/TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md)
|
|
110
|
+
- [TestMailbox](contracts/test/TestMailbox.sol/contract.TestMailbox.md)
|
|
111
|
+
- [TestMerkle](contracts/test/TestMerkle.sol/contract.TestMerkle.md)
|
|
112
|
+
- [TestMessage](contracts/test/TestMessage.sol/contract.TestMessage.md)
|
|
113
|
+
- [TestMultisigIsm](contracts/test/TestMultisigIsm.sol/contract.TestMultisigIsm.md)
|
|
114
|
+
- [TestQuery](contracts/test/TestQuery.sol/contract.TestQuery.md)
|
|
115
|
+
- [TestQuerySender](contracts/test/TestQuerySender.sol/contract.TestQuerySender.md)
|
|
116
|
+
- [TestRecipient](contracts/test/TestRecipient.sol/contract.TestRecipient.md)
|
|
117
|
+
- [TestRouter](contracts/test/TestRouter.sol/contract.TestRouter.md)
|
|
118
|
+
- [TestSendReceiver](contracts/test/TestSendReceiver.sol/contract.TestSendReceiver.md)
|
|
119
|
+
- [TestTokenRecipient](contracts/test/TestTokenRecipient.sol/contract.TestTokenRecipient.md)
|
|
120
|
+
- [❱ upgrade](contracts/upgrade/README.md)
|
|
121
|
+
- [Versioned](contracts/upgrade/Versioned.sol/contract.Versioned.md)
|
|
122
|
+
- [GasRouter](contracts/GasRouter.sol/abstract.GasRouter.md)
|
|
123
|
+
- [HyperlaneConnectionClient](contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md)
|
|
124
|
+
- [Mailbox](contracts/Mailbox.sol/contract.Mailbox.md)
|
|
125
|
+
- [OwnableMulticall](contracts/OwnableMulticall.sol/contract.OwnableMulticall.md)
|
|
126
|
+
- [PausableReentrancyGuardUpgradeable](contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md)
|
|
127
|
+
- [Router](contracts/Router.sol/abstract.Router.md)
|
|
128
|
+
- [ValidatorAnnounce](contracts/ValidatorAnnounce.sol/contract.ValidatorAnnounce.md)
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# GasRouter
|
|
2
|
+
[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/GasRouter.sol)
|
|
3
|
+
|
|
4
|
+
**Inherits:**
|
|
5
|
+
[Router](/contracts/Router.sol/abstract.Router.md)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## State Variables
|
|
9
|
+
### destinationGas
|
|
10
|
+
|
|
11
|
+
```solidity
|
|
12
|
+
mapping(uint32 => uint256) public destinationGas;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## Functions
|
|
17
|
+
### setDestinationGas
|
|
18
|
+
|
|
19
|
+
Sets the gas amount dispatched for each configured domain.
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
```solidity
|
|
23
|
+
function setDestinationGas(GasRouterConfig[] calldata gasConfigs) external onlyOwner;
|
|
24
|
+
```
|
|
25
|
+
**Parameters**
|
|
26
|
+
|
|
27
|
+
|Name|Type|Description|
|
|
28
|
+
|----|----|-----------|
|
|
29
|
+
|`gasConfigs`|`GasRouterConfig[]`|The array of GasRouterConfig structs|
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### quoteGasPayment
|
|
33
|
+
|
|
34
|
+
Returns the gas payment required to dispatch a message to the given domain's router.
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
```solidity
|
|
38
|
+
function quoteGasPayment(uint32 _destinationDomain) external view returns (uint256 _gasPayment);
|
|
39
|
+
```
|
|
40
|
+
**Parameters**
|
|
41
|
+
|
|
42
|
+
|Name|Type|Description|
|
|
43
|
+
|----|----|-----------|
|
|
44
|
+
|`_destinationDomain`|`uint32`|The domain of the router.|
|
|
45
|
+
|
|
46
|
+
**Returns**
|
|
47
|
+
|
|
48
|
+
|Name|Type|Description|
|
|
49
|
+
|----|----|-----------|
|
|
50
|
+
|`_gasPayment`|`uint256`|Payment computed by the registered InterchainGasPaymaster.|
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
### _setDestinationGas
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
```solidity
|
|
57
|
+
function _setDestinationGas(uint32 domain, uint256 gas) internal;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### _dispatchWithGas
|
|
61
|
+
|
|
62
|
+
Dispatches a message to an enrolled router via the local router's Mailbox
|
|
63
|
+
and pays for it to be relayed to the destination.
|
|
64
|
+
|
|
65
|
+
*Uses the destinationGas mapping to populate the gas amount for the message.*
|
|
66
|
+
|
|
67
|
+
*Reverts if there is no enrolled router for _destinationDomain.*
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
```solidity
|
|
71
|
+
function _dispatchWithGas(
|
|
72
|
+
uint32 _destinationDomain,
|
|
73
|
+
bytes memory _messageBody,
|
|
74
|
+
uint256 _gasPayment,
|
|
75
|
+
address _gasPaymentRefundAddress
|
|
76
|
+
) internal returns (bytes32 _messageId);
|
|
77
|
+
```
|
|
78
|
+
**Parameters**
|
|
79
|
+
|
|
80
|
+
|Name|Type|Description|
|
|
81
|
+
|----|----|-----------|
|
|
82
|
+
|`_destinationDomain`|`uint32`|The domain of the chain to which to send the message.|
|
|
83
|
+
|`_messageBody`|`bytes`|Raw bytes content of message.|
|
|
84
|
+
|`_gasPayment`|`uint256`|The amount of native tokens to pay for the message to be relayed.|
|
|
85
|
+
|`_gasPaymentRefundAddress`|`address`|The address to refund any gas overpayment to.|
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
### _dispatchWithGas
|
|
89
|
+
|
|
90
|
+
*Passes `msg.value` as gas payment and `msg.sender` as gas payment refund address.*
|
|
91
|
+
|
|
92
|
+
*Uses the destinationGas mapping to populate the gas amount for the message.*
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
```solidity
|
|
96
|
+
function _dispatchWithGas(uint32 _destinationDomain, bytes memory _messageBody) internal returns (bytes32 _messageId);
|
|
97
|
+
```
|
|
98
|
+
**Parameters**
|
|
99
|
+
|
|
100
|
+
|Name|Type|Description|
|
|
101
|
+
|----|----|-----------|
|
|
102
|
+
|`_destinationDomain`|`uint32`|The domain of the chain to send the message.|
|
|
103
|
+
|`_messageBody`|`bytes`|Raw bytes content of message.|
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
## Events
|
|
107
|
+
### DestinationGasSet
|
|
108
|
+
Emitted when a domain's destination gas is set.
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
```solidity
|
|
112
|
+
event DestinationGasSet(uint32 indexed domain, uint256 gas);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Structs
|
|
116
|
+
### GasRouterConfig
|
|
117
|
+
|
|
118
|
+
```solidity
|
|
119
|
+
struct GasRouterConfig {
|
|
120
|
+
uint32 domain;
|
|
121
|
+
uint256 gas;
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
package/docs/src/contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md
ADDED
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
# HyperlaneConnectionClient
|
|
2
|
+
[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/60f321f452052881dce4e22999022e11fc117456/contracts/HyperlaneConnectionClient.sol)
|
|
3
|
+
|
|
4
|
+
**Inherits:**
|
|
5
|
+
OwnableUpgradeable, [IHyperlaneConnectionClient](/contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
## State Variables
|
|
9
|
+
### mailbox
|
|
10
|
+
|
|
11
|
+
```solidity
|
|
12
|
+
IMailbox public mailbox;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### interchainGasPaymaster
|
|
17
|
+
|
|
18
|
+
```solidity
|
|
19
|
+
IInterchainGasPaymaster public interchainGasPaymaster;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### interchainSecurityModule
|
|
24
|
+
|
|
25
|
+
```solidity
|
|
26
|
+
IInterchainSecurityModule public interchainSecurityModule;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### __GAP
|
|
31
|
+
|
|
32
|
+
```solidity
|
|
33
|
+
uint256[48] private __GAP;
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
## Functions
|
|
38
|
+
### onlyMailbox
|
|
39
|
+
|
|
40
|
+
Only accept messages from an Hyperlane Mailbox contract
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
```solidity
|
|
44
|
+
modifier onlyMailbox();
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### onlyContract
|
|
48
|
+
|
|
49
|
+
Only accept addresses that at least have contract code
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
```solidity
|
|
53
|
+
modifier onlyContract(address _contract);
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### __HyperlaneConnectionClient_initialize
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
```solidity
|
|
60
|
+
function __HyperlaneConnectionClient_initialize(address _mailbox) internal onlyInitializing;
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### __HyperlaneConnectionClient_initialize
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
```solidity
|
|
67
|
+
function __HyperlaneConnectionClient_initialize(address _mailbox, address _interchainGasPaymaster)
|
|
68
|
+
internal
|
|
69
|
+
onlyInitializing;
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### __HyperlaneConnectionClient_initialize
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
```solidity
|
|
76
|
+
function __HyperlaneConnectionClient_initialize(
|
|
77
|
+
address _mailbox,
|
|
78
|
+
address _interchainGasPaymaster,
|
|
79
|
+
address _interchainSecurityModule
|
|
80
|
+
) internal onlyInitializing;
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### __HyperlaneConnectionClient_initialize
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
```solidity
|
|
87
|
+
function __HyperlaneConnectionClient_initialize(
|
|
88
|
+
address _mailbox,
|
|
89
|
+
address _interchainGasPaymaster,
|
|
90
|
+
address _interchainSecurityModule,
|
|
91
|
+
address _owner
|
|
92
|
+
) internal onlyInitializing;
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### setMailbox
|
|
96
|
+
|
|
97
|
+
Sets the address of the application's Mailbox.
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
```solidity
|
|
101
|
+
function setMailbox(address _mailbox) external virtual onlyOwner;
|
|
102
|
+
```
|
|
103
|
+
**Parameters**
|
|
104
|
+
|
|
105
|
+
|Name|Type|Description|
|
|
106
|
+
|----|----|-----------|
|
|
107
|
+
|`_mailbox`|`address`|The address of the Mailbox contract.|
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
### setInterchainGasPaymaster
|
|
111
|
+
|
|
112
|
+
Sets the address of the application's InterchainGasPaymaster.
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
```solidity
|
|
116
|
+
function setInterchainGasPaymaster(address _interchainGasPaymaster) external virtual onlyOwner;
|
|
117
|
+
```
|
|
118
|
+
**Parameters**
|
|
119
|
+
|
|
120
|
+
|Name|Type|Description|
|
|
121
|
+
|----|----|-----------|
|
|
122
|
+
|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
### setInterchainSecurityModule
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
```solidity
|
|
129
|
+
function setInterchainSecurityModule(address _module) external virtual onlyOwner;
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### _setInterchainGasPaymaster
|
|
133
|
+
|
|
134
|
+
Sets the address of the application's InterchainGasPaymaster.
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
```solidity
|
|
138
|
+
function _setInterchainGasPaymaster(address _interchainGasPaymaster) internal onlyContract(_interchainGasPaymaster);
|
|
139
|
+
```
|
|
140
|
+
**Parameters**
|
|
141
|
+
|
|
142
|
+
|Name|Type|Description|
|
|
143
|
+
|----|----|-----------|
|
|
144
|
+
|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
### _setMailbox
|
|
148
|
+
|
|
149
|
+
Modify the contract the Application uses to validate Mailbox contracts
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
```solidity
|
|
153
|
+
function _setMailbox(address _mailbox) internal onlyContract(_mailbox);
|
|
154
|
+
```
|
|
155
|
+
**Parameters**
|
|
156
|
+
|
|
157
|
+
|Name|Type|Description|
|
|
158
|
+
|----|----|-----------|
|
|
159
|
+
|`_mailbox`|`address`|The address of the mailbox contract|
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### _setInterchainSecurityModule
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
```solidity
|
|
166
|
+
function _setInterchainSecurityModule(address _module) internal;
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Events
|
|
170
|
+
### MailboxSet
|
|
171
|
+
Emitted when a new mailbox is set.
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
```solidity
|
|
175
|
+
event MailboxSet(address indexed mailbox);
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### InterchainGasPaymasterSet
|
|
179
|
+
Emitted when a new Interchain Gas Paymaster is set.
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
```solidity
|
|
183
|
+
event InterchainGasPaymasterSet(address indexed interchainGasPaymaster);
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### InterchainSecurityModuleSet
|
|
187
|
+
|
|
188
|
+
```solidity
|
|
189
|
+
event InterchainSecurityModuleSet(address indexed module);
|
|
190
|
+
```
|
|
191
|
+
|