chore(release): 0.1.0-develop.3 [skip ci]

# [0.1.0-develop.3](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/compare/v0.1.0-develop.2...v0.1.0-develop.3) (2023-07-29)

### Features

* add name api ([e612211](e6122110c5))

.github/workflows/ci.yml

@@ -0,0 +1,13 @@
+name: Build/Publish
+
+on:
+    push:
+        branches:
+            - master
+            - develop
+            - develop-*
+
+jobs:
+    main:
+        uses: lumeweb/github-node-deploy-workflow/.github/workflows/main.yml@master
+        secrets: inherit

.presetterrc.json

@@ -0,0 +1,18 @@
+{
+    "preset": [
+        "@lumeweb/presetter-kernel-module-preset"
+    ],
+    "config": {
+        "vite": {
+            "resolve": {
+                "alias": {
+                    "timers": "timers-browserify",
+                    "protomux": "@lumeweb/kernel-protomux-client"
+                }
+            },
+            "optimize": {
+                "node-fetch": "export default undefined;"
+            }
+        }
+    }
+}

CHANGELOG.md

@@ -0,0 +1,24 @@
+# [0.1.0-develop.3](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/compare/v0.1.0-develop.2...v0.1.0-develop.3) (2023-07-29)
+
+
+### Features
+
+* add name api ([e612211](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/commit/e6122110c5e9d42773aeb57e0bfee2cee0e6febf))
+
+# [0.1.0-develop.2](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/compare/v0.1.0-develop.1...v0.1.0-develop.2) (2023-07-23)
+
+# [0.1.0-develop.1](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/compare/v0.0.2-develop.1...v0.1.0-develop.1) (2023-07-23)
+
+
+### Bug Fixes
+
+* await swarm.join ([f08c87c](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/commit/f08c87c1845b7561c9aea1f7c21cf1f5528f92b7))
+* need to override protomux with our kernel-protomux-client ([61050a5](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/commit/61050a5a054686c65a4e1e58035e39b6e37c25d6))
+
+
+### Features
+
+* add registry api for use with network registry ([f5ce851](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/commit/f5ce8518bb5261fbf25d5281c9f31ead99d735fd))
+* add status api ([024c810](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/commit/024c810edf8a9f57693d89d44c785306d3edee89))
+
+## [0.0.2-develop.1](https://git.lumeweb.com/LumeWeb/kernel-handshake-node/compare/v0.0.1...v0.0.2-develop.1) (2023-07-06)

README.md

@@ -1,2 +0,0 @@
-# kernel-handshake-node
-

build.js

@@ -1,14 +0,0 @@
-import esbuild from "esbuild";
-
-esbuild.buildSync({
-  entryPoints: ["src/index.ts"],
-  outfile: "dist/index.js",
-  format: "iife",
-  bundle: true,
-  legalComments: "external",
-  //  minify: true
-  define: {
-    global: "self",
-  },
-    external: ['dns']
-});

package.json

@@ -1,65 +1,39 @@
 {
     "name": "@lumeweb/kernel-handshake-node",
     "types": "module",
+    "repository": {
+        "type": "git",
+        "url": "gitea@git.lumeweb.com:LumeWeb/kernel-handshake-node.git"
+    },
     "author": {
         "name": "Hammer Technologies LLC",
         "email": "contact@lumeweb.com"
     },
-    "scripts": {
-        "test": "jest",
-        "format": "prettier -w src",
-        "build-script": "tsc --project tsconfig.build.json && mv dist-build/build.js dist-build/build.mjs",
-        "compile": "npm run build-script && tsc && rollup -c rollup.config.js",
-        "build": "npm run compile && node ./dist-build/build.mjs dev"
-    },
     "type": "module",
-    "dependencies": {
+    "version": "0.1.0-develop.3",
-        "@lumeweb/kernel-swarm-client": "git+https://git.lumeweb.com/LumeWeb/kernel-swarm-client.git",
+    "readme": "ERROR: No README data found!",
-        "@lumeweb/libhyperproxy": "git+https://git.lumeweb.com/LumeWeb/libhyperproxy.git",
+    "scripts": {
-        "hsd": "github:handshake-org/hsd",
+        "prepare": "presetter bootstrap",
-        "libkmodule": "^0.2.53",
+        "build": "run build",
-        "p-defer": "^4.0.0"
+        "semantic-release": "semantic-release",
+        "postinstall": "patch-package"
     },
     "devDependencies": {
+        "@lumeweb/presetter-kernel-module-preset": "^0.1.0-develop.43",
+        "patch-package": "^7.0.0",
+        "presetter": "*",
+        "timers-browserify": "^2.0.12",
+        "vite": "^4.4.0"
+    },
+    "dependencies": {
         "@i2labs/dns": "^1.0.1",
-        "@rollup/plugin-alias": "^4.0.4",
+        "@lumeweb/kernel-network-registry-client": "^0.1.0-develop.5",
-        "@rollup/plugin-commonjs": "^24.1.0",
+        "@lumeweb/kernel-protomux-client": "^0.0.2-develop.15",
-        "@rollup/plugin-inject": "^5.0.3",
+        "@lumeweb/kernel-swarm-client": "^0.1.0-develop.5",
-        "@rollup/plugin-json": "^6.0.0",
+        "@lumeweb/libhyperproxy": "^0.0.2-develop.2",
-        "@rollup/plugin-node-resolve": "^15.0.2",
+        "@lumeweb/libkernel": "^0.1.0-develop.31",
-        "@rollup/plugin-typescript": "^11.1.0",
+        "assert": "^2.0.0",
-        "@screamingvoid/sodium-universal": "^0.1.1",
+        "hsd": "^5.0.1",
-        "@scure/bip39": "^1.2.0",
+        "p-defer": "^4.0.0"
-        "@skynetlabs/skynet-nodejs": "^2.9.0",
-        "@types/node": "^18.15.11",
-        "@types/read": "^0.0.29",
-        "@types/streamx": "^2.9.1",
-        "cli-progress": "^3.12.0",
-        "esbuild": "^0.17.17",
-        "eventemitter3": "^5.0.0",
-        "node-stdlib-browser": "^1.2.0",
-        "os-browserify": "^0.3.0",
-        "path-browserify": "^1.0.1",
-        "prettier": "^2.8.7",
-        "read": "^2.1.0",
-        "rollup": "^3.20.3",
-        "rollup-plugin-polyfill": "^4.0.0",
-        "rollup-plugin-polyfill-inject": "^1.0.4",
-        "rollup-plugin-polyfill-node": "^0.12.0",
-        "setimmediate": "^1.0.5",
-        "tslib": "^2.5.0",
-        "typescript": "^4.9.5",
-        "util": "^0.12.5",
-        "vite": "^4.2.1",
-        "vite-plugin-node-polyfills": "^0.7.0",
-        "vite-plugin-node-stdlib-browser": "^0.1.1"
-    },
-    "pnpm": {
-        "overrides": {
-            "protomux": "git+https://git.lumeweb.com/LumeWeb/kernel-protomux-client.git"
-        },
-        "patchedDependencies": {
-            "b4a@1.6.3": "patches/b4a@1.6.3.patch"
-        }
     }
 }

patches/b4a@1.6.3.patch

@@ -1,36 +0,0 @@
-diff --git a/browser.js b/browser.js
-index e07f78d17b7b4a2963e4f0062047cc96e6025f9e..a9f266a2644f3f8ebd0f6684b3e11a7519059851 100644
---- a/browser.js
-+++ b/browser.js
-@@ -3,6 +3,7 @@ const base64 = require('./lib/base64')
- const hex = require('./lib/hex')
- const utf8 = require('./lib/utf8')
- const utf16le = require('./lib/utf16le')
-+const Buffer = require('buffer').Buffer
- 
- const LE = new Uint8Array(Uint16Array.of(0xff).buffer)[0] === 0xff
- 
-diff --git a/index.js b/index.js
-index a751d6b4d27c7dd903efbfdc87a98f61044a62b8..8bd32640afdcfbc475168d458c51f8b9162d1656 100644
---- a/index.js
-+++ b/index.js
-@@ -1,3 +1,5 @@
-+const Buffer = require('buffer').Buffer
-+
- function isBuffer (value) {
-   return Buffer.isBuffer(value) || value instanceof Uint8Array
- }
-diff --git a/package.json b/package.json
-index eb0f792709b27e66f26658054781b4099507b5ed..69c4ff39c48b0bdd5f0bc7ebbade517e7c5d76e4 100644
---- a/package.json
-+++ b/package.json
-@@ -8,9 +8,6 @@
-     "index.js",
-     "lib"
-   ],
--  "browser": {
--    "./index.js": "./browser.js"
--  },
-   "scripts": {
-     "test": "standard && brittle test/*.mjs"
-   },

rollup.config.js

@@ -1,37 +0,0 @@
-import resolve from "@rollup/plugin-node-resolve";
-import commonjs from "@rollup/plugin-commonjs";
-import json from "@rollup/plugin-json";
-import stdLibBrowser from "node-stdlib-browser";
-import { handleCircularDependancyWarning } from "node-stdlib-browser/helpers/rollup/plugin";
-import alias from "@rollup/plugin-alias";
-import inject from "@rollup/plugin-inject";
-import { defineConfig } from "rollup";
-import * as fs from "fs";
-import path from "path";
-
-export default defineConfig({
-  input: "build/index.js",
-  output: {
-    file: "dist/index.js",
-    format: "iife",
-    inlineDynamicImports: true,
-    banner: fs.readFileSync(
-      path.resolve("node_modules/setimmediate/setImmediate.js")
-    ),
-  },
-  plugins: [
-    json(),
-    alias({
-      entries: stdLibBrowser,
-    }),
-    resolve({ browser: true, preferBuiltins: true, dedupe: ["libkmodule"] }),
-    commonjs({ transformMixedEsModules: true }),
-    inject({
-      process: stdLibBrowser.process,
-      Buffer: [stdLibBrowser.buffer, "Buffer"],
-    }),
-  ],
-  onwarn: (warning, rollupWarn) => {
-    handleCircularDependancyWarning(warning, rollupWarn);
-  },
-});

src-build/build.ts

@@ -1,218 +0,0 @@
-// This is the standard build script for a kernel module.
-
-import * as fs from "fs";
-import read from "read";
-import * as bip39 from "@scure/bip39";
-import { wordlist } from "@scure/bip39/wordlists/english.js";
-//@ts-ignore
-import { SkynetClient } from "@skynetlabs/skynet-nodejs";
-
-// Helper variables to make it easier to return empty values alongside errors.
-const nu8 = new Uint8Array(0);
-const nkp = {
-  publicKey: nu8,
-  secretKey: nu8,
-};
-
-// readFile is a wrapper for fs.readFileSync that handles the try-catch for the
-// caller.
-function readFile(fileName: string): [string, string | null] {
-  try {
-    let data = fs.readFileSync(fileName, "utf8");
-    return [data, null];
-  } catch (err) {
-    return ["", "unable to read file: " + JSON.stringify(err)];
-  }
-}
-
-// readFileBinary is a wrapper for fs.readFileSync that handles the try-catch
-// for the caller.
-function readFileBinary(fileName: string): [Uint8Array, string | null] {
-  try {
-    let data = fs.readFileSync(fileName, null);
-    return [data, null];
-  } catch (err) {
-    return [nu8, "unable to read file: " + JSON.stringify(err)];
-  }
-}
-
-// writeFile is a wrapper for fs.writeFileSync which handles the try-catch in a
-// non-exception way.
-function writeFile(fileName: string, fileData: string): string | null {
-  try {
-    fs.writeFileSync(fileName, fileData);
-    return null;
-  } catch (err) {
-    return "unable to write file: " + JSON.stringify(err);
-  }
-}
-
-// handlePass handles all portions of the script that occur after the password
-// has been requested. If no password needs to be requested, handlePass will be
-// called with a null input. We need to structure the code this way because the
-// password reader is async and we can only access the password when using a
-// callback.
-function handlePass(password: string) {
-  try {
-    // If we are running prod and the seed file does not exist, we
-    // need to confirm the password and also warn the user to use a
-    // secure password.
-    if (!fs.existsSync(seedFile) && process.argv[2] === "prod") {
-      // The file does not exist, we need to confirm the
-      // password.
-      console.log();
-      console.log(
-        "No production entry found for module. Creating new production module..."
-      );
-      console.log(
-        "If someone can guess the password, they can push arbitrary changes to your module."
-      );
-      console.log("Please use a secure password.");
-      console.log();
-      read(
-        { prompt: "Confirm Password: ", silent: true },
-        function (err: any, confirmPassword: string) {
-          if (err) {
-            console.error("unable to fetch password:", err);
-            process.exit(1);
-          }
-          if (password !== confirmPassword) {
-            console.error("passwords do not match");
-            process.exit(1);
-          }
-          handlePassConfirm(moduleSalt, password);
-        }
-      );
-    } else {
-      // If the seed file does exist, or if we are using dev,
-      // there's no need to confirm the password but we do
-      // need to pass the logic off to the handlePassConfirm
-      // callback.
-      handlePassConfirm(moduleSalt, password);
-    }
-  } catch (err) {
-    console.error("Unable to read seedFile:", err);
-    process.exit(1);
-  }
-}
-
-// handlePassConfirm handles the full script after the confirmation password
-// has been provided. If not confirmation password is needed, this function
-// will be called anyway using the unconfirmed password as input.
-function handlePassConfirm(seed: string, password: string) {
-  // Create the seedFile if it does not exist. For dev we just save the
-  // seed to disk outright, because this is a dev build and therefore not
-  // security sensitive. Also the dev seed does not get pushed to the
-  // github repo.
-  //
-  // For prod, we use the seed to create a new seed (called the shield)
-  // which allows us to verify that the developer has provided the right
-  // password when deploying the module. The shield does get pushed to
-  // the github repo so that the production module is the same on all
-  // devices.
-  if (!fs.existsSync(seedFile) && process.argv[2] !== "prod") {
-    // Generate the seed phrase and write it to the file.
-    let seedPhrase = bip39.generateMnemonic(wordlist);
-    let errWF = writeFile(seedFile, seedPhrase);
-    if (errWF !== null) {
-      console.error("unable to write file:", errWF);
-      process.exit(1);
-    }
-  } else if (!fs.existsSync(seedFile) && process.argv[2] === "prod") {
-    // Generate the seed phrase.
-    let seedPhrase = bip39.generateMnemonic(wordlist);
-    // Write the registry link to the file.
-  }
-
-  // Load or verify the seed. If this is prod, the password is used to
-  // create and verify the seed. If this is dev, we just load the seed
-  // with no password.
-  let seedPhrase: string;
-  let registryLink: string;
-  if (process.argv[2] === "prod") {
-    // Generate the seed phrase from the password.
-    seedPhrase = bip39.generateMnemonic(wordlist);
-  } else {
-    let [sp, errRF] = readFile(seedFile);
-    if (errRF !== null) {
-      console.error("unable to read seed phrase for dev command from disk");
-      process.exit(1);
-    }
-    seedPhrase = sp;
-  }
-
-  let metadata = {
-    Filename: "index.js",
-  };
-  const client = new SkynetClient("https://web3portal.com");
-  client
-    .uploadFile("dist/index.js")
-    .then((result: any) => {
-      console.log("Immutable Link for kernel:", result);
-    })
-    .catch((err: any) => {
-      console.error("unable to upload file", err);
-      process.exit(1);
-    });
-}
-
-// Add a newline for readability.
-console.log();
-
-// Check for a 'dev' or 'prod' input to the script.
-if (process.argv.length !== 3) {
-  console.error("need to provide either 'dev' or 'prod' as an input");
-  process.exit(1);
-}
-
-// Create the build folder if it does not exist.
-if (!fs.existsSync("build")) {
-  fs.mkdirSync("build");
-}
-
-// Determine the seed file.
-let seedFile: string;
-if (process.argv[2] === "prod") {
-  seedFile = "module-skylink";
-} else if (process.argv[2] === "dev") {
-  seedFile = "build/dev-seed";
-} else {
-  console.error("need to provide either 'dev' or 'prod' as an input");
-  process.exit(1);
-}
-
-// If doing a prod deployment, check whether the salt file exists. If it does
-// not, create it.
-let moduleSalt: string;
-if (!fs.existsSync(".module-salt")) {
-  moduleSalt = bip39.generateMnemonic(wordlist);
-  let errWF = writeFile(".module-salt", moduleSalt);
-  if (errWF !== null) {
-    console.error("unable to write module salt file:", errWF);
-    process.exit(1);
-  }
-} else {
-  let [ms, errRF] = readFile(".module-salt");
-  if (errRF !== null) {
-    console.error("unable to read moduleSalt");
-    process.exit(1);
-  }
-  ms = ms.replace(/\n$/, "");
-  moduleSalt = ms;
-}
-
-// Need to get a password if this is a prod build.
-if (process.argv[2] === "prod") {
-  read(
-    { prompt: "Password: ", silent: true },
-    function (err: any, password: string) {
-      if (err) {
-        console.error("unable to fetch password:", err);
-        process.exit(1);
-      }
-      handlePass(password);
-    }
-  );
-} else {
-  handlePass("");
-}

src/index.ts

@@ -1,6 +1,7 @@
-import type { ActiveQuery } from "libkmodule";
+import type { ActiveQuery } from "@lumeweb/libkernel/module";
-import { addHandler, handleMessage } from "libkmodule";
+import { addHandler, handleMessage } from "@lumeweb/libkernel/module";
-import { createClient } from "@lumeweb/kernel-swarm-client";
+import { createClient as createSwarmClient } from "@lumeweb/kernel-swarm-client";
+import { createClient as createNetworkRegistryClient } from "@lumeweb/kernel-network-registry-client";
 import {
   createServer,
   DummySocket,
@@ -13,6 +14,7 @@ import dns from "@i2labs/dns";
 import assert from "assert";
 
 const PROTOCOL = "lumeweb.proxy.handshake";
+const TYPES = ["blockchain"];
 
 onmessage = handleMessage;
 
@@ -21,7 +23,10 @@ let moduleLoaded: Promise<void> = new Promise((resolve) => {
   moduleLoadedResolve = resolve;
 });
 
-addHandler("presentSeed", handlePresentSeed);
+addHandler("presentKey", handlePresentKey);
+addHandler("register", handleRegister);
+addHandler("status", handleStatus, { receiveUpdates: true });
+addHandler("name", handleName);
 addHandler("ready", handleReady);
 addHandler("query", handleQuery);
 
@@ -29,6 +34,8 @@ let swarm;
 let proxy: MultiSocketProxy;
 let node: SPVNode;
 
+const networkRegistry = createNetworkRegistryClient();
+
 function resolveWithPeers(resolve: Function) {
   if (!node.pool.peers.head()) {
     node.pool.on("peer", () => {
@@ -60,8 +67,8 @@ function resolveWithPeers(resolve: Function) {
   return resolve(null);
 }
 
-async function handlePresentSeed(aq: ActiveQuery) {
+async function handlePresentKey(aq: ActiveQuery) {
-  swarm = createClient();
+  swarm = createSwarmClient();
 
   const peerConnected = defer();
   node = new SPVNode({
@@ -107,8 +114,8 @@ async function handlePresentSeed(aq: ActiveQuery) {
       "208.67.220.222",
     ]);
 
-    const out = [];
+    const out: string[] = [];
-    const types = [];
+    const types: string[] = [];
 
     if (family == null || family === 4) types.push("A");
 
@@ -148,7 +155,7 @@ async function handlePresentSeed(aq: ActiveQuery) {
     peerConnected.resolve();
   });
 
-  swarm.join(PROTOCOL);
+  await swarm.join(PROTOCOL);
   await swarm.start();
 
   await peerConnected.promise;
@@ -188,3 +195,48 @@ async function handleQuery(aq: ActiveQuery) {
     aq.reject((e as Error).message);
   }
 }
+
+async function handleRegister(aq: ActiveQuery) {
+  await networkRegistry.registerNetwork(TYPES);
+
+  aq.respond();
+}
+
+async function handleStatus(aq: ActiveQuery) {
+  let chainProgress = node.chain.getProgress();
+  let chainPeers = node.pool.peers.size();
+
+  const chainProgressListener = node.chain.on("tip", () => {
+    chainProgress = node.chain.getProgress();
+    sendUpdate();
+  });
+
+  function peersListener() {
+    chainPeers = node.pool.peers.size();
+    sendUpdate();
+  }
+
+  node.pool.on("peer", peersListener);
+  node.pool.on("peer close", peersListener);
+
+  function sendUpdate() {
+    aq.sendUpdate({
+      sync: chainProgress * 100,
+      peers: chainPeers,
+      ready: node.chain.synced,
+    });
+  }
+
+  aq.setReceiveUpdate?.(() => {
+    node.chain.off("tip", chainProgressListener);
+    node.pool.off("peer", peersListener);
+    node.pool.off("peer close", peersListener);
+    aq.respond();
+  });
+
+  sendUpdate();
+}
+
+function handleName(aq: ActiveQuery) {
+  aq.respond("Handshake");
+}

tsconfig.build.json

@@ -1,14 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "esnext",
-		"module": "esnext",
-		"moduleResolution": "node",
-		"allowSyntheticDefaultImports": true,
-		"declaration": true,
-		"outDir": "./dist-build",
-		"strict": true,
-        "esModuleInterop": true
-	},
-	"include": ["src-build"],
-	"exclude": ["node_modules", "**/__tests__/*"]
-}

tsconfig.json

@@ -1,12 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "esnext",
-		"declaration": true,
-		"moduleResolution": "node",
-		"outDir": "./build",
-		"strict": true,
-        "allowSyntheticDefaultImports": true
-    },
-	"include": ["src"],
-	"exclude": ["node_modules", "**/__tests__/*"]
-}