add workflows, todo zkey migr

Author: erhant

.github/workflows/release.yaml

@@ -0,0 +1,46 @@
+name: "Release libraries"
+
+on:
+  release:
+    types: [published]
+  # TODO: remove manual dispatch
+  workflow_dispatch:
+
+jobs:
+  release:
+    name: Release - ${{ matrix.platform.os-name }}
+    strategy:
+      matrix:
+        platform:
+          - os-name: Linux-x86_64
+            runs-on: ubuntu-20.04
+            target: x86_64-unknown-linux-musl
+
+          - os-name: Linux-aarch64
+            runs-on: ubuntu-20.04
+            target: aarch64-unknown-linux-musl
+
+          - os-name: macOS-x86_64
+            runs-on: macOS-latest
+            target: x86_64-apple-darwin
+
+          # more targets here ...
+
+    runs-on: ${{ matrix.platform.runs-on }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build binary
+        uses: houseabsolute/actions-rust-cross@v1
+        with:
+          command: ${{ matrix.platform.command }}
+          target: ${{ matrix.platform.target }}
+          args: "--locked --release"
+          strip: true
+
+      - name: Publish artifacts and release
+        uses: houseabsolute/actions-rust-release@v0
+        with:
+          executable-name: ubi
+          target: ${{ matrix.platform.target }}

.github/workflows/test.yaml

@@ -0,0 +1,36 @@
+name: Rust Tests
+
+on:
+  push:
+    branches: ["main"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Build
+        run: cargo build --verbose
+
+      - name: Run tests
+        run: cargo test --verbose

TODO.md

@@ -0,0 +1,2 @@
+- [ ] Add Github Workflows
+- [ ] Add zkey reader from LambdaWorks

src/lambdaworks/mod.rs

@@ -6,6 +6,7 @@ pub use lambdaworks_groth16::*;
 use crate::{SnarkjsProof, SnarkjsPublicSignals};
 
 mod snarkjs;
+mod zkey;
 
 pub fn prove_with_witness(wtns_path: impl AsRef<Path>, r1cs_path: impl AsRef<Path>) {
     let (qap, wtns) = circom_to_lambda(

src/lambdaworks/zkey.rs

@@ -0,0 +1,96 @@
+//! Lambdaworks does not have a zkey reader by default, but we can add a converter from Arkworks perhaps.
+//!
+//!
+//! ## ArkWorks
+//!
+//! ```rs
+//! pub struct ProvingKey<E: Pairing> {
+//!    /// The underlying verification key.
+//!    pub vk: VerifyingKey<E>,
+//!    /// The element `beta * G` in `E::G1`.
+//!    pub beta_g1: E::G1Affine,
+//!    /// The element `delta * G` in `E::G1`.
+//!    pub delta_g1: E::G1Affine,
+//!    /// The elements `a_i * G` in `E::G1`.
+//!    pub a_query: Vec<E::G1Affine>,
+//!    /// The elements `b_i * G` in `E::G1`.
+//!    pub b_g1_query: Vec<E::G1Affine>,
+//!    /// The elements `b_i * H` in `E::G2`.
+//!    pub b_g2_query: Vec<E::G2Affine>,
+//!    /// The elements `h_i * G` in `E::G1`.
+//!    pub h_query: Vec<E::G1Affine>,
+//!    /// The elements `l_i * G` in `E::G1`.
+//!    pub l_query: Vec<E::G1Affine>,
+//!}
+//! ```
+//!
+//! ## LambdaWorks
+//!
+//! ```rs
+//! pub struct ProvingKey {
+//! pub alpha_g1: G1Point,
+//! pub beta_g1: G1Point,
+//! pub beta_g2: G2Point,
+//! pub delta_g1: G1Point,
+//! pub delta_g2: G2Point,
+//! // [A_0(τ)]_1, [A_1(τ)]_1, ..., [A_n(τ)]_1
+//! pub l_tau_g1: Vec<G1Point>,
+//! // [B_0(τ)]_1, [B_1(τ)]_1, ..., [B_n(τ)]_1
+//! pub r_tau_g1: Vec<G1Point>,
+//! // [B_0(τ)]_2, [B_1(τ)]_2, ..., [B_n(τ)]_2
+//! pub r_tau_g2: Vec<G2Point>,
+//! // [K_{k+1}(τ)]_1, [K_{k+2}(τ)]_1, ..., [K_n(τ)]_1
+//! // where K_i(τ) = ƍ^{-1} * (β*l(τ) + α*r(τ) + o(τ))
+//! // and "k" is the number of public inputs
+//! pub prover_k_tau_g1: Vec<G1Point>,
+//! // [delta^{-1} * t(τ) * tau^0]_1, [delta^{-1} * t(τ) * τ^1]_1, ..., [delta^{-1} * t(τ) * τ^m]_1
+//! pub z_powers_of_tau_g1: Vec<G1Point>,
+//! }
+//! ```
+
+use ark_ec::pairing::Pairing;
+use ark_groth16::VerifyingKey;
+use lambdaworks_groth16::common::{G1Point, G2Point};
+
+/// The prover key for for the Groth16 zkSNARK.
+pub struct ArkworksProvingKey<E: Pairing> {
+    /// The underlying verification key.
+    pub vk: VerifyingKey<E>,
+    /// The element `beta * G` in `E::G1`.
+    pub beta_g1: E::G1Affine,
+    /// The element `delta * G` in `E::G1`.
+    pub delta_g1: E::G1Affine,
+    /// The elements `a_i * G` in `E::G1`.
+    pub a_query: Vec<E::G1Affine>,
+    /// The elements `b_i * G` in `E::G1`.
+    pub b_g1_query: Vec<E::G1Affine>,
+    /// The elements `b_i * H` in `E::G2`.
+    pub b_g2_query: Vec<E::G2Affine>,
+    /// The elements `h_i * G` in `E::G1`.
+    pub h_query: Vec<E::G1Affine>,
+    /// The elements `l_i * G` in `E::G1`.
+    pub l_query: Vec<E::G1Affine>,
+}
+
+/// Converts an Arkworks `ProvingKey` to a Lambdaworks `ProvingKey`.
+///
+/// Here is how the mapping is done Arkworks to Lambdaworks:
+/// - `pk.vb.alpha_g1` -> `alpha_g1`
+///
+/// - `pk.b_g1_query` -> `beta_g1`
+/// - `pk.vk.beta_g2` -> `beta_g2`
+///
+/// - `pk.delta_g1` -> `delta_g1`
+/// - `pk.vk.delta_g2` -> `delta_g2`
+///
+/// - `pk.l_query` -> `l_tau_g1`
+/// - `pk.b_g1_query` -> `r_tau_g1`
+/// - `pk.b_g2_query` -> `r_tau_g2`
+///
+/// - `pk.vk.gamma_abc_g1` -> `prover_k_tau_g1`
+///
+pub fn convert_zkey<E: Pairing>(
+    ark_pk: ark_groth16::ProvingKey<E>,
+) -> lambdaworks_groth16::ProvingKey {
+    todo!()
+}

src/lib.rs

@@ -8,7 +8,9 @@ use std::ffi::{c_char, CStr, CString};
 
 pub use snarkjs::*;
 
-// TODO: !!!
+/// Given a string input, returns the same.
+/// 
+/// Can be used for testing.
 #[no_mangle]
 #[allow(improper_ctypes_definitions)]
 pub extern "C" fn echo(input: *const c_char) -> CString {
@@ -20,6 +22,7 @@ pub extern "C" fn echo(input: *const c_char) -> CString {
     CString::new(input).unwrap()
 }
 
+/// Generate an Arkworks proof.
 #[no_mangle]
 #[allow(improper_ctypes_definitions)]
 pub extern "C" fn arkworks_prove(