test: use a single docker image for contracts

Author: alxdca

.github/workflows/build-test.yml

@@ -226,8 +226,8 @@ jobs:
           INTEGRATION_TEST_NITRO_CONTRACTS_BRANCH=${{matrix.config.nitro-contracts-branch}} \
           pnpm test:integration
 
-  publish-nitro-contracts-image:
-    name: Publish Nitro Contracts Image
+  publish-int-test-contracts-image:
+    name: Publish Integration Test Contracts Image
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -236,9 +236,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set nitro contracts image
+      - name: Set integration test contracts image
         run: |
-          echo "NITRO_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-nitro-contracts-anvil:v3.2.0-2f747c7" >> "$GITHUB_ENV"
+          echo "INT_TEST_CONTRACTS_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-int-test-contracts:v3.2.0-2f747c7-v1.2.5-5975d8f73608" >> "$GITHUB_ENV"
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -250,73 +250,29 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Check nitro contracts image
+      - name: Check integration test contracts image
         id: check-image
         run: |
-          if docker manifest inspect "${NITRO_CONTRACTS_GHCR_IMAGE}" >/dev/null 2>&1; then
+          if docker manifest inspect "${INT_TEST_CONTRACTS_IMAGE}" >/dev/null 2>&1; then
             echo "exists=true" >> "$GITHUB_OUTPUT"
           else
             echo "exists=false" >> "$GITHUB_OUTPUT"
           fi
 
-      - name: Build and push nitro contracts image
+      - name: Build and push integration test contracts image
         if: steps.check-image.outputs.exists != 'true'
         uses: docker/build-push-action@v6
         with:
-          context: ./nitro-contracts
-          file: ./nitro-contracts/Dockerfile
+          context: ./src/integrationTestHelpers/docker-test-contracts
+          file: ./src/integrationTestHelpers/docker-test-contracts/Dockerfile
           push: true
           tags: |
-            ${{ env.NITRO_CONTRACTS_GHCR_IMAGE }}
-
-  publish-token-bridge-contracts-image:
-    name: Publish Token Bridge Contracts Image
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set token bridge contracts image
-        run: |
-          echo "TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-token-bridge-contracts-anvil:v1.2.5-5975d8f73608" >> "$GITHUB_ENV"
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Log in to GHCR
-        uses: docker/login-action@v3
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Check token bridge contracts image
-        id: check-image
-        run: |
-          if docker manifest inspect "${TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE}" >/dev/null 2>&1; then
-            echo "exists=true" >> "$GITHUB_OUTPUT"
-          else
-            echo "exists=false" >> "$GITHUB_OUTPUT"
-          fi
-
-      - name: Build and push token bridge contracts image
-        if: steps.check-image.outputs.exists != 'true'
-        uses: docker/build-push-action@v6
-        with:
-          context: ./token-bridge-contracts
-          file: ./token-bridge-contracts/Dockerfile.anvil
-          push: true
-          tags: |
-            ${{ env.TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE }}
+            ${{ env.INT_TEST_CONTRACTS_IMAGE }}
 
   test-integration-anvil:
     name: Test (Integration Anvil)
     needs:
-      - publish-nitro-contracts-image
-      - publish-token-bridge-contracts-image
+      - publish-int-test-contracts-image
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -325,10 +281,9 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set nitro contracts image
+      - name: Set integration test contracts image
         run: |
-          echo "NITRO_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-nitro-contracts-anvil:v3.2.0-2f747c7" >> "$GITHUB_ENV"
-          echo "TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-token-bridge-contracts-anvil:v1.2.5-5975d8f73608" >> "$GITHUB_ENV"
+          echo "INT_TEST_CONTRACTS_IMAGE=ghcr.io/${GITHUB_REPOSITORY_OWNER,,}/chain-sdk-int-test-contracts:v3.2.0-2f747c7-v1.2.5-5975d8f73608" >> "$GITHUB_ENV"
 
       - name: Log in to GHCR
         uses: docker/login-action@v3
@@ -337,11 +292,8 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Load nitro contracts image
-        run: docker pull "${NITRO_CONTRACTS_GHCR_IMAGE}"
-
-      - name: Load token bridge contracts image
-        run: docker pull "${TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE}"
+      - name: Load integration test contracts image
+        run: docker pull "${INT_TEST_CONTRACTS_IMAGE}"
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v4

anvil-tooling/entrypoint.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+set -eu
+
+if [ "$#" -lt 2 ]; then
+  echo "usage: chain-sdk-int-test-contracts <nitro-contracts|token-bridge-contracts> <command> [args...]" >&2
+  exit 1
+fi
+
+workspace="$1"
+shift
+
+case "$workspace" in
+  nitro-contracts)
+    cd /workspace/nitro-contracts
+    ;;
+  token-bridge-contracts)
+    cd /workspace/token-bridge-contracts
+    ;;
+  *)
+    echo "unknown workspace: $workspace" >&2
+    exit 1
+    ;;
+esac
+
+exec yarn "$@"

src/integrationTestHelpers/anvilHarnessHelpers.ts

@@ -22,9 +22,8 @@ import { tokenBridgeCreatorAddress } from '../contracts/TokenBridgeCreator';
 import { testConstants } from './constants';
 import {
   dockerAsync,
-  getNitroContractsImage,
+  getIntTestContractsImage,
   getRollupCreatorDockerArgs,
-  getTokenBridgeContractsImage,
   getTokenBridgeCreatorDockerArgs,
 } from './dockerHelpers';
 import type { PrivateKeyAccountWithPrivateKey } from '../testHelpers';
@@ -472,7 +471,7 @@ async function withBlockAdvancing<T>(
 }
 
 export async function deployRollupCreator(params: DeployRollupCreatorParams): Promise<Address> {
-  const nitroContractsImage = getNitroContractsImage();
+  const intTestContractsImage = getIntTestContractsImage();
   const stdout = await withBlockAdvancing(params.blockAdvancer, () =>
     dockerAsync(
       getRollupCreatorDockerArgs(
@@ -483,7 +482,7 @@ export async function deployRollupCreator(params: DeployRollupCreatorParams): Pr
           maxDataSize: params.maxDataSize,
           chainId: params.chainId,
         },
-        nitroContractsImage,
+        intTestContractsImage,
       ),
     ),
   );
@@ -494,15 +493,15 @@ export async function deployRollupCreator(params: DeployRollupCreatorParams): Pr
 export async function deployTokenBridgeCreator(
   params: DeployTokenBridgeCreatorParams,
 ): Promise<Address> {
-  const tokenBridgeContractsImage = getTokenBridgeContractsImage();
+  const intTestContractsImage = getIntTestContractsImage();
   const hostname = new URL(params.rpcUrl).hostname;
   const rpcUrl = params.rpcUrl.replace(hostname, 'host.docker.internal');
 
   const deploy = () =>
     dockerAsync(
       getTokenBridgeCreatorDockerArgs(
         { ...params, rpcUrl, addHostDockerInternal: true },
-        tokenBridgeContractsImage,
+        intTestContractsImage,
       ),
     );
 

src/integrationTestHelpers/constants.ts

@@ -4,10 +4,8 @@ import { ethers } from 'ethers';
 export const testConstants = {
   ANVIL_IMAGE: 'ghcr.io/foundry-rs/foundry:v1.3.1',
   NITRO_IMAGE: 'offchainlabs/nitro-node:v3.9.5-66e42c4',
-  DEFAULT_NITRO_CONTRACTS_IMAGE:
-    'ghcr.io/offchainlabs/chain-sdk-nitro-contracts-anvil:v3.2.0-2f747c7',
-  DEFAULT_TOKEN_BRIDGE_CONTRACTS_IMAGE:
-    'ghcr.io/offchainlabs/chain-sdk-token-bridge-contracts-anvil:v1.2.5-5975d8f73608',
+  INT_TEST_CONTRACTS_IMAGE:
+    'ghcr.io/offchainlabs/chain-sdk-int-test-contracts:v3.2.0-2f747c7-v1.2.5-5975d8f73608',
   DEPLOYER_PRIVATE_KEY:
     '0x490d84b7602e4b470af4f86a3ad095607a8bb5a4fa8ba148f41fcfd236b4fdf5' as Address,
   L2_CHAIN_ID: 421_337,

src/integrationTestHelpers/docker-test-contracts/Dockerfile

@@ -0,0 +1,44 @@
+FROM ghcr.io/foundry-rs/foundry:v1.3.1 AS foundry
+
+FROM node:20-bullseye-slim AS builder
+
+COPY --from=foundry /usr/local/bin/forge /usr/local/bin/forge
+
+RUN apt-get update \
+    && apt-get install -y git python3 build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /workspace
+
+RUN mkdir nitro-contracts
+WORKDIR /workspace/nitro-contracts
+RUN git init . \
+    && git remote add origin https://github.com/OffchainLabs/nitro-contracts.git \
+    && git fetch --depth 1 origin 2f747c722d98d5fd662bfda08cd86aa534b22be2 \
+    && git checkout --detach FETCH_HEAD \
+    && git submodule update --init --recursive --depth 1
+RUN cp scripts/config.example.ts scripts/config.ts
+RUN yarn install --frozen-lockfile
+RUN yarn build:all
+
+WORKDIR /workspace
+RUN mkdir token-bridge-contracts
+WORKDIR /workspace/token-bridge-contracts
+RUN git init . \
+    && git remote add origin https://github.com/OffchainLabs/token-bridge-contracts.git \
+    && git fetch --depth 1 origin 5975d8f7360816341be7f94fd333ef240f4aec23 \
+    && git checkout --detach FETCH_HEAD
+RUN yarn install --frozen-lockfile
+RUN yarn build
+
+FROM node:20-bullseye-slim
+
+WORKDIR /workspace
+
+COPY --from=builder /workspace/nitro-contracts /workspace/nitro-contracts
+COPY --from=builder /workspace/token-bridge-contracts /workspace/token-bridge-contracts
+COPY entrypoint.sh /usr/local/bin/chain-sdk-int-test-contracts
+
+RUN chmod +x /usr/local/bin/chain-sdk-int-test-contracts
+
+ENTRYPOINT ["chain-sdk-int-test-contracts"]

src/integrationTestHelpers/docker-test-contracts/entrypoint.sh

@@ -0,0 +1,26 @@
+#!/bin/sh
+
+set -eu
+
+if [ "$#" -lt 2 ]; then
+  echo "usage: chain-sdk-int-test-contracts <nitro-contracts|token-bridge-contracts> <command> [args...]" >&2
+  exit 1
+fi
+
+workspace="$1"
+shift
+
+case "$workspace" in
+  nitro-contracts)
+    cd /workspace/nitro-contracts
+    ;;
+  token-bridge-contracts)
+    cd /workspace/token-bridge-contracts
+    ;;
+  *)
+    echo "unknown workspace: $workspace" >&2
+    exit 1
+    ;;
+esac
+
+exec yarn "$@"

src/integrationTestHelpers/dockerHelpers.ts

@@ -36,32 +36,20 @@ export function dockerAsync(args: string[]): Promise<string> {
   });
 }
 
-export function getNitroContractsImage(): string {
-  const image =
-    process.env.NITRO_CONTRACTS_GHCR_IMAGE ?? testConstants.DEFAULT_NITRO_CONTRACTS_IMAGE;
+export function getIntTestContractsImage(): string {
+  const image = testConstants.INT_TEST_CONTRACTS_IMAGE;
   try {
     docker(['image', 'inspect', image]);
     return image;
   } catch {
-    const nitroContractsDir = join(process.cwd(), 'nitro-contracts');
-    const dockerfilePath = join(process.cwd(), 'nitro-contracts', 'Dockerfile');
-    docker(['build', '-f', dockerfilePath, '-t', image, nitroContractsDir]);
-
-    return image;
-  }
-}
-
-export function getTokenBridgeContractsImage(): string {
-  const image =
-    process.env.TOKEN_BRIDGE_CONTRACTS_GHCR_IMAGE ??
-    testConstants.DEFAULT_TOKEN_BRIDGE_CONTRACTS_IMAGE;
-  try {
-    docker(['image', 'inspect', image]);
-    return image;
-  } catch {
-    const tokenBridgeContractsDir = join(process.cwd(), 'token-bridge-contracts');
-    const dockerfilePath = join(tokenBridgeContractsDir, 'Dockerfile.anvil');
-    docker(['build', '-f', dockerfilePath, '-t', image, tokenBridgeContractsDir]);
+    const intTestContractsDir = join(
+      process.cwd(),
+      'src',
+      'integrationTestHelpers',
+      'docker-test-contracts',
+    );
+    const dockerfilePath = join(intTestContractsDir, 'Dockerfile');
+    docker(['build', '-f', dockerfilePath, '-t', image, intTestContractsDir]);
 
     return image;
   }
@@ -75,7 +63,7 @@ export function getRollupCreatorDockerArgs(
     maxDataSize: number;
     chainId: number;
   },
-  nitroContractsImage: string,
+  intTestContractsImage: string,
 ) {
   return [
     'run',
@@ -98,7 +86,8 @@ export function getRollupCreatorDockerArgs(
     'DISABLE_VERIFICATION=true',
     '-e',
     'IGNORE_MAX_DATA_SIZE_WARNING=true',
-    nitroContractsImage,
+    intTestContractsImage,
+    'nitro-contracts',
     'hardhat',
     'run',
     '--no-compile',
@@ -116,7 +105,7 @@ export function getTokenBridgeCreatorDockerArgs(
     wethAddress: Address;
     addHostDockerInternal?: boolean;
   },
-  tokenBridgeContractsImage: string,
+  intTestContractsImage: string,
 ) {
   return [
     'run',
@@ -135,7 +124,8 @@ export function getTokenBridgeCreatorDockerArgs(
     `POLLING_INTERVAL=${testConstants.POLLING_INTERVAL}`,
     '-e',
     'DISABLE_CONTRACT_VERIFICATION=true',
-    tokenBridgeContractsImage,
+    intTestContractsImage,
+    'token-bridge-contracts',
     'deploy:token-bridge-creator',
   ];
 }