quantumcoin 7.0.14 → 8.0.0

package/README-SDK.md

@@ -12,6 +12,7 @@ This document is the **complete, detailed SDK reference** for QuantumCoin.js (et
   - [Install](#install)
   - [Initialization (required)](#initialization-required)
   - [Key differences vs ethers/Ethereum](#key-differences-vs-ethersethereum)
+  - [Platform support (Node.js and browser)](#platform-support-nodejs-and-browser)
 - [Configuration (`quantumcoin/config`)](#configuration-quantumcoinconfig)
   - [`Config`](#config)
   - [`Initialize(config)`](#initializeconfig)
@@ -100,6 +101,43 @@ await Initialize(new Config(123123, "https://public.rpc.quantumcoinapi.com"));
 - **Signing and ABI encoding/decoding** are delegated to `quantum-coin-js-sdk` (WASM)
 - **Initialize must be called** once at startup for wallet/address/ABI helpers
 
+### Platform support (Node.js and browser)
+
+QuantumCoin.js is **platform agnostic** and runs in both Node.js (20+) and modern
+browsers. It does **not** depend on Node's built-in `crypto` module: all
+cryptographic primitives (`keccak256`, `sha256`, `sha512`, `ripemd160`,
+`computeHmac`, `pbkdf2`, `scrypt`/`scryptSync`) are provided by
+`quantum-coin-js-sdk` (WebAssembly), and `randomBytes` uses the standard Web
+Crypto API (`globalThis.crypto`).
+
+Because the crypto primitives come from `quantum-coin-js-sdk`, **the hashing and
+KDF helpers require `Initialize()` to have completed** before use. Calling them
+beforehand throws a `NOT_INITIALIZED` error:
+
+```js
+const qc = require("quantumcoin");
+const { Initialize } = require("quantumcoin/config");
+
+await Initialize(null);
+qc.keccak256(qc.toUtf8Bytes("hello")); // ok after Initialize()
+```
+
+Notes for browser usage:
+
+- Bundle your app with a browser bundler (esbuild, webpack, Vite, Rollup, etc.).
+  `quantum-coin-js-sdk` ships its WASM embedded, so no extra asset fetching or
+  `wasm_exec.js` wiring is required — just `require`/`import` the SDK and call
+  `Initialize()`.
+- The `IpcSocketProvider` (Unix domain socket / named pipe transport) is
+  **Node-only**; it lazily loads `node:net` and throws `NOT_IMPLEMENTED` in the
+  browser. `JsonRpcProvider` (via `fetch`), `WebSocketProvider` (via
+  `globalThis.WebSocket`) and `BrowserProvider` (EIP-1193) all work in browsers.
+  The package's `browser` field maps `node:net` to `false` so bundlers can drop
+  the IPC code path.
+
+The browser surface is validated by an automated headless-browser suite
+(`npm run test:browser`, Playwright + esbuild).
+
 ## Configuration (`quantumcoin/config`)
 
 ### `Config`
@@ -184,6 +222,7 @@ Base provider implementation. Subclasses implement `_perform`.
 - `getTransactionCount(address: string, blockTag?: string | null): Promise<number>`
 - `call(tx: TransactionRequest, blockTag?: string | null): Promise<string>`
 - `estimateGas(tx: TransactionRequest): Promise<bigint>`
+- `getFeeData(walletOrKeyType: Wallet | number, fullSign?: boolean | null): Promise<FeeData>` — returns fee data for a wallet (its key type is read via `getKeyType()`) or for a key type number (`3` or `5`) passed directly. `fullSign` applies only to key type `3` (full signing costs more gas) and is ignored for key type `5`. `FeeData` currently exposes a single field `gasPrice: bigint`, the price **per unit of gas** in wei (so the total transaction fee is `gasPrice * gasLimit`). Only DynamicFeeTx (dynamic-fee) transactions are supported; the EIP-1559 fields `maxFeePerGas` / `maxPriorityFeePerGas` are **not supported yet** (QuantumCoin has no base-fee / priority-tip model) and are absent from `FeeData`. Like ethers, this is a provider method; later releases may issue a network call (hence the `Promise`).
 - `getCode(address: string, blockTag?: string | null): Promise<string>`
 - `getStorageAt(address: string, position: bigint, blockTag?: string | null): Promise<string>`
 - `getLogs(filter: Filter | FilterByBlockHash): Promise<Log[]>`
@@ -403,6 +442,7 @@ User-facing wallet class.
 - `connect(provider: AbstractProvider): Wallet`
 - `getPhrase(): string[] | null` — returns the seed phrase (list of words) when the wallet has a seed, else `null`. Works for `createRandom`, `fromPhrase`, `fromSeed`, and `fromEncryptedJsonSync` on a version-5 keystore. Returns `null` for `fromKeys` and for v3/v4 keystores.
 - `getSigningContext(fullSign?: boolean | null): number` — returns the recommended signing context for this wallet (based on public key type). Setting `fullSign` to `true` may incur additional gas cost.
+- `getKeyType(): number` — returns the wallet's key type, derived from its public key length: `3` (HYBRIDEDMLDSASLHDSA) or `5` (HYBRIDEDMLDSASLHDSA5). The key type drives gas-price selection in `getFeeData`. Throws for an unsupported public key size.
 
 **Seed & phrase applicability**
 
@@ -645,6 +685,12 @@ const asOutput: Uint256 = 123n;
 - `scrypt(password: BytesLike, salt: BytesLike, N: number, r: number, p: number, dkLen: number): Promise<string>`
 - `scryptSync(password: BytesLike, salt: BytesLike, N: number, r: number, p: number, dkLen: number): string`
 
+> These helpers are backed by `quantum-coin-js-sdk` (WASM) and therefore require
+> `Initialize()` to have completed first; otherwise they throw a
+> `NOT_INITIALIZED` error. `computeHmac` and `pbkdf2` support the `"sha256"`
+> (default) and `"sha512"` algorithms. `randomBytes` uses the Web Crypto API and
+> works without initialization.
+
 ### Units
 
 - `formatUnits(value: BigNumberish, decimals?: number): string`

package/README.md

@@ -4,7 +4,7 @@
 
 ## QuantumCoin.js
 
-QuantumCoin.js is an **ethers.js v6-compatible** SDK surface for the QuantumCoin blockchain.
+QuantumCoin.js is a SDK for the QuantumCoin blockchain that maintains close compatibility with **ethers.js v6**.
 
 Key differences vs Ethereum/ethers:
 

package/generate-sdk.js

@@ -1744,11 +1744,13 @@ function _createPackageScaffold({ outDir, pkgName, pkgDesc, pkgAuthor, pkgLicens
   const outLang = _normalizeLang(lang);
   const isTs = outLang === "ts";
 
-  const rootPkg = _readRootPackageJson();
-  const rootDeps = _rewriteFileDepsToAbsolute(rootPkg.dependencies || {}, __dirname);
-
-  // Ensure the generated package depends on this repo's quantumcoin via absolute file path.
-  rootDeps.quantumcoin = `file:${__dirname.replace(/\\\\/g, "/")}`;
+  // The generated SDK only imports from "quantumcoin" (and "quantumcoin/config").
+  // quantum-coin-js-sdk and seed-words are pulled in transitively via quantumcoin,
+  // so we intentionally do NOT copy them as direct dependencies here — the
+  // generated package.json lists only the minimum it actually needs.
+  const dependencies = {
+    quantumcoin: `file:${__dirname.replace(/\\\\/g, "/")}`,
+  };
 
   const pkgJson = {
     name: pkgName,
@@ -1774,7 +1776,7 @@ function _createPackageScaffold({ outDir, pkgName, pkgDesc, pkgAuthor, pkgLicens
             "test:e2e": "node --test --test-concurrency=1 \"test/e2e/**/*.test.js\"",
           }),
     },
-    dependencies: rootDeps,
+    dependencies,
     devDependencies: {},
   };
 

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "quantumcoin",
-  "version": "7.0.14",
+  "version": "8.0.0",
   "description": "QuantumCoin.js - a post quantum cryptography SDK for QuantumCoin",
   "main": "index.js",
   "types": "src/index.d.ts",
+  "browser": {
+    "node:net": false
+  },
   "typesVersions": {
     "*": {
       "types": [
@@ -43,6 +46,8 @@
     "test:ts:integration": "npx tsx --test \"test/integration/**/*.test.ts\"",
     "test:ts:security": "npx tsx --test \"test/security/**/*.test.ts\"",
     "test:ts:e2e": "npx tsx --test --test-concurrency=1 \"test/e2e/*.test.ts\" \"test/e2e/*.e2e.test.ts\" \"test/e2e/*.dynamic.test.ts\"",
+    "test:browser:build": "node test/browser/build.js",
+    "test:browser": "npm run test:browser:build && npx playwright test",
     "example": "node examples/example.js",
     "example:ts": "npx tsx examples/example.ts",
     "example:provider": "node examples/example.js",
@@ -67,7 +72,15 @@
     "url": "git+https://github.com/quantumcoinproject/quantumcoin.js.git"
   },
   "files": [
-    "**"
+    "index.js",
+    "config.js",
+    "config.d.ts",
+    "generate-sdk.js",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "README.md",
+    "README-SDK.md",
+    "LICENSE"
   ],
   "keywords": [
     "cryptography",
@@ -86,10 +99,15 @@
     "sdkgen": "./generate-sdk.js"
   },
   "devDependencies": {
+    "@playwright/test": "^1.61.1",
+    "esbuild": "^0.28.1",
     "tsx": "^4.19.0"
   },
   "dependencies": {
-    "seed-words": "^1.0.2",
-    "quantum-coin-js-sdk": "1.0.36"
+    "quantum-coin-js-sdk": "2.1.1",
+    "seed-words": "^1.1.1"
+  },
+  "allowScripts": {
+    "esbuild@0.28.1": true
   }
 }

package/src/abi/interface.d.ts

@@ -1,128 +1,133 @@
-export class Interface {
-    /**
-     * @param {any[]|Interface} abi
-     */
-    constructor(abi: any[] | Interface);
-    abi: any;
-    _abiJson: string;
-    _qcsdkAbi: any[];
-    _qcsdkAbiJson: string;
-    /**
-     * Returns JSON format of ABI.
-     * @returns {string}
-     */
-    formatJson(): string;
-    /**
-     * Internal: normalized ABI JSON for qcsdk.
-     * @returns {string}
-     */
-    _qcsdkFormatJson(): string;
-    /**
-     * Internal: normalize argument values for qcsdk based on original ABI params.
-     * @param {Array<any>} params
-     * @param {Array<any>} values
-     * @returns {Array<any>}
-     */
-    _qcsdkNormalizeValues(params: Array<any>, values: Array<any>): Array<any>;
-    /**
-     * Basic formatter (ethers supports multiple formats).
-     * @param {string=} format
-     * @returns {string}
-     */
-    format(format?: string | undefined): string;
-    /**
-     * Get a function fragment by name (first match).
-     * @param {string} nameOrSignature
-     * @returns {FunctionFragment}
-     */
-    getFunction(nameOrSignature: string): FunctionFragment;
-    /**
-     * Get an event fragment by name (first match).
-     * @param {string} nameOrSignature
-     * @returns {EventFragment}
-     */
-    getEvent(nameOrSignature: string): EventFragment;
-    /**
-     * Get an error fragment by name (first match).
-     * @param {string} nameOrSignature
-     * @returns {ErrorFragment}
-     */
-    getError(nameOrSignature: string): ErrorFragment;
-    /**
-     * Returns the constructor fragment if present.
-     * @returns {ConstructorFragment|null}
-     */
-    getConstructor(): ConstructorFragment | null;
-    /**
-     * Encode function data using quantum-coin-js-sdk.
-     * @param {FunctionFragment|string} functionFragment
-     * @param {any[]} values
-     * @returns {string}
-     */
-    encodeFunctionData(functionFragment: FunctionFragment | string, values: any[]): string;
-    /**
-     * Decode function result using quantum-coin-js-sdk.
-     * @param {FunctionFragment|string} functionFragment
-     * @param {string} data
-     * @returns {any}
-     */
-    decodeFunctionResult(functionFragment: FunctionFragment | string, data: string): any;
-    /**
-     * Encode an event log from values.
-     * @param {EventFragment|any} eventFragment
-     * @param {any[]} values
-     * @returns {{ topics: string[], data: string }}
-     */
-    encodeEventLog(eventFragment: EventFragment | any, values: any[]): {
-        topics: string[];
-        data: string;
-    };
-    /**
-     * Decode an event log.
-     * @param {EventFragment|any} eventFragment
-     * @param {string[]} topics
-     * @param {string} data
-     * @returns {any}
-     */
-    decodeEventLog(eventFragment: EventFragment | any, topics: string[], data: string): any;
-    parseTransaction(): void;
-    parseLog(...args: any[]): {
-        fragment: EventFragment;
-        name: any;
-        signature: any;
-        topic: string;
-        args: Result;
-    };
-    parseError(): void;
-    getSighash(): void;
-    getEventTopic(): void;
-    getFallback(): any;
-    getReceive(): any;
-}
-export class AbiCoder {
-    /**
-     * Encode values by types into ABI data.
-     * @param {(string|any)[]} types
-     * @param {any[]} values
-     * @returns {string}
-     */
-    encode(types: (string | any)[], values: any[]): string;
-    /**
-     * Decode ABI data by output types.
-     * @param {(string|any)[]} types
-     * @param {string} data
-     * @returns {any}
-     */
-    decode(types: (string | any)[], data: string): any;
-    /**
-     * Return a default value for types.
-     * @param {(string|any)[]} types
-     * @returns {any}
-     */
-    getDefaultValue(types: (string | any)[]): any;
-}
-import { FunctionFragment } from "./fragments";
-import { EventFragment } from "./fragments";
-import { ErrorFragment } from "./fragments";
-import { ConstructorFragment } from "./fragments";
-import { Result } from "../utils/result";
+export class Interface {
+    /**
+     * @param {any[]|Interface} abi
+     */
+    constructor(abi: any[] | Interface);
+    abi: any;
+    _abiJson: string;
+    _qcsdkAbi: any[];
+    _qcsdkAbiJson: string;
+    /**
+     * Returns JSON format of ABI.
+     * @returns {string}
+     */
+    formatJson(): string;
+    /**
+     * Internal: normalized ABI JSON for qcsdk.
+     * @returns {string}
+     */
+    _qcsdkFormatJson(): string;
+    /**
+     * Internal: normalize argument values for qcsdk based on original ABI params.
+     * @param {Array<any>} params
+     * @param {Array<any>} values
+     * @returns {Array<any>}
+     */
+    _qcsdkNormalizeValues(params: Array<any>, values: Array<any>): Array<any>;
+    /**
+     * Basic formatter (ethers supports multiple formats).
+     * @param {string=} format
+     * @returns {string}
+     */
+    format(format?: string | undefined): string;
+    /**
+     * Get a function fragment by name (first match).
+     * @param {string} nameOrSignature
+     * @returns {FunctionFragment}
+     */
+    getFunction(nameOrSignature: string): FunctionFragment;
+    /**
+     * Get an event fragment by name (first match).
+     * @param {string} nameOrSignature
+     * @returns {EventFragment}
+     */
+    getEvent(nameOrSignature: string): EventFragment;
+    /**
+     * Get an error fragment by name (first match).
+     * @param {string} nameOrSignature
+     * @returns {ErrorFragment}
+     */
+    getError(nameOrSignature: string): ErrorFragment;
+    /**
+     * Returns the constructor fragment if present.
+     * @returns {ConstructorFragment|null}
+     */
+    getConstructor(): ConstructorFragment | null;
+    /**
+     * Encode function data using quantum-coin-js-sdk.
+     * @param {FunctionFragment|string} functionFragment
+     * @param {any[]} values
+     * @returns {string}
+     */
+    encodeFunctionData(functionFragment: FunctionFragment | string, values: any[]): string;
+    /**
+     * Decode function result using quantum-coin-js-sdk.
+     * @param {FunctionFragment|string} functionFragment
+     * @param {string} data
+     * @returns {any}
+     */
+    decodeFunctionResult(functionFragment: FunctionFragment | string, data: string): any;
+    /**
+     * Encode an event log from values.
+     * @param {EventFragment|any} eventFragment
+     * @param {any[]} values
+     * @returns {{ topics: string[], data: string }}
+     */
+    encodeEventLog(eventFragment: EventFragment | any, values: any[]): {
+        topics: string[];
+        data: string;
+    };
+    /**
+     * Decode an event log.
+     * @param {EventFragment|any} eventFragment
+     * @param {string[]} topics
+     * @param {string} data
+     * @returns {any}
+     */
+    decodeEventLog(eventFragment: EventFragment | any, topics: string[], data: string): any;
+    parseTransaction(): void;
+    parseLog(...args: any[]): {
+        fragment: EventFragment;
+        name: any;
+        signature: any;
+        topic: string;
+        args: Result;
+    };
+    parseError(): void;
+    getSighash(): void;
+    /**
+     * Compute the topic0 (event signature hash) for an event.
+     * @param {string|EventFragment|any} nameOrFragment
+     * @returns {string} normalized 0x-prefixed topic hash
+     */
+    getEventTopic(nameOrFragment: string | EventFragment | any): string;
+    getFallback(): null;
+    getReceive(): null;
+}
+export class AbiCoder {
+    /**
+     * Encode values by types into ABI data.
+     * @param {(string|any)[]} types
+     * @param {any[]} values
+     * @returns {string}
+     */
+    encode(types: (string | any)[], values: any[]): string;
+    /**
+     * Decode ABI data by output types.
+     * @param {(string|any)[]} types
+     * @param {string} data
+     * @returns {any}
+     */
+    decode(types: (string | any)[], data: string): any;
+    /**
+     * Return a default value for types.
+     * @param {(string|any)[]} types
+     * @returns {any}
+     */
+    getDefaultValue(types: (string | any)[]): any;
+}
+import { FunctionFragment } from "./fragments";
+import { EventFragment } from "./fragments";
+import { ErrorFragment } from "./fragments";
+import { ConstructorFragment } from "./fragments";
+import { Result } from "../utils/result";

package/src/abi/js-abi-coder.d.ts

@@ -1,8 +1,8 @@
-export function hasTuple(params: any): boolean;
-export function hasNestedArrays(params: any): boolean;
-export function needsJsAbi(params: any): boolean;
-export function canonicalType(param: any): any;
-export function functionSelectorHex(name: any, inputs: any): string;
-export function encodeFunctionData(name: any, inputs: any, values: any): string;
-export function encodeTupleLike(params: any, values: any): Uint8Array<any>;
-export function decodeFunctionResult(outputs: any, dataHex: any): any[];
+export function hasTuple(params: any): boolean;
+export function hasNestedArrays(params: any): boolean;
+export function needsJsAbi(params: any): boolean;
+export function canonicalType(param: any): any;
+export function functionSelectorHex(name: any, inputs: any): string;
+export function encodeFunctionData(name: any, inputs: any, values: any): string;
+export function encodeTupleLike(params: any, values: any, depth: any): Uint8Array<any>;
+export function decodeFunctionResult(outputs: any, dataHex: any): any[];

package/src/constants.d.ts

@@ -1,61 +1,61 @@
-/**
- * The current version of the QuantumCoin.js library.
- * @type {string}
- */
-export const version: string;
-/**
- * The zero address (32 bytes).
- * @type {string}
- */
-export const ZeroAddress: string;
-/**
- * The zero hash (32 bytes).
- * @type {string}
- */
-export const ZeroHash: string;
-/**
- * The maximum value for a uint256.
- * @type {bigint}
- */
-export const MaxUint256: bigint;
-/**
- * The maximum value for a uint160.
- * @type {bigint}
- */
-export const MaxUint160: bigint;
-/**
- * The minimum value for an int256.
- * @type {bigint}
- */
-export const MinInt256: bigint;
-/**
- * The maximum value for an int256.
- * @type {bigint}
- */
-export const MaxInt256: bigint;
-/**
- * Error code for numeric faults.
- * @type {string}
- */
-export const NumericFault: string;
-/**
- * Error code for numeric faults (alias).
- * @type {string}
- */
-export const NumericFaultCode: string;
-/**
- * Wei per coin (1e18).
- * @type {bigint}
- */
-export const WeiPerEther: bigint;
-/**
- * Currency symbol (compat with ethers.js v6).
- * @type {string}
- */
-export const EtherSymbol: string;
-/**
- * BigNumber constant (exported as `N` in ethers.js v6).
- * In QuantumCoin.js, this is a bigint constant.
- * @type {bigint}
- */
-export const N: bigint;
+/**
+ * The current version of the QuantumCoin.js library.
+ * @type {string}
+ */
+export const version: string;
+/**
+ * The zero address (32 bytes).
+ * @type {string}
+ */
+export const ZeroAddress: string;
+/**
+ * The zero hash (32 bytes).
+ * @type {string}
+ */
+export const ZeroHash: string;
+/**
+ * The maximum value for a uint256.
+ * @type {bigint}
+ */
+export const MaxUint256: bigint;
+/**
+ * The maximum value for a uint160.
+ * @type {bigint}
+ */
+export const MaxUint160: bigint;
+/**
+ * The minimum value for an int256.
+ * @type {bigint}
+ */
+export const MinInt256: bigint;
+/**
+ * The maximum value for an int256.
+ * @type {bigint}
+ */
+export const MaxInt256: bigint;
+/**
+ * Error code for numeric faults.
+ * @type {string}
+ */
+export const NumericFault: string;
+/**
+ * Error code for numeric faults (alias).
+ * @type {string}
+ */
+export const NumericFaultCode: string;
+/**
+ * Wei per coin (1e18).
+ * @type {bigint}
+ */
+export const WeiPerEther: bigint;
+/**
+ * Currency symbol (compat with ethers.js v6).
+ * @type {string}
+ */
+export const EtherSymbol: string;
+/**
+ * BigNumber constant (exported as `N` in ethers.js v6).
+ * In QuantumCoin.js, this is a bigint constant.
+ * @type {bigint}
+ */
+export const N: bigint;

package/src/contract/contract-factory.d.ts

@@ -1,28 +1,28 @@
-export class ContractFactory {
-    /**
-     * @param {any[]|Interface} abi
-     * @param {string} bytecode
-     * @param {any} signer
-     */
-    constructor(abi: any[] | Interface, bytecode: string, signer: any);
-    abi: any;
-    interface: Interface;
-    bytecode: string;
-    signer: any;
-    /**
-     * Compute deploy transaction request.
-     * @param  {...any} args
-     * @returns {import("../providers/provider").TransactionRequest}
-     */
-    getDeployTransaction(...args: any[]): import("../providers/provider").TransactionRequest;
-    /**
-     * Deploy contract.
-     * @param  {...any} args
-     * @returns {Promise<Contract>}
-     */
-    deploy(...args: any[]): Promise<Contract>;
-    attach(address: any): Contract;
-    connect(signer: any): ContractFactory;
-}
-import { Interface } from "../abi/interface";
-import { Contract } from "./contract";
+export class ContractFactory {
+    /**
+     * @param {any[]|Interface} abi
+     * @param {string} bytecode
+     * @param {any} signer
+     */
+    constructor(abi: any[] | Interface, bytecode: string, signer: any);
+    abi: any;
+    interface: Interface;
+    bytecode: string;
+    signer: any;
+    /**
+     * Compute deploy transaction request.
+     * @param  {...any} args
+     * @returns {import("../providers/provider").TransactionRequest}
+     */
+    getDeployTransaction(...args: any[]): import("../providers/provider").TransactionRequest;
+    /**
+     * Deploy contract.
+     * @param  {...any} args
+     * @returns {Promise<Contract>}
+     */
+    deploy(...args: any[]): Promise<Contract>;
+    attach(address: any): Contract;
+    connect(signer: any): ContractFactory;
+}
+import { Interface } from "../abi/interface";
+import { Contract } from "./contract";