@baerae/zkap-zkp-react-native 0.1.4 → 0.1.6

package/README.md

@@ -5,7 +5,7 @@ React Native SDK for zkap-zkp with Expo modules integration.
 Install:
 
 ```bash
-npm install @baerae/zkap-zkp-react-native
+npx expo install @baerae/zkap-zkp-react-native
 ```
 
 Requires Expo New Architecture and the following peer dependencies:
@@ -22,3 +22,26 @@ const anchor = await generateAnchor(config, secrets)
 ```
 
 The npm package bundles the iOS XCFramework and Android `.so` libraries produced by CI.
+
+This direct runtime package exposes the React Native UniFFI API and keeps the
+historical snake_case request/config shape. Use `@baerae/zkap-zkp` with this
+package when you need the camelCase compatibility facade plus helpers such as
+`downloadRelease()` and `loadCircuitConfig()`.
+
+`prove()` expects a downloaded zkap-circuit release bundle that includes
+`manifest.json`, `pk.bin`, `circuit.ar1cs`, and `witness_gen.wasm` from the same
+circuit release. The package does not bundle `witness_gen.wasm`.
+
+On iOS-family targets, `witness_gen.wasm` runs inside a headless `WKWebView`.
+The witness output is transferred back to native code with chunked base64,
+validated by sha256/length, written to a temp file, and then consumed by the
+native proof pipeline. The iOS native binary does not link Wasmtime, Cranelift,
+Pulley, or Wasmi.
+
+Android and other non-iOS native targets keep the Wasmtime-backed witness
+runtime and pass witness bytes directly into the native proof pipeline without a
+React Native bridge transfer.
+
+For App Store submissions, keep the zkap-circuit release URL immutable and pin
+the expected release artifact hashes. The SDK validates the release bundle before
+proving, but App Review approval is still the host app's responsibility.

package/ZkapReactNative.podspec

@@ -0,0 +1,42 @@
+# Generated by uniffi-bindgen-react-native
+require "json"
+
+package = JSON.parse(File.read(File.join(__dir__, "package.json")))
+folly_compiler_flags = '-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1 -Wno-comma -Wno-shorten-64-to-32'
+
+Pod::Spec.new do |s|
+  s.name         = "ZkapReactNative"
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+
+  s.platforms    = { :ios => min_ios_version_supported }
+  s.source       = { :git => "https://github.com/baerae-zkap/zkap-zkp-sdk.git", :tag => "#{s.version}" }
+
+  s.source_files = "ios/ZkapReactNative.{h,mm}", "cpp/**/*.{hpp,cpp,c,h}"
+  s.vendored_frameworks = "ios/ZkapZkp.xcframework"
+  s.frameworks = "WebKit"
+  s.dependency "uniffi-bindgen-react-native", "0.31.0-2"
+
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+
+    if ENV["RCT_NEW_ARCH_ENABLED"] == "1" then
+      s.compiler_flags = folly_compiler_flags + " -DRCT_NEW_ARCH_ENABLED=1"
+      s.pod_target_xcconfig = {
+        "HEADER_SEARCH_PATHS" => "\"$(PODS_ROOT)/boost\"",
+        "OTHER_CPLUSPLUSFLAGS" => "-DFOLLY_NO_CONFIG -DFOLLY_MOBILE=1 -DFOLLY_USE_LIBCPP=1",
+        "CLANG_CXX_LANGUAGE_STANDARD" => "c++17"
+      }
+      s.dependency "React-Codegen"
+      s.dependency "RCT-Folly"
+      s.dependency "RCTRequired"
+      s.dependency "RCTTypeSafety"
+      s.dependency "ReactCommon/turbomodule/core"
+    end
+  end
+end

package/android/CMakeLists.txt

@@ -0,0 +1,81 @@
+# Generated by uniffi-bindgen-react-native
+cmake_minimum_required(VERSION 3.9.0)
+project(ZkapReactNative)
+
+set (CMAKE_VERBOSE_MAKEFILE ON)
+set (CMAKE_CXX_STANDARD 17)
+
+if(NOT DEFINED NODE_MODULES_DIR)
+    set(NODE_MODULES_DIR "${CMAKE_SOURCE_DIR}/../../node_modules")
+endif()
+
+# Resolve the path to the uniffi-bindgen-react-native package. When this
+# package is consumed through a local file dependency, Gradle follows the
+# symlink into this repo, so Node's default lookup does not reach the app's
+# node_modules unless we pass it explicitly.
+execute_process(
+    COMMAND node -p "require.resolve('uniffi-bindgen-react-native/package.json', { paths: [process.cwd(), '${NODE_MODULES_DIR}'] })"
+    OUTPUT_VARIABLE UNIFFI_BINDGEN_PATH
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+# Get the directory; get_filename_component and cmake_path will normalize
+# paths with Windows path separators.
+get_filename_component(UNIFFI_BINDGEN_PATH "${UNIFFI_BINDGEN_PATH}" DIRECTORY)
+
+# Specifies a path to native header files.
+include_directories(
+    ../cpp
+    ../cpp/generated
+
+    ${UNIFFI_BINDGEN_PATH}/cpp/includes
+)
+
+add_library(baerae-zkap-react-native            SHARED
+    ../cpp/baerae-zkap-react-native.cpp
+    ../cpp/generated/zkap_uniffi_bindings.cpp
+    cpp-adapter.cpp
+)
+
+# Set C++ compiler flags
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fexceptions")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -frtti")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fstack-protector-all")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror")
+
+# Set linker flags for 16KB page size alignment (required for Android 15+)
+set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-z,max-page-size=16384")
+
+set(MY_RUST_LIB_DIR "${CMAKE_SOURCE_DIR}/libs/${ANDROID_ABI}")
+target_link_directories(baerae-zkap-react-native PRIVATE "${MY_RUST_LIB_DIR}")
+
+# Add ReactAndroid libraries, being careful to account for different versions.
+find_package(ReactAndroid REQUIRED CONFIG)
+find_library(LOGCAT log)
+
+# REACTNATIVE_MERGED_SO seems to be only be set in a build.gradle.kt file,
+# which we don't use. Thus falling back to version number sniffing.
+if (ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
+  set(REACTNATIVE_MERGED_SO true)
+endif()
+
+# https://github.com/react-native-community/discussions-and-proposals/discussions/816
+# This if-then-else can be removed once this library does not support version below 0.76
+if (REACTNATIVE_MERGED_SO)
+  target_link_libraries(baerae-zkap-react-native ReactAndroid::reactnative)
+else()
+  target_link_libraries(baerae-zkap-react-native
+    ReactAndroid::turbomodulejsijni
+    ReactAndroid::react_nativemodule_core
+  )
+endif()
+
+find_package(fbjni REQUIRED CONFIG)
+target_link_libraries(
+  baerae-zkap-react-native
+  fbjni::fbjni
+  ReactAndroid::jsi
+  ${LOGCAT}
+  zkap_uniffi_bindings
+)

package/android/build.gradle

@@ -1,32 +1,129 @@
-apply plugin: 'com.android.library'
-apply plugin: 'kotlin-android'
+// Generated by uniffi-bindgen-react-native
+
+buildscript {
+  def kotlin_version = rootProject.ext.has("kotlinVersion") ? rootProject.ext.get("kotlinVersion") : (project.properties["ZkapReactNative_kotlinVersion"] ?: "1.9.24")
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:7.2.1"
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+def reactNativeArchitectures() {
+  def value = rootProject.getProperties().get("reactNativeArchitectures")
+  def supported = ["x86_64", "arm64-v8a"]
+  return value ? value.split(",").findAll { supported.contains(it) } : supported
+}
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrDefault(name) {
+  def defaults = [
+    kotlinVersion: "1.9.24",
+    ndkVersion: "27.1.12297006",
+  ]
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ZkapReactNative_" + name] ?: defaults[name])
+}
+
+def getExtOrIntegerDefault(name) {
+  def defaults = [
+    compileSdkVersion: 35,
+    minSdkVersion: 24,
+    targetSdkVersion: 35,
+  ]
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ZkapReactNative_" + name] ?: defaults[name]).toInteger()
+}
 
 android {
-  compileSdkVersion 34
-  namespace "expo.modules.zkap"
+  namespace "com.baerae.zkapreactnative"
+  ndkVersion getExtOrDefault("ndkVersion")
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
 
   defaultConfig {
-    minSdkVersion 24
-    targetSdkVersion 34
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+    consumerProguardFiles "proguard-rules.pro"
+
+    buildFeatures {
+      prefab true
+    }
+    externalNativeBuild {
+      cmake {
+        arguments "-DANDROID_STL=c++_shared",
+          "-DNODE_MODULES_DIR=${rootProject.projectDir}/../node_modules"
+        abiFilters (*reactNativeArchitectures())
+      }
+    }
+    ndk {
+      abiFilters "arm64-v8a", "x86_64"
+    }
   }
 
   sourceSets {
     main {
-      java.srcDirs += ['src/main/java']
-      jniLibs.srcDirs = ['libs']
+      java.srcDirs = ["src/main/java/com/baerae/zkapreactnative"]
+      kotlin.srcDirs = ["src/main/java/com/baerae/zkapreactnative"]
+      jniLibs.srcDirs = ["libs"]
+    }
+  }
+
+  externalNativeBuild {
+    cmake {
+      path "CMakeLists.txt"
+    }
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
     }
   }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
 }
 
 repositories {
   mavenCentral()
+  google()
 }
 
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
 dependencies {
-  implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.0"
-  // JNA is required by uniffi-generated Kotlin bindings
-  implementation "net.java.dev.jna:jna:5.14.0@aar"
-  // expo-modules-core provides Module, ModuleDefinition, AsyncFunction, etc.
-  // compileOnly: provided by the consumer app at runtime
-  compileOnly project(':expo-modules-core')
+  implementation "com.facebook.react:react-native:+"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "ZkapReactNative"
+    codegenJavaPackageName = "com.baerae.zkapreactnative"
+  }
 }

package/android/cpp-adapter.cpp

@@ -0,0 +1,43 @@
+// Generated by uniffi-bindgen-react-native
+#include <jni.h>
+#include <jsi/jsi.h>
+#include <ReactCommon/CallInvokerHolder.h>
+#include "baerae-zkap-react-native.h"
+
+namespace jsi = facebook::jsi;
+namespace react = facebook::react;
+
+// Automated testing checks Java_com_baerae_zkapreactnative_ZkapReactNativeModule and baerae_zkapreactnative
+// by comparing the whole line here.
+/*
+Java_com_baerae_zkapreactnative_ZkapReactNativeModule_nativeMultiply(JNIEnv *env, jclass type, jdouble a, jdouble b) {
+    return baerae_zkapreactnative::multiply(a, b);
+}
+*/
+
+// Installer coming from ZkapReactNativeModule
+extern "C"
+JNIEXPORT jboolean JNICALL
+Java_com_baerae_zkapreactnative_ZkapReactNativeModule_nativeInstallRustCrate(
+    JNIEnv *env,
+    jclass type,
+    jlong rtPtr,
+    jobject callInvokerHolderJavaObj
+) {
+    using JCallInvokerHolder = facebook::react::CallInvokerHolder;
+
+    auto holderLocal = facebook::jni::make_local(callInvokerHolderJavaObj);
+    auto holderRef = facebook::jni::static_ref_cast<JCallInvokerHolder::javaobject>(holderLocal);
+    auto* holderCxx = holderRef->cthis();
+    auto jsCallInvoker = holderCxx->getCallInvoker();
+    auto runtime = reinterpret_cast<jsi::Runtime *>(rtPtr);
+
+    return baerae_zkapreactnative::installRustCrate(*runtime, jsCallInvoker);
+}
+
+extern "C"
+JNIEXPORT jboolean JNICALL
+Java_com_baerae_zkapreactnative_ZkapReactNativeModule_nativeCleanupRustCrate(JNIEnv *env, jclass type, jlong rtPtr) {
+    auto runtime = reinterpret_cast<jsi::Runtime *>(rtPtr);
+    return baerae_zkapreactnative::cleanupRustCrate(*runtime);
+}

package/android/proguard-rules.pro

@@ -0,0 +1,2 @@
+# Consumer ProGuard rules for @baerae/zkap-zkp-react-native.
+# No keep rules are currently required.

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,5 @@
+
+<!-- Generated by uniffi-bindgen-react-native -->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.baerae.zkapreactnative">
+</manifest>

package/android/src/main/java/com/baerae/zkapreactnative/ZkapReactNativeModule.kt

@@ -0,0 +1,51 @@
+// Generated by uniffi-bindgen-react-native
+package com.baerae.zkapreactnative
+
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.bridge.Promise
+import com.facebook.react.module.annotations.ReactModule
+import com.facebook.react.turbomodule.core.interfaces.CallInvokerHolder
+
+@ReactModule(name = ZkapReactNativeModule.NAME)
+class ZkapReactNativeModule(reactContext: ReactApplicationContext) :
+  NativeZkapReactNativeSpec(reactContext) {
+
+  override fun getName(): String {
+    return NAME
+  }
+
+  // Two native methods implemented in cpp-adapter.cpp, and ultimately
+  // baerae-zkap-react-native.cpp
+
+  external fun nativeInstallRustCrate(runtimePointer: Long, callInvoker: CallInvokerHolder): Boolean
+  external fun nativeCleanupRustCrate(runtimePointer: Long): Boolean
+
+  override fun installRustCrate(): Boolean {
+    val context = this.reactApplicationContext
+    return nativeInstallRustCrate(
+      context.javaScriptContextHolder!!.get(),
+      context.jsCallInvokerHolder!!
+    )
+  }
+
+  override fun cleanupRustCrate(): Boolean {
+    return nativeCleanupRustCrate(
+      this.reactApplicationContext.javaScriptContextHolder!!.get()
+    )
+  }
+
+  override fun runWitnessInWkWebView(inputJson: String, promise: Promise) {
+    promise.reject(
+      "zkap-witness-webview-unsupported",
+      "runWitnessInWkWebView is only available on iOS"
+    )
+  }
+
+  companion object {
+    const val NAME = "ZkapReactNative"
+
+    init {
+      System.loadLibrary("baerae-zkap-react-native")
+    }
+  }
+}

package/android/src/main/java/com/baerae/zkapreactnative/ZkapReactNativePackage.kt

@@ -0,0 +1,34 @@
+// Generated by uniffi-bindgen-react-native
+package com.baerae.zkapreactnative
+
+import com.facebook.react.TurboReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import java.util.HashMap
+
+class ZkapReactNativePackage : TurboReactPackage() {
+  override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+    return if (name == ZkapReactNativeModule.NAME) {
+      ZkapReactNativeModule(reactContext)
+    } else {
+      null
+    }
+  }
+
+  override fun getReactModuleInfoProvider(): ReactModuleInfoProvider {
+    return ReactModuleInfoProvider {
+      val moduleInfos: MutableMap<String, ReactModuleInfo> = HashMap()
+      moduleInfos[ZkapReactNativeModule.NAME] = ReactModuleInfo(
+        ZkapReactNativeModule.NAME,
+        ZkapReactNativeModule.NAME,
+        false,  // canOverrideExistingModule
+        false,  // needsEagerInit
+        false,  // isCxxModule
+        true // isTurboModule
+      )
+      moduleInfos
+    }
+  }
+}

package/cpp/baerae-zkap-react-native.cpp

@@ -0,0 +1,17 @@
+// Generated by uniffi-bindgen-react-native
+#include "baerae-zkap-react-native.h"
+#include "generated/zkap_uniffi_bindings.hpp"
+
+namespace baerae_zkapreactnative {
+	using namespace facebook;
+
+	uint8_t installRustCrate(jsi::Runtime &runtime, std::shared_ptr<react::CallInvoker> callInvoker) {
+		NativeZkapUniffiBindings::registerModule(runtime, callInvoker);
+		return true;
+	}
+
+	uint8_t cleanupRustCrate(jsi::Runtime &runtime) {
+		NativeZkapUniffiBindings::unregisterModule(runtime);
+		return true;
+	}
+}

package/cpp/baerae-zkap-react-native.h

@@ -0,0 +1,15 @@
+#ifndef BAERAE_ZKAPREACTNATIVE_H
+#define BAERAE_ZKAPREACTNATIVE_H
+// Generated by uniffi-bindgen-react-native
+#include <cstdint>
+#include <jsi/jsi.h>
+#include <ReactCommon/CallInvoker.h>
+
+namespace baerae_zkapreactnative {
+  using namespace facebook;
+
+  uint8_t installRustCrate(jsi::Runtime &runtime, std::shared_ptr<react::CallInvoker> callInvoker);
+  uint8_t cleanupRustCrate(jsi::Runtime &runtime);
+}
+
+#endif /* BAERAE_ZKAPREACTNATIVE_H */