feat: initial genesis merging

Author: roderik

README.md

@@ -10,12 +10,14 @@ Usage: network-bootstrapper [options] [command]
 Utilities for configuring Besu-based networks.
 
 Options:
-  -h, --help          display help for command
+  -h, --help                 display help for command
 
 Commands:
-  generate [options]  Generate node identities, configure consensus, and emit a
-                      Besu genesis.
-  help [command]      display help for command
+  generate [options]         Generate node identities, configure consensus, and
+                             emit a Besu genesis.
+  compile-genesis [options]  Merge per-account allocation ConfigMaps into a Besu
+                             genesis file.
+  help [command]             display help for command
 
 
 Usage: network-bootstrapper generate [options]

src/cli/allocations.test.ts renamed to src/cli/commands/bootstrap/bootstrap.allocations.test.ts

@@ -5,7 +5,7 @@ import { join } from "node:path";
 
 import { getAddress } from "viem";
 
-import { loadAllocations } from "./allocations.ts";
+import { loadAllocations } from "./bootstrap.allocations.ts";
 
 const INVALID_JSON_ERROR = /Allocations file is not valid JSON/;
 const INVALID_ADDRESS_ERROR = /Invalid address/;

src/cli/allocations.ts renamed to src/cli/commands/bootstrap/bootstrap.allocations.ts

@@ -1,7 +1,7 @@
 import { getAddress, isAddress, isHex } from "viem";
 import { z } from "zod";
 
-import type { BesuAllocAccount } from "../genesis/besu-genesis.service.ts";
+import type { BesuAllocAccount } from "../../../genesis/besu-genesis.service.ts";
 
 type HexLiteral = `0x${string}`;
 

src/cli/colors.test.ts renamed to src/cli/commands/bootstrap/bootstrap.colors.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from "bun:test";
 
-import { accent, label, muted, success } from "./colors.ts";
+import { accent, label, muted, success } from "./bootstrap.colors.ts";
 
 const SAMPLE = "hello";
 const RESET = "\x1b[0m";

src/cli/colors.ts renamed to src/cli/commands/bootstrap/bootstrap.colors.ts

@@ -1,14 +1,14 @@
 import { afterEach, beforeEach, describe, expect, test } from "bun:test";
 
 import { getAddress } from "viem";
-import { ARTIFACT_DEFAULTS } from "../constants/artifact-defaults.ts";
-import type { BesuAllocAccount } from "../genesis/besu-genesis.service.ts";
-import { ALGORITHM } from "../genesis/besu-genesis.service.ts";
-import type { GeneratedNodeKey } from "../keys/node-key-factory.ts";
-import type { BootstrapDependencies, CliOptions } from "./build-command.ts";
-import { createCliCommand, runBootstrap } from "./build-command.ts";
-import type { OutputPayload, OutputType } from "./output.ts";
-import { outputResult as realOutputResult } from "./output.ts";
+import { ARTIFACT_DEFAULTS } from "../../../constants/artifact-defaults.ts";
+import type { BesuAllocAccount } from "../../../genesis/besu-genesis.service.ts";
+import { ALGORITHM } from "../../../genesis/besu-genesis.service.ts";
+import type { GeneratedNodeKey } from "../../../keys/node-key-factory.ts";
+import type { BootstrapDependencies, CliOptions } from "./bootstrap.command.ts";
+import { createCliCommand, runBootstrap } from "./bootstrap.command.ts";
+import type { OutputPayload, OutputType } from "./bootstrap.output.ts";
+import { outputResult as realOutputResult } from "./bootstrap.output.ts";
 
 const VALIDATOR_LABEL = "validator nodes";
 const VALIDATOR_RETURN = 2;

src/cli/build-command.test.ts renamed to src/cli/commands/bootstrap/bootstrap.command.test.ts

@@ -1,24 +1,28 @@
 import { Command, InvalidArgumentError } from "commander";
-import { ARTIFACT_DEFAULTS } from "../constants/artifact-defaults.ts";
+import { ARTIFACT_DEFAULTS } from "../../../constants/artifact-defaults.ts";
 import {
   ALGORITHM,
   type Algorithm,
   BesuGenesisService,
-} from "../genesis/besu-genesis.service.ts";
-import { NodeKeyFactory } from "../keys/node-key-factory.ts";
-import { loadAllocations } from "./allocations.ts";
-import { type HexAddress, promptForGenesisConfig } from "./genesis-prompts.ts";
+} from "../../../genesis/besu-genesis.service.ts";
+import { NodeKeyFactory } from "../../../keys/node-key-factory.ts";
+import { createCompileGenesisCommand } from "../compile-genesis/compile-genesis.command.ts";
+import { loadAllocations } from "./bootstrap.allocations.ts";
+import {
+  type HexAddress,
+  promptForGenesisConfig,
+} from "./bootstrap.genesis-prompts.ts";
 import {
   outputResult as defaultOutputResult,
   type IndexedNode,
   type OutputPayload,
   type OutputType,
-} from "./output.ts";
+} from "./bootstrap.output.ts";
 import {
   createCountParser,
   promptForCount,
   promptForText,
-} from "./prompt-helpers.ts";
+} from "./bootstrap.prompt-helpers.ts";
 
 type CliOptions = {
   allocations?: string;
@@ -600,6 +604,9 @@ const createCliCommand = (
       await runBootstrap(sanitizedOptions, deps);
     });
 
+  // Register subcommands from their own modules to keep the bootstrap surface composable.
+  command.addCommand(createCompileGenesisCommand());
+
   return command;
 };
 

src/cli/build-command.ts renamed to src/cli/commands/bootstrap/bootstrap.command.ts

@@ -6,12 +6,12 @@ import {
   type BesuAllocAccount,
   type BesuGenesis,
   type BesuGenesisService,
-} from "../genesis/besu-genesis.service.ts";
+} from "../../../genesis/besu-genesis.service.ts";
 import {
   type HexAddress,
   type PromptOverrides,
   promptForGenesisConfig,
-} from "./genesis-prompts.ts";
+} from "./bootstrap.genesis-prompts.ts";
 
 const CHAIN_ID_RESPONSE = 42;
 const BLOCK_TIME_RESPONSE = 5;

src/cli/genesis-prompts.test.ts renamed to src/cli/commands/bootstrap/bootstrap.genesis-prompts.test.ts

@@ -7,14 +7,14 @@ import {
   type BesuGenesis,
   type BesuGenesisService,
   type BesuNetworkConfig,
-} from "../genesis/besu-genesis.service.ts";
-import { accent } from "./colors.ts";
+} from "../../../genesis/besu-genesis.service.ts";
+import { accent } from "./bootstrap.colors.ts";
 import {
   ABORT_MESSAGE,
   ABORT_OPTION,
   promptForBigIntString,
   promptForInteger,
-} from "./prompt-helpers.ts";
+} from "./bootstrap.prompt-helpers.ts";
 
 const HEX_RADIX = 16;
 

src/cli/genesis-prompts.ts renamed to src/cli/commands/bootstrap/bootstrap.genesis-prompts.ts

@@ -4,14 +4,23 @@ import { join } from "node:path";
 
 import { type CoreV1Api, KubeConfig } from "@kubernetes/client-node";
 
-import { ARTIFACT_DEFAULTS } from "../constants/artifact-defaults.ts";
-import type { IndexedNode, OutputPayload, OutputType } from "./output.ts";
+import { ARTIFACT_DEFAULTS } from "../../../constants/artifact-defaults.ts";
+import {
+  ALGORITHM,
+  type BesuAllocAccount,
+  BesuGenesisService,
+} from "../../../genesis/besu-genesis.service.ts";
+import type {
+  IndexedNode,
+  OutputPayload,
+  OutputType,
+} from "./bootstrap.output.ts";
 import {
   outputResult,
   printFaucet,
   printGenesis,
   printGroup,
-} from "./output.ts";
+} from "./bootstrap.output.ts";
 
 let output = "";
 let originalWrite: typeof process.stdout.write;
@@ -77,7 +86,7 @@ const PUBLIC_KEY_HEX_LENGTH = 128;
 const HEX_RADIX = 16;
 const SAMPLE_VALIDATOR_INDEX = 1;
 const SAMPLE_FAUCET_INDEX = 99;
-const EXPECTED_CONFIGMAP_COUNT = 7;
+const EXPECTED_CONFIGMAP_COUNT = 8;
 const EXPECTED_SECRET_COUNT = 2;
 const HEX_PREFIX_PATTERN = /^0x/;
 const TEST_CHAIN_ID = 1;
@@ -217,10 +226,37 @@ const staticNodeUri = (
 
 const sampleValidator = sampleNode(SAMPLE_VALIDATOR_INDEX);
 const sampleFaucet = sampleNode(SAMPLE_FAUCET_INDEX);
+const allocationTarget = sampleNode(SAMPLE_FAUCET_INDEX + 1);
+
+const SAMPLE_EXTRA_ALLOCATION: BesuAllocAccount = {
+  balance: "0x1234",
+  code: "0x6000",
+  storage: {
+    "0x1": "0x2",
+  },
+};
+
+const toAllocationConfigMapName = (address: string): string =>
+  `alloc-${address.slice(2).toLowerCase()}`;
+
+const genesisService = new BesuGenesisService(TEST_CHAIN_ID);
+const sampleGenesis = genesisService.generate(
+  ALGORITHM.QBFT,
+  {
+    chainId: TEST_CHAIN_ID,
+    faucetWalletAddress: sampleFaucet.address,
+    gasLimit: "0x1",
+    gasPrice: 0,
+    secondsPerBlock: 2,
+  },
+  {
+    [allocationTarget.address]: SAMPLE_EXTRA_ALLOCATION,
+  }
+);
 
 const samplePayload: OutputPayload = {
   faucet: sampleFaucet,
-  genesis: { config: { chainId: TEST_CHAIN_ID }, extraData: "0xabc" },
+  genesis: sampleGenesis,
   validators: [sampleValidator],
   staticNodes: [
     staticNodeUri(
@@ -253,6 +289,9 @@ describe("outputResult", () => {
 
     await outputResult("file", samplePayload);
 
+    expect(output).toContain("[bootstrap] Output mode: file");
+    expect(output).toContain("[bootstrap] Writing besu-genesis.json");
+
     const directories = await readdir("out");
     expect(directories.length).toBe(1);
     const targetDir = directories[0];
@@ -300,6 +339,7 @@ describe("outputResult", () => {
       namespace: string;
       name: string;
       data: Record<string, string>;
+      immutable?: boolean;
     }> = [];
     const createdSecrets: Array<{
       namespace: string;
@@ -336,6 +376,7 @@ describe("outputResult", () => {
               namespace,
               name: body?.metadata?.name ?? "",
               data: body?.data ?? {},
+              immutable: body?.immutable,
             });
             return Promise.resolve();
           },
@@ -364,6 +405,10 @@ describe("outputResult", () => {
 
       await outputResult("kubernetes", samplePayload);
 
+      expect(output).toContain("[bootstrap] Output mode: kubernetes");
+      expect(output).toContain("[bootstrap] ConfigMap → besu-genesis");
+      expect(output).toContain("[bootstrap] Secret → besu-faucet-private-key");
+
       expect(listedConfigNamespaces).toEqual(["test-namespace"]);
       expect(listedSecretNamespaces).toEqual(["test-namespace"]);
       expect(createdConfigMaps).toHaveLength(EXPECTED_CONFIGMAP_COUNT);
@@ -374,6 +419,9 @@ describe("outputResult", () => {
       expect(mapNames).toContain("besu-faucet-address");
       expect(mapNames).toContain("besu-faucet-pubkey");
       expect(mapNames).toContain("besu-static-nodes");
+      expect(mapNames).toContain(
+        toAllocationConfigMapName(allocationTarget.address)
+      );
       expect(mapNames).not.toContain("besu-faucet-enode");
       const secretNames = createdSecrets.map((entry) => entry.name).sort();
       expect(secretNames).toEqual([
@@ -391,6 +439,44 @@ describe("outputResult", () => {
       expect(
         JSON.parse(staticNodesConfig?.data?.["static-nodes.json"] ?? "[]")
       ).toEqual(samplePayload.staticNodes);
+      const genesisConfig = createdConfigMaps.find(
+        (entry) => entry.name === "besu-genesis"
+      );
+      expect(genesisConfig?.immutable).toBe(true);
+      const parsedGenesis = JSON.parse(
+        genesisConfig?.data?.["genesis.json"] ?? "{}"
+      ) as {
+        config: { chainId: number };
+        alloc?: Record<string, BesuAllocAccount>;
+      };
+      expect(parsedGenesis.config.chainId).toBe(TEST_CHAIN_ID);
+      const allocations = parsedGenesis.alloc;
+      if (!allocations) {
+        throw new Error("expected allocations payload");
+      }
+      const faucetAlloc = allocations[sampleFaucet.address];
+      if (!faucetAlloc) {
+        throw new Error("expected faucet allocation entry");
+      }
+      const expectedFaucetAlloc = sampleGenesis.alloc[sampleFaucet.address];
+      if (!expectedFaucetAlloc) {
+        throw new Error("sample genesis missing faucet entry");
+      }
+      expect(faucetAlloc.balance).toBe(expectedFaucetAlloc.balance);
+      const placeholderAlloc = allocations[allocationTarget.address];
+      if (!placeholderAlloc) {
+        throw new Error("expected placeholder allocation entry");
+      }
+      expect(placeholderAlloc.balance).toBe("0x0");
+      const allocationConfig = createdConfigMaps.find(
+        (entry) =>
+          entry.name === toAllocationConfigMapName(allocationTarget.address)
+      );
+      expect(allocationConfig?.immutable).toBe(true);
+      const parsedAllocation = JSON.parse(
+        allocationConfig?.data?.["alloc.json"] ?? "{}"
+      ) as BesuAllocAccount;
+      expect(parsedAllocation).toEqual(SAMPLE_EXTRA_ALLOCATION);
     } finally {
       (KubeConfig.prototype as any).loadFromCluster = originalLoad;
       (KubeConfig.prototype as any).makeApiClient = originalMake;
@@ -429,7 +515,11 @@ describe("outputResult", () => {
         "custom-genesis",
         "custom-static",
         "custom-validator-0-address",
+        "custom-validator-0-enode",
+        "custom-validator-0-pubkey",
         "custom-faucet-address",
+        "custom-faucet-pubkey",
+        toAllocationConfigMapName(allocationTarget.address),
       ];
       const expectedSecrets = [
         "custom-faucet-private-key",