@lib-q/ring 0.0.2

package/README.md

@@ -0,0 +1,18 @@
+# lib-q-ring
+
+Portable negacyclic ring arithmetic for `R_q = Z_q[X]/(X^256 + 1)` with `q = 8_380_417` (FIPS 204 ML-DSA field). Shared by [**lib-q-ml-dsa**](../lib-q-ml-dsa), [**lib-q-lattice-zkp**](../lib-q-lattice-zkp), and related crates.
+
+## Contents
+
+- Montgomery / Barrett reduction and ML-DSA NTT (forward + inverse with Montgomery scaling)
+- Polynomial types `Poly` / `NttPoly`, module vectors and matrices
+- SHAKE128 matrix expansion (ExpandA-style) and FIPS 204 `SampleInBall` (SHAKE256)
+
+## Features
+
+- `default`: `alloc`
+- `alloc`: enables `lib-q-sha3/alloc` for XOF buffering helpers
+
+## Security
+
+This crate is **research-grade** infrastructure: parameter sets and protocol security are not asserted here.

package/integrity-manifest.json

@@ -0,0 +1,6 @@
+{
+  "integrity": {
+    "nodejs/lib_q_ring_bg.wasm": "sha384-hXicZ3IKvVYzEMMop8KPYR6V5W2/mlI/k5pWnNBgja7MIv18f3Na57YBlntuvORA",
+    "web/lib_q_ring_bg.wasm": "sha384-hXicZ3IKvVYzEMMop8KPYR6V5W2/mlI/k5pWnNBgja7MIv18f3Na57YBlntuvORA"
+  }
+}

package/nodejs/README.md

@@ -0,0 +1,18 @@
+# lib-q-ring
+
+Portable negacyclic ring arithmetic for `R_q = Z_q[X]/(X^256 + 1)` with `q = 8_380_417` (FIPS 204 ML-DSA field). Shared by [**lib-q-ml-dsa**](../lib-q-ml-dsa), [**lib-q-lattice-zkp**](../lib-q-lattice-zkp), and related crates.
+
+## Contents
+
+- Montgomery / Barrett reduction and ML-DSA NTT (forward + inverse with Montgomery scaling)
+- Polynomial types `Poly` / `NttPoly`, module vectors and matrices
+- SHAKE128 matrix expansion (ExpandA-style) and FIPS 204 `SampleInBall` (SHAKE256)
+
+## Features
+
+- `default`: `alloc`
+- `alloc`: enables `lib-q-sha3/alloc` for XOF buffering helpers
+
+## Security
+
+This crate is **research-grade** infrastructure: parameter sets and protocol security are not asserted here.

package/nodejs/lib_q_ring.d.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Ring dimension `N` (coefficients per polynomial), matching FIPS 204 ML-DSA.
+ */
+export function ringCoefficientCount(): number;
+
+/**
+ * Modulus `q` for \(R_q = Z_q[X]/(X^{256}+1)\).
+ */
+export function ringModulusQ(): number;

package/nodejs/lib_q_ring.js

@@ -0,0 +1,46 @@
+/* @ts-self-types="./lib_q_ring.d.ts" */
+
+/**
+ * Ring dimension `N` (coefficients per polynomial), matching FIPS 204 ML-DSA.
+ * @returns {number}
+ */
+function ringCoefficientCount() {
+    const ret = wasm.ringCoefficientCount();
+    return ret >>> 0;
+}
+exports.ringCoefficientCount = ringCoefficientCount;
+
+/**
+ * Modulus `q` for \(R_q = Z_q[X]/(X^{256}+1)\).
+ * @returns {number}
+ */
+function ringModulusQ() {
+    const ret = wasm.ringModulusQ();
+    return ret >>> 0;
+}
+exports.ringModulusQ = ringModulusQ;
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./lib_q_ring_bg.js": import0,
+    };
+}
+
+const wasmPath = `${__dirname}/lib_q_ring_bg.wasm`;
+const wasmBytes = require('fs').readFileSync(wasmPath);
+const wasmModule = new WebAssembly.Module(wasmBytes);
+let wasmInstance = new WebAssembly.Instance(wasmModule, __wbg_get_imports());
+let wasm = wasmInstance.exports;
+wasm.__wbindgen_start();

package/nodejs/lib_q_ring_bg.wasm.d.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const ringCoefficientCount: () => number;
+export const ringModulusQ: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_start: () => void;

package/nodejs/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "lib-q-ring",
+  "description": "Shared ring arithmetic (R_q = Z_q[X]/(X^n+1)) for FIPS 204 lattice primitives",
+  "version": "0.0.2",
+  "license": "Apache-2.0",
+  "files": [
+    "lib_q_ring_bg.wasm",
+    "lib_q_ring.js",
+    "lib_q_ring.d.ts"
+  ],
+  "main": "lib_q_ring.js",
+  "types": "lib_q_ring.d.ts",
+  "keywords": [
+    "cryptography",
+    "post-quantum",
+    "lattice",
+    "ml-dsa",
+    "no-std"
+  ]
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@lib-q/ring",
+  "type": "module",
+  "description": "ML-DSA ring arithmetic R_q (shared with lattice-zkp)",
+  "version": "0.0.2",
+  "license": "Apache-2.0",
+  "files": [
+    "web",
+    "nodejs",
+    "README.md",
+    "integrity-manifest.json"
+  ],
+  "main": "./nodejs/lib_q_ring.js",
+  "types": "./web/lib_q_ring.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": "[\"cryptography\",\"post-quantum\",\"lattice\",\"ml-dsa\",\"wasm\"]",
+  "author": "lib-Q Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Enkom-Tech/libQ.git"
+  },
+  "homepage": "https://github.com/Enkom-Tech/libQ#readme",
+  "bugs": {
+    "url": "https://github.com/Enkom-Tech/libQ/issues"
+  },
+  "module": "./web/lib_q_ring.js",
+  "exports": {
+    ".": {
+      "types": "./web/lib_q_ring.d.ts",
+      "browser": "./web/lib_q_ring.js",
+      "node": "./nodejs/lib_q_ring.js",
+      "default": "./web/lib_q_ring.js"
+    }
+  }
+}

package/web/README.md

@@ -0,0 +1,18 @@
+# lib-q-ring
+
+Portable negacyclic ring arithmetic for `R_q = Z_q[X]/(X^256 + 1)` with `q = 8_380_417` (FIPS 204 ML-DSA field). Shared by [**lib-q-ml-dsa**](../lib-q-ml-dsa), [**lib-q-lattice-zkp**](../lib-q-lattice-zkp), and related crates.
+
+## Contents
+
+- Montgomery / Barrett reduction and ML-DSA NTT (forward + inverse with Montgomery scaling)
+- Polynomial types `Poly` / `NttPoly`, module vectors and matrices
+- SHAKE128 matrix expansion (ExpandA-style) and FIPS 204 `SampleInBall` (SHAKE256)
+
+## Features
+
+- `default`: `alloc`
+- `alloc`: enables `lib-q-sha3/alloc` for XOF buffering helpers
+
+## Security
+
+This crate is **research-grade** infrastructure: parameter sets and protocol security are not asserted here.

package/web/lib_q_ring.d.ts

@@ -0,0 +1,44 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Ring dimension `N` (coefficients per polynomial), matching FIPS 204 ML-DSA.
+ */
+export function ringCoefficientCount(): number;
+
+/**
+ * Modulus `q` for \(R_q = Z_q[X]/(X^{256}+1)\).
+ */
+export function ringModulusQ(): number;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly ringCoefficientCount: () => number;
+    readonly ringModulusQ: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/web/lib_q_ring.js

@@ -0,0 +1,129 @@
+/* @ts-self-types="./lib_q_ring.d.ts" */
+
+/**
+ * Ring dimension `N` (coefficients per polynomial), matching FIPS 204 ML-DSA.
+ * @returns {number}
+ */
+export function ringCoefficientCount() {
+    const ret = wasm.ringCoefficientCount();
+    return ret >>> 0;
+}
+
+/**
+ * Modulus `q` for \(R_q = Z_q[X]/(X^{256}+1)\).
+ * @returns {number}
+ */
+export function ringModulusQ() {
+    const ret = wasm.ringModulusQ();
+    return ret >>> 0;
+}
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            const offset = table.grow(4);
+            table.set(0, undefined);
+            table.set(offset + 0, undefined);
+            table.set(offset + 1, null);
+            table.set(offset + 2, true);
+            table.set(offset + 3, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./lib_q_ring_bg.js": import0,
+    };
+}
+
+let wasmModule, wasmInstance, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
+    wasm = instance.exports;
+    wasmModule = module;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = module.ok && expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('lib_q_ring_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };

package/web/lib_q_ring_bg.wasm.d.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const ringCoefficientCount: () => number;
+export const ringModulusQ: () => number;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_start: () => void;

package/web/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "lib-q-ring",
+  "type": "module",
+  "description": "Shared ring arithmetic (R_q = Z_q[X]/(X^n+1)) for FIPS 204 lattice primitives",
+  "version": "0.0.2",
+  "license": "Apache-2.0",
+  "files": [
+    "lib_q_ring_bg.wasm",
+    "lib_q_ring.js",
+    "lib_q_ring.d.ts"
+  ],
+  "main": "lib_q_ring.js",
+  "types": "lib_q_ring.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ],
+  "keywords": [
+    "cryptography",
+    "post-quantum",
+    "lattice",
+    "ml-dsa",
+    "no-std"
+  ]
+}