🔖 (release) [NO-ISSUE]: New release incoming: Signer SOL 1.5.1, Signer ETH 1.9.4, Context Module 1.11.1, Signer Utils 1.1.1, Transport Speculos 1.1.2, Transport Web BLE 1.3.1, Transport RN BLE 1.3.1, Transport Mockserver 1.0.1, Transport Web HID 1.2.2, Transport RN HID 1.0.2, DMK 0.13.0 (#1186)

Author: jiyuzhuang

apps/clear-signing-tester/README.md

@@ -41,17 +41,26 @@ Ethereum Transaction Tester CLI - Clean Architecture Edition
 
 Options:
   -V, --version                  output the version number
-  --derivation-path <path>       Derivation path (default: "44'/60'/0'/0/0") (default: "44'/60'/0'/0/0")
-  --speculos-url <url>           Speculos server URL (default: http://localhost) (default: "http://localhost")
+
+  # @config.speculos
+  --speculos-url <url>           Speculos server URL (default: http://localhost)
   --speculos-port <port>         Speculos server port (random port if not provided)
-  --device <device>              Device type (stax, nanox, nanos, nanos+, flex, apex, default: stax) (default: "stax")
-  --app-eth-version <version>    Ethereum app version (e.g., 1.19.1). If not specified, automatically resolves the latest available version for the device.
-  --os-version <version>         Device OS version (e.g., 1.8.1). If not specified, automatically resolves the latest available OS version for the device.
-  --plugin <plugin>              Plugin to use (e.g., Paraswap). If not specified, uses no plugin.
-  --plugin-version <version>     Plugin version to use. If not specified, automatically resolves the latest available version.
   --docker-image-tag <tag>       Docker image tag for Speculos (default: latest)
-  --verbose, -v                  Enable verbose output (default: false)
-  --quiet, -q                    Show only result tables (quiet mode) (default: false)
+  --device <device>              Device type (stax, nanox, nanos, nanos+, flex, apex, default: stax)
+  --app-eth-version <version>    Ethereum app version (e.g., 1.19.1). If not specified, uses latest version for the device.
+  --os-version <version>         Device OS version (e.g., 1.8.1). If not specified, uses latest OS version for the device.
+  --plugin <plugin>              Plugin to use (e.g., Paraswap). If not specified, uses no plugin.
+  --plugin-version <version>     Plugin version to use. If not specified, uses latest version.
+  --screenshot-folder-path <path>  Save screenshots to a folder during transaction signing
+
+  # @config.signer
+  --derivation-path <path>       Derivation path (default: "44'/60'/0'/0/0")
+
+  # @config.logger
+  --log-level <level>            Console log level: none, error, warn, info, debug (default: info)
+  --log-file <path>              Log output to a file
+  --file-log-level <level>       File log level: none, error, warn, info, debug (requires --log-file)
+
   -h, --help                     display help for command
 
 Commands:
@@ -154,6 +163,46 @@ Options:
 - `--chain-id <number>`: Chain id to use (default to 1)
 - `--skip-cal`: Skip CAL (Crypto Asset List) filtering and fetch random transactions directly from Etherscan instead of only CAL-registered transactions
 
+### Logging
+
+The tester supports configurable logging levels for both console and file output:
+
+```bash
+# Default: console at info level
+pnpm cs-tester cli raw-file ./ressources/raw-erc20.json
+
+# Verbose console output (debug level)
+pnpm cs-tester cli --log-level debug raw-file ./ressources/raw-erc20.json
+
+# Quiet mode (errors only)
+pnpm cs-tester cli --log-level error raw-file ./ressources/raw-erc20.json
+
+# Log to file with debug level (console stays at info)
+pnpm cs-tester cli --log-file ./output.log --file-log-level debug raw-file ./ressources/raw-erc20.json
+
+# Silent console, verbose file
+pnpm cs-tester cli --log-level none --log-file ./debug.log --file-log-level debug raw-file ./ressources/raw-erc20.json
+```
+
+**Log Levels:**
+
+- `none` - No logging
+- `error` - Errors only
+- `warn` - Errors and warnings
+- `info` - Errors, warnings, and info (default)
+- `debug` - All messages including debug
+
+### Screenshots
+
+Save screenshots of each screen during transaction signing:
+
+```bash
+# Save screenshots to a folder
+pnpm cs-tester cli --screenshot-folder-path ./screenshots raw-file ./ressources/raw-erc20.json
+```
+
+Screenshots are saved as `screenshot_1.png`, `screenshot_2.png`, etc. in the specified folder.
+
 ### Plugin Support
 
 The tester supports running Ethereum transactions with plugins (e.g., Paraswap, 1inch, etc.). When a plugin is specified, Speculos will run the plugin app with the Ethereum app loaded as a library using the `-l` flag.

apps/clear-signing-tester/src/cli/EthereumTransactionTesterCli.ts

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-import { ConsoleLogger, LogLevel } from "@ledgerhq/device-management-kit";
 import { Command } from "commander";
 import { type Container } from "inversify";
 
@@ -13,22 +12,39 @@ import { type TestTypedDataUseCase } from "@root/src/application/usecases/TestTy
 import { makeContainer } from "@root/src/di/container";
 import { type ClearSigningTesterConfig } from "@root/src/di/modules/configModuleFactory";
 import { TYPES } from "@root/src/di/types";
+import {
+  CLI_LOG_LEVELS,
+  type CliLogLevel,
+} from "@root/src/domain/models/config/LoggerConfig";
 import { type SpeculosConfig } from "@root/src/domain/models/config/SpeculosConfig";
 import { type ServiceController } from "@root/src/domain/services/ServiceController";
 
 export type CliConfig = {
-  derivationPath: string;
+  // config.speculos
   speculosUrl: string;
   speculosPort: number;
-  verbose: boolean;
-  quiet: boolean;
+  speculosVncPort?: number;
+  dockerImageTag?: string;
   device: SpeculosConfig["device"];
   appEthVersion?: SpeculosConfig["version"];
   osVersion?: SpeculosConfig["os"];
   plugin?: string;
   pluginVersion?: string;
+  screenshotFolderPath?: string;
+
+  // config.signer
   skipCal?: boolean;
-  dockerImageTag?: string;
+
+  // config.logger
+  logLevel: CliLogLevel;
+  logFile?: string;
+  fileLogLevel?: CliLogLevel;
+
+  // extras (not in config section but used by CLI)
+  derivationPath: string;
+
+  // Start Speculos only (skip DMK initialization)
+  onlySpeculos?: boolean;
 };
 
 /**
@@ -46,27 +62,22 @@ export class EthereumTransactionTesterCli {
   constructor(config: CliConfig) {
     this.config = config;
 
-    const logger = new ConsoleLogger(
-      config.quiet
-        ? LogLevel.Error
-        : config.verbose
-          ? LogLevel.Debug
-          : LogLevel.Info,
-    );
-
     const randomPort = Math.floor(Math.random() * 10000) + 10000;
+    const randomVncPort = Math.floor(Math.random() * 10000) + 20000;
 
     // Create DI container configuration
     const diConfig: ClearSigningTesterConfig = {
       speculos: {
         url: config.speculosUrl || `http://localhost`,
         port: config.speculosPort || randomPort,
+        vncPort: config.speculosVncPort || randomVncPort,
         dockerImageTag: config.dockerImageTag || "latest",
         device: config.device,
         os: config.osVersion,
         version: config.appEthVersion,
         plugin: config.plugin,
         pluginVersion: config.pluginVersion,
+        screenshotPath: config.screenshotFolderPath,
       },
       signer: {
         originToken: process.env["GATING_TOKEN"] || "test-origin-token",
@@ -78,12 +89,24 @@ export class EthereumTransactionTesterCli {
       apps: {
         path: process.env["COIN_APPS_PATH"] || "",
       },
+      onlySpeculos: config.onlySpeculos,
     };
 
     // Create DI container and resolve tester
     this.container = makeContainer({
       config: diConfig,
-      loggers: [logger],
+      logger: {
+        cli: {
+          level: config.logLevel,
+        },
+        file: config.logFile
+          ? {
+              // default to cli log level if file log level is not specified,
+              level: config.fileLogLevel || config.logLevel,
+              filePath: config.logFile,
+            }
+          : undefined,
+      },
     });
 
     this.controller = this.container.get<ServiceController>(
@@ -143,6 +166,17 @@ export class EthereumTransactionTesterCli {
           return port;
         },
       )
+      .option(
+        "--speculos-vnc-port <port>",
+        "Speculos VNC port (random port if not provided)",
+        (value: string) => {
+          const port = parseInt(value);
+          if (isNaN(port) || port < 1 || port > 65535) {
+            throw new Error("Invalid port number");
+          }
+          return port;
+        },
+      )
       .option(
         "--device <device>",
         "Device type (stax, nanox, nanos, nanos+, flex, apex, default: stax)",
@@ -187,8 +221,36 @@ export class EthereumTransactionTesterCli {
         "Docker image tag for Speculos (default: latest)",
         "latest",
       )
-      .option("--verbose, -v", "Enable verbose output", false)
-      .option("--quiet, -q", "Show only result tables (quiet mode)", false);
+      .option(
+        "--screenshot-folder-path <path>",
+        "Save screenshots to a folder during transaction signing",
+      )
+      .option(
+        "--log-level <level>",
+        `Console log level: ${CLI_LOG_LEVELS.join(", ")} (default: info)`,
+        (value: string) => {
+          if (!CLI_LOG_LEVELS.includes(value as CliLogLevel)) {
+            throw new Error(
+              `Invalid log level '${value}'. Must be one of: ${CLI_LOG_LEVELS.join(", ")}`,
+            );
+          }
+          return value as CliLogLevel;
+        },
+        "info" as CliLogLevel,
+      )
+      .option("--log-file <path>", "Log output to a file")
+      .option(
+        "--file-log-level <level>",
+        `File log level: ${CLI_LOG_LEVELS.join(", ")} (requires --log-file)`,
+        (value: string) => {
+          if (!CLI_LOG_LEVELS.includes(value as CliLogLevel)) {
+            throw new Error(
+              `Invalid log level '${value}'. Must be one of: ${CLI_LOG_LEVELS.join(", ")}`,
+            );
+          }
+          return value as CliLogLevel;
+        },
+      );
 
     // Set up signal handlers that work with the CLI instance
     const handleShutdown = async (signal: string) => {
@@ -197,11 +259,13 @@ export class EthereumTransactionTesterCli {
       process.exit(0);
     };
 
-    process.on("SIGINT", () => handleShutdown("SIGINT"));
-    process.on("SIGTERM", () => handleShutdown("SIGTERM"));
+    process.once("SIGINT", () => handleShutdown("SIGINT"));
+    process.once("SIGTERM", () => handleShutdown("SIGTERM"));
 
     program.hook("preAction", async (_, command) => {
       const config = command.parent!.opts() as CliConfig;
+      // Set onlySpeculos flag when running start-speculos command
+      config.onlySpeculos = command.name() === "start-speculos";
       cli = new EthereumTransactionTesterCli(config);
       await cli.initialize();
     });
@@ -280,6 +344,16 @@ export class EthereumTransactionTesterCli {
         exitCode = await cli!.handleContractFile(file, options.skipCal);
       });
 
+    // Start Speculos command (no signing tests)
+    program
+      .command("start-speculos")
+      .description(
+        "Start Speculos emulator without running any signing tests. Press Ctrl+C to stop.",
+      )
+      .action(async () => {
+        await cli!.handleStartSpeculos();
+      });
+
     return program;
   }
 
@@ -418,6 +492,18 @@ export class EthereumTransactionTesterCli {
 
     return result.exitCode;
   }
+
+  /**
+   * Handle start-speculos command
+   * Starts Speculos and keeps it running until interrupted
+   */
+  async handleStartSpeculos(): Promise<void> {
+    console.log("\nSpeculos is running.");
+    console.log("Press Ctrl+C to stop.\n");
+
+    // Wait indefinitely until interrupted
+    await new Promise<void>(() => {});
+  }
 }
 
 // Main execution when run directly

apps/clear-signing-tester/src/di/container.ts

@@ -1,6 +1,7 @@
-import { type LoggerSubscriberService } from "@ledgerhq/device-management-kit";
 import { Container } from "inversify";
 
+import { type LoggerConfig } from "@root/src/domain/models/config/LoggerConfig";
+
 import { applicationModuleFactory } from "./modules/applicationModuleFactory";
 import {
   type ClearSigningTesterConfig,
@@ -11,20 +12,20 @@ import { loggerModuleFactory } from "./modules/loggerModuleFactory";
 
 type MakeContainerArgs = {
   config: ClearSigningTesterConfig;
-  loggers?: LoggerSubscriberService[];
+  logger: LoggerConfig;
 };
 
 export const makeContainer = ({
   config,
-  loggers = [],
+  logger,
 }: MakeContainerArgs): Container => {
   const container = new Container();
 
   container.loadSync(
     configModuleFactory(config),
     infrastructureModuleFactory(config),
     applicationModuleFactory(),
-    loggerModuleFactory({ subscribers: loggers }),
+    loggerModuleFactory({ config: logger }),
   );
 
   return container;

apps/clear-signing-tester/src/di/modules/configModuleFactory.ts

@@ -11,6 +11,7 @@ export type ClearSigningTesterConfig = {
   signer: SignerConfig;
   etherscan: EtherscanConfig;
   apps: AppsConfig;
+  onlySpeculos?: boolean;
 };
 
 export const configModuleFactory = (config: ClearSigningTesterConfig) =>

apps/clear-signing-tester/src/di/modules/infrastructureModuleFactory.ts

@@ -9,6 +9,7 @@ import { type EtherscanAdapter } from "@root/src/domain/adapters/EtherscanAdapte
 import { type FileReader } from "@root/src/domain/adapters/FileReader";
 import { type JsonParser } from "@root/src/domain/adapters/JsonParser";
 import { type ScreenReader } from "@root/src/domain/adapters/ScreenReader";
+import { type ScreenshotSaver } from "@root/src/domain/adapters/ScreenshotSaver";
 import { type TransactionCrafter } from "@root/src/domain/adapters/TransactionCrafter";
 import { type ContractInput } from "@root/src/domain/models/ContractInput";
 import { type TransactionInput } from "@root/src/domain/models/TransactionInput";
@@ -28,6 +29,7 @@ import { EthersTransactionCrafter } from "@root/src/infrastructure/adapters/evm/
 import { HttpCalAdapter } from "@root/src/infrastructure/adapters/external/HttpCalAdapter";
 import { HttpEtherscanAdapter } from "@root/src/infrastructure/adapters/external/HttpEtherscanAdapter";
 import { SpeculosScreenReader } from "@root/src/infrastructure/adapters/speculos/SpeculosScreenReader";
+import { SpeculosScreenshotSaver } from "@root/src/infrastructure/adapters/speculos/SpeculosScreenshotSaver";
 import { NodeDockerContainer } from "@root/src/infrastructure/adapters/system/NodeDockerContainer";
 import { NodeFileReader } from "@root/src/infrastructure/adapters/system/NodeFileReader";
 import { NodeJsonParser } from "@root/src/infrastructure/adapters/system/NodeJsonParser";
@@ -113,17 +115,27 @@ export const infrastructureModuleFactory = (config: ClearSigningTesterConfig) =>
 
     // Service Controllers Array (ordered for startup/shutdown)
     bind<ServiceController[]>(TYPES.ServiceControllers)
-      .toDynamicValue((context) => [
-        // Start order: Speculos -> DMK
-        context.get<ServiceController>(TYPES.SpeculosServiceController),
-        context.get<ServiceController>(TYPES.DMKServiceController),
-      ])
+      .toDynamicValue((context) => {
+        const controllers: ServiceController[] = [
+          context.get<ServiceController>(TYPES.SpeculosServiceController),
+        ];
+        // Only add DMK controller if not in onlySpeculos mode
+        if (!config.onlySpeculos) {
+          controllers.push(
+            context.get<ServiceController>(TYPES.DMKServiceController),
+          );
+        }
+        return controllers;
+      })
       .inSingletonScope();
 
     // Adapters
     bind<ScreenReader>(TYPES.ScreenReader)
       .to(SpeculosScreenReader)
       .inSingletonScope();
+    bind<ScreenshotSaver>(TYPES.ScreenshotSaver)
+      .to(SpeculosScreenshotSaver)
+      .inSingletonScope();
     bind<FileReader>(TYPES.FileReader).to(NodeFileReader).inSingletonScope();
     bind<JsonParser>(TYPES.JsonParser).to(NodeJsonParser).inSingletonScope();
     bind<DockerContainer>(TYPES.DockerContainer)