refactor: optional mailbox on warp config (#5500)

### Description

This PR updates the warp route deployment configuration to handle
mailbox addresses more consistently. Key changes:
- Makes mailbox optional in the WarpRouteDeployConfig schema
- Introduces a new WarpRouteDeployConfigMailboxRequired type for
internal use
- Updates the config filling logic to handle mailbox addresses through
the context
- Removes direct mailbox address prompting during config creation

### Drive-by changes

- Cleaned up some unused imports
- Improved type safety around mailbox requirements
- Updated tests to reflect new mailbox handling

### Related issues

#5258

### Backward compatibility

Yes - This change maintains backward compatibility while improving the
internal handling of mailbox addresses.

### Testing

Unit Tests - Existing tests have been updated to accommodate the new
mailbox handling approach

Author: mshojaei-txfusion

.changeset/forty-mugs-deny.md

@@ -0,0 +1,6 @@
+---
+'@hyperlane-xyz/cli': minor
+'@hyperlane-xyz/sdk': minor
+---
+
+Make mailbox optional on warp deploy config

.changeset/violet-beers-hang.md

@@ -13,18 +13,21 @@ Removes `HypNativeScaled` in favor of `HypNative` with `scale` parameter.
 If you want to keep the same behavior as before, you can set `scale` to `1` in all your routes.
 
 ### `HypNativeScaled` Usage
+
 ```diff
 - HypNativeScaled(scale, mailbox)
 + HypNative(scale, mailbox)
 ```
 
 ### `HypERC20` Usage
+
 ```diff
 - HypERC20(decimals, mailbox)
 + HypERC20(decimals, scale, mailbox)
 ```
 
 ### `HypERC20Collateral` Usage
+
 ```diff
 - HypERC20Collateral(erc20, mailbox)
 + HypERC20Collateral(erc20, scale, mailbox)

typescript/cli/src/commands/config.ts

@@ -97,8 +97,8 @@ const validateWarpCommand: CommandModuleWithContext<{ path: string }> = {
   builder: {
     path: inputFileCommandOption(),
   },
-  handler: async ({ path }) => {
-    await readWarpRouteDeployConfig(path);
+  handler: async ({ path, context }) => {
+    await readWarpRouteDeployConfig(path, context);
     logGreen('Config is valid');
     process.exit(0);
   },

typescript/cli/src/commands/warp.ts

@@ -115,7 +115,7 @@ export const apply: CommandModuleWithWriteContext<{
 
     if (strategyUrl)
       ChainSubmissionStrategySchema.parse(readYamlOrJson(strategyUrl));
-    const warpDeployConfig = await readWarpRouteDeployConfig(config);
+    const warpDeployConfig = await readWarpRouteDeployConfig(config, context);
 
     await runWarpRouteApply({
       context,

typescript/cli/src/config/warp.ts

@@ -11,15 +11,11 @@ import {
   WarpCoreConfig,
   WarpCoreConfigSchema,
   WarpRouteDeployConfig,
+  WarpRouteDeployConfigMailboxRequired,
+  WarpRouteDeployConfigMailboxRequiredSchema,
   WarpRouteDeployConfigSchema,
 } from '@hyperlane-xyz/sdk';
-import {
-  Address,
-  assert,
-  isAddress,
-  objMap,
-  promiseObjAll,
-} from '@hyperlane-xyz/utils';
+import { Address, assert, objMap, promiseObjAll } from '@hyperlane-xyz/utils';
 
 import { CommandContext } from '../context/types.js';
 import { errorRed, log, logBlue, logGreen } from '../logger.js';
@@ -96,15 +92,16 @@ async function fillDefaults(
 
 export async function readWarpRouteDeployConfig(
   filePath: string,
-  context?: CommandContext,
-): Promise<WarpRouteDeployConfig> {
+  context: CommandContext,
+): Promise<WarpRouteDeployConfigMailboxRequired> {
   let config = readYamlOrJson(filePath);
   if (!config)
     throw new Error(`No warp route deploy config found at ${filePath}`);
-  if (context) {
-    config = await fillDefaults(context, config as any);
-  }
-  return WarpRouteDeployConfigSchema.parse(config);
+
+  config = await fillDefaults(context, config as any);
+
+  //fillDefaults would have added a mailbox to the config if it was missing
+  return WarpRouteDeployConfigMailboxRequiredSchema.parse(config);
 }
 
 export function isValidWarpRouteDeployConfig(config: any) {
@@ -142,16 +139,6 @@ export async function createWarpRouteDeployConfig({
       'signer',
     );
 
-    // default to the mailbox from the registry and if not found ask to the user to submit one
-    const chainAddresses = await context.registry.getChainAddresses(chain);
-
-    const mailbox =
-      chainAddresses?.mailbox ??
-      (await input({
-        validate: isAddress,
-        message: `Could not retrieve mailbox address from the registry for chain "${chain}". Please enter a valid mailbox address:`,
-      }));
-
     const proxyAdmin: DeployedOwnableConfig | undefined =
       await setProxyAdminConfig(context, chain);
 
@@ -193,7 +180,6 @@ export async function createWarpRouteDeployConfig({
       case TokenType.collateralUri:
       case TokenType.fastCollateral:
         result[chain] = {
-          mailbox,
           type,
           owner,
           proxyAdmin,
@@ -206,7 +192,6 @@ export async function createWarpRouteDeployConfig({
         break;
       case TokenType.syntheticRebase:
         result[chain] = {
-          mailbox,
           type,
           owner,
           isNft,
@@ -221,7 +206,6 @@ export async function createWarpRouteDeployConfig({
         break;
       case TokenType.collateralVaultRebase:
         result[chain] = {
-          mailbox,
           type,
           owner,
           proxyAdmin,
@@ -236,7 +220,6 @@ export async function createWarpRouteDeployConfig({
         break;
       case TokenType.collateralVault:
         result[chain] = {
-          mailbox,
           type,
           owner,
           proxyAdmin,
@@ -249,7 +232,6 @@ export async function createWarpRouteDeployConfig({
         break;
       default:
         result[chain] = {
-          mailbox,
           type,
           owner,
           proxyAdmin,

typescript/cli/src/deploy/warp.ts

@@ -46,6 +46,7 @@ import {
   WarpCoreConfig,
   WarpCoreConfigSchema,
   WarpRouteDeployConfig,
+  WarpRouteDeployConfigMailboxRequired,
   WarpRouteDeployConfigSchema,
   attachContractsMap,
   connectContractsMap,
@@ -88,7 +89,7 @@ import {
 
 interface DeployParams {
   context: WriteCommandContext;
-  warpDeployConfig: WarpRouteDeployConfig;
+  warpDeployConfig: WarpRouteDeployConfigMailboxRequired;
 }
 
 interface WarpApplyParams extends DeployParams {
@@ -193,7 +194,7 @@ async function executeDeploy(
     ? new HypERC721Deployer(multiProvider)
     : new HypERC20Deployer(multiProvider); // TODO: replace with EvmERC20WarpModule
 
-  const config: WarpRouteDeployConfig =
+  const config: WarpRouteDeployConfigMailboxRequired =
     isDryRun && dryRunChain
       ? { [dryRunChain]: warpDeployConfig[dryRunChain] }
       : warpDeployConfig;
@@ -238,11 +239,11 @@ async function writeDeploymentArtifacts(
 }
 
 async function resolveWarpIsmAndHook(
-  warpConfig: WarpRouteDeployConfig,
+  warpConfig: WarpRouteDeployConfigMailboxRequired,
   context: WriteCommandContext,
   ismFactoryDeployer: HyperlaneProxyFactoryDeployer,
   contractVerifier?: ContractVerifier,
-): Promise<WarpRouteDeployConfig> {
+): Promise<WarpRouteDeployConfigMailboxRequired> {
   return promiseObjAll(
     objMap(warpConfig, async (chain, config) => {
       const registryAddresses = await context.registry.getAddresses();
@@ -573,12 +574,12 @@ async function extendWarpRoute(
   const warpCoreChains = Object.keys(warpCoreConfigByChain);
 
   // Split between the existing and additional config
-  const existingConfigs: WarpRouteDeployConfig = objFilter(
+  const existingConfigs: WarpRouteDeployConfigMailboxRequired = objFilter(
     warpDeployConfig,
     (chain, _config): _config is any => warpCoreChains.includes(chain),
   );
 
-  let extendedConfigs: WarpRouteDeployConfig = objFilter(
+  let extendedConfigs: WarpRouteDeployConfigMailboxRequired = objFilter(
     warpDeployConfig,
     (chain, _config): _config is any => !warpCoreChains.includes(chain),
   );
@@ -660,12 +661,14 @@ async function updateExistingWarpRoute(
           staticAggregationHookFactory,
           staticMerkleRootWeightedMultisigIsmFactory,
           staticMessageIdWeightedMultisigIsmFactory,
+          mailbox,
         } = registryAddresses[chain];
+        const configWithMailbox = { ...config, mailbox };
 
         const evmERC20WarpModule = new EvmERC20WarpModule(
           multiProvider,
           {
-            config,
+            config: configWithMailbox,
             chain,
             addresses: {
               deployedTokenRoute,
@@ -681,7 +684,9 @@ async function updateExistingWarpRoute(
           ccipContractCache,
           contractVerifier,
         );
-        transactions.push(...(await evmERC20WarpModule.update(config)));
+        transactions.push(
+          ...(await evmERC20WarpModule.update(configWithMailbox)),
+        );
       });
     }),
   );
@@ -708,9 +713,9 @@ export function readChainSubmissionStrategy(
  */
 async function deriveMetadataFromExisting(
   multiProvider: MultiProvider,
-  existingConfigs: WarpRouteDeployConfig,
-  extendedConfigs: WarpRouteDeployConfig,
-): Promise<WarpRouteDeployConfig> {
+  existingConfigs: WarpRouteDeployConfigMailboxRequired,
+  extendedConfigs: WarpRouteDeployConfigMailboxRequired,
+): Promise<WarpRouteDeployConfigMailboxRequired> {
   const existingTokenMetadata = await HypERC20Deployer.deriveTokenMetadata(
     multiProvider,
     existingConfigs,

typescript/cli/src/tests/warp/warp-init.e2e-test.ts

@@ -1,9 +1,7 @@
 import { expect } from 'chai';
 import { Wallet } from 'ethers';
 
-import { ChainAddresses } from '@hyperlane-xyz/registry';
 import {
-  ChainMap,
   ChainName,
   TokenType,
   WarpRouteDeployConfig,
@@ -16,15 +14,13 @@ import {
   CHAIN_NAME_2,
   CHAIN_NAME_3,
   CONFIRM_DETECTED_OWNER_STEP,
-  CORE_CONFIG_PATH,
   DEFAULT_E2E_TEST_TIMEOUT,
   KeyBoardKeys,
   SELECT_ANVIL_2_AND_ANVIL_3_STEPS,
   SELECT_ANVIL_2_FROM_MULTICHAIN_PICKER,
   SELECT_MAINNET_CHAIN_TYPE_STEP,
   TestPromptAction,
   WARP_CONFIG_PATH_2,
-  deployOrUseExistingCore,
   deployToken,
   handlePrompts,
 } from '../commands/helpers.js';
@@ -33,38 +29,21 @@ import { hyperlaneWarpInit } from '../commands/warp.js';
 describe('hyperlane warp init e2e tests', async function () {
   this.timeout(2 * DEFAULT_E2E_TEST_TIMEOUT);
 
-  let chain2Addresses: ChainAddresses = {};
-  let chain3Addresses: ChainAddresses = {};
   let initialOwnerAddress: Address;
-  let chainMapAddresses: ChainMap<ChainAddresses> = {};
 
   before(async function () {
-    [chain2Addresses, chain3Addresses] = await Promise.all([
-      deployOrUseExistingCore(CHAIN_NAME_2, CORE_CONFIG_PATH, ANVIL_KEY),
-      deployOrUseExistingCore(CHAIN_NAME_3, CORE_CONFIG_PATH, ANVIL_KEY),
-    ]);
-
-    chainMapAddresses = {
-      [CHAIN_NAME_2]: chain2Addresses,
-      [CHAIN_NAME_3]: chain3Addresses,
-    };
-
     const wallet = new Wallet(ANVIL_KEY);
     initialOwnerAddress = wallet.address;
   });
 
   describe('hyperlane warp init --yes', () => {
     function assertWarpConfig(
       warpConfig: WarpRouteDeployConfig,
-      chainMapAddresses: ChainMap<ChainAddresses>,
       chainName: ChainName,
     ) {
       expect(warpConfig[chainName]).not.to.be.undefined;
 
       const chain2TokenConfig = warpConfig[chainName];
-      expect(chain2TokenConfig.mailbox).equal(
-        chainMapAddresses[chainName].mailbox,
-      );
       expect(chain2TokenConfig.owner).equal(initialOwnerAddress);
       expect(chain2TokenConfig.type).equal(TokenType.native);
       expect(chain2TokenConfig.interchainSecurityModule).undefined;
@@ -96,7 +75,7 @@ describe('hyperlane warp init e2e tests', async function () {
       const warpConfig: WarpRouteDeployConfig =
         readYamlOrJson(WARP_CONFIG_PATH_2);
 
-      assertWarpConfig(warpConfig, chainMapAddresses, CHAIN_NAME_2);
+      assertWarpConfig(warpConfig, CHAIN_NAME_2);
     });
 
     it('it should generate a warp deploy config with a 2 chains warp route (native->native)', async function () {
@@ -125,7 +104,7 @@ describe('hyperlane warp init e2e tests', async function () {
         readYamlOrJson(WARP_CONFIG_PATH_2);
 
       [CHAIN_NAME_2, CHAIN_NAME_3].map((chainName) =>
-        assertWarpConfig(warpConfig, chainMapAddresses, chainName),
+        assertWarpConfig(warpConfig, chainName),
       );
     });
 
@@ -167,15 +146,13 @@ describe('hyperlane warp init e2e tests', async function () {
       expect(warpConfig[CHAIN_NAME_2]).not.to.be.undefined;
 
       const chain2TokenConfig = warpConfig[CHAIN_NAME_2];
-      expect(chain2TokenConfig.mailbox).equal(chain2Addresses.mailbox);
       expect(chain2TokenConfig.owner).equal(initialOwnerAddress);
       expect(chain2TokenConfig.type).equal(TokenType.collateral);
       expect((chain2TokenConfig as any).token).equal(erc20Token.address);
 
       expect(warpConfig[CHAIN_NAME_3]).not.to.be.undefined;
 
       const chain3TokenConfig = warpConfig[CHAIN_NAME_3];
-      expect(chain3TokenConfig.mailbox).equal(chain3Addresses.mailbox);
       expect(chain3TokenConfig.owner).equal(initialOwnerAddress);
       expect(chain3TokenConfig.type).equal(TokenType.synthetic);
     });