fix(cli): restore foreignDeployment behaviour during deployment + add cross chain tests for the cli (#7156)

Author: xeno097

.changeset/long-adults-repeat.md

@@ -0,0 +1,6 @@
+---
+"@hyperlane-xyz/cli": patch
+"@hyperlane-xyz/sdk": patch
+---
+
+Restore foreignDeployment field behaviour to allow enrollment of unsupported chains during deployment

.github/workflows/test.yml

@@ -393,9 +393,43 @@ jobs:
         env:
           CLI_E2E_TEST: ${{ matrix.test }}
 
+  cli-cross-chain-e2e-matrix:
+    runs-on: depot-ubuntu-latest
+    needs: [rust-only]
+    if: needs.rust-only.outputs.only_rust == 'false'
+    strategy:
+      fail-fast: false
+      matrix:
+        test:
+          # Warp Commands
+          - warp-apply
+          - warp-deploy
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          submodules: recursive
+          fetch-depth: 0
+
+      - name: install-hyperlane-cli
+        id: install-hyperlane-cli
+        uses: ./.github/actions/install-cli
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          cache-provider: github
+
+      - name: Checkout registry
+        uses: ./.github/actions/checkout-registry
+
+      - name: CLI cross chain e2e tests (${{ matrix.test }})
+        run: yarn --cwd typescript/cli test:cross-chain:e2e
+        env:
+          CLI_E2E_TEST: ${{ matrix.test }}
+
   cli-e2e:
     runs-on: ubuntu-latest
-    needs: [cli-evm-e2e-matrix, cli-cosmos-e2e-matrix]
+    needs:
+      [cli-evm-e2e-matrix, cli-cosmos-e2e-matrix, cli-cross-chain-e2e-matrix]
     if: always()
     steps:
       - uses: actions/checkout@v4
@@ -409,6 +443,11 @@ jobs:
         with:
           job_name: 'CLI CosmosNative E2E'
           result: ${{ needs.cli-cosmos-e2e-matrix.result }}
+      - name: Check CLI Cross Chain E2E status
+        uses: ./.github/actions/check-job-status
+        with:
+          job_name: 'CLI Cross Chain E2E'
+          result: ${{ needs.cli-cross-chain-e2e-matrix.result }}
 
   cosmos-sdk-e2e-run:
     runs-on: depot-ubuntu-latest

typescript/cli/package.json

@@ -43,6 +43,7 @@
     "prettier": "^3.5.3",
     "prom-client": "^14.0.1",
     "terminal-link": "^3.0.0",
+    "testcontainers": "11.7.0",
     "tsx": "^4.19.1",
     "typescript": "5.3.3",
     "yaml": "2.4.5",
@@ -62,6 +63,7 @@
     "prettier": "prettier --write ./src ./examples",
     "test:ci": "yarn mocha --config .mocharc.json",
     "test:ethereum:e2e": "./src/tests/ethereum/run-e2e-test.sh",
+    "test:cross-chain:e2e": "./src/tests/cross-chain/run-e2e-test.sh",
     "test:cosmosnative:e2e": "./src/tests/cosmosnative/run-e2e-test.sh",
     "version:update": "echo \"export const VERSION = '$npm_package_version';\" > src/version.ts",
     "prepack": "yarn bundle"

typescript/cli/src/deploy/warp.ts

@@ -373,7 +373,7 @@ export async function runWarpRouteApply(
   params: WarpApplyParams,
 ): Promise<void> {
   const { warpDeployConfig, warpCoreConfig, context } = params;
-  const { chainMetadata, skipConfirmation } = context;
+  const { chainMetadata, skipConfirmation, multiProvider } = context;
 
   WarpRouteDeployConfigSchema.parse(warpDeployConfig);
   WarpCoreConfigSchema.parse(warpCoreConfig);
@@ -394,10 +394,18 @@ export async function runWarpRouteApply(
   // temporarily configure deployer as owner so that warp update after extension
   // can leverage JSON RPC submitter on new chains
   const intermediateOwnerConfig = await promiseObjAll(
-    objMap(params.warpDeployConfig, async (chain, config) => ({
-      ...config,
-      owner: await multiProtocolSigner.getSignerAddress(chain),
-    })),
+    objMap(params.warpDeployConfig, async (chain, config) => {
+      const protocolType = multiProvider.getProtocol(chain);
+
+      if (!COMPATIBLE_PROTOCOLS.includes(protocolType)) {
+        return config;
+      }
+
+      return {
+        ...config,
+        owner: await multiProtocolSigner.getSignerAddress(chain),
+      };
+    }),
   );
 
   // Extend the warp route and get the updated configs
@@ -636,14 +644,20 @@ async function updateExistingWarpRoute(
   await promiseObjAll(
     objMap(expandedWarpDeployConfig, async (chain, config) => {
       await retryAsync(async () => {
+        const protocolType = multiProvider.getProtocol(chain);
+        if (!COMPATIBLE_PROTOCOLS.includes(protocolType)) {
+          logBlue(`Skipping non-compatible chain ${chain}`);
+          return;
+        }
+
         const deployedTokenRoute = deployedRoutersAddresses[chain];
         assert(deployedTokenRoute, `Missing artifacts for ${chain}.`);
         const configWithMailbox = {
           ...config,
           mailbox: registryAddresses[chain].mailbox,
         };
 
-        switch (multiProvider.getProtocol(chain)) {
+        switch (protocolType) {
           case ProtocolType.Ethereum: {
             const evmERC20WarpModule = new EvmERC20WarpModule(
               multiProvider,
@@ -683,10 +697,6 @@ async function updateExistingWarpRoute(
             updateTransactions[chain] = transactions;
             break;
           }
-          default: {
-            logBlue(`Skipping non-compatible chain ${chain}`);
-            return;
-          }
         }
       });
     }),

typescript/cli/src/read/warp.ts

@@ -20,10 +20,12 @@ import {
 import {
   Address,
   ProtocolType,
+  objFilter,
   objMap,
   promiseObjAll,
 } from '@hyperlane-xyz/utils';
 
+import { COMPATIBLE_PROTOCOLS } from '../config/protocols.js';
 import { CommandContext } from '../context/types.js';
 import { logGray, logRed, logTable, warnYellow } from '../logger.js';
 import { getWarpCoreConfigOrExit } from '../utils/warp.js';
@@ -66,7 +68,21 @@ export async function runWarpRouteRead({
     );
   }
 
-  return deriveWarpRouteConfigs(context, addresses, warpCoreConfig);
+  // Remove any unsupported chain to avoid crashing
+  const filteredAddresses = objFilter(
+    addresses,
+    (chain, _address): _address is string =>
+      COMPATIBLE_PROTOCOLS.includes(context.multiProvider.getProtocol(chain)),
+  );
+  if (warpCoreConfig) {
+    warpCoreConfig.tokens = warpCoreConfig.tokens.filter((config) =>
+      COMPATIBLE_PROTOCOLS.includes(
+        context.multiProvider.getProtocol(config.chainName),
+      ),
+    );
+  }
+
+  return deriveWarpRouteConfigs(context, filteredAddresses, warpCoreConfig);
 }
 
 export async function getWarpRouteConfigsByCore({

typescript/cli/src/tests/commands/core.ts

@@ -9,6 +9,8 @@ import { readYamlOrJson } from '../../utils/files.js';
 
 import { localTestRunCmdPrefix } from './helpers.js';
 
+$.verbose = true;
+
 export class HyperlaneE2ECoreTestCommands {
   protected cmdPrefix: string[];
 

typescript/cli/src/tests/commands/warp.ts

@@ -118,13 +118,15 @@ export class HyperlaneE2EWarpTestCommands {
     skipConfirmationPrompts,
     privateKey,
     warpRouteId,
+    extraArgs,
   }: {
     warpCorePath?: string;
     warpDeployPath?: string;
     hypKey?: string;
     skipConfirmationPrompts?: boolean;
     privateKey?: string;
     warpRouteId?: string;
+    extraArgs?: string[];
   }): ProcessPromise {
     return $`${
       hypKey ? [`${this.hypKeyEnvName}=${hypKey}`] : []
@@ -135,7 +137,9 @@ export class HyperlaneE2EWarpTestCommands {
           ${privateKey ? [this.privateKeyFlag, privateKey] : []} \
           --verbosity debug \
           ${warpRouteId ? ['--warpRouteId', warpRouteId] : []} \
-          ${skipConfirmationPrompts ? ['--yes'] : []}`;
+          ${skipConfirmationPrompts ? ['--yes'] : []} \
+          ${extraArgs ? extraArgs : []}
+          `;
   }
 
   /**
@@ -153,4 +157,41 @@ export class HyperlaneE2EWarpTestCommands {
       warpRouteId,
     });
   }
+
+  public applyRaw({
+    warpDeployPath,
+    warpCorePath,
+    strategyUrl,
+    warpRouteId,
+    privateKey,
+    relay,
+    hypKey,
+    extraArgs,
+    skipConfirmationPrompts,
+  }: {
+    warpDeployPath?: string;
+    warpCorePath?: string;
+    strategyUrl?: string;
+    warpRouteId?: string;
+    privateKey?: string;
+    hypKey?: string;
+    relay?: boolean;
+    skipConfirmationPrompts?: boolean;
+    extraArgs?: string[];
+  }): ProcessPromise {
+    return $` ${
+      hypKey ? [`${this.hypKeyEnvName}=${hypKey}`] : []
+    } ${localTestRunCmdPrefix()} hyperlane warp apply \
+          --registry ${this.registryPath} \
+          ${warpDeployPath ? ['--config', warpDeployPath] : []} \
+          ${warpCorePath ? ['--warp', warpCorePath] : []} \
+          ${strategyUrl ? ['--strategy', strategyUrl] : []} \
+          ${warpRouteId ? ['--warpRouteId', warpRouteId] : []} \
+          ${privateKey ? [this.privateKeyFlag, privateKey] : []} \
+          --verbosity debug \
+          ${relay ? ['--relay'] : []} \
+          ${skipConfirmationPrompts ? ['--yes'] : []} \
+          ${extraArgs ? extraArgs : []}
+          `;
+  }
 }