nano-pow 5.1.9 → 5.1.10

package/AUTHORS.md

@@ -1,7 +1,7 @@
 <!--
-SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
-Chris Duncan <chris@zoso.dev> (zoso.dev)
+Chris Duncan <chris@codecow.com> (codecow.com)
 Ben Green <ben@latenightsketches.com> (numtel.github.io)

package/README.md

@@ -1,9 +1,10 @@
 <!--
-SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 SPDX-License-Identifier: GPL-3.0-or-later
 -->
 
 # nano-pow
+
 _Proof-of-work generation and validation with WebGPU/WebGL for Nano cryptocurrency._
 
 NanoPow uses WebGPU to generate proof-of-work nonces meeting the requirements
@@ -14,17 +15,21 @@ as fallbacks.
 All calculations take place client-side, so nonces can be generated offline and
 cached for the next transaction block. For more information about the
 proof-of-work equation defined by Nano, see
-https://docs.nano.org/integration-guides/work-generation/#work-calculation-details
+<https://docs.nano.org/integration-guides/work-generation/#work-calculation-details>
 
 ## Installation
+
 ```console
-$ npm i nano-pow
+npm i nano-pow
 ```
+
 NanoPow can also be installed globally to add the `nano-pow` command to the
 system environment. To learn more, see [#Executables](#executables).
 
 ## Usage
+
 ### Import
+
 The easiest way to use NanoPow is to import it directly. Based on the features
 available in the environment, NanoPow will try to use its most performant API.
 
@@ -32,124 +37,140 @@ The following two import statements are equivalent, and both are provided to
 accomodate project style preferences:
 
 ```javascript
-import { NanoPow } from 'nano-pow'
+import { NanoPow } from "nano-pow";
 // OR
-import NanoPow from 'nano-pow'
+import NanoPow from "nano-pow";
 ```
 
 Use it directly on a webpage with a script module:
 
 ```html
 <script type="module">
-	(async () => {
-		const { NanoPow } = await import('https://cdn.jsdelivr.net/npm/nano-pow@latest')
-		const { work } = await NanoPow.work_generate(some_hash)
-		console.log(work)
-	})()
+  (async () => {
+    const { NanoPow } =
+      await import("https://cdn.jsdelivr.net/npm/nano-pow@latest");
+    const { work } = await NanoPow.work_generate(some_hash);
+    console.log(work);
+  })();
 </script>
 ```
 
 ### Generate
+
 ```javascript
 // `hash` is a 64-char hex string
-const hash = '0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef'
-const { work } = await NanoPow.work_generate(hash)
+const hash = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
+const { work } = await NanoPow.work_generate(hash);
 // Result is a 16-char hex string
 ```
 
 ### Validate
+
 ```javascript
 // `work` is a 16-char hex string
-const work = 'fedcba0987654321'
+const work = "fedcba0987654321";
 // `hash` is a 64-char hex string
-const hash = '0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef'
-const { valid } = await NanoPow.work_validate(work, hash)
+const hash = "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef";
+const { valid } = await NanoPow.work_validate(work, hash);
 // Result is a boolean
 ```
 
 ### Options
+
 ```javascript
 const options = {
-	// default best available in order: webgpu => webgl => wasm => cpu
-	api: 'webgpu',
-	// default FFFFFFF800000000 for send/change blocks
-	difficulty: 'FFFFFFC000000000',
-	// default 4, valid range 1-32
-	effort: 2,
-	// default false
-	debug: true
-}
-const { work } = await NanoPow.work_generate(hash, options)
+  // default best available in order: webgpu => webgl => wasm => cpu
+  api: "webgpu",
+  // default FFFFFFF800000000 for send/change blocks
+  difficulty: "FFFFFFC000000000",
+  // default 4, valid range 1-32
+  effort: 2,
+  // default false
+  debug: true,
+};
+const { work } = await NanoPow.work_generate(hash, options);
 ```
 
 #### What is "effort"?
+
 NanoPow's "effort" metric is an abstraction of various GPU and CPU capabilities.
 Different systems will have different optimal settings, but as a general rule of
 thumb:
 
-* WebGPU must strike a balance between the overhead of dispatching work to the
-GPU and the time it takes to compute the dispatch itself. Start with a low value
-like 2 or 4.
-* WegGL works by drawing to an invisible 2-D canvas that is `effort * 256`
-pixels long on each side. Since PoW speed in this case depends on resolution
-_and_ framerate, push for a value as high as the GPU can support. For example, a
-GPU that can draw 4096 x 4096 at 15 FPS should be set around 16 effort.
-* WASM does not use the GPU at all and instead depends on Web Workers for CPU
-multi-threading capabilities. Set effort equal to the number of physical cores
-in the CPU.
+- WebGPU must strike a balance between the overhead of dispatching work to the
+  GPU and the time it takes to compute the dispatch itself. Start with a low value
+  like 2 or 4.
+- WegGL works by drawing to an invisible 2-D canvas that is `effort * 256`
+  pixels long on each side. Since PoW speed in this case depends on resolution
+  _and_ framerate, push for a value as high as the GPU can support. For example, a
+  GPU that can draw 4096 x 4096 at 15 FPS should be set around 16 effort.
+- WASM does not use the GPU at all and instead depends on Web Workers for CPU
+  multi-threading capabilities. Set effort equal to the number of physical cores
+  in the CPU.
 
 ## Executables
+
 NanoPow can be installed globally and executed from the command line. This is
 useful for systems without a graphical interface.
+
 ```console
-$ npm -g i nano-pow
-$ nano-pow --help    # view abbreviated CLI help
-$ man nano-pow       # view full manual
+npm -g i nano-pow
+nano-pow --help    # view abbreviated CLI help
+man nano-pow       # view full manual
 ```
+
 Ensure proper permissions exist on the
 [npm `prefix`](https://docs.npmjs.com/cli/v11/commands/npm-prefix) directory and
 that `PATH` is also configured accordingly. [nvm](https://github.com/nvm-sh/nvm)
 is a great tool that handles this automatically.
 
 ### Command Line
+
 NanoPow provides a shell command&mdash;`nano-pow`&mdash;to accomodate systems
 without a graphical user interface. It launches a headless Chrome browser using
 `puppeteer` to access the required WebGPU or WebGL APIs. Use the `--global` flag
 when installing to add the executable script to the system.
+
 ```console
-$ npm i -g nano-pow
+npm i -g nano-pow
 ```
+
 Some examples are provided below, and for full documentation, read the manual
 with `man nano-pow`.
 
 ```console
-$ # Generate a work value using default settings and debugging output enabled.
-$ nano-pow --debug 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+# Generate a work value using default settings and debugging output enabled.
+nano-pow --debug 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
 ```
+
 ```console
-$ # Generate work using customized behavior with options.
-$ nano-pow --effort 32 --difficulty FFFFFFC000000000 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
+# Generate work using customized behavior with options.
+nano-pow --effort 32 --difficulty FFFFFFC000000000 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
 ```
+
 ```console
-$ # Validate an existing work nonce against a blockhash.
+# Validate an existing work nonce against a blockhash.
 nano-pow --validate fedcba9876543210 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
 ```
+
 ```console
-$ # Process blockhashes in batches to reduce the initial startup overhead.
-$ nano-pow 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef [...]
-$ # OR
+# Process blockhashes in batches to reduce the initial startup overhead.
+nano-pow 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef [...]
+# OR
 nano-pow $(cat /path/to/hashes/file)
-$ # OR
-$ cat /path/to/hashes/file | nano-pow
+# OR
+cat /path/to/hashes/file | nano-pow
 ```
 
 ### Server
+
 NanoPow also provides a basic work server similar to the one included in the
 official Nano node software. The installed command will launch the server in a
 detached process, and it can also be started manually to customize behavior by
 executing the server script directly.
 
 #### Environment Variables
+
 `NANO_POW_DEBUG`: enable additional logging saved to the HOME directory
 
 `NANO_POW_EFFORT`: increase or decrease demand on the GPU
@@ -157,48 +178,52 @@ executing the server script directly.
 `NANO_POW_PORT`: override the default port 5040
 
 ```console
-$ # Launch the server and detach from the current session
-$ NANO_POW_PORT=8080 nano-pow --server
-$ # View process ID for "NanoPow Server"
-$ cat ~/.nano-pow/server.pid
-$ # Display list of server logs
-$ ls ~/.nano-pow/logs/
-$ # Find process ID manually
-$ pgrep NanoPow
+# Launch the server and detach from the current session
+NANO_POW_PORT=8080 nano-pow --server
+# View process ID for "NanoPow Server"
+cat ~/.nano-pow/server.pid
+# Display list of server logs
+ls ~/.nano-pow/logs/
+# Find process ID manually
+pgrep NanoPow
 ```
+
 Work is generated or validated by sending an HTTP `POST` request to the
 configured hostname or IP address of the machine. Some basic help is available
 via `GET` request.
+
 ```console
 $ # Generate a work value
 $ curl -d '{
-	"action": "work_generate",
-	"hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
+  "action": "work_generate",
+  "hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
 }' localhost:5040
 ```
+
 ```console
 $ # Validate a work value
 $ curl -d '{
-	"action": "work_validate",
-	"work": "e45835c3b291c3d1",
-	"hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
+  "action": "work_validate",
+  "work": "e45835c3b291c3d1",
+  "hash": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
 }' localhost:5040
 ```
 
 ## Notes
+
 The `work` field in a Nano transaction block contains an 8-byte nonce that
 satisfies the following equation:
 
 > 𝘣𝘭𝘢𝘬𝘦2𝘣(𝘯𝘰𝘯𝘤𝘦 || 𝘣𝘭𝘰𝘤𝘬𝘩𝘢𝘴𝘩) ≥ 𝘵𝘩𝘳𝘦𝘴𝘩𝘰𝘭𝘥
 
-* 𝘣𝘭𝘢𝘬𝘦2𝘣() is the cryptographic hash function BLAKE2b.
-* 𝘯𝘰𝘯𝘤𝘦, an 8-byte value, is generated for the transaction.
-* || is concatenation.
-* 𝘣𝘭𝘰𝘤𝘬𝘩𝘢𝘴𝘩, a 32-byte value, is either the public key of brand new accounts
-without transactions or the hash of the most recent block in the account chain
-for all other accounts.
-* 𝘵𝘩𝘳𝘦𝘴𝘩𝘰𝘭𝘥 is 0xFFFFFFF800000000 for send/change blocks and 0xFFFFFE0000000000
-for receive/open/epoch blocks.
+- 𝘣𝘭𝘢𝘬𝘦2𝘣() is the cryptographic hash function BLAKE2b.
+- 𝘯𝘰𝘯𝘤𝘦, an 8-byte value, is generated for the transaction.
+- || is concatenation.
+- 𝘣𝘭𝘰𝘤𝘬𝘩𝘢𝘴𝘩, a 32-byte value, is either the public key of brand new accounts
+  without transactions or the hash of the most recent block in the account chain
+  for all other accounts.
+- 𝘵𝘩𝘳𝘦𝘴𝘩𝘰𝘭𝘥 is 0xFFFFFFF800000000 for send/change blocks and 0xFFFFFE0000000000
+  for receive/open/epoch blocks.
 
 The BLAKE2b implementation has been optimized to the extreme for this package
 due to the very narrow use case to which it is applied. The compute shader used
@@ -206,37 +231,43 @@ by the WebGPU implementation is consequently immense, but the goal is to squeeze
 every last bit of speed and performance out of it.
 
 ## Tests
-A few basic tests are availabe in the source repository.
-* `test/index.html` in the source repository contains a web interface to change
-execution options and compare results.
-* `test/script.sh` runs some basic benchmarks to check the CLI, and then it
-starts the `nano-pow` server and sends some validate and generate requests.
+
+A few basic tests are available in the source repository.
+
+- `test/index.html` in the source repository contains a web interface to change
+  execution options and compare results.
+- `test/script.sh` runs some basic benchmarks to check the CLI, and then it
+  starts the `nano-pow` server and sends some validate and generate requests.
 
 ## Building
+
 1. Clone source
 1. Enter the directory
 1. Install dev dependencies
 1. Compile, minify, and bundle
 
 ```console
-$ git clone https://zoso.dev/nano-pow.git
-$ cd nano-pow
-$ npm i
+git clone https://codecow.com/nano-pow.git
+cd nano-pow
+npm i
 ```
 
 ## Reporting Bugs
-Email: <bug-nano-pow@zoso.dev>
+
+Email: <bug-nano-pow@codecow.com>
 
 ## Acknowledgements
-[numtel/nano-webgl-pow](https://github.com/numtel/nano-webgl-pow) for his WebGL
-implementation
+
+[numtel/nano-webgl-pow](https://github.com/numtel/nano-webgl-pow) for his
+original WebGL implementation.
 
 ## Licenses
+
 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
+
 Tips are always appreciated and can be sent to the following developer address:
-```
+
 nano_1zosoqs47yt47bnfg7sdf46kj7asn58b7uzm9ek95jw7ccatq37898u1zoso
-```

package/dist/bin/cli.js

@@ -6,7 +6,7 @@ import { getRandomValues } from "node:crypto";
 import { createInterface } from "node:readline/promises";
 
 // src/utils/api-support/wasm.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var wasm = { isSupported: false };
 Object.defineProperty(wasm, "isSupported", {
@@ -84,7 +84,7 @@ Object.defineProperty(wasm, "isSupported", {
 });
 
 // src/utils/api-support/webgl.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var webgl = { isSupported: false };
 Object.defineProperty(webgl, "isSupported", {
@@ -105,7 +105,7 @@ Object.defineProperty(webgl, "isSupported", {
 });
 
 // src/utils/api-support/webgpu.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var webgpu = { isSupported: false };
 Object.defineProperty(webgpu, "isSupported", {
@@ -126,11 +126,11 @@ Object.defineProperty(webgpu, "isSupported", {
 });
 
 // src/utils/api-support/index.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 
 // src/utils/bigint.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 function bigintFrom(value, type) {
   if (typeof value === "bigint") {
@@ -156,7 +156,7 @@ function bigintFrom(value, type) {
 }
 
 // src/utils/cache.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var Cache = class {
   static clear() {
@@ -198,7 +198,7 @@ var Cache = class {
 };
 
 // src/utils/logger.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var Logger = class {
   isEnabled = false;
@@ -238,11 +238,11 @@ var Logger = class {
 };
 
 // src/utils/queue.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 
 // src/utils/index.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var clearCache = Cache.clear;
 function isHexN(value, byteLength) {
@@ -311,7 +311,7 @@ function stats(times) {
 }
 
 // src/bin/cli.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 process.title = "NanoPow CLI";
 var logger = new Logger();
@@ -357,7 +357,7 @@ If validating a nonce, it must be a 16-character hexadecimal value.
 Effort must be a decimal number between 1-32.
 Difficulty must be a hexadecimal string between 0-FFFFFFFFFFFFFFFF.
 
-Report bugs: <bug-nano-pow@zoso.dev>
+Report bugs: <bug-nano-pow@codecow.com>
 Full documentation: <https://www.npmjs.com/package/nano-pow>
 `);
   process.exit(0);

package/dist/bin/nano-pow.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-# SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+# SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 SCRIPT_LINK=$(readlink -f "$0");

package/dist/bin/server.js

@@ -9,7 +9,7 @@ import { join } from "node:path";
 import { launch } from "puppeteer";
 
 // src/utils/api-support/wasm.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var wasm = { isSupported: false };
 Object.defineProperty(wasm, "isSupported", {
@@ -87,7 +87,7 @@ Object.defineProperty(wasm, "isSupported", {
 });
 
 // src/utils/api-support/webgl.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var webgl = { isSupported: false };
 Object.defineProperty(webgl, "isSupported", {
@@ -108,7 +108,7 @@ Object.defineProperty(webgl, "isSupported", {
 });
 
 // src/utils/api-support/webgpu.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var webgpu = { isSupported: false };
 Object.defineProperty(webgpu, "isSupported", {
@@ -129,11 +129,11 @@ Object.defineProperty(webgpu, "isSupported", {
 });
 
 // src/utils/api-support/index.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 
 // src/utils/bigint.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 function bigintFrom(value, type) {
   if (typeof value === "bigint") {
@@ -159,7 +159,7 @@ function bigintFrom(value, type) {
 }
 
 // src/utils/cache.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var Cache = class {
   static clear() {
@@ -201,7 +201,7 @@ var Cache = class {
 };
 
 // src/utils/logger.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var Logger = class {
   isEnabled = false;
@@ -241,11 +241,11 @@ var Logger = class {
 };
 
 // src/utils/queue.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 
 // src/utils/index.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 var clearCache = Cache.clear;
 function isHexN(value, byteLength) {
@@ -263,7 +263,7 @@ function isHex32(value) {
 }
 
 // src/bin/server.ts
-//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
+//! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@codecow.com>
 //! SPDX-License-Identifier: GPL-3.0-or-later
 process.title = "NanoPow Server";
 await writeFile(`${homedir()}/.nano-pow/server.pid`, `${process.pid}
@@ -439,7 +439,7 @@ HASH is a big-endian 64-character hexadecimal string.
 WORK is little-endian 16-character hexadecimal string.
 DIFFICULTY is an optional 16-character hexadecimal string (default: FFFFFFF800000000)
 
-Report bugs: <bug-nano-pow@zoso.dev>
+Report bugs: <bug-nano-pow@codecow.com>
 Full documentation: <https://www.npmjs.com/package/nano-pow>
 `);
 }