@hyperlane-xyz/core 1.4.1 → 1.4.2

package/docs/book.css

@@ -0,0 +1,13 @@
+table {
+    margin: 0 auto;
+    border-collapse: collapse;
+    width: 100%;
+}
+
+table td:first-child {
+    width: 15%;
+}
+  
+table td:nth-child(2) {
+    width: 25%;
+}

package/docs/book.toml

@@ -0,0 +1,12 @@
+[book]
+src = "src"
+title = ""
+
+[output.html]
+no-section-label = true
+additional-js = ["solidity.min.js"]
+additional-css = ["book.css"]
+git-repository-url = "https://github.com/hyperlane-xyz/hyperlane-monorepo"
+
+[output.html.fold]
+enable = true

package/docs/solidity.min.js

@@ -0,0 +1,74 @@
+hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
+}catch(e){return!1}}
+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|\$)/
+;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
+begin:a,relevance:0},n={
+keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
+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",
+literal:"true false"},i={className:"string",
+begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
+begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
+return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
+return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
+SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
+var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
+begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
+begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
+className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
+contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
+className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
+contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
+solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
+HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
+;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
+;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
+;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
+;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={
+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",
+literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
+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"
+},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
+},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
+excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
+begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
+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"
+},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
+lexemes:C,keywords:p}),w={className:"built_in",
+begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
+begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
+excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
+contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
+contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
+excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
+relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
+keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
+keywords:p,lexemes:C,
+contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
+className:"function",lexemes:C,
+beginKeywords:"function modifier event constructor fallback receive error",
+end:/[{;]/,excludeEnd:!0,
+contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
+},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,{
+className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
+excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
+},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
+beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
+beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
+contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
+beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
+contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
+beginKeywords:"pragma",end:";",lexemes:C,keywords:{
+keyword:"pragma solidity experimental abicoder",
+built_in:"ABIEncoderV2 SMTChecker v1 v2"},
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
+className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
+beginKeywords:"assembly",end:/\b\B/,
+contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
+end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
+end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
+
+// Ugly hack to reload HLJS
+hljs.initHighlightingOnLoad();

package/docs/src/README.md

@@ -0,0 +1,15 @@
+# Hyperlane Solidity
+
+On-chain implementations of Hyperlane in Solidity.
+
+## Setup
+
+- `yarn install`
+
+## Build
+
+- `yarn build`
+
+## Test
+
+- `yarn test`

package/docs/src/SUMMARY.md

@@ -0,0 +1,139 @@
+# Summary
+- [Home](README.md)
+# contracts
+  - [❱ hooks](contracts/hooks/README.md)
+    - [❱ ERC5164](contracts/hooks/ERC5164/README.md)
+      - [❱ interfaces](contracts/hooks/ERC5164/interfaces/README.md)
+        - [IMessageDispatcher](contracts/hooks/ERC5164/interfaces/IMessageDispatcher.sol/interface.IMessageDispatcher.md)
+      - [ERC5164MessageHook](contracts/hooks/ERC5164/ERC5164MessageHook.sol/contract.ERC5164MessageHook.md)
+    - [OptimismMessageHook](contracts/hooks/OptimismMessageHook.sol/contract.OptimismMessageHook.md)
+  - [❱ igps](contracts/igps/README.md)
+    - [❱ gas-oracles](contracts/igps/gas-oracles/README.md)
+      - [StorageGasOracle](contracts/igps/gas-oracles/StorageGasOracle.sol/contract.StorageGasOracle.md)
+    - [InterchainGasPaymaster](contracts/igps/InterchainGasPaymaster.sol/contract.InterchainGasPaymaster.md)
+    - [OverheadIgp](contracts/igps/OverheadIgp.sol/contract.OverheadIgp.md)
+  - [❱ interfaces](contracts/interfaces/README.md)
+    - [❱ hooks](contracts/interfaces/hooks/README.md)
+      - [IMessageHook](contracts/interfaces/hooks/IMessageHook.sol/interface.IMessageHook.md)
+    - [❱ isms](contracts/interfaces/isms/README.md)
+      - [IAggregationIsm](contracts/interfaces/isms/IAggregationIsm.sol/interface.IAggregationIsm.md)
+      - [IMultisigIsm](contracts/interfaces/isms/IMultisigIsm.sol/interface.IMultisigIsm.md)
+      - [IRoutingIsm](contracts/interfaces/isms/IRoutingIsm.sol/interface.IRoutingIsm.md)
+    - [❱ middleware](contracts/interfaces/middleware/README.md)
+      - [IInterchainAccountRouter](contracts/interfaces/middleware/IInterchainAccountRouter.sol/interface.IInterchainAccountRouter.md)
+      - [IInterchainQueryRouter](contracts/interfaces/middleware/IInterchainQueryRouter.sol/interface.IInterchainQueryRouter.md)
+    - [IGasOracle](contracts/interfaces/IGasOracle.sol/interface.IGasOracle.md)
+    - [IHyperlaneConnectionClient](contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
+    - [IInterchainGasPaymaster](contracts/interfaces/IInterchainGasPaymaster.sol/interface.IInterchainGasPaymaster.md)
+    - [IInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.IInterchainSecurityModule.md)
+    - [ISpecifiesInterchainSecurityModule](contracts/interfaces/IInterchainSecurityModule.sol/interface.ISpecifiesInterchainSecurityModule.md)
+    - [ILiquidityLayerMessageRecipient](contracts/interfaces/ILiquidityLayerMessageRecipient.sol/interface.ILiquidityLayerMessageRecipient.md)
+    - [ILiquidityLayerRouter](contracts/interfaces/ILiquidityLayerRouter.sol/interface.ILiquidityLayerRouter.md)
+    - [IMailbox](contracts/interfaces/IMailbox.sol/interface.IMailbox.md)
+    - [IMessageRecipient](contracts/interfaces/IMessageRecipient.sol/interface.IMessageRecipient.md)
+    - [IRouter](contracts/interfaces/IRouter.sol/interface.IRouter.md)
+    - [IValidatorAnnounce](contracts/interfaces/IValidatorAnnounce.sol/interface.IValidatorAnnounce.md)
+  - [❱ isms](contracts/isms/README.md)
+    - [❱ aggregation](contracts/isms/aggregation/README.md)
+      - [AbstractAggregationIsm](contracts/isms/aggregation/AbstractAggregationIsm.sol/abstract.AbstractAggregationIsm.md)
+      - [StaticAggregationIsm](contracts/isms/aggregation/StaticAggregationIsm.sol/contract.StaticAggregationIsm.md)
+      - [StaticAggregationIsmFactory](contracts/isms/aggregation/StaticAggregationIsmFactory.sol/contract.StaticAggregationIsmFactory.md)
+    - [❱ hook](contracts/isms/hook/README.md)
+      - [❱ optimism](contracts/isms/hook/optimism/README.md)
+        - [CrossChainEnabledOptimism](contracts/isms/hook/optimism/CrossChainEnabledOptimism.sol/abstract.CrossChainEnabledOptimism.md)
+        - [LibOptimism](contracts/isms/hook/optimism/LibOptimism.sol/library.LibOptimism.md)
+        - [OptimismISM](contracts/isms/hook/optimism/OptimismISM.sol/contract.OptimismISM.md)
+      - [AbstractHookISM](contracts/isms/hook/AbstractHookISM.sol/abstract.AbstractHookISM.md)
+      - [CrossChainEnabled](contracts/isms/hook/CrossChainEnabled.sol/abstract.CrossChainEnabled.md)
+      - [ERC5164ISM](contracts/isms/hook/ERC5164ISM.sol/contract.ERC5164ISM.md)
+    - [❱ multisig](contracts/isms/multisig/README.md)
+      - [AbstractMerkleRootMultisigIsm](contracts/isms/multisig/AbstractMerkleRootMultisigIsm.sol/abstract.AbstractMerkleRootMultisigIsm.md)
+      - [AbstractMessageIdMultisigIsm](contracts/isms/multisig/AbstractMessageIdMultisigIsm.sol/abstract.AbstractMessageIdMultisigIsm.md)
+      - [AbstractMultisigIsm](contracts/isms/multisig/AbstractMultisigIsm.sol/abstract.AbstractMultisigIsm.md)
+      - [LegacyMultisigIsm](contracts/isms/multisig/LegacyMultisigIsm.sol/contract.LegacyMultisigIsm.md)
+      - [AbstractMetaProxyMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/abstract.AbstractMetaProxyMultisigIsm.md)
+      - [StaticMerkleRootMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsm.md)
+      - [StaticMessageIdMultisigIsm](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsm.md)
+      - [StaticMerkleRootMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMerkleRootMultisigIsmFactory.md)
+      - [StaticMessageIdMultisigIsmFactory](contracts/isms/multisig/StaticMultisigIsm.sol/contract.StaticMessageIdMultisigIsmFactory.md)
+    - [❱ routing](contracts/isms/routing/README.md)
+      - [AbstractRoutingIsm](contracts/isms/routing/AbstractRoutingIsm.sol/abstract.AbstractRoutingIsm.md)
+      - [DomainRoutingIsm](contracts/isms/routing/DomainRoutingIsm.sol/contract.DomainRoutingIsm.md)
+      - [DomainRoutingIsmFactory](contracts/isms/routing/DomainRoutingIsmFactory.sol/contract.DomainRoutingIsmFactory.md)
+      - [InterchainAccountIsm](contracts/isms/routing/InterchainAccountIsm.sol/contract.InterchainAccountIsm.md)
+  - [❱ libs](contracts/libs/README.md)
+    - [❱ isms](contracts/libs/isms/README.md)
+      - [AggregationIsmMetadata](contracts/libs/isms/AggregationIsmMetadata.sol/library.AggregationIsmMetadata.md)
+      - [LegacyMultisigIsmMetadata](contracts/libs/isms/LegacyMultisigIsmMetadata.sol/library.LegacyMultisigIsmMetadata.md)
+      - [MerkleRootMultisigIsmMetadata](contracts/libs/isms/MerkleRootMultisigIsmMetadata.sol/library.MerkleRootMultisigIsmMetadata.md)
+      - [MessageIdMultisigIsmMetadata](contracts/libs/isms/MessageIdMultisigIsmMetadata.sol/library.MessageIdMultisigIsmMetadata.md)
+    - [❱ middleware](contracts/libs/middleware/README.md)
+      - [InterchainAccountMessage](contracts/libs/middleware/InterchainAccountMessage.sol/library.InterchainAccountMessage.md)
+      - [InterchainQueryMessage](contracts/libs/middleware/InterchainQueryMessage.sol/library.InterchainQueryMessage.md)
+    - [CallLib](contracts/libs/Call.sol/library.CallLib.md)
+    - [CheckpointLib](contracts/libs/CheckpointLib.sol/library.CheckpointLib.md)
+    - [EnumerableMapExtended](contracts/libs/EnumerableMapExtended.sol/library.EnumerableMapExtended.md)
+    - [LegacyCheckpointLib](contracts/libs/LegacyCheckpointLib.sol/library.LegacyCheckpointLib.md)
+    - [MerkleLib](contracts/libs/Merkle.sol/library.MerkleLib.md)
+    - [Message](contracts/libs/Message.sol/library.Message.md)
+    - [MetaProxy](contracts/libs/MetaProxy.sol/library.MetaProxy.md)
+    - [MinimalProxy](contracts/libs/MinimalProxy.sol/library.MinimalProxy.md)
+    - [StaticMOfNAddressSetFactory](contracts/libs/StaticMOfNAddressSetFactory.sol/abstract.StaticMOfNAddressSetFactory.md)
+    - [TypeCasts](contracts/libs/TypeCasts.sol/library.TypeCasts.md)
+    - [ValidatorAnnouncements](contracts/libs/ValidatorAnnouncements.sol/library.ValidatorAnnouncements.md)
+  - [❱ middleware](contracts/middleware/README.md)
+    - [❱ liquidity-layer](contracts/middleware/liquidity-layer/README.md)
+      - [❱ adapters](contracts/middleware/liquidity-layer/adapters/README.md)
+        - [CircleBridgeAdapter](contracts/middleware/liquidity-layer/adapters/CircleBridgeAdapter.sol/contract.CircleBridgeAdapter.md)
+        - [PortalAdapter](contracts/middleware/liquidity-layer/adapters/PortalAdapter.sol/contract.PortalAdapter.md)
+      - [❱ interfaces](contracts/middleware/liquidity-layer/interfaces/README.md)
+        - [❱ circle](contracts/middleware/liquidity-layer/interfaces/circle/README.md)
+          - [ICircleMessageTransmitter](contracts/middleware/liquidity-layer/interfaces/circle/ICircleMessageTransmitter.sol/interface.ICircleMessageTransmitter.md)
+          - [ITokenMessenger](contracts/middleware/liquidity-layer/interfaces/circle/ITokenMessenger.sol/interface.ITokenMessenger.md)
+        - [❱ portal](contracts/middleware/liquidity-layer/interfaces/portal/README.md)
+          - [IPortalTokenBridge](contracts/middleware/liquidity-layer/interfaces/portal/IPortalTokenBridge.sol/interface.IPortalTokenBridge.md)
+        - [ILiquidityLayerAdapter](contracts/middleware/liquidity-layer/interfaces/ILiquidityLayerAdapter.sol/interface.ILiquidityLayerAdapter.md)
+      - [LiquidityLayerRouter](contracts/middleware/liquidity-layer/LiquidityLayerRouter.sol/contract.LiquidityLayerRouter.md)
+    - [InterchainAccountRouter](contracts/middleware/InterchainAccountRouter.sol/contract.InterchainAccountRouter.md)
+    - [InterchainQueryRouter](contracts/middleware/InterchainQueryRouter.sol/contract.InterchainQueryRouter.md)
+  - [❱ mock](contracts/mock/README.md)
+    - [MockCircleMessageTransmitter](contracts/mock/MockCircleMessageTransmitter.sol/contract.MockCircleMessageTransmitter.md)
+    - [MockCircleTokenMessenger](contracts/mock/MockCircleTokenMessenger.sol/contract.MockCircleTokenMessenger.md)
+    - [MockMessageDispatcher](contracts/mock/MockERC5164.sol/contract.MockMessageDispatcher.md)
+    - [MockMessageExecutor](contracts/mock/MockERC5164.sol/contract.MockMessageExecutor.md)
+    - [MockHyperlaneEnvironment](contracts/mock/MockHyperlaneEnvironment.sol/contract.MockHyperlaneEnvironment.md)
+    - [MockMailbox](contracts/mock/MockMailbox.sol/contract.MockMailbox.md)
+    - [MockPortalBridge](contracts/mock/MockPortalBridge.sol/contract.MockPortalBridge.md)
+    - [MockToken](contracts/mock/MockToken.sol/contract.MockToken.md)
+  - [❱ test](contracts/test/README.md)
+    - [❱ bad-recipient](contracts/test/bad-recipient/README.md)
+      - [BadRecipient1](contracts/test/bad-recipient/BadRecipient1.sol/contract.BadRecipient1.md)
+      - [BadRecipient2](contracts/test/bad-recipient/BadRecipient2.sol/contract.BadRecipient2.md)
+      - [BadRecipient3](contracts/test/bad-recipient/BadRecipient3.sol/contract.BadRecipient3.md)
+      - [BadRecipient5](contracts/test/bad-recipient/BadRecipient5.sol/contract.BadRecipient5.md)
+      - [BadRecipient6](contracts/test/bad-recipient/BadRecipient6.sol/contract.BadRecipient6.md)
+    - [LightTestRecipient](contracts/test/LightTestRecipient.sol/contract.LightTestRecipient.md)
+    - [TestGasRouter](contracts/test/TestGasRouter.sol/contract.TestGasRouter.md)
+    - [TestHyperlaneConnectionClient](contracts/test/TestHyperlaneConnectionClient.sol/contract.TestHyperlaneConnectionClient.md)
+    - [TestInterchainGasPaymaster](contracts/test/TestInterchainGasPaymaster.sol/contract.TestInterchainGasPaymaster.md)
+    - [TestLegacyMultisigIsm](contracts/test/TestLegacyMultisigIsm.sol/contract.TestLegacyMultisigIsm.md)
+    - [TestLiquidityLayerMessageRecipient](contracts/test/TestLiquidityLayerMessageRecipient.sol/contract.TestLiquidityLayerMessageRecipient.md)
+    - [TestMailbox](contracts/test/TestMailbox.sol/contract.TestMailbox.md)
+    - [TestMerkle](contracts/test/TestMerkle.sol/contract.TestMerkle.md)
+    - [TestMessage](contracts/test/TestMessage.sol/contract.TestMessage.md)
+    - [TestMultisigIsm](contracts/test/TestMultisigIsm.sol/contract.TestMultisigIsm.md)
+    - [TestQuery](contracts/test/TestQuery.sol/contract.TestQuery.md)
+    - [TestQuerySender](contracts/test/TestQuerySender.sol/contract.TestQuerySender.md)
+    - [TestRecipient](contracts/test/TestRecipient.sol/contract.TestRecipient.md)
+    - [TestRouter](contracts/test/TestRouter.sol/contract.TestRouter.md)
+    - [TestSendReceiver](contracts/test/TestSendReceiver.sol/contract.TestSendReceiver.md)
+    - [TestTokenRecipient](contracts/test/TestTokenRecipient.sol/contract.TestTokenRecipient.md)
+  - [❱ upgrade](contracts/upgrade/README.md)
+    - [Versioned](contracts/upgrade/Versioned.sol/contract.Versioned.md)
+  - [GasRouter](contracts/GasRouter.sol/abstract.GasRouter.md)
+  - [HyperlaneConnectionClient](contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md)
+  - [Mailbox](contracts/Mailbox.sol/contract.Mailbox.md)
+  - [OwnableMulticall](contracts/OwnableMulticall.sol/contract.OwnableMulticall.md)
+  - [PausableReentrancyGuardUpgradeable](contracts/PausableReentrancyGuard.sol/abstract.PausableReentrancyGuardUpgradeable.md)
+  - [Router](contracts/Router.sol/abstract.Router.md)
+  - [ValidatorAnnounce](contracts/ValidatorAnnounce.sol/contract.ValidatorAnnounce.md)

package/docs/src/contracts/GasRouter.sol/abstract.GasRouter.md

@@ -0,0 +1,124 @@
+# GasRouter
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/GasRouter.sol)
+
+**Inherits:**
+[Router](/contracts/Router.sol/abstract.Router.md)
+
+
+## State Variables
+### destinationGas
+
+```solidity
+mapping(uint32 => uint256) public destinationGas;
+```
+
+
+## Functions
+### setDestinationGas
+
+Sets the gas amount dispatched for each configured domain.
+
+
+```solidity
+function setDestinationGas(GasRouterConfig[] calldata gasConfigs) external onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`gasConfigs`|`GasRouterConfig[]`|The array of GasRouterConfig structs|
+
+
+### quoteGasPayment
+
+Returns the gas payment required to dispatch a message to the given domain's router.
+
+
+```solidity
+function quoteGasPayment(uint32 _destinationDomain) external view returns (uint256 _gasPayment);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the router.|
+
+**Returns**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_gasPayment`|`uint256`|Payment computed by the registered InterchainGasPaymaster.|
+
+
+### _setDestinationGas
+
+
+```solidity
+function _setDestinationGas(uint32 domain, uint256 gas) internal;
+```
+
+### _dispatchWithGas
+
+Dispatches a message to an enrolled router via the local router's Mailbox
+and pays for it to be relayed to the destination.
+
+*Uses the destinationGas mapping to populate the gas amount for the message.*
+
+*Reverts if there is no enrolled router for _destinationDomain.*
+
+
+```solidity
+function _dispatchWithGas(
+    uint32 _destinationDomain,
+    bytes memory _messageBody,
+    uint256 _gasPayment,
+    address _gasPaymentRefundAddress
+) internal returns (bytes32 _messageId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the chain to which to send the message.|
+|`_messageBody`|`bytes`|Raw bytes content of message.|
+|`_gasPayment`|`uint256`|The amount of native tokens to pay for the message to be relayed.|
+|`_gasPaymentRefundAddress`|`address`|The address to refund any gas overpayment to.|
+
+
+### _dispatchWithGas
+
+*Passes `msg.value` as gas payment and `msg.sender` as gas payment refund address.*
+
+*Uses the destinationGas mapping to populate the gas amount for the message.*
+
+
+```solidity
+function _dispatchWithGas(uint32 _destinationDomain, bytes memory _messageBody) internal returns (bytes32 _messageId);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_destinationDomain`|`uint32`|The domain of the chain to send the message.|
+|`_messageBody`|`bytes`|Raw bytes content of message.|
+
+
+## Events
+### DestinationGasSet
+Emitted when a domain's destination gas is set.
+
+
+```solidity
+event DestinationGasSet(uint32 indexed domain, uint256 gas);
+```
+
+## Structs
+### GasRouterConfig
+
+```solidity
+struct GasRouterConfig {
+    uint32 domain;
+    uint256 gas;
+}
+```
+

package/docs/src/contracts/HyperlaneConnectionClient.sol/abstract.HyperlaneConnectionClient.md

@@ -0,0 +1,191 @@
+# HyperlaneConnectionClient
+[Git Source](https://github.com/hyperlane-xyz/hyperlane-monorepo/blob/a5209dbd9b0f5eb34e0bc9df2ba157dda2b454d3/contracts/HyperlaneConnectionClient.sol)
+
+**Inherits:**
+OwnableUpgradeable, [IHyperlaneConnectionClient](/contracts/interfaces/IHyperlaneConnectionClient.sol/interface.IHyperlaneConnectionClient.md)
+
+
+## State Variables
+### mailbox
+
+```solidity
+IMailbox public mailbox;
+```
+
+
+### interchainGasPaymaster
+
+```solidity
+IInterchainGasPaymaster public interchainGasPaymaster;
+```
+
+
+### interchainSecurityModule
+
+```solidity
+IInterchainSecurityModule public interchainSecurityModule;
+```
+
+
+### __GAP
+
+```solidity
+uint256[48] private __GAP;
+```
+
+
+## Functions
+### onlyMailbox
+
+Only accept messages from an Hyperlane Mailbox contract
+
+
+```solidity
+modifier onlyMailbox();
+```
+
+### onlyContract
+
+Only accept addresses that at least have contract code
+
+
+```solidity
+modifier onlyContract(address _contract);
+```
+
+### __HyperlaneConnectionClient_initialize
+
+
+```solidity
+function __HyperlaneConnectionClient_initialize(address _mailbox) internal onlyInitializing;
+```
+
+### __HyperlaneConnectionClient_initialize
+
+
+```solidity
+function __HyperlaneConnectionClient_initialize(address _mailbox, address _interchainGasPaymaster)
+    internal
+    onlyInitializing;
+```
+
+### __HyperlaneConnectionClient_initialize
+
+
+```solidity
+function __HyperlaneConnectionClient_initialize(
+    address _mailbox,
+    address _interchainGasPaymaster,
+    address _interchainSecurityModule
+) internal onlyInitializing;
+```
+
+### __HyperlaneConnectionClient_initialize
+
+
+```solidity
+function __HyperlaneConnectionClient_initialize(
+    address _mailbox,
+    address _interchainGasPaymaster,
+    address _interchainSecurityModule,
+    address _owner
+) internal onlyInitializing;
+```
+
+### setMailbox
+
+Sets the address of the application's Mailbox.
+
+
+```solidity
+function setMailbox(address _mailbox) external virtual onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_mailbox`|`address`|The address of the Mailbox contract.|
+
+
+### setInterchainGasPaymaster
+
+Sets the address of the application's InterchainGasPaymaster.
+
+
+```solidity
+function setInterchainGasPaymaster(address _interchainGasPaymaster) external virtual onlyOwner;
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
+
+
+### setInterchainSecurityModule
+
+
+```solidity
+function setInterchainSecurityModule(address _module) external virtual onlyOwner;
+```
+
+### _setInterchainGasPaymaster
+
+Sets the address of the application's InterchainGasPaymaster.
+
+
+```solidity
+function _setInterchainGasPaymaster(address _interchainGasPaymaster) internal onlyContract(_interchainGasPaymaster);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_interchainGasPaymaster`|`address`|The address of the InterchainGasPaymaster contract.|
+
+
+### _setMailbox
+
+Modify the contract the Application uses to validate Mailbox contracts
+
+
+```solidity
+function _setMailbox(address _mailbox) internal onlyContract(_mailbox);
+```
+**Parameters**
+
+|Name|Type|Description|
+|----|----|-----------|
+|`_mailbox`|`address`|The address of the mailbox contract|
+
+
+### _setInterchainSecurityModule
+
+
+```solidity
+function _setInterchainSecurityModule(address _module) internal;
+```
+
+## Events
+### MailboxSet
+Emitted when a new mailbox is set.
+
+
+```solidity
+event MailboxSet(address indexed mailbox);
+```
+
+### InterchainGasPaymasterSet
+Emitted when a new Interchain Gas Paymaster is set.
+
+
+```solidity
+event InterchainGasPaymasterSet(address indexed interchainGasPaymaster);
+```
+
+### InterchainSecurityModuleSet
+
+```solidity
+event InterchainSecurityModuleSet(address indexed module);
+```
+