nano-pow 3.1.1 → 3.1.3

package/README.md

@@ -143,7 +143,8 @@ Email: <bug-nano-pow@zoso.dev>
 implementation
 
 ## Licenses
-GPLv3 (or later) & MIT
+GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
+Portions of this code are also provided under the MIT License: <https://spdx.org/licenses/MIT.html>
 
 ## Donations
 If you find this package helpful, please consider tipping the developer.

package/dist/cli.js

@@ -2,28 +2,43 @@
 //! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 
-import * as puppeteer from 'puppeteer'
 import * as fs from 'node:fs/promises'
+import * as readline from 'node:readline/promises'
+import * as puppeteer from 'puppeteer'
+
+const hashes = []
+
+const stdinErrors = []
+if (!process.stdin.isTTY) {
+	const stdin = readline.createInterface({
+		input: process.stdin
+	})
+	for await (const line of stdin) {
+		if (/^[0-9A-Fa-f]{64}$/.test(line)) {
+			hashes.push(line)
+		} else {
+			stdinErrors.push(`Skipping invalid stdin input: ${line}`)
+		}
+	}
+}
 
 const args = process.argv.slice(2)
-if (args.length === 0 || args.some(v => v === '--help' || v === '-h')) {
+if ((hashes.length === 0 && args.length === 0) || (args.some(v => v === '--help' || v === '-h'))) {
 	console.log(`Usage: nano-pow [OPTION]... BLOCKHASH...
 Generate work for BLOCKHASH, or multiple work values for BLOCKHASH(es)
-BLOCKHASH is a 64-character hexadecimal string.
-Multiple blockhash values must be separated by spaces.
-Prints a 16-character hexadecimal work value to standard output.
-If using --validate, prints 'true' or 'false' to standard output instead.
-All command options are optional.
+BLOCKHASH is a 64-character hexadecimal string. Multiple blockhashes must be separated by whitespace or line breaks.
+Prints a 16-character hexadecimal work value to standard output. If using --validate, prints 'true' or 'false' to standard output instead.
 
   -h, --help                  show this dialog
   -d, --debug                 enable additional logging output
-  -e, --effort <value>        increase demand on GPU processing
-  -t, --threshold <value>     override the minimum threshold value
-  -v, --validate <value>      check an existing work value instead of searching for one
+	-j, --json                  format output as JSON
+  -e, --effort=<value>        increase demand on GPU processing
+  -t, --threshold=<value>     override the minimum threshold value
+  -v, --validate=<value>      check an existing work value instead of searching for one
 
 If validating a nonce, it must be a 16-character hexadecimal value.
-Effort must be a decimal number between 1 - 32.
-Threshold must be a hexadecimal number between 0x0 - 0xFFFFFFFF.
+Effort must be a decimal number between 1-32.
+Threshold must be a hexadecimal string between 0-FFFFFFFF.
 
 Report bugs: <bug-nano-pow@zoso.dev>
 Full documentation: <https://www.npmjs.com/package/nano-pow>
@@ -31,18 +46,17 @@ Full documentation: <https://www.npmjs.com/package/nano-pow>
 	process.exit()
 }
 
-const hashes = []
+const inArgs = []
 while (/^[0-9A-Fa-f]{64}$/.test(args[args.length - 1] ?? '')) {
-	hashes.unshift(args.pop())
-}
-if (hashes.length === 0) {
-	console.error('Invalid block hash input')
-	process.exit(1)
+	inArgs.unshift(args.pop())
 }
+hashes.push(...inArgs)
 
 let fn = 'search'
 let work = ''
+let isJson = false
 const options = {}
+
 for (let i = 0; i < args.length; i++) {
 	switch (args[i]) {
 		case ('--validate'):
@@ -72,13 +86,27 @@ for (let i = 0; i < args.length; i++) {
 			options['debug'] = true
 			break
 		}
+		case ('--json'):
+		case ('-j'): {
+			isJson = true
+			break
+		}
+	}
+}
+
+if (options['debug']) {
+	console.log(`NanoPowCli.${fn}()`)
+	console.log(`${fn} options`, JSON.stringify(options))
+	for (const stdinErr of stdinErrors) {
+		console.warn(stdinErr)
 	}
 }
 
-if (options['debug']) console.log(`NanoPowCli.${fn}()`)
-if (options['debug']) console.log(`${fn} options`, JSON.stringify(options))
+if (hashes.length === 0) {
+	console.error('Invalid block hash input')
+	process.exit(1)
+}
 
-	;
 /**
 * Main
 */
@@ -105,10 +133,22 @@ if (options['debug']) console.log(`${fn} options`, JSON.stringify(options))
 		const output = msg.text().split(' ')
 		if (output[0] === 'cli') {
 			if (output[1] === 'exit') {
+				if (isJson) {
+					const results = await page.evaluate(() => {
+						return window.results
+					})
+					for (let i = 0; i < results.length; i++) {
+						results[i] = {
+							blockhash: hashes[i],
+							work: results[i]
+						}
+					}
+					console.log(JSON.stringify(results, null, 4))
+				}
 				const end = performance.now()
 				if (options['debug']) console.log(end - start, 'ms total |', (end - start) / hashes.length, 'ms avg')
-				process.exit()
-			} else {
+				await browser.close()
+			} else if (!isJson) {
 				console.log(output[1])
 			}
 		} else if (options['debug']) {
@@ -128,10 +168,12 @@ if (options['debug']) console.log(`${fn} options`, JSON.stringify(options))
 				createScript: string => string,
 			})
 			${NanoPow}
+			window.results = []
 			const hashes = ["${hashes.join('","')}"]
 			for (const hash of hashes) {
 				try {
 					const work = await NanoPow.${fn}(${work}hash, ${JSON.stringify(options)})
+					window.results.push(work)
 					console.log(\`cli \${work}\`)
 				} catch (err) {
 					console.error(\`cli \${err}\`)

package/dist/main.min.js

@@ -68,6 +68,66 @@ layout(std140) uniform WORK {
 	uvec2 seed;
 };
 
+/**
+* Initialization vector defined by BLAKE2. Each vec2<u32> represents two halves
+* of the original u64 value from the reference implementation. They appear
+* reversed pairwise as defined below, but this is an illusion due to endianness:
+* the \`x\` component of the vector is the low bits and the \`y\` component is the
+* high bits, and if you laid the bits out individually, they would match the
+* little-endian 64-bit representation.
+*/
+const uvec2 BLAKE2B_IV[8] = uvec2[8](
+	uvec2(0xF3BCC908u, 0x6A09E667u),
+	uvec2(0x84CAA73Bu, 0xBB67AE85u),
+	uvec2(0xFE94F82Bu, 0x3C6EF372u),
+	uvec2(0x5F1D36F1u, 0xA54FF53Au),
+	uvec2(0xADE682D1u, 0x510E527Fu),
+	uvec2(0x2B3E6C1Fu, 0x9B05688Cu),
+	uvec2(0xFB41BD6Bu, 0x1F83D9ABu),
+	uvec2(0x137E2179u, 0x5BE0CD19u)
+);
+
+/**
+* Parameter block as defined in BLAKE2 section 2.8 and configured as follows:
+* maximal depth = 1, fanout = 1, digest byte length = 8
+*/
+const uvec2 BLAKE2B_PARAM = uvec2(0x01010008u, 0u);
+
+/**
+* Message input length which is always 40 for Nano.
+* 8 nonce bytes + 32 block hash bytes
+*/
+const uvec2 BLAKE2B_INLEN = uvec2(0x00000028u, 0u);
+
+/**
+* Finalization flag as defined in BLAKE2 section 2.4 and set to ~0 since this is
+* the final (and only) message block being hashed.
+*/
+const uvec2 BLAKE2B_FINAL = uvec2(0xFFFFFFFFu, 0xFFFFFFFFu);
+
+/**
+* Fully initialized state array that is locally copied at each thread start.
+* Application of each XOR is defined by BLAKE2 section 2.4 compression function.
+*/
+const uvec2 BLAKE2B_INIT[16] = uvec2[16](
+	BLAKE2B_IV[0u] ^ BLAKE2B_PARAM,
+	BLAKE2B_IV[1u],
+	BLAKE2B_IV[2u],
+	BLAKE2B_IV[3u],
+	BLAKE2B_IV[4u],
+	BLAKE2B_IV[5u],
+	BLAKE2B_IV[6u],
+	BLAKE2B_IV[7u],
+	BLAKE2B_IV[0u],
+	BLAKE2B_IV[1u],
+	BLAKE2B_IV[2u],
+	BLAKE2B_IV[3u],
+	BLAKE2B_IV[4u] ^ BLAKE2B_INLEN,
+	BLAKE2B_IV[5u],
+	BLAKE2B_IV[6u] ^ BLAKE2B_FINAL,
+	BLAKE2B_IV[7u]
+);
+
 // Defined separately from uint v[0].y below as the original value is required
 // to calculate the second uint32 of the digest for threshold comparison
 const uint BLAKE2B_IV32_1 = 0x6A09E667u;
@@ -79,36 +139,6 @@ const uvec4 ROTATE_16 = uvec4(16u);
 const uvec4 ROTATE_24 = uvec4(24u);
 const uvec4 ROTATE_31 = uvec4(31u);
 
-// Both buffers represent 16 uint64s as 32 uint32s
-// because that's what GLSL offers, just like Javascript
-
-// Compression buffer, intialized to 2 instances of the initialization vector
-// The following values have been modified from the BLAKE2B_IV:
-// OUTLEN is constant 8 bytes
-// v[0] ^= 0x01010000u ^ uint(OUTLEN);
-// INLEN is constant 40 bytes: work value (8) + block hash (32)
-// v[12] ^= uint(INLEN);
-// It's always the "last" compression at this INLEN
-// v[14] = ~v[14];
-const uvec2 blake2b_iv[16] = uvec2[16](
-	uvec2(0xF2BDC900u, 0x6A09E667u),
-	uvec2(0x84CAA73Bu, 0xBB67AE85u),
-	uvec2(0xFE94F82Bu, 0x3C6EF372u),
-	uvec2(0x5F1D36F1u, 0xA54FF53Au),
-	uvec2(0xADE682D1u, 0x510E527Fu),
-	uvec2(0x2B3E6C1Fu, 0x9B05688Cu),
-	uvec2(0xFB41BD6Bu, 0x1F83D9ABu),
-	uvec2(0x137E2179u, 0x5BE0CD19u),
-	uvec2(0xF3BCC908u, 0x6A09E667u),
-	uvec2(0x84CAA73Bu, 0xBB67AE85u),
-	uvec2(0xFE94F82Bu, 0x3C6EF372u),
-	uvec2(0x5F1D36F1u, 0xA54FF53Au),
-	uvec2(0xADE682F9u, 0x510E527Fu),
-	uvec2(0x2B3E6C1Fu, 0x9B05688Cu),
-	uvec2(0x04BE4294u, 0xE07C2654u),
-	uvec2(0x137E2179u, 0x5BE0CD19u)
-);
-
 // Iterated initialization vector
 uvec2 v[16];
 
@@ -162,7 +192,7 @@ void main() {
 	m[4u] = uvec2(blockhash[6u], blockhash[7u]);
 
 	// Reset v
-	v = blake2b_iv;
+	v = BLAKE2B_INIT;
 
 	// Twelve rounds of G mixing
 
@@ -240,7 +270,7 @@ void main() {
 
 	// Pixel data set from work seed values
 	// Finalize digest from high bits, low bits can be safely ignored
-	if ((BLAKE2B_IV32_1 ^ v[0u].y ^ v[8u].y) >= threshold && (search || uvec2(gl_FragCoord) == uvec2(0u))) {
+	if ((BLAKE2B_INIT[0u].y ^ v[0u].y ^ v[8u].y) >= threshold && (search || uvec2(gl_FragCoord) == uvec2(0u))) {
 		nonce = uvec4(1u, m[0u].y, m[0u].x, (uint(gl_FragCoord.x) << 16u) | uint(gl_FragCoord.y));
 	}
 

package/dist/nano-pow.1

@@ -11,15 +11,10 @@ nano-pow \- proof-of-work generation and validation for Nano cryptocurrency
 
 .SH DESCRIPTION
 Generate work for \fIBLOCKHASH\fR, or multiple work values for \fIBLOCKHASH\fR(es).
-Nano PoW documentation: <https://docs.nano.org/integration-guides/work-generation/\#work-calculation-details>
 .PP
-\fIBLOCKHASH\fR is a 64-character hexadecimal string.
+\fIBLOCKHASH\fR is a 64-character hexadecimal string. Multiple blockhashes must be separated by whitespace or line breaks.
 .PP
-Multiple blockhash values must be separated by spaces.
-.PP
-Prints a 16-character hexadecimal work value to standard output.
-.PP
-If \fB--validate\fR is used, prints 'true' or 'false' to standard output.
+Prints a 16-character hexadecimal work value to standard output. If \fB--validate\fR is used, prints 'true' or 'false' to standard output.
 
 .SH OPTIONS
 .TP
@@ -29,43 +24,54 @@ Show this help dialog and exit.
 \fB\-d\fR, \fB\-\-debug\fR
 Enable additional logging output.
 .TP
-\fB\-e\fR, \fB\-\-effort\fR \fIEFFORT\fR
+\fB\-j\fR, \fB\-\-json\fR
+Format output as JSON.
+.TP
+\fB\-e\fR, \fB\-\-effort\fR=\fIEFFORT\fR
 Increase demand on GPU processing. Must be between 1 and 32 inclusive.
 .TP
-\fB\-t\fR, \fB\-\-threshold\fR \fITHRESHOLD\fR
-Override the minimum threshold value. Higher values increase difficulty. Must be in hexadecimal format between 0x0 and 0xFFFFFFFF.
+\fB\-t\fR, \fB\-\-threshold\fR=\fITHRESHOLD\fR
+Override the minimum threshold value. Higher values increase difficulty. Must be a hexadecimal string between 0 and FFFFFFFF inclusive.
 .TP
-\fB\-v\fR, \fB\-\-validate\fR \fIWORK\fR
+\fB\-v\fR, \fB\-\-validate\fR=\fIWORK\fR
 Check an existing work value instead of searching for one.
 
 .SH EXAMPLES
+.PP
 Search for a work nonce for a blockhash using the default threshold 0xFFFFFFF8:
 .EX
-nano-pow 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
+.PP
 Search for a work nonce using a custom threshold and increased effort:
 .EX
-nano-pow \-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB\-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
-Search for multiple nonces from a file:
+.PP
+Read one or more lines of blockhashes from a file and output to another file:
 .EX
-nano-pow $(cat /path/to/file.txt)
+$ cat /path/to/file.txt | nano-pow --json > work.json
 .EE
 
+.PP
 Validate an existing work nonce against a blockhash and show debugging output:
 .EX
-nano-pow \-d \-v fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+$ nano-pow \fB\-d \-v fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
 .EE
 
 .SH AUTHOR
 Written by Chris Duncan.
 
 .SH BUGS
-Email: <mailto:bug-nano-pow@zoso.dev>
+Email <bug-nano-pow@zoso.dev>.
 
 .SH COPYRIGHT
-Copyright \(co 2025 Chris Duncan <chris@zoso.dev>
 .PP
+.EX
+Copyright \(co 2025 Chris Duncan <chris@zoso.dev>
+Nano PoW documentation: <https://docs.nano.org/integration-guides/work-generation/#work-calculation-details>
 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>
+Portions of this code are also provided under the MIT License: <https://spdx.org/licenses/MIT.html>
+.EE

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nano-pow",
-	"version": "3.1.1",
+	"version": "3.1.3",
 	"description": "Proof-of-work generation and validation with WebGPU/WebGL for Nano cryptocurrency.",
 	"keywords": [
 		"nemo",
@@ -8,6 +8,7 @@
 		"cash",
 		"crypto",
 		"currency",
+		"cryptocurrency",
 		"coin",
 		"nonce",
 		"pow",
@@ -32,8 +33,7 @@
 	],
 	"main": "dist/main.min.js",
 	"browser": {
-		"dist/main.min.js": true,
-		"node:worker_threads": false
+		"./dist/main.min.js": true
 	},
 	"bin": "./dist/cli.js",
 	"man": "./dist/nano-pow.1",
@@ -53,10 +53,12 @@
 		"typescript": "^5.8.2"
 	},
 	"type": "module",
-	"exports": [
-		"./dist/main.min.js",
-		"./dist/types.d.ts"
-	],
+	"exports": {
+		".": {
+			"types": "./dist/types.d.ts",
+			"default": "./dist/main.min.js"
+		}
+	},
 	"types": "./dist/types.d.ts",
 	"unpkg": "./dist/main.min.js",
 	"optionalDependencies": {