Merge branch 'v3' into v3-agents-feedback

.github/workflows/node.yml

@@ -120,7 +120,7 @@ jobs:
   #   needs: [yarn-build]
   #   strategy:
   #     matrix:
-  #       environment: [testnet3, mainnet2]
+  #       environment: [testnet4, mainnet2]
   #       module: [ism, core, igp, ica, helloworld]
 
   #   steps:

rust/agents/scraper/migration/src/m20230309_000001_create_table_domain.rs

@@ -182,14 +182,6 @@ const DOMAINS: &[RawDomain] = &[
         is_test_net: true,
         is_deprecated: false,
     },
-    RawDomain {
-        name: "zksync2testnet",
-        token: "ETH",
-        domain: 280,
-        chain_id: 280,
-        is_test_net: true,
-        is_deprecated: false,
-    },
 ];
 
 #[derive(DeriveMigrationName)]

rust/hyperlane-core/src/chain.rs

@@ -54,6 +54,7 @@ pub enum KnownHyperlaneDomain {
 
     Polygon = 137,
     Mumbai = 80001,
+    PolygonZkEvmTestnet = 1442,
 
     Avalanche = 43114,
     Fuji = 43113,
@@ -76,8 +77,7 @@ pub enum KnownHyperlaneDomain {
     MoonbaseAlpha = 1287,
 
     Gnosis = 100,
-
-    Zksync2Testnet = 280,
+    Chiado = 10200,
 
     // -- Local test chains --
     /// Test1 local chain
@@ -94,6 +94,11 @@ pub enum KnownHyperlaneDomain {
     SealevelTest1 = 13375,
     /// Sealevel local chain 1
     SealevelTest2 = 13376,
+
+    // -- v3 testnets --
+    LineaGoerli = 59140,
+    BaseGoerli = 84531,
+    ScrollSepolia = 534351,
 }
 
 #[derive(Clone)]
@@ -182,12 +187,11 @@ impl KnownHyperlaneDomain {
         many_to_one!(match self {
             Mainnet: [
                 Ethereum, Avalanche, Arbitrum, Polygon, Optimism, BinanceSmartChain, Celo,
-                Moonbeam,
-                Gnosis
+                Moonbeam, Gnosis
             ],
             Testnet: [
                 Goerli, Mumbai, Fuji, ArbitrumGoerli, OptimismGoerli, BinanceSmartChainTestnet,
-                Alfajores, MoonbaseAlpha, Zksync2Testnet, Sepolia
+                Alfajores, MoonbaseAlpha, Sepolia, PolygonZkEvmTestnet, LineaGoerli, BaseGoerli, ScrollSepolia, Chiado
             ],
             LocalTestChain: [Test1, Test2, Test3, FuelTest1, SealevelTest1, SealevelTest2],
         })
@@ -200,7 +204,7 @@ impl KnownHyperlaneDomain {
             HyperlaneDomainProtocol::Ethereum: [
                 Ethereum, Goerli, Sepolia, Polygon, Mumbai, Avalanche, Fuji, Arbitrum, ArbitrumGoerli,
                 Optimism, OptimismGoerli, BinanceSmartChain, BinanceSmartChainTestnet, Celo, Gnosis,
-                Alfajores, Moonbeam, MoonbaseAlpha, Zksync2Testnet, Test1, Test2, Test3
+                Alfajores, Moonbeam, MoonbaseAlpha, PolygonZkEvmTestnet, LineaGoerli, BaseGoerli, ScrollSepolia, Chiado, Test1, Test2, Test3
             ],
             HyperlaneDomainProtocol::Fuel: [FuelTest1],
             HyperlaneDomainProtocol::Sealevel: [SealevelTest1, SealevelTest2],

solidity/contracts/Mailbox.sol

@@ -297,6 +297,10 @@ contract Mailbox is IMailbox, Indexed, Versioned, OwnableUpgradeable {
 
         /// INTERACTIONS ///
         uint256 requiredValue = requiredHook.quoteDispatch(metadata, message);
+        // if underpaying, defer to required hook's reverting behavior
+        if (msg.value < requiredValue) {
+            requiredValue = msg.value;
+        }
         requiredHook.postDispatch{value: requiredValue}(metadata, message);
         hook.postDispatch{value: msg.value - requiredValue}(metadata, message);
 

solidity/hardhat.config.ts

@@ -27,7 +27,7 @@ module.exports = {
   typechain: {
     outDir: './types',
     target: 'ethers-v5',
-    alwaysGenerateOverloads: false,
+    alwaysGenerateOverloads: true,
   },
   mocha: {
     bail: true,

typescript/helloworld/hardhat.config.ts

@@ -21,6 +21,6 @@ module.exports = {
   typechain: {
     outDir: './src/types',
     target: 'ethers-v5',
-    alwaysGenerateOverloads: false, // should overloads with full signatures like deposit(uint256) be generated always, even if there are no overloads?
+    alwaysGenerateOverloads: true,
   },
 };

typescript/helloworld/src/test/helloworld.test.ts

@@ -80,9 +80,9 @@ describe('HelloWorld', async () => {
     const body = 'Hello';
     await expect(
       local.sendHelloWorld(remoteDomain, body, {
-        value: (await quoteGasPayment(body)).sub(1),
+        value: 0,
       }),
-    ).to.be.revertedWith('insufficient interchain gas payment');
+    ).to.be.revertedWith('StaticProtocolFee: insufficient protocol fee');
   });
 
   it('handles a message', async () => {

typescript/infra/config/aggregationIsm.ts

@@ -14,11 +14,11 @@ import { DeployEnvironment } from '../src/config';
 import { Contexts } from './contexts';
 import { owners as mainnet2Owners } from './environments/mainnet2/owners';
 import { owners as testOwners } from './environments/test/owners';
-import { owners as testnet3Owners } from './environments/testnet3/owners';
+import { owners as testnet4Owners } from './environments/testnet4/owners';
 import { multisigIsms } from './multisigIsm';
 
 const owners = {
-  testnet3: testnet3Owners,
+  testnet4: testnet4Owners,
   mainnet2: mainnet2Owners,
   test: testOwners,
 };

typescript/infra/config/environments/index.ts

@@ -1,9 +1,9 @@
 import { environment as mainnet2 } from './mainnet2';
 import { environment as test } from './test';
-import { environment as testnet3 } from './testnet3';
+import { environment as testnet4 } from './testnet4';
 
 export const environments = {
   test,
-  testnet3,
+  testnet4,
   mainnet2,
 };

typescript/infra/config/environments/mainnet2/core.ts

@@ -1,9 +1,20 @@
-import { ChainMap, CoreConfig, HookType } from '@hyperlane-xyz/sdk';
+import { BigNumber, ethers } from 'ethers';
+
+import {
+  AggregationHookConfig,
+  ChainMap,
+  CoreConfig,
+  HookType,
+  IgpHookConfig,
+  MerkleTreeHookConfig,
+  ProtocolFeeHookConfig,
+} from '@hyperlane-xyz/sdk';
 import { objMap } from '@hyperlane-xyz/utils';
 
 import { aggregationIsm } from '../../aggregationIsm';
 import { Contexts } from '../../contexts';
 
+import { igp } from './igp';
 import { owners } from './owners';
 
 export const core: ChainMap<CoreConfig> = objMap(owners, (local, owner) => {
@@ -23,15 +34,32 @@ export const core: ChainMap<CoreConfig> = objMap(owners, (local, owner) => {
     };
   }
 
+  const merkleHook: MerkleTreeHookConfig = {
+    type: HookType.MERKLE_TREE,
+  };
+
+  const igpHook: IgpHookConfig = {
+    type: HookType.INTERCHAIN_GAS_PAYMASTER,
+    ...igp[local],
+  };
+
+  const defaultHook: AggregationHookConfig = {
+    type: HookType.AGGREGATION,
+    hooks: [merkleHook, igpHook],
+  };
+
+  const requiredHook: ProtocolFeeHookConfig = {
+    type: HookType.PROTOCOL_FEE,
+    maxProtocolFee: ethers.utils.parseUnits('1', 'gwei'), // 1 gwei of native token
+    protocolFee: BigNumber.from(1), // 1 wei
+    beneficiary: owner,
+    owner,
+  };
+
   return {
     owner,
-    upgrade,
     defaultIsm,
-    defaultHook: {
-      type: HookType.INTERCHAIN_GAS_PAYMASTER,
-    },
-    requiredHook: {
-      type: HookType.MERKLE_TREE,
-    },
+    defaultHook,
+    requiredHook,
   };
 });

typescript/infra/config/environments/mainnet2/igp.ts

@@ -8,7 +8,6 @@ import {
 import { exclude, objMap } from '@hyperlane-xyz/utils';
 
 import { MainnetChains, supportedChainNames } from './chains';
-import { core } from './core';
 import { owners } from './owners';
 
 // TODO: make this generic
@@ -25,20 +24,21 @@ function getGasOracles(local: MainnetChains) {
 }
 
 export const igp: ChainMap<IgpConfig> = objMap(owners, (chain, owner) => {
+  const overhead = Object.fromEntries(
+    exclude(chain, supportedChainNames).map((remote) => [
+      remote,
+      multisigIsmVerificationCost(
+        defaultMultisigIsmConfigs[remote].threshold,
+        defaultMultisigIsmConfigs[remote].validators.length,
+      ),
+    ]),
+  );
+
   return {
     owner,
     oracleKey: DEPLOYER_ADDRESS,
     beneficiary: KEY_FUNDER_ADDRESS,
     gasOracleType: getGasOracles(chain),
-    overhead: Object.fromEntries(
-      exclude(chain, supportedChainNames).map((remote) => [
-        remote,
-        multisigIsmVerificationCost(
-          defaultMultisigIsmConfigs[remote].threshold,
-          defaultMultisigIsmConfigs[remote].validators.length,
-        ),
-      ]),
-    ),
-    upgrade: core[chain].upgrade,
+    overhead,
   };
 });

typescript/infra/config/environments/test/core.ts

@@ -1,13 +1,20 @@
+import { BigNumber, ethers } from 'ethers';
+
 import {
+  AggregationHookConfig,
   ChainMap,
   CoreConfig,
   HookType,
+  IgpHookConfig,
+  MerkleTreeHookConfig,
   ModuleType,
   RoutingIsmConfig,
 } from '@hyperlane-xyz/sdk';
+import { ProtocolFeeHookConfig } from '@hyperlane-xyz/sdk/src/hook/types';
 import { objMap } from '@hyperlane-xyz/utils';
 
 import { aggregationIsm } from './aggregationIsm';
+import { igp } from './igp';
 import { chainToValidator } from './multisigIsm';
 import { owners } from './owners';
 
@@ -22,14 +29,32 @@ export const core: ChainMap<CoreConfig> = objMap(owners, (local, owner) => {
     ),
   };
 
+  const merkleHook: MerkleTreeHookConfig = {
+    type: HookType.MERKLE_TREE,
+  };
+
+  const igpHook: IgpHookConfig = {
+    type: HookType.INTERCHAIN_GAS_PAYMASTER,
+    ...igp[local],
+  };
+
+  const defaultHook: AggregationHookConfig = {
+    type: HookType.AGGREGATION,
+    hooks: [merkleHook, igpHook],
+  };
+
+  const requiredHook: ProtocolFeeHookConfig = {
+    type: HookType.PROTOCOL_FEE,
+    maxProtocolFee: ethers.utils.parseUnits('1', 'gwei'), // 1 gwei of native token
+    protocolFee: BigNumber.from(1), // 1 wei
+    beneficiary: owner,
+    owner,
+  };
+
   return {
     owner,
     defaultIsm,
-    defaultHook: {
-      type: HookType.INTERCHAIN_GAS_PAYMASTER,
-    },
-    requiredHook: {
-      type: HookType.MERKLE_TREE,
-    },
+    defaultHook,
+    requiredHook,
   };
 });

typescript/infra/config/environments/test/igp.ts

@@ -20,19 +20,20 @@ function getGasOracles(local: TestChains) {
 }
 
 export const igp: ChainMap<IgpConfig> = objMap(owners, (chain, owner) => {
+  const overhead = Object.fromEntries(
+    exclude(chain, chainNames).map((remote) => [
+      remote,
+      multisigIsmVerificationCost(
+        multisigIsm[remote].threshold,
+        multisigIsm[remote].validators.length,
+      ),
+    ]),
+  );
   return {
     owner,
     oracleKey: owner,
     beneficiary: owner,
     gasOracleType: getGasOracles(chain),
-    overhead: Object.fromEntries(
-      exclude(chain, chainNames).map((remote) => [
-        remote,
-        multisigIsmVerificationCost(
-          multisigIsm[remote].threshold,
-          multisigIsm[remote].validators.length,
-        ),
-      ]),
-    ),
+    overhead,
   };
 });

typescript/infra/config/environments/test/index.ts

@@ -8,7 +8,6 @@ import { agents } from './agent';
 import { testConfigs } from './chains';
 import { core } from './core';
 import { storageGasOracleConfig } from './gas-oracle';
-import { merkleTree } from './hooks';
 import { igp } from './igp';
 import { infra } from './infra';
 import { owners } from './owners';
@@ -18,7 +17,6 @@ export const environment: EnvironmentConfig = {
   chainMetadataConfigs: testConfigs,
   agents,
   core,
-  hook: merkleTree,
   igp,
   owners,
   infra,