fix(infra): use agent-only overrides only for generating config (#7254)

Author: paulbalaji

typescript/infra/config/environments/mainnet3/chains.ts

@@ -12,6 +12,34 @@ export const ethereumChainNames = supportedChainNames.filter(
   isEthereumProtocolChain,
 );
 
+// Agent specific chain metadata overrides
+// Such as minGasPrice, minFeePerGas, minPriorityFeePerGas
+export const agentSpecificChainMetadataOverrides: ChainMap<
+  Partial<ChainMetadata>
+> = {
+  incentiv: {
+    transactionOverrides: {
+      minGasPrice: 1 * 10 ** 9, // 1 gwei
+      minFeePerGas: 1 * 10 ** 9, // 1 gwei
+      minPriorityFeePerGas: 1 * 10 ** 9, // 1 gwei
+    },
+  },
+  ronin: {
+    transactionOverrides: {
+      minGasPrice: 20 * 10 ** 9, // 20 gwei
+      minFeePerGas: 20 * 10 ** 9, // 20 gwei
+      minPriorityFeePerGas: 20 * 10 ** 9, // 20 gwei
+    },
+  },
+  ink: {
+    transactionOverrides: {
+      minGasPrice: 1, // 1 wei
+      minFeePerGas: 1, // 1 wei
+      minPriorityFeePerGas: 1, // 1 wei
+    },
+  },
+};
+
 export const chainMetadataOverrides: ChainMap<Partial<ChainMetadata>> = {
   bsc: {
     transactionOverrides: {
@@ -50,27 +78,6 @@ export const chainMetadataOverrides: ChainMap<Partial<ChainMetadata>> = {
       gasPrice: 1 * 10 ** 6, // 0.001 gwei
     },
   },
-  incentiv: {
-    transactionOverrides: {
-      minGasPrice: 1 * 10 ** 9, // 1 gwei
-      minFeePerGas: 1 * 10 ** 9, // 1 gwei
-      minPriorityFeePerGas: 1 * 10 ** 9, // 1 gwei
-    },
-  },
-  ronin: {
-    transactionOverrides: {
-      minGasPrice: 20 * 10 ** 9, // 20 gwei
-      minFeePerGas: 20 * 10 ** 9, // 20 gwei
-      minPriorityFeePerGas: 20 * 10 ** 9, // 20 gwei
-    },
-  },
-  ink: {
-    transactionOverrides: {
-      minGasPrice: 1, // 1 wei
-      minFeePerGas: 1, // 1 wei
-      minPriorityFeePerGas: 1, // 1 wei
-    },
-  },
   // Deploy-only overrides, set when deploying contracts
   // chilizmainnet: {
   //   transactionOverrides: {

typescript/infra/scripts/agents/update-agent-config.ts

@@ -5,6 +5,7 @@ import { ChainAddresses } from '@hyperlane-xyz/registry';
 import {
   AgentConfig,
   ChainMap,
+  ChainMetadata,
   ChainTechnicalStack,
   CoreFactories,
   HyperlaneContracts,
@@ -25,6 +26,7 @@ import {
 } from '@hyperlane-xyz/utils';
 
 import { Contexts } from '../../config/contexts.js';
+import { agentSpecificChainMetadataOverrides } from '../../config/environments/mainnet3/chains.js';
 import mainnet3GasPrices from '../../config/environments/mainnet3/gasPrices.json' with { type: 'json' };
 import testnet4GasPrices from '../../config/environments/testnet4/gasPrices.json' with { type: 'json' };
 import {
@@ -69,20 +71,29 @@ export async function writeAgentConfig(
   // Get gas prices for Cosmos chains.
   // Instead of iterating through `addresses`, which only includes EVM chains,
   // iterate through the environment chain names.
+
+  const envConfig = getEnvironmentConfig(environment);
   const envAgentConfig = getAgentConfig(Contexts.Hyperlane, environment);
   const environmentChains = envAgentConfig.environmentChainNames;
+  const registry =
+    environment !== 'test' ? await envConfig.getRegistry() : undefined;
+
+  // Build additional config for:
+  // - cosmos/cosmos native chains that require special gas price handling
+  // - any chains that have agent-specific overrides
   const additionalConfig = Object.fromEntries(
     await Promise.all(
-      environmentChains
-        .filter(
-          (chain) =>
-            chainIsProtocol(chain, ProtocolType.Cosmos) ||
-            chainIsProtocol(chain, ProtocolType.CosmosNative),
-        )
-        .map(async (chain) => {
+      environmentChains.map(async (chain) => {
+        let config: Partial<ChainMetadata> = {};
+
+        // Get Cosmos gas price if applicable
+        if (
+          chainIsProtocol(chain, ProtocolType.Cosmos) ||
+          chainIsProtocol(chain, ProtocolType.CosmosNative)
+        ) {
           try {
             const gasPrice = await getCosmosChainGasPrice(chain, multiProvider);
-            return [chain, { gasPrice }];
+            config.gasPrice = gasPrice;
           } catch (error) {
             rootLogger.error(`Error getting gas price for ${chain}:`, error);
             const { denom } = await multiProvider.getNativeToken(chain);
@@ -93,9 +104,27 @@ export async function writeAgentConfig(
                     .amount
                 : testnet4GasPrices[chain as keyof typeof testnet4GasPrices]
                     .amount;
-            return [chain, { gasPrice: { denom, amount } }];
+            config.gasPrice = { denom, amount };
           }
-        }),
+        }
+
+        // Merge agent-specific overrides with general overrides
+        // TODO: support testnet4 overrides (if we ever need to)
+        const agentSpecificOverrides =
+          agentSpecificChainMetadataOverrides[chain];
+        if (agentSpecificOverrides && registry) {
+          const chainMetadata = await registry.getChainMetadata(chain);
+          assert(chainMetadata, `Chain metadata not found for chain ${chain}`);
+          // Only care about blocks and transactionOverrides from the agent-specific overrides
+          const { blocks, transactionOverrides } = objMerge(
+            chainMetadata,
+            agentSpecificOverrides,
+          );
+          config = objMerge(config, { blocks, transactionOverrides });
+        }
+
+        return [chain, config];
+      }),
     ),
   );