zk lightnet logs command implementation. (#520)

Co-authored-by: Yoni Mekuria <ymekuria@gmail.com>

Author: shimkiv

CHANGELOG.md

@@ -5,11 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.15.1] - 2023-11-29
+
+### Added
+
+- Lightnet sub-commands implementation (`logs`). [#520](https://github.com/o1-labs/zkapp-cli/pull/520)
+
 ## [0.15.0] - 2023-11-07
 
-### Changed
+### Added
 
-- Lightnet sub-commands implementation (start/stop/status). [#510](https://github.com/o1-labs/zkapp-cli/pull/510)
+- Lightnet sub-commands implementation (`start`/`stop`/`status`). [#510](https://github.com/o1-labs/zkapp-cli/pull/510)
 
 ## [0.14.1] - 2023-11-03
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "zkapp-cli",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "CLI to create zkApps (zero-knowledge apps) for Mina Protocol",
   "homepage": "https://github.com/o1-labs/zkapp-cli/",
   "keywords": [

package.json

@@ -12,9 +12,11 @@ import { deploy } from '../lib/deploy.js';
 import { example } from '../lib/example.js';
 import { file } from '../lib/file.js';
 import {
+  lightnetFollowLogs,
+  lightnetSaveLogs,
+  lightnetStart,
   lightnetStatus,
-  startLightnet,
-  stopLightnet,
+  lightnetStop,
 } from '../lib/lightnet.js';
 import { project } from '../lib/project.js';
 import system from '../lib/system.js';
@@ -193,7 +195,7 @@ yargs(hideBin(process.argv))
             },
             ...commonOptions,
           },
-          async (argv) => await startLightnet(argv)
+          async (argv) => await lightnetStart(argv)
         )
         .command(
           ['stop [save-logs] [clean-up] [debug]'],
@@ -219,7 +221,7 @@ yargs(hideBin(process.argv))
             },
             ...commonOptions,
           },
-          async (argv) => await stopLightnet(argv)
+          async (argv) => await lightnetStop(argv)
         )
         .command(
           ['status [debug]'],
@@ -233,6 +235,41 @@ yargs(hideBin(process.argv))
               debug: argv.debug,
             })
         )
+        .command(
+          ['logs <sub-command> [options]'],
+          'Handle the lightweight Mina blockchain network Docker container processes logs.',
+          (yargs) => {
+            yargs
+              .command(
+                ['save [debug]'],
+                'Save the lightweight Mina blockchain network Docker container processes logs to the host file system.',
+                {
+                  ...commonOptions,
+                },
+                async (argv) => await lightnetSaveLogs(argv)
+              )
+              .command(
+                ['follow [process] [debug]'],
+                'Follow one of the lightweight Mina blockchain network Docker container processes logs.',
+                {
+                  process: {
+                    alias: 'p',
+                    demand: false,
+                    string: true,
+                    hidden: false,
+                    choices: [
+                      ...Constants.lightnetProcessToLogFileMapping.keys(),
+                    ],
+                    description:
+                      'The name of the Docker container process to follow the logs of.',
+                  },
+                  ...commonOptions,
+                },
+                async (argv) => await lightnetFollowLogs(argv)
+              )
+              .demandCommand();
+          }
+        )
         .demandCommand();
     }
   )

src/bin/index.js

@@ -9,7 +9,7 @@ import path from 'path';
  * @typedef {'none' | 'full'} LightnetProofLevel
  * @typedef {'o1js-main' | 'berkeley' | 'develop'} LightnetMinaBranch
  *
- * @type {{ uiTypes: UiType[], exampleTypes: ExampleType[], feePayerCacheDir: string, lightnetWorkDir: string, lightnetModes: LightnetMode[], lightnetTypes: LightnetType[], lightnetProofLevels: LightnetProofLevel[], lightnetMinaBranches: LightnetMinaBranch[] }}
+ * @type {{ uiTypes: UiType[], exampleTypes: ExampleType[], feePayerCacheDir: string, lightnetWorkDir: string, lightnetModes: LightnetMode[], lightnetTypes: LightnetType[], lightnetProofLevels: LightnetProofLevel[], lightnetMinaBranches: LightnetMinaBranch[], lightnetProcessToLogFileMapping: Map<string, string> }}
  */
 const Constants = Object.freeze({
   uiTypes: ['next', 'svelte', 'nuxt', 'empty', 'none'],
@@ -20,6 +20,18 @@ const Constants = Object.freeze({
   lightnetTypes: ['fast', 'real'],
   lightnetProofLevels: ['none', 'full'],
   lightnetMinaBranches: ['o1js-main', 'berkeley', 'develop'],
+  lightnetProcessToLogFileMapping: new Map([
+    ['Archive-Node-API application', 'logs/archive-node-api.log'],
+    ['Mina Archive process', 'logs/archive-node.log,archive/log.txt'],
+    ['Mina multi-purpose Daemon', 'logs/single-node-network.log'],
+    ['Fish BP #1', 'fish_0/log.txt'],
+    ['Non-consensus node #1', 'node_0/log.txt'],
+    ['Seed node #1', 'seed/log.txt'],
+    ['SNARK coordinator #1', 'snark_coordinator/log.txt'],
+    ['SNARK worker #1', 'snark_workers/worker_0/log.txt'],
+    ['Whale BP #1', 'whale_0/log.txt'],
+    ['Whale BP #2', 'whale_1/log.txt'],
+  ]),
 });
 
 export default Constants;