Document "build/wasm" scripts

Author: Shigoto-dev19

scripts/build/wasm/build-node.sh

@@ -1,7 +1,21 @@
 #!/usr/bin/env bash
-
 set -Eeuo pipefail
 
+# Description:
+#   Builds the Kimchi WebAssembly (WASM) bindings for Node.js. This script:
+#     - Compiles the Kimchi proof system’s Node bindings using Dune, generating
+#       the WebAssembly and JavaScript interface files:
+#         - `plonk_wasm_bg.wasm` and its TypeScript definitions.
+#         - `plonk_wasm.js` (the JS interface) and its type declarations.
+#     - Copies all generated artifacts into `src/bindings/compiled/node_bindings/`.
+#     - Converts the output files to CommonJS format (`.cjs` / `.d.cts`) for
+#       compatibility with Node.js environments.
+#     - Applies automatic fixes to the generated bindings via
+#       `src/build/fix-wasm-bindings-node.js` to ensure correct runtime behavior.
+#
+# Usage:
+#   npm run build:wasm:node
+
 source ./scripts/lib/ux.sh
 
 setup_script "wasm-node-build" "wasm node build"

scripts/build/wasm/build-web.sh

@@ -1,7 +1,23 @@
 #!/usr/bin/env bash
-
 set -Eeuo pipefail
 
+# Description:
+#   Builds the Kimchi WebAssembly (WASM) bindings for Web (browser) usage. This script:
+#     - Compiles the Kimchi proof system’s Web bindings using Dune, generating:
+#         - `plonk_wasm_bg.wasm` (the main WebAssembly module) and its TypeScript definitions.
+#         - `plonk_wasm.js` (the JavaScript interface) and its type declarations.
+#     - Copies all generated artifacts into `src/bindings/compiled/web_bindings/`.
+#     - Optimizes the WebAssembly binary using `wasm-opt` with advanced flags
+#       (`--detect-features`, `--enable-mutable-globals`, `-O4`) for performance and size reduction.
+#     - Ensures proper file permissions after optimization.
+#
+# Note:
+#   - Requires `wasm-opt` (from Binaryen) to be installed and available in PATH.
+#
+# Usage:
+#   npm run build:wasm:web
+
+
 source ./scripts/lib/ux.sh
 
 setup_script "wasm-web-build" "wasm web build"