feat(cli): publish subgraph hash configmap

Author: roderik

README.md

@@ -42,6 +42,7 @@ Options:
   -v, --validators <count>               Number of validator nodes to generate. (default: 4)
   -a, --allocations <file>               Path to a genesis allocations JSON file. (default: none)
   --abi-directory <path>                 Directory containing ABI JSON files to publish as ConfigMaps.
+  --subgraph-hash-file <path>            Path to a file containing the subgraph IPFS hash.
   -o, --outputType <type>                Output target (screen, file, kubernetes). (default: "screen")
   --static-node-port <number>            P2P port used for static-nodes enode URIs. (default: 30303)
   --static-node-discovery-port <number>  Discovery port used for static-nodes enode URIs. (default: 30303)

bun.lock

@@ -41,6 +41,7 @@
     "@inquirer/prompts": "7.8.6",
     "@kubernetes/client-node": "1.3.0",
     "commander": "14.0.1",
+    "multiformats": "12.1.3",
     "lefthook": "1.13.1",
     "ox": "0.9.6",
     "viem": "2.37.7",

package.json

@@ -23,6 +23,7 @@ const {
   genesisConfigMapName: DEFAULT_GENESIS_CONFIGMAP_NAME,
   staticNodesConfigMapName: DEFAULT_STATIC_NODES_CONFIGMAP_NAME,
   faucetArtifactPrefix: DEFAULT_FAUCET_PREFIX,
+  subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
 } = ARTIFACT_DEFAULTS;
 const UNCOMPRESSED_PUBLIC_KEY_PREFIX = "04";
 const UNCOMPRESSED_PUBLIC_KEY_LENGTH = 130;
@@ -35,6 +36,8 @@ const PUBLIC_KEY_REPEAT = 64;
 const FIRST_VALIDATOR_INDEX = 1;
 const SECOND_VALIDATOR_INDEX = 2;
 const FAUCET_INDEX = VALIDATOR_RETURN + 1;
+const SAMPLE_SUBGRAPH_HASH =
+  "bafybeigdyrztzd4gufq2bdsd6we3jh7uzulnd2ipkyli5sto6f5j6rlude";
 const createFactoryStub = () => {
   let counter = 0;
   return {
@@ -204,6 +207,7 @@ describe("CLI command bootstrap", () => {
         loadAbisPath = path;
         return Promise.resolve([]);
       },
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: async (type, payload) => {
         outputInvocation = { type, payload };
         await realOutputResult(type, payload);
@@ -242,6 +246,7 @@ describe("CLI command bootstrap", () => {
       validatorPrefix: DEFAULT_POD_PREFIX,
       genesisConfigMapName: DEFAULT_GENESIS_CONFIGMAP_NAME,
       staticNodesConfigMapName: DEFAULT_STATIC_NODES_CONFIGMAP_NAME,
+      subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
     });
   });
 
@@ -278,6 +283,7 @@ describe("CLI command bootstrap", () => {
         capturedAbiPath = path;
         return Promise.resolve(abiArtifacts);
       },
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: (_type, payload) => {
         capturedPayload = payload;
         return Promise.resolve();
@@ -296,6 +302,56 @@ describe("CLI command bootstrap", () => {
     expect(capturedPayload?.abiArtifacts).toEqual(abiArtifacts);
   });
 
+  test("runBootstrap loads subgraph hash from environment", async () => {
+    const factory = createFactoryStub();
+    let capturedPath: string | undefined;
+    let capturedPayload: OutputPayload | undefined;
+    const originalEnv = Bun.env.SUBGRAPH_HASH_FILE;
+
+    const deps: BootstrapDependencies = {
+      factory,
+      promptForCount: () => Promise.resolve(EXPECTED_DEFAULT_VALIDATOR),
+      promptForGenesis: async (_service, { faucetAddress }) => ({
+        algorithm: ALGORITHM.QBFT,
+        config: {
+          chainId: 1,
+          faucetWalletAddress: faucetAddress,
+          gasLimit: "0x1",
+          secondsPerBlock: 2,
+        },
+        genesis: { config: {}, extraData: "0x" } as any,
+      }),
+      promptForText: passthroughTextPrompt,
+      service: {} as any,
+      loadAllocations: () =>
+        Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
+      loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: (path: string) => {
+        capturedPath = path;
+        return Promise.resolve(SAMPLE_SUBGRAPH_HASH);
+      },
+      outputResult: (_type, payload) => {
+        capturedPayload = payload;
+        return Promise.resolve();
+      },
+    };
+
+    Bun.env.SUBGRAPH_HASH_FILE = "  /tmp/subgraph.txt  ";
+
+    try {
+      await runBootstrap({ acceptDefaults: true }, deps);
+    } finally {
+      if (originalEnv === undefined) {
+        Bun.env.SUBGRAPH_HASH_FILE = undefined;
+      } else {
+        Bun.env.SUBGRAPH_HASH_FILE = originalEnv;
+      }
+    }
+
+    expect(capturedPath).toBe("/tmp/subgraph.txt");
+    expect(capturedPayload?.subgraphHash).toBe(SAMPLE_SUBGRAPH_HASH);
+  });
+
   test("createCliCommand wires metadata", () => {
     const command = createCliCommand();
     expect(command.name()).toBe("network-bootstrapper");
@@ -337,6 +393,7 @@ describe("CLI command bootstrap", () => {
       loadAllocations: () =>
         Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
       loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: async (type, payload) => {
         await realOutputResult(type, payload);
       },
@@ -405,6 +462,7 @@ describe("CLI command bootstrap", () => {
       loadAllocations: () =>
         Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
       loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: (_type, payload) => {
         capturedPayload = payload;
         return Promise.resolve();
@@ -457,6 +515,7 @@ describe("CLI command bootstrap", () => {
       validatorPrefix: "custom-validator",
       genesisConfigMapName: "custom-genesis",
       staticNodesConfigMapName: "custom-static-nodes",
+      subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
     });
   });
 
@@ -487,6 +546,7 @@ describe("CLI command bootstrap", () => {
       loadAllocations: () =>
         Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
       loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: (_type, payload) => {
         capturedPayload = payload;
         return Promise.resolve();
@@ -556,6 +616,7 @@ describe("CLI command bootstrap", () => {
       loadAllocations: () =>
         Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
       loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: async () => {
         // no-op for test
       },
@@ -639,6 +700,7 @@ describe("CLI command bootstrap", () => {
       loadAllocations: () =>
         Promise.resolve({} satisfies Record<string, BesuAllocAccount>),
       loadAbis: () => Promise.resolve([]),
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: (type) => {
         capturedOutputType = type;
         return Promise.resolve();
@@ -730,13 +792,15 @@ describe("CLI command bootstrap", () => {
         loadAbisInvoked = true;
         return Promise.resolve([]);
       },
+      loadSubgraphHash: () => Promise.resolve(SAMPLE_SUBGRAPH_HASH),
       outputResult: (_type, payload) => {
         expect(payload.validators).toHaveLength(EXPECTED_DEFAULT_VALIDATOR);
         expect(payload.artifactNames).toEqual({
           faucetPrefix: DEFAULT_FAUCET_PREFIX,
           validatorPrefix: DEFAULT_POD_PREFIX,
           genesisConfigMapName: DEFAULT_GENESIS_CONFIGMAP_NAME,
           staticNodesConfigMapName: DEFAULT_STATIC_NODES_CONFIGMAP_NAME,
+          subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
         });
         return Promise.resolve();
       },

src/cli/commands/bootstrap/bootstrap.command.test.ts

@@ -25,6 +25,7 @@ import {
   promptForCount,
   promptForText,
 } from "./bootstrap.prompt-helpers.ts";
+import { loadSubgraphHash } from "./bootstrap.subgraph.ts";
 
 type CliOptions = {
   allocations?: string;
@@ -48,6 +49,7 @@ type CliOptions = {
   genesisConfigmapName?: string;
   staticNodesConfigmapName?: string;
   faucetArtifactPrefix?: string;
+  subgraphHashFile?: string;
 };
 
 type BootstrapDependencies = {
@@ -58,6 +60,7 @@ type BootstrapDependencies = {
   service: BesuGenesisService;
   loadAllocations: typeof loadAllocations;
   loadAbis: typeof loadAbis;
+  loadSubgraphHash: typeof loadSubgraphHash;
   outputResult: (type: OutputType, payload: OutputPayload) => Promise<void>;
 };
 
@@ -69,6 +72,7 @@ const {
   genesisConfigMapName: DEFAULT_GENESIS_CONFIGMAP_NAME,
   staticNodesConfigMapName: DEFAULT_STATIC_NODES_CONFIGMAP_NAME,
   faucetArtifactPrefix: DEFAULT_FAUCET_ARTIFACT_PREFIX,
+  subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
 } = ARTIFACT_DEFAULTS;
 const OUTPUT_CHOICES: OutputType[] = ["screen", "file", "kubernetes"];
 const LEADING_DOT_REGEX = /^\./u;
@@ -303,6 +307,7 @@ const runBootstrap = async (
     genesisConfigmapName: genesisConfigmapNameOption,
     staticNodesConfigmapName: staticNodesConfigmapNameOption,
     faucetArtifactPrefix: faucetArtifactPrefixOption,
+    subgraphHashFile: subgraphHashFileOption,
   } = options;
 
   const resolveCount = (
@@ -399,6 +404,22 @@ const runBootstrap = async (
     ? await deps.loadAbis(trimmedAbiDirectory)
     : [];
 
+  const envSubgraphHashFile = Bun.env.SUBGRAPH_HASH_FILE?.trim();
+  const providedSubgraphHashFile =
+    subgraphHashFileOption === undefined
+      ? undefined
+      : subgraphHashFileOption.trim();
+  let subgraphHashPath: string | undefined;
+  if (providedSubgraphHashFile && providedSubgraphHashFile.length > 0) {
+    subgraphHashPath = providedSubgraphHashFile;
+  } else if (envSubgraphHashFile && envSubgraphHashFile.length > 0) {
+    subgraphHashPath = envSubgraphHashFile;
+  }
+
+  const subgraphHash = subgraphHashPath
+    ? await deps.loadSubgraphHash(subgraphHashPath)
+    : undefined;
+
   const { genesis } = await deps.promptForGenesis(deps.service, {
     faucetAddress,
     allocations: allocationOverrides,
@@ -425,8 +446,10 @@ const runBootstrap = async (
       validatorPrefix: staticNodePodPrefix,
       genesisConfigMapName,
       staticNodesConfigMapName,
+      subgraphConfigMapName: DEFAULT_SUBGRAPH_CONFIGMAP_NAME,
     },
     abiArtifacts,
+    subgraphHash,
   };
 
   await deps.outputResult(outputType ?? "screen", payload);
@@ -441,6 +464,7 @@ const defaultDependencies: BootstrapDependencies = {
   service: new BesuGenesisService(),
   loadAllocations,
   loadAbis,
+  loadSubgraphHash,
   outputResult: defaultOutputResult,
 };
 /* c8 ignore end */
@@ -487,6 +511,11 @@ const createCliCommand = (
       "Directory containing ABI JSON files to publish as ConfigMaps.",
       (value: string) => stripSurroundingQuotes(value)
     )
+    .option(
+      "--subgraph-hash-file <path>",
+      "Path to a file containing the subgraph IPFS hash.",
+      (value: string) => stripSurroundingQuotes(value)
+    )
     .option(
       "-o, --outputType <type>",
       `Output target (${OUTPUT_CHOICES.join(", ")}).`,
@@ -601,6 +630,10 @@ const createCliCommand = (
           normalizedOptions.abiDirectory === undefined
             ? undefined
             : stripSurroundingQuotes(normalizedOptions.abiDirectory),
+        subgraphHashFile:
+          normalizedOptions.subgraphHashFile === undefined
+            ? undefined
+            : stripSurroundingQuotes(normalizedOptions.subgraphHashFile),
       };
 
       for (const { key, sanitize } of TEXT_OPTION_DESCRIPTORS) {
@@ -628,6 +661,12 @@ const createCliCommand = (
           trimmed.length === 0 ? undefined : trimmed;
       }
 
+      if (sanitizedOptions.subgraphHashFile) {
+        const trimmed = sanitizedOptions.subgraphHashFile.trim();
+        sanitizedOptions.subgraphHashFile =
+          trimmed.length === 0 ? undefined : trimmed;
+      }
+
       await runBootstrap(sanitizedOptions, deps);
     });