test(cli): warp commands e2e tests

.github/workflows/test.yml

@@ -135,10 +135,12 @@ jobs:
           # Other commands
           - relay
           # Warp Commands
-          - warp-init
-          - warp-read
           - warp-apply
+          - warp-check
           - warp-deploy
+          - warp-init
+          - warp-read
+          - warp-send
     steps:
       - uses: actions/checkout@v4
         with:

typescript/cli/src/context/strategies/chain/MultiChainResolver.ts

@@ -68,7 +68,7 @@ export class MultiChainResolver implements ChainResolver {
     argv.config ||= DEFAULT_WARP_ROUTE_DEPLOYMENT_CONFIG_PATH;
     argv.context.chains = await this.getWarpRouteConfigChains(
       argv.config.trim(),
-      argv.skipConfirmation,
+      argv.context.skipConfirmation,
     );
     return argv.context.chains;
   }

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

@@ -1,8 +1,15 @@
 import { ethers } from 'ethers';
 import { $, ProcessOutput, ProcessPromise } from 'zx';
 
-import { ERC20Test__factory, ERC4626Test__factory } from '@hyperlane-xyz/core';
-import { ChainAddresses } from '@hyperlane-xyz/registry';
+import {
+  ERC20Test,
+  ERC20Test__factory,
+  ERC4626Test__factory,
+} from '@hyperlane-xyz/core';
+import {
+  ChainAddresses,
+  createWarpRouteConfigId,
+} from '@hyperlane-xyz/registry';
 import {
   HypTokenRouterConfig,
   WarpCoreConfig,
@@ -41,8 +48,19 @@ export const CHAIN_3_METADATA_PATH = `${REGISTRY_PATH}/chains/${CHAIN_NAME_3}/me
 
 export const WARP_CONFIG_PATH_EXAMPLE = `${EXAMPLES_PATH}/warp-route-deployment.yaml`;
 export const WARP_CONFIG_PATH_2 = `${TEMP_PATH}/${CHAIN_NAME_2}/warp-route-deployment-anvil2.yaml`;
+export const WARP_DEPLOY_OUTPUT_PATH = `${TEMP_PATH}/warp-route-deployment.yaml`;
 export const WARP_CORE_CONFIG_PATH_2 = `${REGISTRY_PATH}/deployments/warp_routes/ETH/anvil2-config.yaml`;
 
+export function getCombinedWarpRoutePath(
+  tokenSymbol: string,
+  chains: string[],
+): string {
+  return `${REGISTRY_PATH}/deployments/warp_routes/${createWarpRouteConfigId(
+    tokenSymbol.toUpperCase(),
+    chains,
+  )}-config.yaml`;
+}
+
 export const DEFAULT_E2E_TEST_TIMEOUT = 100_000; // Long timeout since these tests can take a while
 
 export enum KeyBoardKeys {
@@ -258,7 +276,7 @@ export async function deployToken(
   privateKey: string,
   chain: string,
   decimals = 18,
-) {
+): Promise<ERC20Test> {
   const { multiProvider } = await getContext({
     registryUri: REGISTRY_PATH,
     registryOverrideUri: '',

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

@@ -25,15 +25,37 @@ export function hyperlaneWarpInit(warpCorePath: string): ProcessPromise {
 /**
  * Deploys the Warp route to the specified chain using the provided config.
  */
-export async function hyperlaneWarpDeploy(warpCorePath: string) {
-  // --overrides is " " to allow local testing to work
-  return $`yarn workspace @hyperlane-xyz/cli run hyperlane warp deploy \
+export function hyperlaneWarpDeployRaw({
+  warpCorePath,
+  hypKey,
+  skipConfirmationPrompts,
+  privateKey,
+}: {
+  warpCorePath?: string;
+  hypKey?: string;
+  skipConfirmationPrompts?: boolean;
+  privateKey?: string;
+}): ProcessPromise {
+  return $`${
+    hypKey ? ['HYP_KEY=' + hypKey] : ''
+  } yarn workspace @hyperlane-xyz/cli run hyperlane warp deploy \
         --registry ${REGISTRY_PATH} \
         --overrides " " \
-        --config ${warpCorePath} \
-        --key ${ANVIL_KEY} \
+        ${warpCorePath ? ['--config', warpCorePath] : ''} \
+        ${privateKey ? ['--key', privateKey] : ''} \
         --verbosity debug \
-        --yes`;
+        ${skipConfirmationPrompts ? ['--yes'] : ''}`;
+}
+
+/**
+ * Deploys the Warp route to the specified chain using the provided config.
+ */
+export function hyperlaneWarpDeploy(warpCorePath: string): ProcessPromise {
+  return hyperlaneWarpDeployRaw({
+    privateKey: ANVIL_KEY,
+    warpCorePath: warpCorePath,
+    skipConfirmationPrompts: true,
+  });
 }
 
 /**
@@ -55,27 +77,83 @@ export async function hyperlaneWarpApply(
         --yes`;
 }
 
-export async function hyperlaneWarpRead(
+export function hyperlaneWarpReadRaw({
+  chain,
+  warpAddress,
+  outputPath,
+  privateKey,
+  symbol,
+}: {
+  chain?: string;
+  symbol?: string;
+  privateKey?: string;
+  warpAddress?: string;
+  outputPath?: string;
+}): ProcessPromise {
+  return $`yarn workspace @hyperlane-xyz/cli run hyperlane warp read \
+        --registry ${REGISTRY_PATH} \
+        --overrides " " \
+        ${warpAddress ? ['--address', warpAddress] : ''} \
+        ${chain ? ['--chain', chain] : ''} \
+        ${symbol ? ['--symbol', symbol] : ''} \
+        ${privateKey ? ['--key', privateKey] : ''} \
+        --verbosity debug \
+        ${outputPath ? ['--config', outputPath] : ''}`;
+}
+
+export function hyperlaneWarpRead(
   chain: string,
   warpAddress: string,
   warpDeployPath: string,
-) {
-  return $`yarn workspace @hyperlane-xyz/cli run hyperlane warp read \
+): ProcessPromise {
+  return hyperlaneWarpReadRaw({
+    chain,
+    warpAddress,
+    outputPath: warpDeployPath,
+    privateKey: ANVIL_KEY,
+  });
+}
+
+export function hyperlaneWarpCheckRaw({
+  warpDeployPath,
+  symbol,
+  privateKey,
+  hypKey,
+}: {
+  symbol?: string;
+  privateKey?: string;
+  warpDeployPath?: string;
+  hypKey?: string;
+}): ProcessPromise {
+  return $`${
+    hypKey && !privateKey ? ['HYP_KEY=' + hypKey] : ''
+  } yarn workspace @hyperlane-xyz/cli run hyperlane warp check \
         --registry ${REGISTRY_PATH} \
         --overrides " " \
-        --address ${warpAddress} \
-        --chain ${chain} \
-        --key ${ANVIL_KEY} \
+        ${symbol ? ['--symbol', symbol] : ''} \
+        ${privateKey && !hypKey ? ['--key', privateKey] : ''} \
         --verbosity debug \
-        --config ${warpDeployPath}`;
+        ${warpDeployPath ? ['--config', warpDeployPath] : ''}`;
+}
+
+export function hyperlaneWarpCheck(
+  warpDeployPath: string,
+  symbol: string,
+): ProcessPromise {
+  return hyperlaneWarpCheckRaw({
+    warpDeployPath,
+    privateKey: ANVIL_KEY,
+    symbol,
+  });
 }
 
-export async function hyperlaneWarpSendRelay(
+export function hyperlaneWarpSendRelay(
   origin: string,
   destination: string,
   warpCorePath: string,
   relay = true,
-) {
+  value = 1,
+): ProcessPromise {
   return $`yarn workspace @hyperlane-xyz/cli run hyperlane warp send \
         ${relay ? '--relay' : ''} \
         --registry ${REGISTRY_PATH} \
@@ -85,7 +163,8 @@ export async function hyperlaneWarpSendRelay(
         --warp ${warpCorePath} \
         --key ${ANVIL_KEY} \
         --verbosity debug \
-        --yes`;
+        --yes \
+        --amount ${value}`;
 }
 
 /**

typescript/cli/src/tests/core/core-check.e2e-test.ts

@@ -50,7 +50,7 @@ describe('hyperlane core check e2e tests', async function () {
     );
 
     expect(output.exitCode).to.equal(0);
-    expect(output.text().includes('No violations found')).to.be.true;
+    expect(output.text()).to.includes('No violations found');
   });
 
   it('should find differences between the local and onchain config', async () => {
@@ -69,8 +69,8 @@ describe('hyperlane core check e2e tests', async function () {
     ).nothrow();
 
     expect(output.exitCode).to.equal(1);
-    expect(output.text().includes(expectedDiffText)).to.be.true;
-    expect(output.text().includes(expectedActualText)).to.be.true;
+    expect(output.text()).to.include(expectedDiffText);
+    expect(output.text()).to.include(expectedActualText);
   });
 
   it('should successfully check the config when provided with a custom mailbox', async () => {
@@ -88,6 +88,6 @@ describe('hyperlane core check e2e tests', async function () {
     );
 
     expect(output.exitCode).to.equal(0);
-    expect(output.text().includes('No violations found')).to.be.true;
+    expect(output.text()).to.includes('No violations found');
   });
 });