@theqrl/dilithium5 1.2.2 → 1.2.3

package/README.md

@@ -26,10 +26,11 @@ const pk = new Uint8Array(CryptoPublicKeyBytes);  // 2592 bytes
 const sk = new Uint8Array(CryptoSecretKeyBytes);  // 4896 bytes
 cryptoSignKeypair(null, pk, sk);  // null = random seed
 
-// Sign a message (hedged by default — recommended per TOB-QRLLIB-6).
-// Pass `false` only when deterministic signatures are themselves a
-// protocol requirement (e.g. KAT vector reproduction); for that case
-// use `cryptoSignDeterministic`.
+// Sign a message. The randomized flag is required — there is no default;
+// hedged (`true`) is the recommended mode. Pass `false` only when
+// deterministic signatures are themselves a protocol requirement
+// (e.g. KAT vector reproduction); for that case use
+// `cryptoSignDeterministic`.
 const message = new TextEncoder().encode('Hello, quantum world!');
 const signedMessage = cryptoSign(message, sk, true);  // true = hedged (recommended)
 
@@ -121,7 +122,7 @@ Check if buffer is all zeros (constant-time).
 go-qrllib pre-hashes seeds with SHAKE256 before key generation. To generate matching keys:
 
 ```javascript
-import { shake256 } from '@noble/hashes/sha3';
+import { shake256 } from '@noble/hashes/sha3.js';
 
 // go-qrllib: hashedSeed = SHAKE256(rawSeed)[:32]
 const hashedSeed = shake256(rawSeed, { dkLen: 32 });

package/dist/cjs/dilithium5.d.cts

@@ -50,7 +50,7 @@ export const zetas: readonly number[];
  * @throws Error if pk/sk buffers are wrong size or null
  */
 export function cryptoSignKeypair(
-  seed: Uint8Array | null,
+  seed: Uint8Array | null | undefined,
   pk: Uint8Array,
   sk: Uint8Array
 ): Uint8Array;
@@ -187,6 +187,12 @@ export function isZero(buffer: Uint8Array): boolean;
 /**
  * Zero the coefficient arrays of a polynomial vector (best-effort, see
  * SECURITY.md). Centralizes the secret-wiping pattern used by signing paths.
+ *
+ * @deprecated Internal API — its parameter types (`PolyVecK`/`PolyVecL`) are
+ * themselves internal and cannot be constructed through the documented
+ * surface, so this is a stable function over deprecated types. Not part of
+ * the stable documented API; will move behind a subpath or be removed at the
+ * next major version. See CONTRIBUTING.md "Public API surface policy".
  */
 export function zeroizePolyVec(polyVec: PolyVecK | PolyVecL): void;
 

package/dist/mjs/dilithium5.d.mts

@@ -50,7 +50,7 @@ export const zetas: readonly number[];
  * @throws Error if pk/sk buffers are wrong size or null
  */
 export function cryptoSignKeypair(
-  seed: Uint8Array | null,
+  seed: Uint8Array | null | undefined,
   pk: Uint8Array,
   sk: Uint8Array
 ): Uint8Array;
@@ -187,6 +187,12 @@ export function isZero(buffer: Uint8Array): boolean;
 /**
  * Zero the coefficient arrays of a polynomial vector (best-effort, see
  * SECURITY.md). Centralizes the secret-wiping pattern used by signing paths.
+ *
+ * @deprecated Internal API — its parameter types (`PolyVecK`/`PolyVecL`) are
+ * themselves internal and cannot be constructed through the documented
+ * surface, so this is a stable function over deprecated types. Not part of
+ * the stable documented API; will move behind a subpath or be removed at the
+ * next major version. See CONTRIBUTING.md "Public API surface policy".
  */
 export function zeroizePolyVec(polyVec: PolyVecK | PolyVecL): void;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theqrl/dilithium5",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Dilithium-5 cryptography",
   "keywords": [
     "dilithium",
@@ -34,8 +34,6 @@
     "test": "../../node_modules/mocha/bin/mocha.js --require ../../scripts/node-test-setup.cjs --timeout 10000",
     "test:browser": "playwright test",
     "build": "rollup -c && ./fixup",
-    "lint-check": "eslint 'src/**/*.js' 'test/**/*.js'",
-    "lint": "eslint --fix 'src/**/*.js' 'test/**/*.js'",
     "coverage": "c8 npm run test",
     "report-coverage": "c8 --reporter=text-lcov npm run test > coverage.lcov"
   },

package/src/index.d.ts

@@ -50,7 +50,7 @@ export const zetas: readonly number[];
  * @throws Error if pk/sk buffers are wrong size or null
  */
 export function cryptoSignKeypair(
-  seed: Uint8Array | null,
+  seed: Uint8Array | null | undefined,
   pk: Uint8Array,
   sk: Uint8Array
 ): Uint8Array;
@@ -187,6 +187,12 @@ export function isZero(buffer: Uint8Array): boolean;
 /**
  * Zero the coefficient arrays of a polynomial vector (best-effort, see
  * SECURITY.md). Centralizes the secret-wiping pattern used by signing paths.
+ *
+ * @deprecated Internal API — its parameter types (`PolyVecK`/`PolyVecL`) are
+ * themselves internal and cannot be constructed through the documented
+ * surface, so this is a stable function over deprecated types. Not part of
+ * the stable documented API; will move behind a subpath or be removed at the
+ * next major version. See CONTRIBUTING.md "Public API surface policy".
  */
 export function zeroizePolyVec(polyVec: PolyVecK | PolyVecL): void;