nano-pow 3.1.4 → 3.2.0

package/dist/types.d.ts

@@ -1,7 +1,67 @@
 // SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>
 // SPDX-License-Identifier: GPL-3.0-or-later
 
-import "@webgpu/types"
+import '@webgpu/types'
+
+/**
+* Used by work server for inbound requests to `work_generate`.
+*
+* @param {string} action - Method to call
+* @param {string} hash - Block hash used to generate work
+* @param {string} [difficulty=FFFFFFF800000000] - Minimum threshold for a nonce to be valid
+*/
+type WorkGenerateRequest = {
+	action: 'work_generate'
+	hash: string
+	difficulty?: string
+}
+
+/**
+* Used by work server for outbound responses to `work_generate`.
+*
+* @param {string} hash - Block hash used to generate or validate work
+* @param {string} work - Valid proof-of-work nonce generated for input hash
+* @param {string} difficulty - BLAKE2b hash result which was compared to specified minimum threshold
+*/
+type WorkGenerateResponse = {
+	hash: string
+	work: string
+	difficulty: string
+}
+
+/**
+* Used by work server for inbound requests to `work_validate`.
+*
+* @param {string} action - Method to call
+* @param {string} hash - Block hash used to validate work
+* @param {string} work - Existing nonce to check against hash
+* @param {string} [difficulty=FFFFFFF800000000] - Minimum threshold for a nonce to be valid
+*/
+type WorkValidateRequest = {
+	action: 'work_validate'
+	hash: string
+	work: string
+	difficulty?: string
+}
+
+/**
+* Used by work server for outbound responses to `work_validate`.
+*
+* @param {string} hash - Hash from validate request
+* @param {string} work - Nonce from validate request
+* @param {string} difficulty - BLAKE2b hash result which is compared to specified minimum threshold
+* @param {string} [valid] - Excluded if optional difficulty was not included in the request. 1 for true if nonce is valid for requested difficulty, else 0 for false
+* @param {string} valid_all - 1 for true if nonce is valid for send blocks, else 0 for false
+* @param {string} valid_receive - 1 for true if nonce is valid for receive blocks, else 0 for false
+*/
+type WorkValidateResponse = {
+	hash: string
+	work: string
+	difficulty: string
+	valid?: '0' | '1'
+	valid_all: '0' | '1'
+	valid_receive: '0' | '1'
+}
 
 export declare const NanoPowGlDownsampleShader: string
 export declare const NanoPowGlDrawShader: string
@@ -36,24 +96,41 @@ export type FBO = {
 export type NanoPowOptions = {
 	debug?: boolean
 	effort?: number
-	threshold?: number
+	threshold?: bigint | number
 }
 
 /**
 * Nano proof-of-work using WebGL 2.0.
 */
 export declare class NanoPowGl {
-	/** Compile */
+	#private
+	/** Drawing buffer width in pixels. */
+	static get size (): number | undefined
+	/**
+	* Constructs canvas, gets WebGL context, initializes buffers, and compiles
+	* shaders.
+	*/
 	static init (): Promise<void>
+	/**
+	* On WebGL context loss, attempts to clear all program variables and then
+	* reinitialize them by calling `init()`.
+	*/
 	static reset (): void
 	/**
 	* Finds a nonce that satisfies the Nano proof-of-work requirements.
 	*
 	* @param {string} hash - Hexadecimal hash of previous block, or public key for new accounts
-	* @param {NanoPowOptions} options - Options used to configure search execution
+	* @param {NanoPowOptions} options - Used to configure search execution
 	*/
 	static search (hash: string, options?: NanoPowOptions): Promise<string>
 	/**
+	* Finds a nonce that satisfies the Nano proof-of-work requirements.
+	*
+	* @param {string} hash - Hexadecimal hash of previous block, or public key for new accounts
+	* @param {NanoPowOptions} options - Options used to configure search execution
+	*/
+	static work_generate (hash: string, options?: NanoPowOptions): Promise<WorkGenerateResponse>
+	/**
 	* Validates that a nonce satisfies Nano proof-of-work requirements.
 	*
 	* @param {string} work - Hexadecimal proof-of-work value to validate
@@ -61,12 +138,21 @@ export declare class NanoPowGl {
 	* @param {NanoPowOptions} options - Options used to configure search execution
 	*/
 	static validate (work: string, hash: string, options?: NanoPowOptions): Promise<boolean>
+	/**
+	* Validates that a nonce satisfies Nano proof-of-work requirements.
+	*
+	* @param {string} work - Hexadecimal proof-of-work value to validate
+	* @param {string} hash - Hexadecimal hash of previous block, or public key for new accounts
+	* @param {NanoPowOptions} options - Options used to configure search execution
+	*/
+	static work_validate (work: string, hash: string, options?: NanoPowOptions): Promise<WorkValidateResponse>
 }
 
 /**
 * Nano proof-of-work using WebGPU.
 */
 export declare class NanoPowGpu {
+	#private
 	static init (): Promise<void>
 	static setup (): void
 	static reset (): void
@@ -78,6 +164,13 @@ export declare class NanoPowGpu {
 	*/
 	static search (hash: string, options?: NanoPowOptions): Promise<string>
 	/**
+	* Finds a nonce that satisfies the Nano proof-of-work requirements.
+	*
+	* @param {string} hash - Hexadecimal hash of previous block, or public key for new accounts
+	* @param {NanoPowOptions} options - Used to configure search execution
+	*/
+	static work_generate (hash: string, options?: NanoPowOptions): Promise<WorkGenerateResponse>
+	/**
 	* Validates that a nonce satisfies Nano proof-of-work requirements.
 	*
 	* @param {string} work - Hexadecimal proof-of-work value to validate
@@ -85,4 +178,12 @@ export declare class NanoPowGpu {
 	* @param {NanoPowOptions} options - Options used to configure search execution
 	*/
 	static validate (work: string, hash: string, options?: NanoPowOptions): Promise<boolean>
+	/**
+	* Validates that a nonce satisfies Nano proof-of-work requirements.
+	*
+	* @param {string} work - Hexadecimal proof-of-work value to validate
+	* @param {string} hash - Hexadecimal hash of previous block, or public key for new accounts
+	* @param {NanoPowOptions} options - Options used to configure search execution
+	*/
+	static work_validate (work: string, hash: string, options?: NanoPowOptions): Promise<WorkValidateResponse>
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "nano-pow",
-	"version": "3.1.4",
+	"version": "3.2.0",
 	"description": "Proof-of-work generation and validation with WebGPU/WebGL for Nano cryptocurrency.",
 	"keywords": [
 		"nemo",
@@ -45,14 +45,13 @@
 		"url": "git+https://zoso.dev/nano-pow.git"
 	},
 	"scripts": {
-		"build": "rm -rf {dist,types} && tsc && node esbuild.mjs && npm run fix-copyright && cp -r src/bin src/types.d.ts dist",
-		"fix-copyright": "sed -i '/\\/\\/ src\\/shaders\\/compute\\.wgsl/a //! SPDX-FileCopyrightText: 2025 Chris Duncan <chris@zoso.dev>\\n//! SPDX-License-Identifier: GPL-3.0-or-later' dist/main.min.js"
+		"build": "rm -rf {dist,types} && tsc && node esbuild.mjs"
 	},
 	"devDependencies": {
 		"@types/node": "^22.13.10",
-		"@webgpu/types": "^0.1.55",
+		"@webgpu/types": "^0.1.57",
 		"esbuild": "^0.25.1",
-		"esbuild-plugin-glsl": "^1.2.3",
+		"esbuild-plugin-glsl": "^1.4.0",
 		"typescript": "^5.8.2"
 	},
 	"type": "module",