@witnet/sdk 3.0.0 → 3.0.3

package/src/bin/cli/radon.js

@@ -14,146 +14,99 @@ import { utils, Witnet } from "../../../dist/src/index.js";
 import { default as legacy } from "../../../witnet/assets/index.cjs";
 import * as helpers from "../helpers.js";
 
-const WITNET_ASSETS_PATH = process.env.WITNET_SDK_RADON_ASSETS_PATH || "../../../../../witnet/assets";
-
 /// ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /// CLI SUBMODULE CONSTANTS ===========================================================================================
 
-const isModuleInitialized = fs.existsSync("./witnet/assets/index.cjs");
+const __dirname = helpers.searchWorkspace();
+const isModuleInitialized = __dirname !== path.dirname(__dirname) && fs.existsSync(`${__dirname}/package.json`);
+const WITNET_ASSETS_PATH = process.env.WITNET_SDK_RADON_ASSETS_PATH || `${__dirname}/witnet/assets`;
 
 export const flags = {
-	module: {
-		hint: "Package where to fetch Radon assets from (supersedes --legacy).",
+	package: {
+		hint: "Imported package where to fetch Radon assets from (supersedes --legacy).",
 		param: "NPM_PACKAGE",
 	},
 };
 
-export const router = isModuleInitialized
-	? {
-			assets: {
-				hint: "List available Witnet Radon assets.",
-				params: "[RADON_ASSETS ...]",
-				options: {
-					filter: {
-						hint: "Restrict output to name-matching assets.",
-					},
-					legacy: {
-						hint: "List only those declared in witnet/assets folder.",
-					},
-					modals: {
-						hint: "Restrict output to Radon modals.",
-					},
-					requests: {
-						hint: "Restrict output to Radon requests.",
-					},
-					templates: {
-						hint: "Restrict output to Radon templates.",
-					},
-				},
+export const router = {
+	assets: {
+		hint: "List available Witnet Radon assets.",
+		params: "[RADON_ASSETS ...]",
+		options: {
+			filter: {
+				hint: "Restrict output to name-matching assets.",
 			},
-			check: {
-				hint: "Check correctness of Witnet Radon artifacts declared in witnet/assets folder.",
-				params: [],
-				options: {},
+			legacy: {
+				hint: "List only those declared within the ./witnet/assets subfolder.",
 			},
-			decode: {
-				hint: "Break down specs of one or more Radon assets.",
-				params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
-				options: {
-					bytecode: {
-						hint: "Outputs RAD bytecode as hex string (supersedes --json).",
-					},
-					json: {
-						hint: "Outputs data in JSON format.",
-					},
-					headline: {
-						hint: "Settles output report headline.",
-						param: ":string",
-					},
-					indent: {
-						hint: "Prefixes given number of white spaces for every output line.",
-						param: ":number",
-					},
-				},
+			modals: {
+				hint: "Restrict output to Radon modals.",
 			},
-			"dry-run": {
-				hint: "Simulate resolution of one or more Radon assets, as if solved by the Wit/Oracle.",
-				params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
-				options: {
-					default: {
-						hint: "Use default sample parameters on parametrized Radon assets.",
-					},
-					json: {
-						hint: "Outputs data in JSON format.",
-					},
-					headline: {
-						hint: "Settles output report headline.",
-						param: ":string",
-					},
-					indent: {
-						hint: "Prefixes given number of white spaces for every output line.",
-						param: ":number",
-					},
-					verbose: {
-						hint: "Outputs detailed dry-run report.",
-					},
-				},
+			requests: {
+				hint: "Restrict output to Radon requests.",
 			},
-		}
-	: {
-			assets: {
-				hint: "List available Witnet Radon assets.",
-				params: "[RADON_ASSETS ...]",
-				options: {
-					filter: {
-						hint: "Restrict output to name-matching assets.",
-					},
-					legacy: {
-						hint: "List only those declared in witnet/assets folder.",
-					},
-				},
+			templates: {
+				hint: "Restrict output to Radon templates.",
 			},
-			decode: {
-				hint: "Break down specs of one or more Radon assets.",
-				params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
-				options: {
-					json: {
-						hint: "Outputs data in JSON format.",
-					},
-					headline: {
-						hint: "Settles output report headline.",
-						param: ":string",
-					},
-					indent: {
-						hint: "Prefixes given number of white spaces for every output line.",
-						param: ":number",
-					},
-				},
+		},
+	},
+	decode: {
+		hint: "Break down specs of one or more Radon assets.",
+		params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
+		options: {
+			bytecode: {
+				hint: "Outputs RAD bytecode as hex string (supersedes --json).",
 			},
-			"dry-run": {
-				hint: "Simulate resolution of one or more Radon assets, as if solved by the Wit/Oracle.",
-				params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
-				options: {
-					json: {
-						hint: "Outputs data in JSON format.",
-					},
-					headline: {
-						hint: "Settles output report headline.",
-						param: ":string",
-					},
-					indent: {
-						hint: "Prefixes given number of white spaces for every output line.",
-						param: ":number",
-					},
-					verbose: {
-						hint: "Outputs detailed dry-run report.",
-					},
-				},
+			json: {
+				hint: "Outputs data in JSON format.",
+			},
+			headline: {
+				hint: "Settles output report headline.",
+				param: ":string",
+			},
+			indent: {
+				hint: "Prefixes given number of white spaces for every output line.",
+				param: ":number",
+			},
+		},
+	},
+	"dry-run": {
+		hint: "Simulate resolution of one or more Radon assets, as if solved by the Wit/Oracle.",
+		params: ["RAD_BYTECODE | RAD_HASH | RADON_ASSET"],
+		options: {
+			default: {
+				hint: "Use default sample parameters on parametrized Radon assets.",
 			},
-			init: {
-				hint: "Initialize a Witnet Radon workspace in this project.",
+			json: {
+				hint: "Outputs data in JSON format.",
 			},
-		};
+			headline: {
+				hint: "Settles output report headline.",
+				param: ":string",
+			},
+			indent: {
+				hint: "Prefixes given number of white spaces for every output line.",
+				param: ":number",
+			},
+			verbose: {
+				hint: "Outputs detailed dry-run report.",
+			},
+		},
+	},
+	...(isModuleInitialized
+		? {
+				check: {
+					hint: "Check correctness of Witnet Radon artifacts declared in witnet/assets folder.",
+					params: [],
+					options: {},
+				},
+			}
+		: {
+				init: {
+					hint: "Initialize a Witnet Radon workspace within the current folder.",
+				},
+			}),
+};
 
 export const subcommands = {
 	assets,
@@ -174,16 +127,16 @@ async function init() {
 		fs.cpSync("node_modules/@witnet/sdk/.env_witnet", ".env_witnet");
 	}
 	if (!fs.existsSync("./witnet/assets/index.js")) {
-		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_index.js", "./witnet/assets/index.js");
+		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_index.cjs", "./witnet/assets/index.cjs");
 	}
 	if (!fs.existsSync("./witnet/assets/requests.js")) {
-		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_requests.js", "./witnet/assets/requests.js");
+		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_requests.cjs", "./witnet/assets/requests.cjs");
 	}
 	if (!fs.existsSync("./witnet/assets/sources.js")) {
-		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_sources.js", "./witnet/assets/sources.js");
+		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_sources.cjs", "./witnet/assets/sources.cjs");
 	}
 	if (!fs.existsSync("./witnet/assets/templates.js")) {
-		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_templates.js", "./witnet/assets/templates.js");
+		fs.cpSync("node_modules/@witnet/sdk/witnet/assets/_templates.cjs", "./witnet/assets/templates.cjs");
 	}
 	console.info(`Initialized Witnet Radon workspace at folder ${process.cwd()}/witnet/assets`);
 }
@@ -208,9 +161,8 @@ async function assets(options = {}, [...patterns]) {
 
 async function check() {
 	if (!isModuleInitialized) {
-		throw new Error(
-			`No Witnet Radon workspace has been initialized. Please, run ${white("npx witsdk radon init")} if willing to declare your own Radon assets.`,
-		);
+		console.error(`Sorry, no Witnet workspace was initialized yet.`);
+		return;
 	}
 	try {
 		const assets = loadAssets({ legacy: true });
@@ -421,7 +373,9 @@ const stringifyReducer = (x, c) => {
 
 export function loadAssets(options) {
 	const assets = options?.legacy ? {} : legacy;
-	return isModuleInitialized ? merge(assets, require(`${WITNET_ASSETS_PATH}/index.cjs`)) : assets;
+	return fs.existsSync(`${WITNET_ASSETS_PATH}/index.cjs`)
+		? merge(assets, require(`${WITNET_ASSETS_PATH}/index.cjs`))
+		: assets;
 }
 
 function flattenRadonArtifacts(tree, headers) {
@@ -587,7 +541,8 @@ function traceWitnetRadonRequest(request, options) {
 		traceWitnetRadonReportHeadline(request, options);
 		console.info(`${indent}╚══╤═══════════════════════════════════════════════════════════════════════════╝`);
 		if (options?.bytecode) {
-			console.info(request.toBytecode());
+			console.info(`${indent}   v`);
+			console.info(helpers.colors.gray(request.toBytecode()));
 			return;
 		}
 		console.info(`${indent}┌──┴─────────────────┐`);
@@ -623,16 +578,11 @@ function traceWitnetRadonRequest(request, options) {
 					console.info(`${indent}   │ ${sep}    > HTTP body:      ${helpers.colors.green(source.body)}`);
 				}
 				if (source?.script) {
-					// console.log(source.script.toBytecode())
 					const steps = source.script.disect();
 					console.info(
-						`${indent}   │ ${sep}    > Radon script:   ${helpers.colors.lyellow(
-							"[ ",
-						)}${helpers.colors.yellow(steps[0][1])}${" ".repeat(12 - steps[0][1].length)}${helpers.colors.lyellow(
-							" ]",
-						)} ${helpers.colors.mcyan(steps[0][2])}`,
+						`${indent}   │ ${sep}    > Radon script:   [ ${helpers.colors.gray(source.script.toBytecode())} ]`,
 					);
-					steps.slice(1).forEach((step) => {
+					steps.forEach((step) => {
 						console.info(
 							`${indent}   │ ${sep}                      ${helpers.colors.lyellow(
 								"[ ",
@@ -733,10 +683,12 @@ async function traceWitnetRadonRequestDryRun(request, options) {
 	traceWitnetRadonReportHeadline(request, options);
 	const indent = options?.indent ? " ".repeat(options.indent) : "";
 	console.info(`${indent}╚══╤═══════════════════════════════════════════════════════════════════════════╝`);
-	let execTimeMs = report.retrieve
-		?.map((retrieval) => (retrieval?.running_time.secs || 0) + (retrieval?.running_time.nanos || 0) / 1000)
-		.reduce((sum, secs) => sum + secs);
-	execTimeMs = `${Math.round(execTimeMs)} ms`;
+	let execTimeMs = Math.max(
+		...(report.retrieve?.map(
+			(retrieval) => (retrieval?.running_time.secs || 0) * 1e3 + (retrieval?.running_time.nanos || 0) / 1e6,
+		) ?? 0),
+	);
+	execTimeMs = `${helpers.commas(Math.round(execTimeMs))} ms`;
 	let flexbar = "─".repeat(17);
 	let flexspc = " ".repeat(flexbar.length + 12);
 	console.info(`${indent}┌──┴─────────────────────────────${flexbar}──────┐`);
@@ -850,7 +802,7 @@ async function traceWitnetRadonRequestDryRun(request, options) {
 	}
 	if (resultSize) {
 		console.info(
-			`${indent}│ CBOR size:      ${helpers.colors.cyan(
+			`${indent}│ Encoded size:   ${helpers.colors.cyan(
 				`${resultSize} bytes`,
 			)}${" ".repeat(flexbar.length + 7 - resultSize.toString().length)} │`,
 		);

package/src/bin/helpers.js

@@ -1,7 +1,9 @@
 import { exec } from "node:child_process";
+import fs from "node:fs";
 import { createRequire } from "node:module";
 import * as net from "node:net";
 import * as os from "node:os";
+import path from "node:path";
 import * as readline from "node:readline";
 import moment from "moment";
 
@@ -595,6 +597,14 @@ export function prompter(promise) {
 	});
 }
 
+export function searchWorkspace() {
+	let workspace = path.normalize(process.cwd());
+	while (!fs.existsSync(`${workspace}/witnet/assets`) && path.dirname(workspace) !== workspace) {
+		workspace = path.dirname(workspace);
+	}
+	return workspace;
+}
+
 export function traceChecklists(checklists) {
 	if (checklists && Object.keys(checklists).length > 0) {
 		const headlines = ["NODES", ...Object.keys(checklists).map((key) => `:${key}`)];

package/src/bin/index.js

@@ -28,7 +28,7 @@ import {
 
 const __dirname = import.meta.dirname;
 
-const version = "2.0.21";
+const version = "2.0.23";
 const toolkitDownloadUrlBase = `https://github.com/witnet/witnet-rust/releases/download/${version}/`;
 const toolkitDownloadNames = {
 	win32: (arch) => `witnet_toolkit-${arch}-pc-windows-msvc.exe`,
@@ -274,10 +274,11 @@ async function main() {
 				}
 			} else {
 				showUsage(cmd, module);
+				if (args?.[0]) console.error(colors.red(`\nInvalid subcommand: ${colors.mred(args[0])}`));
 			}
 			process.exit(0);
 		} catch (e) {
-			console.error(`EXCEPTION:\n${e}\n`);
+			console.error(colors.red(`EXCEPTION:\n${e}\n`));
 		}
 	}
 	console.info("USAGE:");