@crisp-e3/zk-inputs 0.9.0 → 0.11.0

package/README.md

@@ -1,29 +1,64 @@
-# Wasm bundle for crisp-zk-inputs
+# @crisp-e3/zk-inputs
 
-Here we export wasm functionality for consumption in TypeScript to enable us to share code between
-Rust and TypeScript.
+WASM bindings for generating CRISP ZK proof inputs, compiled from Rust and shared between the
+server-side Node.js environment and the browser. This package lets the CRISP SDK produce the circuit
+witness data needed for Noir-based vote-validity proofs without duplicating the logic in TypeScript.
+
+## What it generates
+
+The WASM module wraps a `ZKInputsGenerator` class that performs BFV encryption and produces the
+witness data needed for CRISP's Noir circuits. Two main proof types are supported:
+
+- **Vote proof** (`generateInputs`) — encrypts a vote under the committee's threshold BFV public key
+  and produces a witness proving the vote is correctly encrypted and that the voter is eligible
+  (e.g. holds the required token balance, verified via a Merkle membership proof).
+
+- **Vote update / mask proof** (`generateInputsForUpdate`) — same structure, but used for revotes or
+  masker contributions under the
+  [vote masking](https://blog.theinterfold.com/vote-masking-receipt-freeness-secret-ballots/) scheme
+  that provides receipt-freeness. Unlike the first-vote path, this preserves the real
+  `prev_ct_commitment` (rather than zeroing it) to chain updates together.
+
+The generator also exposes `encryptVote` / `decryptVote` for standalone BFV operations and
+`generateKeys` for key generation.
+
+These witness objects are then passed to `@noir-lang/noir_js` and `@aztec/bb.js` to generate the
+actual ZK proofs.
 
 ## Usage
 
-This package exposes an `init` subpackage default function which should be used to universally load
-the wasm module instead of exporting the default loader.
+This package requires a universal init pattern because:
 
-This is because in modern node there is no need for preloading however in the browser we still need
-to load the wasm bundle.
+- In **Node.js** (>=18) WASM can be loaded synchronously — no preloading needed.
+- In the **browser** the WASM binary must be fetched and instantiated asynchronously.
 
-### ❌ DONT USE THE DEFAULT INIT
+The `init` subpackage handles both environments transparently.
+
+### ❌ Don't use the default export
 
 ```ts
-// Bad! Because this uses the raw loader which doesn't exist in node contexts
-import init, { bfvEncryptNumber } from '@crisp-e3/zk-inputs'
+// Bad — the raw default loader doesn't work in Node.js contexts
+import init, { generateVoteInputs } from '@crisp-e3/zk-inputs'
 ```
 
-### ✅ DO USE THE EXPORTED SUBMODULE
+### ✅ Use the universal subpackage loader
 
 ```ts
-// Good! Use the universal loader
 import init from '@crisp-e3/zk-inputs/init'
+import { generateVoteInputs } from '@crisp-e3/zk-inputs'
 
 await init()
-// other package imports here
+const inputs = generateVoteInputs(/* ... */)
+```
+
+Call `init()` once before using any other imports from `@crisp-e3/zk-inputs`. In browser
+environments `init()` fetches the WASM binary; in Node.js it is a no-op.
+
+## Building
+
+The WASM bundle is compiled from the Rust source in `crates/crisp-zk-inputs` using `wasm-pack`:
+
+```bash
+# From the CRISP root
+pnpm build:wasm
 ```

package/dist/index.d.ts

@@ -55,15 +55,15 @@ export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembl
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
     readonly __wbg_zkinputsgenerator_free: (a: number, b: number) => void;
-    readonly zkinputsgenerator_new: (a: number, b: bigint, c: number, d: number) => [number, number, number];
-    readonly zkinputsgenerator_withDefaults: () => [number, number, number];
+    readonly zkinputsgenerator_decryptVote: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly zkinputsgenerator_encryptVote: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly zkinputsgenerator_generateInputs: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
     readonly zkinputsgenerator_generateInputsForUpdate: (a: number, b: number, c: number, d: number, e: number, f: number, g: number) => [number, number, number];
     readonly zkinputsgenerator_generateKeys: (a: number) => [number, number, number];
-    readonly zkinputsgenerator_encryptVote: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
-    readonly zkinputsgenerator_decryptVote: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
     readonly zkinputsgenerator_getBFVParams: (a: number) => [number, number, number];
+    readonly zkinputsgenerator_new: (a: number, b: bigint, c: number, d: number) => [number, number, number];
     readonly zkinputsgenerator_version: () => [number, number];
+    readonly zkinputsgenerator_withDefaults: () => [number, number, number];
     readonly __wbindgen_exn_store: (a: number) => void;
     readonly __externref_table_alloc: () => number;
     readonly __wbindgen_externrefs: WebAssembly.Table;

package/dist/index.js

@@ -5,7 +5,6 @@
  */
 export class ZKInputsGenerator {
     static __wrap(ptr) {
-        ptr = ptr >>> 0;
         const obj = Object.create(ZKInputsGenerator.prototype);
         obj.__wbg_ptr = ptr;
         ZKInputsGeneratorFinalization.register(obj, obj.__wbg_ptr, obj);
@@ -139,7 +138,7 @@ export class ZKInputsGenerator {
         if (ret[2]) {
             throw takeFromExternrefTable0(ret[1]);
         }
-        this.__wbg_ptr = ret[0] >>> 0;
+        this.__wbg_ptr = ret[0];
         ZKInputsGeneratorFinalization.register(this, this.__wbg_ptr, this);
         return this;
     }
@@ -172,142 +171,49 @@ export class ZKInputsGenerator {
     }
 }
 if (Symbol.dispose) ZKInputsGenerator.prototype[Symbol.dispose] = ZKInputsGenerator.prototype.free;
-
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,
-        __wbg_BigInt_7ea1e749ce6b92fd: function() { return handleError(function (arg0) {
+        __wbg_BigInt_d576983233c6e0d1: function() { return handleError(function (arg0) {
             const ret = BigInt(arg0);
             return ret;
         }, arguments); },
-        __wbg___wbindgen_is_function_0095a73b8b156f76: function(arg0) {
-            const ret = typeof(arg0) === 'function';
-            return ret;
-        },
-        __wbg___wbindgen_is_object_5ae8e5880f2c1fbd: function(arg0) {
-            const val = arg0;
-            const ret = typeof(val) === 'object' && val !== null;
-            return ret;
-        },
-        __wbg___wbindgen_is_string_cd444516edc5b180: function(arg0) {
-            const ret = typeof(arg0) === 'string';
-            return ret;
-        },
-        __wbg___wbindgen_is_undefined_9e4d92534c42d778: function(arg0) {
-            const ret = arg0 === undefined;
-            return ret;
-        },
-        __wbg___wbindgen_throw_be289d5034ed271b: function(arg0, arg1) {
+        __wbg___wbindgen_throw_1506f2235d1bdba0: function(arg0, arg1) {
             throw new Error(getStringFromWasm0(arg0, arg1));
         },
-        __wbg_call_389efe28435a9388: function() { return handleError(function (arg0, arg1) {
-            const ret = arg0.call(arg1);
-            return ret;
-        }, arguments); },
-        __wbg_call_4708e0c13bdc8e95: function() { return handleError(function (arg0, arg1, arg2) {
-            const ret = arg0.call(arg1, arg2);
-            return ret;
-        }, arguments); },
-        __wbg_crypto_86f2631e91b51511: function(arg0) {
-            const ret = arg0.crypto;
-            return ret;
-        },
-        __wbg_getRandomValues_b3f15fcbfabb0f8b: function() { return handleError(function (arg0, arg1) {
-            arg0.getRandomValues(arg1);
+        __wbg_getRandomValues_3f44b700395062e5: function() { return handleError(function (arg0, arg1) {
+            globalThis.crypto.getRandomValues(getArrayU8FromWasm0(arg0, arg1));
         }, arguments); },
-        __wbg_length_32ed9a279acd054c: function(arg0) {
-            const ret = arg0.length;
-            return ret;
-        },
-        __wbg_msCrypto_d562bbe83e0d4b91: function(arg0) {
-            const ret = arg0.msCrypto;
-            return ret;
-        },
-        __wbg_new_361308b2356cecd0: function() {
+        __wbg_new_ce1ab61c1c2b300d: function() {
             const ret = new Object();
             return ret;
         },
-        __wbg_new_3eb36ae241fe6f44: function() {
+        __wbg_new_d90091b82fdf5b91: function() {
             const ret = new Array();
             return ret;
         },
-        __wbg_new_from_slice_a3d2629dc1826784: function(arg0, arg1) {
+        __wbg_new_from_slice_18fa1f71286d66b8: function(arg0, arg1) {
             const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
             return ret;
         },
-        __wbg_new_no_args_1c7c842f08d00ebb: function(arg0, arg1) {
-            const ret = new Function(getStringFromWasm0(arg0, arg1));
-            return ret;
-        },
-        __wbg_new_with_length_a2c39cbe88fd8ff1: function(arg0) {
-            const ret = new Uint8Array(arg0 >>> 0);
-            return ret;
-        },
-        __wbg_node_e1f24f89a7336c2e: function(arg0) {
-            const ret = arg0.node;
-            return ret;
-        },
-        __wbg_parse_708461a1feddfb38: function() { return handleError(function (arg0, arg1) {
+        __wbg_parse_03863847d06c4e89: function() { return handleError(function (arg0, arg1) {
             const ret = JSON.parse(getStringFromWasm0(arg0, arg1));
             return ret;
         }, arguments); },
-        __wbg_process_3975fd6c72f520aa: function(arg0) {
-            const ret = arg0.process;
-            return ret;
-        },
-        __wbg_prototypesetcall_bdcdcc5842e4d77d: function(arg0, arg1, arg2) {
-            Uint8Array.prototype.set.call(getArrayU8FromWasm0(arg0, arg1), arg2);
-        },
-        __wbg_push_8ffdcb2063340ba5: function(arg0, arg1) {
+        __wbg_push_a6822215aa43e71c: function(arg0, arg1) {
             const ret = arg0.push(arg1);
             return ret;
         },
-        __wbg_randomFillSync_f8c153b79f285817: function() { return handleError(function (arg0, arg1) {
-            arg0.randomFillSync(arg1);
-        }, arguments); },
-        __wbg_require_b74f47fc2d022fd6: function() { return handleError(function () {
-            const ret = module.require;
-            return ret;
-        }, arguments); },
-        __wbg_set_6cb8631f80447a67: function() { return handleError(function (arg0, arg1, arg2) {
+        __wbg_set_6e30c9374c26414c: function() { return handleError(function (arg0, arg1, arg2) {
             const ret = Reflect.set(arg0, arg1, arg2);
             return ret;
         }, arguments); },
-        __wbg_static_accessor_GLOBAL_12837167ad935116: function() {
-            const ret = typeof global === 'undefined' ? null : global;
-            return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-        },
-        __wbg_static_accessor_GLOBAL_THIS_e628e89ab3b1c95f: function() {
-            const ret = typeof globalThis === 'undefined' ? null : globalThis;
-            return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-        },
-        __wbg_static_accessor_SELF_a621d3dfbb60d0ce: function() {
-            const ret = typeof self === 'undefined' ? null : self;
-            return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-        },
-        __wbg_static_accessor_WINDOW_f8727f0cf888e0bd: function() {
-            const ret = typeof window === 'undefined' ? null : window;
-            return isLikeNone(ret) ? 0 : addToExternrefTable0(ret);
-        },
-        __wbg_subarray_a96e1fef17ed23cb: function(arg0, arg1, arg2) {
-            const ret = arg0.subarray(arg1 >>> 0, arg2 >>> 0);
-            return ret;
-        },
-        __wbg_versions_4e31226f5e8dc909: function(arg0) {
-            const ret = arg0.versions;
-            return ret;
-        },
         __wbindgen_cast_0000000000000001: function(arg0) {
             // Cast intrinsic for `F64 -> Externref`.
             const ret = arg0;
             return ret;
         },
         __wbindgen_cast_0000000000000002: function(arg0, arg1) {
-            // Cast intrinsic for `Ref(Slice(U8)) -> NamedExternref("Uint8Array")`.
-            const ret = getArrayU8FromWasm0(arg0, arg1);
-            return ret;
-        },
-        __wbindgen_cast_0000000000000003: function(arg0, arg1) {
             // Cast intrinsic for `Ref(String) -> Externref`.
             const ret = getStringFromWasm0(arg0, arg1);
             return ret;
@@ -330,7 +236,7 @@ function __wbg_get_imports() {
 
 const ZKInputsGeneratorFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
-    : new FinalizationRegistry(ptr => wasm.__wbg_zkinputsgenerator_free(ptr >>> 0, 1));
+    : new FinalizationRegistry(ptr => wasm.__wbg_zkinputsgenerator_free(ptr, 1));
 
 function addToExternrefTable0(obj) {
     const idx = wasm.__externref_table_alloc();
@@ -365,8 +271,7 @@ function getBigUint64ArrayMemory0() {
 }
 
 function getStringFromWasm0(ptr, len) {
-    ptr = ptr >>> 0;
-    return decodeText(ptr, len);
+    return decodeText(ptr >>> 0, len);
 }
 
 let cachedUint8ArrayMemory0 = null;
@@ -386,10 +291,6 @@ function handleError(f, args) {
     }
 }
 
-function isLikeNone(x) {
-    return x === undefined || x === null;
-}
-
 function passArray64ToWasm0(arg, malloc) {
     const ptr = malloc(arg.length * 8, 8) >>> 0;
     getBigUint64ArrayMemory0().set(arg, ptr / 8);
@@ -426,8 +327,9 @@ function decodeText(ptr, len) {
 
 let WASM_VECTOR_LEN = 0;
 
-let wasmModule, wasm;
+let wasmModule, wasmInstance, wasm;
 function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
     wasm = instance.exports;
     wasmModule = module;
     cachedBigInt64ArrayMemory0 = null;