refactor (#535)

Author: timbrinded

packages/cli/src/internal/effect/ChopsticksMultiChain.ts

@@ -7,6 +7,7 @@
 
 import { Context, Data, Effect, Layer } from "effect";
 import type { HexString } from "@polkadot/util/types";
+import type { BuildBlockMode } from "@acala-network/chopsticks";
 import { createLogger } from "@moonwall/util";
 import {
   type ChopsticksConfig,
@@ -19,6 +20,16 @@ import { type ChopsticksServiceImpl, launchChopsticksEffect } from "./launchChop
 
 const logger = createLogger({ name: "ChopsticksMultiChain" });
 
+/**
+ * Extract a single endpoint string from the config.
+ * The ChopsticksConfig endpoint can be a string, array of strings, or undefined.
+ */
+const getEndpointString = (endpoint: string | string[] | undefined): string | undefined => {
+  if (typeof endpoint === "string") return endpoint;
+  if (Array.isArray(endpoint)) return endpoint[0];
+  return undefined;
+};
+
 // =============================================================================
 // Error Types
 // =============================================================================
@@ -352,7 +363,7 @@ export const ChopsticksMultiChainLayer = (
         catch: (cause) =>
           new ChopsticksSetupError({
             cause,
-            endpoint: config.relay.endpoint,
+            endpoint: getEndpointString(config.relay.endpoint),
           }),
       });
       cleanups.push(
@@ -370,7 +381,7 @@ export const ChopsticksMultiChainLayer = (
           catch: (cause) =>
             new ChopsticksSetupError({
               cause,
-              endpoint: paraConfig.endpoint,
+              endpoint: getEndpointString(paraConfig.endpoint),
             }),
         });
         cleanups.push(
@@ -412,13 +423,15 @@ export const createPolkadotMoonbeamConfig = (
     type: "relay",
     endpoint: "wss://rpc.polkadot.io",
     port: relayPort,
+    "build-block-mode": "Manual" as BuildBlockMode,
   },
   parachains: [
     {
       type: "parachain",
       paraId: 2004, // Moonbeam on Polkadot
       endpoint: "wss://wss.api.moonbeam.network",
       port: moonbeamPort,
+      "build-block-mode": "Manual" as BuildBlockMode,
     },
   ],
 });
@@ -438,13 +451,15 @@ export const createKusamaMoonriverConfig = (
     type: "relay",
     endpoint: "wss://kusama-rpc.polkadot.io",
     port: relayPort,
+    "build-block-mode": "Manual" as BuildBlockMode,
   },
   parachains: [
     {
       type: "parachain",
       paraId: 2023, // Moonriver on Kusama
       endpoint: "wss://wss.api.moonriver.moonbeam.network",
       port: moonriverPort,
+      "build-block-mode": "Manual" as BuildBlockMode,
     },
   ],
 });

packages/cli/src/internal/effect/ChopsticksService.ts

@@ -3,12 +3,24 @@
  *
  * This service provides a type-safe, Effect-based interface to @acala-network/chopsticks,
  * replacing the previous CLI-subprocess approach with direct programmatic control.
+ *
+ * The configuration type (ChopsticksConfig) is imported directly from @acala-network/chopsticks
+ * to ensure it stays in sync with upstream changes and supports all config options like rpc-timeout.
  */
 
 import { Context, Data, Effect } from "effect";
-import type { Blockchain, BuildBlockMode } from "@acala-network/chopsticks";
+import type { Blockchain, BuildBlockMode, fetchConfig } from "@acala-network/chopsticks";
 import type { HexString } from "@polkadot/util/types";
 
+/**
+ * The ChopsticksConfig type, derived from the fetchConfig return type.
+ *
+ * This ensures our type stays in sync with upstream chopsticks changes.
+ * The config uses kebab-case keys as defined by chopsticks (e.g., 'rpc-timeout',
+ * 'build-block-mode', 'mock-signature-host').
+ */
+export type ChopsticksConfig = Awaited<ReturnType<typeof fetchConfig>>;
+
 // =============================================================================
 // Error Types
 // =============================================================================
@@ -80,34 +92,6 @@ export type ChopsticksError =
 // Configuration Types
 // =============================================================================
 
-/**
- * Configuration for launching a chopsticks instance
- */
-export interface ChopsticksConfig {
-  /** WebSocket endpoint to fork from (e.g., "wss://rpc.polkadot.io") */
-  readonly endpoint: string;
-  /** Block number or hash to fork from (defaults to latest finalized) */
-  readonly block?: string | number | null;
-  /** Port to listen on (defaults to 8000) */
-  readonly port?: number;
-  /** Host to bind to (defaults to "127.0.0.1") */
-  readonly host?: string;
-  /** Block building mode: "batch" | "manual" | "instant" */
-  readonly buildBlockMode?: BuildBlockMode;
-  /** Path to WASM override file */
-  readonly wasmOverride?: string;
-  /** Whether to allow unresolved imports in WASM */
-  readonly allowUnresolvedImports?: boolean;
-  /** Whether to mock signature verification */
-  readonly mockSignatureHost?: boolean;
-  /** Path to SQLite database for caching */
-  readonly db?: string;
-  /** Storage overrides to apply */
-  readonly importStorage?: Record<string, Record<string, unknown>>;
-  /** Runtime log level (0-5) */
-  readonly runtimeLogLevel?: number;
-}
-
 /**
  * Result from creating a new block
  */

packages/cli/src/internal/effect/__tests__/ChopsticksMultiChain.test.ts

@@ -1,5 +1,6 @@
 import { describe, it, expect } from "vitest";
 import { Effect, Layer } from "effect";
+import { BuildBlockMode } from "@acala-network/chopsticks";
 import {
   ChopsticksOrchestrationError,
   ChopsticksMultiChainService,
@@ -83,48 +84,53 @@ describe("ChopsticksMultiChain - Phase 4: Multi-chain XCM Support", () => {
   });
 
   describe("Configuration Types", () => {
-    it("should create valid RelayChainConfig", () => {
+    it("should create valid RelayChainConfig with kebab-case keys", () => {
       const config: RelayChainConfig = {
         type: "relay",
         endpoint: "wss://rpc.polkadot.io",
         port: 8000,
+        "build-block-mode": BuildBlockMode.Manual,
       };
 
       expect(config.type).toBe("relay");
       expect(config.endpoint).toBe("wss://rpc.polkadot.io");
     });
 
-    it("should create valid ParachainConfig", () => {
+    it("should create valid ParachainConfig with kebab-case keys", () => {
       const config: ParachainConfig = {
         type: "parachain",
         paraId: 2000,
         endpoint: "wss://moonbeam.rpc.io",
         port: 8001,
+        "build-block-mode": BuildBlockMode.Manual,
       };
 
       expect(config.type).toBe("parachain");
       expect(config.paraId).toBe(2000);
     });
 
-    it("should create valid MultiChainConfig", () => {
+    it("should create valid MultiChainConfig with kebab-case keys", () => {
       const config: MultiChainConfig = {
         relay: {
           type: "relay",
           endpoint: "wss://rpc.polkadot.io",
           port: 8000,
+          "build-block-mode": BuildBlockMode.Manual,
         },
         parachains: [
           {
             type: "parachain",
             paraId: 2000,
             endpoint: "wss://moonbeam.rpc.io",
             port: 8001,
+            "build-block-mode": BuildBlockMode.Manual,
           },
           {
             type: "parachain",
             paraId: 2001,
             endpoint: "wss://acala.rpc.io",
             port: 8002,
+            "build-block-mode": BuildBlockMode.Manual,
           },
         ],
       };
@@ -364,13 +370,15 @@ describe("ChopsticksMultiChain - Phase 4: Multi-chain XCM Support", () => {
           type: "relay",
           endpoint: "wss://test.io",
           port: 8000,
+          "build-block-mode": BuildBlockMode.Manual,
         },
         parachains: [
           {
             type: "parachain",
             paraId: 2000,
             endpoint: "wss://para.test.io",
             port: 8001,
+            "build-block-mode": BuildBlockMode.Manual,
           },
         ],
       };
@@ -389,6 +397,7 @@ describe("ChopsticksMultiChain - Phase 4: Multi-chain XCM Support", () => {
           type: "relay",
           endpoint: "wss://test.io",
           port: 8000,
+          "build-block-mode": BuildBlockMode.Manual,
         },
         parachains: [],
       };
@@ -444,13 +453,15 @@ describe.skip("ChopsticksMultiChain - Integration Tests", () => {
         type: "relay",
         endpoint: "wss://rpc.polkadot.io",
         port: 8000,
+        "build-block-mode": BuildBlockMode.Manual,
       },
       parachains: [
         {
           type: "parachain",
           paraId: 2004,
           endpoint: "wss://wss.api.moonbeam.network",
           port: 8001,
+          "build-block-mode": BuildBlockMode.Manual,
         },
       ],
     });

packages/cli/src/internal/effect/__tests__/ChopsticksService.test.ts

@@ -218,39 +218,46 @@ describe("ChopsticksService - Phase 1: Types and Errors", () => {
   });
 
   describe("Config Type Validation", () => {
-    it("should allow creating a valid ChopsticksConfig", () => {
+    it("should allow creating a valid ChopsticksConfig with kebab-case keys", () => {
+      // ChopsticksConfig uses kebab-case keys matching chopsticks' native format
       const config: ChopsticksConfig = {
         endpoint: "wss://rpc.polkadot.io",
         block: 12345,
         port: 8000,
         host: "127.0.0.1",
-        buildBlockMode: BuildBlockMode.Manual,
-        wasmOverride: "/path/to/wasm",
-        allowUnresolvedImports: true,
-        mockSignatureHost: true,
+        "build-block-mode": BuildBlockMode.Manual,
+        "wasm-override": "/path/to/wasm",
+        "allow-unresolved-imports": true,
+        "mock-signature-host": true,
         db: "./chopsticks.db",
-        runtimeLogLevel: 3,
+        "runtime-log-level": 3,
+        "rpc-timeout": 30000, // New field supported via chopsticks type
       };
 
       expect(config.endpoint).toBe("wss://rpc.polkadot.io");
       expect(config.block).toBe(12345);
       expect(config.port).toBe(8000);
+      expect(config["rpc-timeout"]).toBe(30000);
     });
 
-    it("should allow minimal ChopsticksConfig with only required fields", () => {
+    it("should allow ChopsticksConfig with required port and build-block-mode", () => {
+      // The chopsticks Config type has port and build-block-mode as required after parsing
       const config: ChopsticksConfig = {
         endpoint: "wss://rpc.polkadot.io",
+        port: 8000,
+        "build-block-mode": BuildBlockMode.Manual,
       };
 
       expect(config.endpoint).toBe("wss://rpc.polkadot.io");
-      expect(config.block).toBeUndefined();
-      expect(config.port).toBeUndefined();
+      expect(config.port).toBe(8000);
+      expect(config["build-block-mode"]).toBe(BuildBlockMode.Manual);
     });
 
     it("should allow providing ChopsticksConfig via Layer", async () => {
       const config: ChopsticksConfig = {
         endpoint: "wss://test.io",
         port: 9000,
+        "build-block-mode": BuildBlockMode.Manual,
       };
 
       const configLayer = Layer.succeed(ChopsticksConfigTag, config);