@holochain/hc-spin 0.500.3 → 0.600.0-rc.0

package/docs/DEVSETUP.md

@@ -2,35 +2,26 @@
 
 To setup the development environment to develop on the CLI itself:
 
-1. Install dependencies:
+1. Enter the nix shell:
 
+```bash
+nix develop
 ```
-yarn
-```
-
-2. Build Rust node add-ons (requires Rust + Go installed)
-
-```
-yarn setup
-```
-
-3. Run the CLI in development mode
 
-```
-yarn dev -- -- [your CLI arguments here]
+2. Install dependencies:
 
+```bash
+yarn
 ```
 
-for example
+3. Build the CLI:
 
-```
-yarn dev -- -- --help
+```bash
+yarn build
 ```
 
-to invoke the help menu showing the available CLI arguments and options.
+4. Run the CLI:
 
-4. Building the CLI:
-
-```
-yarn build
+```bash
+yarn start <path to .webhapp file>
 ```

package/electron.vite.config.ts

@@ -1,9 +1,15 @@
 import { defineConfig, externalizeDepsPlugin } from 'electron-vite';
 import path from 'path';
 
+import packageJson from './package.json';
+
 export default defineConfig({
   main: {
     plugins: [externalizeDepsPlugin({ exclude: ['@holochain/client', 'nanoid', 'get-port'] })],
+    define: {
+      __PACKAGE_VERSION__: JSON.stringify(packageJson.version),
+      __HOLOCHAIN_VERSION__: JSON.stringify(packageJson.holochainVersion),
+    },
   },
   preload: {
     plugins: [externalizeDepsPlugin()],

package/flake.lock

@@ -0,0 +1,234 @@
+{
+  "nodes": {
+    "crane": {
+      "locked": {
+        "lastModified": 1762189950,
+        "narHash": "sha256-aotggLUXjlDGqKWibGPQcMZJGgdr79S21ISrv1Wz6RI=",
+        "owner": "ipetkov",
+        "repo": "crane",
+        "rev": "50700219af884287ad7c85507e2f163b23a027a9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "ipetkov",
+        "repo": "crane",
+        "type": "github"
+      }
+    },
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": "nixpkgs-lib"
+      },
+      "locked": {
+        "lastModified": 1762040540,
+        "narHash": "sha256-z5PlZ47j50VNF3R+IMS9LmzI5fYRGY/Z5O5tol1c9I4=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "0010412d62a25d959151790968765a70c436598b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "hc-launch": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1752056054,
+        "narHash": "sha256-iLHhGQXrSfgAibzLSx+mdOQnnTzq4mrRXto7+a+MDLM=",
+        "owner": "holochain",
+        "repo": "hc-launch",
+        "rev": "612aa244ceb4d2136e5adbf181ff0cc123daff65",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "holochain-weekly",
+        "repo": "hc-launch",
+        "type": "github"
+      }
+    },
+    "hc-scaffold": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1760566803,
+        "narHash": "sha256-fWflEEb2JQyVHfGglbx6dCR6X+4ECGM9pbxQYrKSZtQ=",
+        "owner": "holochain",
+        "repo": "scaffolding",
+        "rev": "751a16e98ddb35db5763cbf4b882a849b642e7e7",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "0.600.0-dev.0",
+        "repo": "scaffolding",
+        "type": "github"
+      }
+    },
+    "holochain": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1762372467,
+        "narHash": "sha256-8LoKyzjkAoHOlJ0+8hUrwc0LTX7/2TdVODoLwMZMNVA=",
+        "owner": "holochain",
+        "repo": "holochain",
+        "rev": "90f56b5bf15b572cd9fdbd63d5a40a288143ff5f",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "holochain-0.6.0-rc.0",
+        "repo": "holochain",
+        "type": "github"
+      }
+    },
+    "holonix": {
+      "inputs": {
+        "crane": "crane",
+        "flake-parts": "flake-parts",
+        "hc-launch": "hc-launch",
+        "hc-scaffold": "hc-scaffold",
+        "holochain": "holochain",
+        "kitsune2": "kitsune2",
+        "lair-keystore": "lair-keystore",
+        "nixpkgs": "nixpkgs",
+        "playground": "playground",
+        "rust-overlay": "rust-overlay"
+      },
+      "locked": {
+        "lastModified": 1762431364,
+        "narHash": "sha256-769gbrsWU5SejCYcvoTPkVakU8nj5qYUw6cDlMRIgDs=",
+        "owner": "holochain",
+        "repo": "holonix",
+        "rev": "2682fec89ecb743c13453a65ee775147076f1919",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "main",
+        "repo": "holonix",
+        "type": "github"
+      }
+    },
+    "kitsune2": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1762303720,
+        "narHash": "sha256-tC2k+1kPxpVYRYJLWYXQPvFlUwgfF4cKoFKbkak0vxU=",
+        "owner": "holochain",
+        "repo": "kitsune2",
+        "rev": "112099b30381ea0d23b8b3af21f5b5bb81ced6c5",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "v0.3.0",
+        "repo": "kitsune2",
+        "type": "github"
+      }
+    },
+    "lair-keystore": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1759147598,
+        "narHash": "sha256-K8TkVlKAwS7uuSZC46oSHddtZTM2XGWUTNnjjYdC1bE=",
+        "owner": "holochain",
+        "repo": "lair",
+        "rev": "8aa9ab1468e82a8bfb9bf1e65762efc51659d306",
+        "type": "github"
+      },
+      "original": {
+        "owner": "holochain",
+        "ref": "v0.6.3",
+        "repo": "lair",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1762233356,
+        "narHash": "sha256-cGS3lLTYusbEP/IJIWGgnkzIl+FA5xDvtiHyjalGr4k=",
+        "owner": "nixos",
+        "repo": "nixpkgs",
+        "rev": "ca534a76c4afb2bdc07b681dbc11b453bab21af8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nixos",
+        "ref": "nixos-25.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-lib": {
+      "locked": {
+        "lastModified": 1761765539,
+        "narHash": "sha256-b0yj6kfvO8ApcSE+QmA6mUfu8IYG6/uU28OFn4PaC8M=",
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "rev": "719359f4562934ae99f5443f20aa06c2ffff91fc",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-community",
+        "repo": "nixpkgs.lib",
+        "type": "github"
+      }
+    },
+    "playground": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1756729856,
+        "narHash": "sha256-xJnIfcIyLRTXsf+N8OOMnqzRkx2gT/DSta7qCm8yU7Y=",
+        "owner": "darksoil-studio",
+        "repo": "holochain-playground",
+        "rev": "5e858641de8ac6113cfa6b47ea1350762a629a61",
+        "type": "github"
+      },
+      "original": {
+        "owner": "darksoil-studio",
+        "ref": "main",
+        "repo": "holochain-playground",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-parts": [
+          "holonix",
+          "flake-parts"
+        ],
+        "holonix": "holonix",
+        "nixpkgs": [
+          "holonix",
+          "nixpkgs"
+        ]
+      }
+    },
+    "rust-overlay": {
+      "inputs": {
+        "nixpkgs": [
+          "holonix",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1762396738,
+        "narHash": "sha256-BarSecuxtzp1boERdABLkkoxQTi6s/V33lJwUbWLrLY=",
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "rev": "c63598992afd54d215d54f2b764adc0484c2b159",
+        "type": "github"
+      },
+      "original": {
+        "owner": "oxalica",
+        "repo": "rust-overlay",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

package/flake.nix

@@ -0,0 +1,31 @@
+{
+  description = "Flake for Holochain app development";
+
+  inputs = {
+    holonix.url = "github:holochain/holonix?ref=main";
+
+    nixpkgs.follows = "holonix/nixpkgs";
+    flake-parts.follows = "holonix/flake-parts";
+  };
+
+  outputs = inputs@{ flake-parts, ... }: flake-parts.lib.mkFlake { inherit inputs; } {
+    systems = builtins.attrNames inputs.holonix.devShells;
+    perSystem = { inputs', pkgs, ... }: {
+      formatter = pkgs.nixpkgs-fmt;
+
+      devShells.default = pkgs.mkShell {
+        inputsFrom = [ inputs'.holonix.devShells.default ];
+
+        packages = (with pkgs; [
+          nodejs_22
+          binaryen
+          yarn
+        ]);
+
+        shellHook = ''
+          export PS1='\[\033[1;34m\][holonix:\w]\$\[\033[0m\] '
+        '';
+      };
+    };
+  };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@holochain/hc-spin",
-  "version": "0.500.3",
-  "holochainVersion": "0.5.4",
+  "version": "0.600.0-rc.0",
+  "holochainVersion": "0.6.0-rc.0",
   "description": "CLI to run Holochain apps during development.",
   "author": "matthme",
   "homepage": "https://developer.holochain.org",
@@ -25,18 +25,18 @@
   "scripts": {
     "format": "prettier --write .",
     "lint": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
+    "lint:check": "eslint . --ext .js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts",
     "typecheck:node": "tsc --noEmit -p tsconfig.node.json --composite false",
     "typecheck:web": "tsc --noEmit -p tsconfig.web.json --composite false",
-    "typecheck": "npm run typecheck:node && npm run typecheck:web",
-    "start": "electron-vite preview",
-    "dev": "electron-vite dev",
-    "build": "rimraf dist && npm run typecheck && electron-vite build && mv ./out ./dist && cp ./cli/cli.js ./dist/cli.js && node ./scripts/replace-electron-version.js"
+    "typecheck": "yarn run typecheck:node && yarn run typecheck:web",
+    "start": "node dist/cli.js",
+    "build": "rimraf dist && yarn run typecheck && electron-vite build && mv ./out ./dist && cp ./cli/cli.js ./dist/cli.js && node ./scripts/replace-electron-version.js"
   },
   "dependencies": {
     "@electron-toolkit/preload": "^3.0.0",
     "@electron-toolkit/utils": "^3.0.0",
-    "@holochain/client": "^0.19.2",
-    "@holochain/hc-spin-rust-utils": "^0.500.0",
+    "@holochain/client": "^0.20.0-dev.2",
+    "@holochain/hc-spin-rust-utils": "0.600.0-dev.0",
     "@msgpack/msgpack": "^2.8.0",
     "bufferutil": "4.0.8",
     "commander": "11.1.0",
@@ -55,6 +55,7 @@
     "electron-builder": "^24.9.1",
     "electron-vite": "2.3.0",
     "eslint": "^8.56.0",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "prettier": "^3.1.1",
     "rimraf": "5.0.5",
     "typescript": "^5.3.3",

package/src/main/index.ts

@@ -1,14 +1,3 @@
-import { app, IpcMainInvokeEvent, ipcMain, protocol, Menu, BrowserWindow } from 'electron';
-import fs from 'fs';
-import path from 'path';
-import { nanoid } from 'nanoid';
-import { Command, Option } from 'commander';
-import contextMenu from 'electron-context-menu';
-import split from 'split';
-import * as childProcess from 'child_process';
-import { ZomeCallSigner } from '@holochain/hc-spin-rust-utils';
-import { createHappWindow, loadHappWindow } from './windows';
-import getPort from 'get-port';
 import {
   AdminWebsocket,
   AgentPubKey,
@@ -18,22 +7,31 @@ import {
   getNonceExpiration,
   randomNonce,
 } from '@holochain/client';
-import { validateCliArgs } from './validateArgs';
+import { ZomeCallSigner } from '@holochain/hc-spin-rust-utils';
 import { encode } from '@msgpack/msgpack';
-import { menu } from './menu';
+import * as childProcess from 'child_process';
+import { Command, Option } from 'commander';
+import { app, BrowserWindow, ipcMain, IpcMainInvokeEvent, Menu, protocol } from 'electron';
+import contextMenu from 'electron-context-menu';
+import fs from 'fs';
+import getPort from 'get-port';
 import { sha512 } from 'js-sha512';
+import { nanoid } from 'nanoid';
+import path from 'path';
+import split from 'split';
 
-const rustUtils = require('@holochain/hc-spin-rust-utils');
+import { menu } from './menu';
+import { validateCliArgs } from './validateArgs';
+import { createHappWindow, loadHappWindow } from './windows';
 
-const cliPackageJsonPath = path.resolve(path.join(app.getAppPath(), '../../package.json'));
-const cliPackageJson = require(cliPackageJsonPath);
+const rustUtils = require('@holochain/hc-spin-rust-utils');
 
 const cli = new Command();
 
 cli
   .name('hc-spin')
   .description('CLI to run Holochain apps during development.')
-  .version(`${cliPackageJson.version} (built for holochain ${cliPackageJson.holochainVersion})`)
+  .version(`${__PACKAGE_VERSION__} (built for holochain ${__HOLOCHAIN_VERSION__})`)
   .argument(
     '<path>',
     'Path to .webhapp or .happ file to launch. If a .happ file is passed, either a UI path must be specified via --ui-path or a port pointing to a localhost server via --ui-port',
@@ -53,6 +51,12 @@ cli
     ),
   )
   .option('--network-seed <string>', 'Install the app with a specific network seed.')
+  .addOption(
+    new Option(
+      '-t, --target-arc-factor <number>',
+      'Set the target arc factor for all conductors. In normal operation, leave this as the default 1. For leacher/zero-arc nodes that do not contribute to gossip, set to 0.',
+    ).argParser(parseInt),
+  )
   .option('--ui-path <path>', "Path to the folder containing the index.html of the webhapp's UI.")
   .option(
     '--ui-port <number>',
@@ -206,6 +210,7 @@ async function spawnSandboxes(
   signalUrl: string,
   appId: string,
   networkSeed?: string,
+  targetArcFactor?: number,
 ): Promise<
   [childProcess.ChildProcessWithoutNullStreams, Array<string>, Record<number, PortsInfo>]
 > {
@@ -220,7 +225,7 @@ async function spawnSandboxes(
     '--run',
   ];
   let appPorts = '';
-  for (var i = 1; i <= nAgents; i++) {
+  for (let i = 1; i <= nAgents; i++) {
     const appPort = await getPort();
     appPorts += `${appPort},`;
   }
@@ -230,7 +235,11 @@ async function spawnSandboxes(
     generateArgs.push('--network-seed');
     generateArgs.push(networkSeed);
   }
-  generateArgs.push(happPath, 'network', '--bootstrap', bootStrapUrl, 'webrtc', signalUrl);
+  generateArgs.push(happPath, 'network');
+  if (targetArcFactor !== undefined) {
+    generateArgs.push('--target-arc-factor', targetArcFactor.toString());
+  }
+  generateArgs.push('--bootstrap', bootStrapUrl, 'webrtc', signalUrl);
   // console.log('GENERATE ARGS: ', generateArgs);
 
   let readyConductors = 0;
@@ -302,6 +311,7 @@ app.whenReady().then(async () => {
     CLI_OPTS.singalingUrl ? CLI_OPTS.singalingUrl : signalingUrl,
     CLI_OPTS.appId,
     CLI_OPTS.networkSeed,
+    CLI_OPTS.targetArcFactor,
   );
 
   const lairUrls: string[] = [];
@@ -324,7 +334,7 @@ app.whenReady().then(async () => {
 
   // open browser window for each sandbox
   //
-  for (var i = 0; i < CLI_OPTS.numAgents; i++) {
+  for (let i = 0; i < CLI_OPTS.numAgents; i++) {
     const zomeCallSigner = await rustUtils.ZomeCallSigner.connect(lairUrls[i], 'pass');
 
     const adminPort = portsInfo[i].admin_port;

package/src/main/menu.ts

@@ -49,41 +49,41 @@ export const menu = Menu.buildFromTemplate([
     ],
   },
   {
-    label: "Edit",
+    label: 'Edit',
     submenu: [
       {
-        label: "Undo",
-        role: "undo",
-        accelerator: "CommandOrControl+Z"
+        label: 'Undo',
+        role: 'undo',
+        accelerator: 'CommandOrControl+Z',
       },
       {
-        label: "Redo",
-        role: "redo",
-        accelerator: "CommandOrControl+Shift+Z"
+        label: 'Redo',
+        role: 'redo',
+        accelerator: 'CommandOrControl+Shift+Z',
       },
       {
-        type: "separator"
+        type: 'separator',
       },
       {
-        label: "Cut",
-        role: "cut",
-        accelerator: "CommandOrControl+X"
+        label: 'Cut',
+        role: 'cut',
+        accelerator: 'CommandOrControl+X',
       },
       {
-        label: "Copy",
-        role: "copy",
-        accelerator: "CommandOrControl+C"
+        label: 'Copy',
+        role: 'copy',
+        accelerator: 'CommandOrControl+C',
       },
       {
-        label: "Paste",
-        role: "paste",
-        accelerator: "CommandOrControl+V"
+        label: 'Paste',
+        role: 'paste',
+        accelerator: 'CommandOrControl+V',
       },
       {
-        label: "Select All",
-        role: "selectAll",
-        accelerator: "CommandOrControl+A"
-      }
-    ]
-  }
+        label: 'Select All',
+        role: 'selectAll',
+        accelerator: 'CommandOrControl+A',
+      },
+    ],
+  },
 ]);

package/src/main/validateArgs.ts

@@ -1,5 +1,6 @@
 import fs from 'fs';
 import path from 'path';
+
 import { UISource } from './windows';
 
 export type CliOpts = {
@@ -7,6 +8,7 @@ export type CliOpts = {
   holochainPath?: string;
   numAgents?: number;
   networkSeed?: string;
+  targetArcFactor?: number;
   uiPath?: string;
   uiPort?: number;
   signalingUrl?: string;
@@ -19,6 +21,7 @@ export type CliOptsValidated = {
   holochainPath: string | undefined;
   numAgents: number;
   networkSeed: string | undefined;
+  targetArcFactor: number | undefined;
   uiSource: UISource;
   singalingUrl: string | undefined;
   bootstrapUrl: string | undefined;
@@ -52,11 +55,22 @@ export function validateCliArgs(
       `Path to .happ or .webhapp file passed as argument does not exist: ${happOrWebhappPath}`,
     );
   }
-  if (cliOpts.numAgents && typeof cliOpts.numAgents !== 'number') {
+  if (
+    cliOpts.numAgents !== undefined &&
+    (typeof cliOpts.numAgents !== 'number' || Number.isNaN(cliOpts.numAgents))
+  ) {
     throw new Error(
       `The --num-agents (-n) option must be of type number but got: ${cliOpts.numAgents}`,
     );
   }
+  if (
+    cliOpts.targetArcFactor !== undefined &&
+    (typeof cliOpts.targetArcFactor !== 'number' || Number.isNaN(cliOpts.targetArcFactor))
+  ) {
+    throw new Error(
+      `The --target-arc-factor (-t) option must be a valid number but got: ${cliOpts.targetArcFactor}`,
+    );
+  }
   const isHapp = happOrWebhappPath.endsWith('.happ');
   if (isHapp && !cliOpts.uiPath && !cliOpts.uiPort) {
     throw new Error(
@@ -78,6 +92,7 @@ export function validateCliArgs(
     holochainPath,
     numAgents,
     networkSeed: cliOpts.networkSeed,
+    targetArcFactor: cliOpts.targetArcFactor,
     uiSource: cliOpts.uiPath
       ? { type: 'path', path: cliOpts.uiPath }
       : cliOpts.uiPort

package/src/main/vite-env.d.ts

@@ -0,0 +1,3 @@
+declare const __PACKAGE_VERSION__: string;
+
+declare const __HOLOCHAIN_VERSION__: string;

package/src/main/windows.ts

@@ -1,9 +1,10 @@
-import path from 'path';
-import fs from 'fs';
-import url from 'url';
+import { is } from '@electron-toolkit/utils';
 import { AppAuthenticationToken, InstalledAppId } from '@holochain/client';
 import { BrowserWindow, NativeImage, nativeImage, net, session, shell } from 'electron';
-import { is } from '@electron-toolkit/utils';
+import fs from 'fs';
+import path from 'path';
+import url from 'url';
+
 import { HappOrWebhappPath } from './validateArgs';
 
 export type UISource =
@@ -146,7 +147,7 @@ export async function loadHappWindow(
       return;
     }
   } else {
-    throw new Error('Unsupported uiSource type: ', (uiSource as any).type);
+    throw new Error(`Unsupported uiSource: ${JSON.stringify(uiSource)}`);
   }
 
   happWindow.show();

package/tsconfig.node.json

@@ -1,8 +1,9 @@
 {
   "extends": "@electron-toolkit/tsconfig/tsconfig.node.json",
-  "include": ["electron.vite.config.*", "src/main/*", "src/preload/*"],
+  "include": ["electron.vite.config.*", "src/main/*", "src/preload/*", "package.json"],
   "compilerOptions": {
     "composite": true,
-    "types": ["electron-vite/node"]
+    "types": ["electron-vite/node"],
+    "resolveJsonModule": true
   }
 }