@constellation-network/node-pilot 0.6.0 → 0.7.0

package/README.md

@@ -21,7 +21,7 @@ $ npm install -g @constellation-network/node-pilot
 $ cpilot COMMAND
 running command...
 $ cpilot (--version|-v)
-@constellation-network/node-pilot/0.6.0 darwin-arm64 node-v22.15.0
+@constellation-network/node-pilot/0.7.0 darwin-arm64 node-v22.15.0
 $ cpilot --help [COMMAND]
 USAGE
   $ cpilot COMMAND
@@ -71,7 +71,7 @@ EXAMPLES
   $ cpilot clean
 ```
 
-_See code: [src/commands/clean.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/clean.ts)_
+_See code: [src/commands/clean.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/clean.ts)_
 
 ## `cpilot config`
 
@@ -88,7 +88,7 @@ EXAMPLES
   $ cpilot config
 ```
 
-_See code: [src/commands/config.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/config.ts)_
+_See code: [src/commands/config.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/config.ts)_
 
 ## `cpilot config get [NAME]`
 
@@ -112,7 +112,7 @@ EXAMPLES
   $ cpilot config get gl0:CL_PUBLIC_HTTP_PORT
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/config/get.ts)_
+_See code: [src/commands/config/get.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/config/get.ts)_
 
 ## `cpilot config set NAME VALUE`
 
@@ -135,7 +135,7 @@ EXAMPLES
   $ cpilot config set gl0:CL_PUBLIC_HTTP_PORT 9000
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/config/set.ts)_
 
 ## `cpilot help [COMMAND]`
 
@@ -172,7 +172,7 @@ EXAMPLES
   $ cpilot info
 ```
 
-_See code: [src/commands/info.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/info.ts)_
+_See code: [src/commands/info.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/info.ts)_
 
 ## `cpilot logs LAYER`
 
@@ -198,7 +198,7 @@ EXAMPLES
   $ cpilot logs
 ```
 
-_See code: [src/commands/logs.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/logs.ts)_
+_See code: [src/commands/logs.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/logs.ts)_
 
 ## `cpilot restart [LAYER]`
 
@@ -226,7 +226,7 @@ EXAMPLES
   $ cpilot restart
 ```
 
-_See code: [src/commands/restart.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/restart.ts)_
+_See code: [src/commands/restart.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/restart.ts)_
 
 ## `cpilot shutdown`
 
@@ -234,10 +234,7 @@ A full shutdown of the validator node
 
 ```
 USAGE
-  $ cpilot shutdown [-l <value>]
-
-FLAGS
-  -l, --layer=<value>  specify a layer to shutdown. e.g. gl0
+  $ cpilot shutdown
 
 DESCRIPTION
   A full shutdown of the validator node
@@ -246,7 +243,7 @@ EXAMPLES
   $ cpilot shutdown
 ```
 
-_See code: [src/commands/shutdown.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/shutdown.ts)_
+_See code: [src/commands/shutdown.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/shutdown.ts)_
 
 ## `cpilot status`
 
@@ -260,5 +257,5 @@ DESCRIPTION
   Display node status and configuration settings
 ```
 
-_See code: [src/commands/status.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.6.0/src/commands/status.ts)_
+_See code: [src/commands/status.ts](https://github.com/Constellation-Labs/node-pilot/blob/v0.7.0/src/commands/status.ts)_
 <!-- commandsstop -->

package/dist/checks/check-layers.js

@@ -2,6 +2,7 @@ import { input } from "@inquirer/prompts";
 import chalk from "chalk";
 import { clm } from "../clm.js";
 import { configStore } from "../config-store.js";
+import { healthCheckConfig } from "../helpers/health-check-config.js";
 import { StatusTable } from "../helpers/status-table.js";
 import { dockerService } from "../services/docker-service.js";
 import { nodeService } from "../services/node-service.js";
@@ -29,6 +30,7 @@ export const checkLayers = {
             await input({ default: 'y', message: 'Would you like to start the validator(s)? (y/n): ' }).then(async (answer) => {
                 if (answer.toLowerCase() === 'y') {
                     await dockerService.dockerBuild();
+                    healthCheckConfig.setNodeState({ lastError: '' });
                     clm.preStep('Starting the node...');
                     await dockerService.dockerUp();
                     await nodeService.pollForLayersState(layersToRun);

package/dist/checks/check-pilot.d.ts

@@ -1,6 +1,15 @@
+import semver from "semver";
 export declare const checkNodePilot: {
     checkDiscordRegistration(): Promise<void>;
     checkVersion(): Promise<void>;
-    isDiscordAlertsEnabled(): any;
+    compareVersions(): Promise<{
+        currentVer: undefined;
+        latestVer: undefined;
+    } | {
+        currentVer: semver.SemVer | null;
+        latestVer: semver.SemVer | null;
+    }>;
+    isDiscordAlertsEnabled(): boolean;
     promptDiscordRegistration(): Promise<void>;
+    runUpgrade(): Promise<void>;
 };

package/dist/checks/check-pilot.js

@@ -1,14 +1,13 @@
-import { JSONStorage } from "node-localstorage";
-import fs from "node:fs";
 import os from "node:os";
-import path from "node:path";
 import semver from "semver";
 import packageJson from '../../package.json' with { type: 'json' };
 import { clm } from "../clm.js";
 import { configStore } from "../config-store.js";
+import { healthCheckConfig } from "../helpers/health-check-config.js";
 import { projectHelper } from "../helpers/project-helper.js";
 import { promptHelper } from "../helpers/prompt-helper.js";
 import { dockerService } from "../services/docker-service.js";
+import { nodeService } from "../services/node-service.js";
 import { shellService } from "../services/shell-service.js";
 const REGISTRY_URL = 'https://registry.npmjs.org/';
 export const checkNodePilot = {
@@ -20,16 +19,7 @@ export const checkNodePilot = {
         configStore.setProjectFlag('discordChecked', true);
     },
     async checkVersion() {
-        const packageUrl = new URL(encodeURIComponent(packageJson.name).replace(/^%40/, '@'), REGISTRY_URL);
-        const headers = {
-            accept: 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*',
-        };
-        const result = await fetch(packageUrl.toString(), { headers }).then(res => res.json()).catch(() => null);
-        if (!result) {
-            return;
-        }
-        const latestVer = semver.parse(result['dist-tags'].latest);
-        const currentVer = semver.parse(packageJson.version);
+        const { currentVer, latestVer } = await this.compareVersions();
         if (!latestVer || !currentVer || latestVer.compare(currentVer) === 0)
             return;
         clm.echo(`There is a new node-pilot version available. Current version: "${currentVer.version}", Latest version: "${latestVer.version}"`);
@@ -43,6 +33,9 @@ export const checkNodePilot = {
             }
             if (await promptHelper.confirmPrompt('Do you wish to update now?')) {
                 if (dockerIsRunning) {
+                    const { layersToRun } = configStore.getProjectInfo();
+                    await nodeService.leaveClusterAllLayers();
+                    await nodeService.pollForLayersState(layersToRun, 'Offline');
                     await dockerService.dockerDown();
                 }
             }
@@ -72,16 +65,27 @@ export const checkNodePilot = {
         clm.postStep('Update completed. Run cpilot again to use the latest version');
         process.exit(0);
     },
+    async compareVersions() {
+        const packageUrl = new URL(encodeURIComponent(packageJson.name).replace(/^%40/, '@'), REGISTRY_URL);
+        const headers = {
+            accept: 'application/vnd.npm.install-v1+json; q=1.0, application/json; q=0.8, */*',
+        };
+        const result = await fetch(packageUrl.toString(), { headers }).then(res => res.json()).catch(() => null);
+        if (!result) {
+            return { currentVer: undefined, latestVer: undefined };
+        }
+        const latestVer = semver.parse(result['dist-tags'].latest);
+        const currentVer = semver.parse(packageJson.version);
+        return { currentVer, latestVer };
+    },
     isDiscordAlertsEnabled() {
-        const hcStorage = getHcStorage();
-        const user = hcStorage.getItem('user');
-        return user && user.webHookEnabled;
+        const { webHookEnabled = false } = healthCheckConfig.getUserState();
+        return webHookEnabled;
     },
     async promptDiscordRegistration() {
-        const hcStorage = getHcStorage();
         const join = await promptHelper.confirmPrompt('Do you want to enable Discord notifications for your node?:');
         if (!join) {
-            hcStorage.setItem('user', { webHookEnabled: false });
+            healthCheckConfig.setUserState({ webHookEnabled: false });
             clm.postStep('Discord notifications are disabled.');
             return;
         }
@@ -99,16 +103,19 @@ export const checkNodePilot = {
         //     if (answer.charAt(0) === '@') answer = answer.slice(1);
         //     hcStorage.setItem('user', {discordUser: answer.trim(), webHookEnabled: true});
         // }
-        hcStorage.setItem('user', { webHookEnabled: true });
+        healthCheckConfig.setUserState({ webHookEnabled: true });
         clm.postStep('Discord notifications are enabled.');
+    },
+    async runUpgrade() {
+        const { currentVer, latestVer } = await this.compareVersions();
+        if (!latestVer || !currentVer || latestVer.compare(currentVer) === 0)
+            return;
+        clm.step('Updating Node Pilot to the latest version...');
+        await shellService.runCommand(`sudo npm install -g @constellation-network/node-pilot@${latestVer.version}`);
+        const hasMajorMinorChange = latestVer.major !== currentVer.major || latestVer.minor !== currentVer.minor;
+        if (hasMajorMinorChange) {
+            clm.step('Updating scripts and configuration files...');
+            await projectHelper.upgradeHypergraph();
+        }
     }
 };
-function getHcStorage() {
-    const { layersToRun, projectDir } = configStore.getProjectInfo();
-    const layer = layersToRun[0];
-    const hcPath = path.join(projectDir, layer, 'data', 'health-check');
-    if (fs.existsSync(hcPath)) {
-        fs.mkdirSync(hcPath, { recursive: true });
-    }
-    return new JSONStorage(hcPath);
-}

package/dist/commands/clean.js

@@ -34,6 +34,7 @@ export default class Clean extends Command {
             await promptHelper.doYouWishToContinue();
             await dockerService.dockerDown();
         }
+        clm.preStep('Requesting sudo permission to remove files...');
         for (const layer of layers) {
             if (deleteData) {
                 // eslint-disable-next-line no-await-in-loop

package/dist/commands/info.js

@@ -1,7 +1,7 @@
 import { Command } from '@oclif/core';
+import { checkNodePilot } from "../checks/check-pilot.js";
 import { configStore } from "../config-store.js";
 import { configHelper } from "../helpers/config-helper.js";
-import { checkNodePilot } from "../checks/check-pilot.js";
 export default class Info extends Command {
     static description = 'Display general info about the validator node';
     static examples = [
@@ -31,6 +31,6 @@ export default class Info extends Command {
         // Fast Forward
         // configHelper.showEnvInfo('Fast Forward Enabled', (projectInfo.fastForward === undefined || Boolean(projectInfo.fastForward)).toString());
         // Discord alerts
-        configHelper.showEnvInfo('Discord Alerts Enabled', checkNodePilot.isDiscordAlertsEnabled());
+        configHelper.showEnvInfo('Discord Alerts Enabled', checkNodePilot.isDiscordAlertsEnabled().toString());
     }
 }

package/dist/commands/restart.js

@@ -85,6 +85,7 @@ export default class Restart extends BaseCommand {
             await dockerService.dockerDown();
         }
         clm.preStep('Checking for a new version...');
+        // await checkNodePilot.runUpgrade();
         await checkProject.runUpgrade();
         clm.preStep('Starting the node...');
         await dockerService.dockerRestartAll();

package/dist/commands/shutdown.d.ts

@@ -2,8 +2,5 @@ import { Command } from '@oclif/core';
 export default class Shutdown extends Command {
     static description: string;
     static examples: string[];
-    static flags: {
-        layer: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
     run(): Promise<void>;
 }

package/dist/commands/shutdown.js

@@ -1,4 +1,4 @@
-import { Command, Flags } from '@oclif/core';
+import { Command } from '@oclif/core';
 import { configStore } from "../config-store.js";
 import { configHelper } from "../helpers/config-helper.js";
 import { dockerService } from "../services/docker-service.js";
@@ -8,26 +8,16 @@ export default class Shutdown extends Command {
     static examples = [
         '<%= config.bin %> <%= command.id %>',
     ];
-    static flags = {
-        layer: Flags.string({ char: 'l', description: 'specify a layer to shutdown. e.g. gl0' })
-    };
+    // NOTE: To only run specific layers, need to first shutdown project, config layers, and restart
+    // static override flags = {
+    //     layer: Flags.string({char: 'l', description: 'specify a layer to shutdown. e.g. gl0'})
+    // }
     async run() {
         configHelper.assertProject('No project found. ');
-        const { flags } = await this.parse(Shutdown);
         const { layersToRun } = configStore.getProjectInfo();
-        const layer = flags.layer;
-        if (layer) {
-            if (!layersToRun.includes(layer)) {
-                this.error(`Invalid layer: ${layer}. Available layers: ${layersToRun.join(',')}`);
-            }
-            await nodeService.leaveCluster(layer);
-            await nodeService.pollForLayersState([], 'Offline');
-            await dockerService.dockerDown([layer]);
-        }
-        else {
-            await nodeService.leaveClusterAllLayers();
-            await nodeService.pollForLayersState(layersToRun, 'Offline');
-            await dockerService.dockerDown();
-        }
+        configStore.setProjectStatusToRunning(false);
+        await nodeService.leaveClusterAllLayers();
+        await nodeService.pollForLayersState(layersToRun, 'Offline');
+        await dockerService.dockerDown();
     }
 }

package/dist/helpers/health-check-config.d.ts

@@ -0,0 +1,13 @@
+export declare const healthCheckConfig: {
+    getUserState(): UserState;
+    setNodeState(state: Partial<NodeState>): void;
+    setUserState(state: Partial<UserState>): void;
+};
+type NodeState = {
+    lastError: string;
+};
+type UserState = {
+    discordUser?: string;
+    webHookEnabled?: boolean;
+};
+export {};

package/dist/helpers/health-check-config.js

@@ -0,0 +1,30 @@
+import { JSONStorage } from "node-localstorage";
+import fs from "node:fs";
+import path from "node:path";
+import { configStore } from "../config-store.js";
+export const healthCheckConfig = {
+    getUserState() {
+        const hcStorage = getHcStorage();
+        const info = hcStorage.getItem('user');
+        return info || {};
+    },
+    setNodeState(state) {
+        const hcStorage = getHcStorage();
+        const info = hcStorage.getItem('node');
+        hcStorage.setItem('node', { ...info, ...state });
+    },
+    setUserState(state) {
+        const hcStorage = getHcStorage();
+        const info = hcStorage.getItem('user');
+        hcStorage.setItem('user', { ...info, ...state });
+    }
+};
+function getHcStorage() {
+    const { layersToRun, projectDir } = configStore.getProjectInfo();
+    const layer = layersToRun[0];
+    const hcPath = path.join(projectDir, layer, 'data', 'health-check');
+    if (fs.existsSync(hcPath)) {
+        fs.mkdirSync(hcPath, { recursive: true });
+    }
+    return new JSONStorage(hcPath);
+}

package/dist/helpers/status-table.js

@@ -38,7 +38,7 @@ export class StatusTable {
         const activeProject = configStore.getActiveProject();
         const projects = configStore.getRunningProjects();
         if (!activeProject || projects.length === 0) {
-            clm.error("No running projects found.");
+            clm.error("No projects are running.");
         }
         const info = [];
         for (const project of projects) {

package/dist/services/docker-service.js

@@ -23,7 +23,6 @@ export const dockerService = {
         }
     },
     async dockerDown(layers) {
-        configStore.setProjectStatusToRunning(false);
         await run('down', layers);
     },
     async dockerRestart(layer) {

package/oclif.manifest.json

@@ -215,16 +215,7 @@
       "examples": [
         "<%= config.bin %> <%= command.id %>"
       ],
-      "flags": {
-        "layer": {
-          "char": "l",
-          "description": "specify a layer to shutdown. e.g. gl0",
-          "name": "layer",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        }
-      },
+      "flags": {},
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "shutdown",
@@ -349,5 +340,5 @@
       ]
     }
   },
-  "version": "0.6.0"
+  "version": "0.7.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@constellation-network/node-pilot",
   "description": "An easy deployment and monitoring tool for Constellation nodes.",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "author": "Frank Fox",
   "bin": {
     "cpilot": "bin/run.js"

package/projects/hypergraph/Dockerfile

@@ -39,7 +39,7 @@ COPY dist/gl0.jar /app/jars/gl0.jar
 #COPY ./health-check /health-check
 #RUN chmod +x /health-check/bin/run.sh
 #RUN chmod +x /health-check/bin/hydrate.sh
-RUN npm install -g "@constellation-network/node-pilot-health-check@0.0.20"
+RUN npm install -g "@constellation-network/node-pilot-health-check@0.0.21"
 
 # Add entrypoint
 COPY ./entrypoint.sh /app/entrypoint.sh