nano-pow 3.1.0 → 3.1.2

package/dist/cli.js

@@ -9,19 +9,18 @@ const args = process.argv.slice(2)
 if (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)
-Multiple blockhash values must be separated by spaces.
-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
+  -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
 
-Blockhash(es) must be 64-character hexadecimal values.
 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>
@@ -103,10 +102,8 @@ if (options['debug']) console.log(`${fn} options`, JSON.stringify(options))
 		const output = msg.text().split(' ')
 		if (output[0] === 'cli') {
 			if (output[1] === 'exit') {
-				if (options['debug']) {
-					const end = performance.now()
-					console.log(end - start, 'ms total |', (end - start) / hashes.length, 'ms avg')
-				}
+				const end = performance.now()
+				if (options['debug']) console.log(end - start, 'ms total |', (end - start) / hashes.length, 'ms avg')
 				process.exit()
 			} else {
 				console.log(output[1])

package/dist/nano-pow.1

@@ -1,12 +1,21 @@
+\# SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+\# SPDX-License-Identifier: GPL-3.0-or-later
+
 .TH nano-pow 1 2025-03-12 "nano-pow v3.1.0"
+
 .SH NAME
 nano-pow \- proof-of-work generation and validation for Nano cryptocurrency
+
 .SH SYNOPSIS
 \fBnano-pow\fR [\fIOPTION\fR]... \fIBLOCKHASH\fR...
+
 .SH DESCRIPTION
-Generate work for BLOCKHASH, or multiple work values for BLOCKHASH(es).
+Generate work for \fIBLOCKHASH\fR, or multiple work values for \fIBLOCKHASH\fR(es).
 .PP
-Multiple blockhash values must be separated by spaces.
+\fIBLOCKHASH\fR is a 64-character hexadecimal string. Multiple blockhashes must be separated by whitespace or line breaks.
+.PP
+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
 \fB\-h\fR, \fB\-\-help\fR
@@ -15,30 +24,50 @@ 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\-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. 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:
-\fBnano-pow 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
+.EX
+$ nano-pow \fB0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
+.EE
+
 .PP
 Search for a work nonce using a custom threshold and increased effort:
-\fBnano-pow \-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
+.EX
+$ nano-pow \fB\-t fffffe00 \-e 32 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
+.EE
+
 .PP
 Search for multiple nonces from a file:
-\fBnano-pow $(cat /path/to/file.txt)\fR
+.EX
+$ nano-pow \fB$(cat /path/to/file.txt)\fR
+.EE
+
 .PP
 Validate an existing work nonce against a blockhash and show debugging output:
-\fBnano-pow \-d \-v fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef\fR
+.EX
+$ 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
+.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>
+.EE

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nano-pow",
-	"version": "3.1.0",
+	"version": "3.1.2",
 	"description": "Proof-of-work generation and validation with WebGPU/WebGL for Nano cryptocurrency.",
 	"keywords": [
 		"nemo",