From 81c24fe7ec879bc83deeef9ae771a84e24bccbbb Mon Sep 17 00:00:00 2001 From: Derrick Hammer Date: Tue, 4 Jul 2023 05:14:36 -0400 Subject: [PATCH] refactor: move to new sdks and portal --- build.js | 14 --- package.json | 48 +++------ patches/b4a@1.6.3.patch | 36 ------- src-build/build.ts | 218 ---------------------------------------- src/index.ts | 6 +- tsconfig.build.json | 14 --- tsconfig.json | 13 --- 7 files changed, 20 insertions(+), 329 deletions(-) delete mode 100644 build.js delete mode 100644 patches/b4a@1.6.3.patch delete mode 100644 src-build/build.ts delete mode 100644 tsconfig.build.json delete mode 100644 tsconfig.json diff --git a/build.js b/build.js deleted file mode 100644 index cca2a6f..0000000 --- a/build.js +++ /dev/null @@ -1,14 +0,0 @@ -import esbuild from "esbuild"; - -esbuild.buildSync({ - entryPoints: ["src/index.ts"], - outfile: "dist/index.js", - format: "esm", - bundle: true, - legalComments: "external", - // minify: true - define: { - global: "self", - }, - external: ["libkernel"], -}); diff --git a/package.json b/package.json index 5510ee4..316eb5a 100644 --- a/package.json +++ b/package.json @@ -2,41 +2,25 @@ "name": "@lumeweb/kernel-rpc", "version": "0.1.0", "type": "module", - "scripts": { - "test": "jest", - "build-script": "tsc --project tsconfig.build.json && mv dist-build/build.js dist-build/build.mjs", - "compile": "npm run build-script && rimraf node_modules/@lumeweb/dht-rpc-client/node_modules node_modules/@lumeweb/kernel-dht-client/node_modules/libkmodule && node build.js", - "build": "npm run compile && node ./dist-build/build.mjs dev" + "repository": { + "type": "git", + "url": "gitea@git.lumeweb.com:LumeWeb/kernel-rpc.git" }, + "scripts": { + "prepare": "presetter bootstrap", + "build": "run build", + "semantic-release": "semantic-release" + }, + "readme": "ERROR: No README data found!", + "_id": "@lumeweb/kernel-rpc@0.1.0", "dependencies": { - "@lumeweb/interface-relay": "git+https://git.lumeweb.com/LumeWeb/interface-relay.git", - "@lumeweb/kernel-swarm-client": "git+https://git.lumeweb.com/LumeWeb/kernel-swarm-client.git", - "@lumeweb/libkernel-universal": "git+https://git.lumeweb.com/LumeWeb/libkernel-universal.git", - "@lumeweb/protomux-rpc-web": "git+https://git.lumeweb.com/LumeWeb/protomux-rpc-web.git", - "@lumeweb/rpc-client": "git+https://git.lumeweb.com/LumeWeb/rpc-client.git", - "b4a": "^1.6.3", - "libkmodule": "^0.2.53", - "p-defer": "^4.0.0" + "@lumeweb/kernel-swarm-client": "^0.0.2-develop.2", + "@lumeweb/libkernel": "^0.1.0-develop.14", + "@lumeweb/rpc-client": "^0.0.2-develop.1" }, "devDependencies": { - "@scure/bip39": "^1.2.0", - "@skynetlabs/skynet-nodejs": "^2.9.0", - "@types/b4a": "^1.6.0", - "@types/node": "^18.15.11", - "@types/read": "^0.0.29", - "cli-progress": "^3.12.0", - "esbuild": "^0.17.17", - "read": "^2.1.0", - "timers-browserify": "^2.0.12", - "typescript": "^5.0.4" - }, - "browser": { - "timers": "timers-browserify", - "protomux-rpc": "@lumeweb/protomux-rpc-web" - }, - "pnpm": { - "patchedDependencies": { - "b4a@1.6.3": "patches/b4a@1.6.3.patch" - } + "@lumeweb/interface-relay": "^0.0.2-develop.1", + "@lumeweb/presetter-kernel-module-preset": "^0.1.0-develop.30", + "presetter": "^4.0.1" } } diff --git a/patches/b4a@1.6.3.patch b/patches/b4a@1.6.3.patch deleted file mode 100644 index 13e4b09..0000000 --- a/patches/b4a@1.6.3.patch +++ /dev/null @@ -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" - }, \ No newline at end of file diff --git a/src-build/build.ts b/src-build/build.ts deleted file mode 100644 index c0833e3..0000000 --- a/src-build/build.ts +++ /dev/null @@ -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 module:", 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(""); -} diff --git a/src/index.ts b/src/index.ts index 6e880a5..a528f5c 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,5 +1,5 @@ -import { addHandler, handleMessage } from "libkmodule"; -import type { ActiveQuery } from "libkmodule"; +import { addHandler, handleMessage } from "@lumeweb/libkernel/module"; +import type { ActiveQuery } from "@lumeweb/libkernel/module"; import { createClient, SwarmClient } from "@lumeweb/kernel-swarm-client"; import { RpcNetwork, RpcQueryOptions, setupStream } from "@lumeweb/rpc-client"; import type { RPCRequest, RPCResponse } from "@lumeweb/interface-relay"; @@ -42,6 +42,7 @@ async function handlePresentSeed() { async function handleCreateNetwork(aq: ActiveQuery) { aq.respond(await createNetwork(false)); } + async function handleSimpleQuery(aq: ActiveQuery) { const { query = undefined, @@ -93,6 +94,7 @@ async function handleReady(aq: ActiveQuery) { ).readyWithRelays; aq.respond(); } + async function createNetwork(def = true): Promise { const dhtInstance = new RpcNetwork(createClient(def)); const id = nextId(); diff --git a/tsconfig.build.json b/tsconfig.build.json deleted file mode 100644 index 90439ba..0000000 --- a/tsconfig.build.json +++ /dev/null @@ -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__/*"] -} diff --git a/tsconfig.json b/tsconfig.json deleted file mode 100644 index c24bef2..0000000 --- a/tsconfig.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "compilerOptions": { - "target": "esnext", - "declaration": true, - "moduleResolution": "node", - "outDir": "./build", - "strict": true, - "allowSyntheticDefaultImports": true, - "esModuleInterop": true - }, - "include": ["src"], - "exclude": ["node_modules", "**/__tests__/*"] -}