feat: add tests for bridge deposit and withdraw (#191)

Author: dutterbutter

.github/workflows/tests.yaml

@@ -21,7 +21,28 @@ jobs:
         with:
           node-version: "18.x"
           registry-url: "https://registry.npmjs.org"
+
       - name: Install dependencies
         run: npm ci
+
+      - name: Build zksync-cli
+        run: npm run build
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Start Anvil in background
+        run: |
+          nohup anvil --port 8012 --no-request-size-limit > anvil-foundry.log 2>&1 &
+          echo "⏳ waiting for anvil to come up…"
+          sleep 5
+
+      - name: Start anvil-zksync in background
+        uses: dutterbutter/anvil-zksync-action@v1.2.0
+        with:
+          mode: run
+          releaseTag: v0.6.1
+          externalL1: "http://localhost:8012"
+          
       - name: Test
         run: npm run test

src/commands/bridge/deposit.ts

@@ -101,15 +101,7 @@ export const handler = async (options: DepositOptions) => {
     const toChain = chains.find((e) => e.network === options.chain);
     const toChainLabel = toChain && !options.rpc ? toChain.name : (options.rpc ?? "Unknown chain");
 
-    const l1Provider = getL1Provider(
-      options.l1Rpc ??
-        toChain?.rpcUrl ??
-        (() => {
-          throw new Error("You must supply either --chain or --l1-rpc");
-        })(),
-      toChain?.id,
-      Boolean(options.l1Rpc)
-    );
+    const l1Provider = getL1Provider(options.l1Rpc ?? toChain!.rpcUrl);
     const l2Provider = getL2Provider(options.rpc ?? toChain!.rpcUrl);
     const senderWallet = getL2Wallet(options.privateKey, l2Provider, l1Provider);
     const token = options.token ? await getTokenInfo(options.token!, l2Provider, l1Provider) : ETH_TOKEN;

src/commands/bridge/withdraw-finalize.ts

@@ -91,15 +91,7 @@ export const handler = async (options: WithdrawFinalizeOptions) => {
     Logger.info(` Withdrawal transaction (L2): ${options.hash}`);
     Logger.info(` Finalizer address (L1):      ${getAddressFromPrivateKey(options.privateKey)}`);
 
-    const l1Provider = getL1Provider(
-      options.l1Rpc ??
-        toChain?.rpcUrl ??
-        (() => {
-          throw new Error("You must supply either --chain or --l1-rpc");
-        })(),
-      toChain?.id,
-      Boolean(options.l1Rpc)
-    );
+    const l1Provider = getL1Provider(options.l1Rpc ?? toChain!.rpcUrl);
     const l2Provider = getL2Provider(options.rpc ?? fromChain!.rpcUrl);
     const zkWallet = getL2Wallet(options.privateKey, l2Provider, l1Provider);
 

src/commands/bridge/withdraw.ts

@@ -100,15 +100,7 @@ export const handler = async (options: WithdrawOptions) => {
     const toChain = chains.find((e) => e.network === options.chain)?.l1Chain;
     const toChainLabel = toChain && !options.l1Rpc ? toChain.name : (options.l1Rpc ?? "Unknown chain");
 
-    const l1Provider = getL1Provider(
-      options.l1Rpc ??
-        toChain?.rpcUrl ??
-        (() => {
-          throw new Error("You must supply either --chain or --l1-rpc");
-        })(),
-      toChain?.id,
-      Boolean(options.l1Rpc)
-    );
+    const l1Provider = getL1Provider(options.l1Rpc ?? toChain!.rpcUrl);
     const l2Provider = getL2Provider(options.rpc ?? fromChain!.rpcUrl);
     const senderWallet = getL2Wallet(options.privateKey, l2Provider, l1Provider);
     const token = options.token ? await getTokenInfo(options.token!, l2Provider, l1Provider) : ETH_TOKEN;

src/utils/helpers.ts

@@ -1,6 +1,6 @@
 import chalk from "chalk";
 import { spawn } from "child_process";
-import { computeAddress, JsonRpcProvider, Network, type Networkish } from "ethers";
+import { computeAddress, JsonRpcProvider } from "ethers";
 import { Wallet, Provider } from "zksync-ethers";
 import { Logger } from "../lib/index.js";
 
@@ -21,18 +21,8 @@ export const getAddressFromPrivateKey = (privateKey: string): string => {
   return computeAddress(privateKey.startsWith("0x") ? privateKey : `0x${privateKey}`);
 };
 
-export const getL1Provider = (url: string, network?: Networkish, detectNetwork = false) => {
-  if (detectNetwork) {
-    return new JsonRpcProvider(url, undefined, { staticNetwork: true });
-  }
-
-  if (network == null) {
-    throw new Error("No chain metadata available.");
-  }
-
-  const netObj: Network = Network.from(network);
-
-  return new JsonRpcProvider(url, netObj, { staticNetwork: netObj });
+export const getL1Provider = (url: string) => {
+  return new JsonRpcProvider(url);
 };
 
 export const getL2Provider = (rpc: string) => {

tests/bridge.spec.ts

@@ -0,0 +1,105 @@
+// tests/bridge.e2e.test.ts
+import { beforeAll, describe, expect, it } from "vitest";
+import { execa } from "execa";
+import { JsonRpcProvider } from "ethers";
+import { Provider, Wallet } from "zksync-ethers";
+
+const PK = process.env.TEST_PK ?? "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
+const L1_RPC = process.env.L1_RPC ?? "http://127.0.0.1:8012";
+const L2_RPC = process.env.L2_RPC ?? "http://127.0.0.1:8011";
+const CHAIN = process.env.CHAIN ?? "in-memory-node";
+
+const DEPOSIT_ETH = "1";
+const WITHDRAW_ETH = "0.001";
+
+if (!PK) throw new Error("TEST_PK is not set – provide a funded private key");
+
+// ────────────────────────────────────────────────────────────
+//  Helpers
+// ────────────────────────────────────────────────────────────
+async function cli(args: string[], env: Record<string, string> = {}) {
+  const { stdout } = await execa("node", ["bin/index.js", ...args], { env });
+  return stdout;
+}
+
+function extractHash(out: string) {
+  const m = out.match(/Transaction hash:\s+(0x[a-f0-9]{64})/i);
+  if (!m) throw new Error("Cannot find tx hash in CLI output\n" + out);
+  return m[1];
+}
+
+// ────────────────────────────────────────────────────────────
+//  Tests
+// ────────────────────────────────────────────────────────────
+describe("bridge CLI", () => {
+  let wallet: Wallet;
+  let l1Provider: JsonRpcProvider;
+  let l2Provider: Provider;
+
+  let depositHash: string | undefined;
+  let withdrawHash: string | undefined;
+
+  beforeAll(() => {
+    l1Provider = new JsonRpcProvider(L1_RPC);
+    l2Provider = new Provider(L2_RPC);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    wallet = new Wallet(PK, l2Provider, l1Provider as any);
+  });
+
+  // ──────────────────────────────────────────────────────────
+  // Deposit
+  // ──────────────────────────────────────────────────────────
+  it("sends a deposit L1 ➜ L2", { timeout: 90_000 }, async () => {
+    const out = await cli([
+      "bridge",
+      "deposit",
+      "--chain",
+      CHAIN,
+      "--amount",
+      DEPOSIT_ETH,
+      "--private-key",
+      PK,
+      "--recipient",
+      wallet.address,
+      "--l1-rpc",
+      L1_RPC,
+      "--rpc",
+      L2_RPC,
+    ]);
+
+    expect(out).toMatch(/Deposit sent:/);
+    depositHash = extractHash(out);
+    expect(depositHash).toMatch(/^0x[a-f0-9]{64}$/);
+  });
+
+  // ──────────────────────────────────────────────────────────
+  // Withdraw
+  // ──────────────────────────────────────────────────────────
+  it("sends a withdrawal L2 ➜ L1", { timeout: 90_000 }, async () => {
+    const out = await cli([
+      "bridge",
+      "withdraw",
+      "--chain",
+      CHAIN,
+      "--amount",
+      WITHDRAW_ETH,
+      "--private-key",
+      PK,
+      "--recipient",
+      wallet.address,
+      "--l1-rpc",
+      L1_RPC,
+      "--rpc",
+      L2_RPC,
+    ]);
+
+    expect(out).toMatch(/Withdraw sent:/);
+    withdrawHash = extractHash(out);
+    expect(withdrawHash).toMatch(/^0x[a-f0-9]{64}$/);
+  });
+
+  // ──────────────────────────────────────────────────────────
+  // Finalize
+  // ──────────────────────────────────────────────────────────
+  // TODO: need to figure out how to wait for the withdrawal to be ready for finalization
+});