Merge pull request #18054 from MinaProtocol/leon/native/napi/proof-generation-functions

(`o1js`) Native prover type generation support

Author: querolita

src/lib/crypto/kimchi_bindings/js/dune

@@ -17,8 +17,7 @@
    bindings/verifier-index.js
    native/native-overrides/oracles.js
    native/native-overrides/util.js
-   native/native-overrides/circuit.js
-   ))
+   native/native-overrides/circuit.js))
  (instrumentation
   (backend bisect_ppx))
  (preprocess

src/lib/crypto/kimchi_bindings/js/native/artifacts/.gitignore

@@ -0,0 +1,2 @@
+index.d.ts
+plonk_napi.node

src/lib/crypto/kimchi_bindings/js/native/build.sh

@@ -4,27 +4,10 @@ set -euo pipefail
 SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
 CURRENT_DIRECTORY="${SCRIPT_DIR}"
 PROOF_SYSTEMS_ROOT=$(cd "${SCRIPT_DIR}/../../../proof-systems" && pwd)
-PLONK_NAPI_ROOT="${PROOF_SYSTEMS_ROOT}/plonk-napi"
 
-TARGET_ROOT="${CARGO_TARGET_DIR:-"${PROOF_SYSTEMS_ROOT}/target"}"
-export CARGO_TARGET_DIR="${TARGET_ROOT}"
-
-cargo build \
-    --manifest-path "${PLONK_NAPI_ROOT}/Cargo.toml" \
-    --release
-
-case "$(uname -s)" in
-    Darwin*) LIB_NAME="libplonk_napi.dylib" ;;
-    MINGW*|MSYS*|CYGWIN*) LIB_NAME="plonk_napi.dll" ;;
-    *) LIB_NAME="libplonk_napi.so" ;;
- esac
-
-ARTIFACT="${TARGET_ROOT}/release/${LIB_NAME}"
-
-if [[ ! -f "${ARTIFACT}" ]]; then
-    echo "Failed to locate plonk-napi artifact at ${ARTIFACT}" >&2
-    exit 1
-fi
-
-rm -f "${CURRENT_DIRECTORY}/plonk_napi.node"
-cp "${ARTIFACT}" "${CURRENT_DIRECTORY}/plonk_napi.node"
+napi build \
+    --manifest-path $PROOF_SYSTEMS_ROOT/Cargo.toml \
+    --package plonk-napi \
+    --output-dir ./ \
+    --release \
+    --esm

src/lib/crypto/kimchi_bindings/js/native/dune

@@ -2,20 +2,21 @@
  (name native_backend)
  (public_name bindings_js.native_backend)
  (js_of_ocaml
-  (flags
-   (:include flags.sexp))
   (javascript_files native_backend.js))
  (instrumentation
   (backend bisect_ppx))
  (preprocess
   (pps ppx_version js_of_ocaml-ppx)))
 
 (rule
- (targets
-  plonk_napi.node
-  flags.sexp)
+ (targets plonk_napi.node index.d.ts)
+ (mode
+  (promote
+   (into ./artifacts)))
  (deps
+  package.json
   build.sh
+  header-d.ts
   ../../dune-build-root
   (source_tree ../../../proof-systems))
  (locks /cargo-lock)
@@ -24,6 +25,4 @@
    (setenv
     CARGO_TARGET_DIR
     "%{read:../../dune-build-root}/cargo_kimchi_native"
-    (run bash build.sh))
-   (write-file flags.sexp "()"))))
-   
+    (run bash build.sh)))))

src/lib/crypto/kimchi_bindings/js/native/header-d.ts

@@ -0,0 +1,9 @@
+// Header section
+// To edit this section, look for 
+// ./src/lib/crypto/kimchi_bindings/js/native/header-d.ts
+// This file gets auto-included in the generated plonk-napi types to supplement
+// external pointer types.
+
+type WasmPastaFpPlonkIndex = {};
+
+// Header section end

src/lib/crypto/kimchi_bindings/js/native/native-overrides/oracles.js

@@ -4,9 +4,6 @@
 // Provides: caml_pasta_fq_poseidon_block_cipher
 // Requires: plonk_wasm, tsRustConversionNative
 function caml_pasta_fq_poseidon_block_cipher(_fake_params, fq_vector) {
-
-    console.log("overriding the old wasm caml_pasta_fq_poseidon_block_cipher, now using the native one")
-
   // 1. get permuted field vector from rust
   var wasm_flat_vector = plonk_wasm.caml_pasta_fq_poseidon_block_cipher(
     tsRustConversionNative.fq.vectorToRust(fq_vector)
@@ -22,10 +19,6 @@ function caml_pasta_fq_poseidon_block_cipher(_fake_params, fq_vector) {
 // Provides: caml_pasta_fp_poseidon_block_cipher
 // Requires: plonk_wasm, tsRustConversionNative
 function caml_pasta_fp_poseidon_block_cipher(_fake_params, fp_vector) {
-
-    console.log("overriding the old wasm caml_pasta_fp_poseidon_block_cipher, now using the native one")
-
-
   // 1. get permuted field vector from rust
   var wasm_flat_vector = plonk_wasm.caml_pasta_fp_poseidon_block_cipher(
     tsRustConversionNative.fp.vectorToRust(fp_vector)

src/lib/crypto/kimchi_bindings/js/native/native_backend.js

@@ -1,4 +1,2 @@
 // Provides: plonk_napi
-var plonk_napi = require('./plonk_napi.node');
-
-module.exports = plonk_napi;
+var plonk_napi = require('@o1js/native-' + process.platform + '-' + process.arch)

src/lib/crypto/kimchi_bindings/js/native/package.json

@@ -0,0 +1,6 @@
+{
+  "napi": {
+    "binaryName": "plonk_napi",
+    "dtsHeaderFile": "./header-d.ts"
+  }
+}

src/lib/crypto/kimchi_bindings/js/node_js/node_backend.js

@@ -1,29 +1,35 @@
 // Provides: plonk_wasm
-var plonk_wasm = require('./plonk_wasm.js');
-var native = null;
-try {
-  native = require('../native/plonk_napi.node');
-} catch (e) {
-  // native not available, keep WASM
-}
+var plonk_wasm = (function() {
+  var wasm = require('./plonk_wasm.js');
 
-function snakeToCamel(name) {
-  return name.replace(/_([a-z])/g, function (_match, ch) {
-    return ch.toUpperCase();
-  });
-}
+  try {
+    var native =  require('@o1js/native-' + process.platform + '-' + process.arch)
 
-function override(functionName) {
-  if (!native) return;
-  var camel = snakeToCamel(functionName);
-  var impl = native[functionName] || native[camel];
-  if (typeof impl === 'function') {
-    plonk_wasm[functionName] = impl;
+    // THIS IS A RUNTIME OVERRIDE
+    // YOU HAVE TO RUN IT TO SEE IF IT BREAKS
+    // IT WON'T CRASH UNLESS O1JS_REQUIRE_NATIVE_BINDINGS
+    // IS SET
+    var overrides = [
+      "prover_to_json",
+      "prover_index_from_bytes",
+      "prover_index_to_bytes",
+      "caml_pasta_fp_poseidon_block_cipher",
+      "caml_pasta_fq_poseidon_block_cipher",
+      "caml_pasta_fp_plonk_proof_create",
+    ]
+
+    overrides.forEach(function (override) {
+      wasm[override] = native[override]
+    })
+
+    wasm.native = true;
+  } catch (e) {
+    if (process.env.O1JS_REQUIRE_NATIVE_BINDINGS) {
+      console.error(e)
+      console.log("native didn't load")
+      process.exit(1);
+    }
   }
-}
 
-// Overwrite only the functions that are already available in native
-override('caml_pasta_fp_poseidon_block_cipher');
-override('caml_pasta_fq_poseidon_block_cipher');
-override('prover_to_json');
-override('prover_index_from_bytes');
+  return wasm
+})()

src/lib/crypto/kimchi_bindings/js/web/web_backend.js

@@ -1,2 +1,5 @@
 // Provides: plonk_wasm
 var plonk_wasm = globalThis.plonk_wasm;
+
+// Provides: plonk_napi
+var plonk_napi = globalThis.plonk_wasm