feat: initial ci

.github/workflows/artifacts.yaml

@@ -0,0 +1,96 @@
+name: build-circuits
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install Protocol Buffers
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y protobuf-compiler libprotobuf-dev
+
+    - name: Install Rust
+      uses: dtolnay/rust-toolchain@master
+      with:
+        toolchain: nightly-2024-06-10
+
+    - name: Install Circom
+      run: |
+        CIRCOM_VERSION=2.1.9
+        curl -L https://github.com/iden3/circom/releases/download/v$CIRCOM_VERSION/circom-linux-amd64 -o circom
+        chmod +x circom
+        sudo mv circom /usr/local/bin/
+        circom --version
+
+    - name: Install circom-witnesscalc
+      run: |
+        cd .. && git clone https://github.com/pluto/circom-witnesscalc.git
+        cd circom-witnesscalc
+        cargo install --path .
+        echo $(which build-circuit)
+
+    - name: Install Node.js dependencies
+      run: |
+        npm install
+
+    - name: Compile Circom circuits
+      run: |
+        mkdir -p artifacts
+        for circuit in circuits/*.circom; do
+          if [ -f "$circuit" ]; then
+            filename=$(basename "$circuit" .circom)
+            output_dir="artifacts/$filename"
+            mkdir -p "$output_dir"
+
+            echo "Processing $filename..."
+
+            # Run circom compilation
+            circom "$circuit" --r1cs --wasm -o "$output_dir" -l node_modules
+
+            # Run witness calculator build
+            build-circuit "$circuit" "$output_dir/$filename.bin" -l node_modules
+          fi
+        done
+
+    - name: Create release artifacts
+      run: |
+        cd artifacts
+        zip -r ../circom-artifacts.zip ./*
+        cd ..
+
+    # Upload artifacts for PR
+    - name: Upload artifacts for PR
+      if: github.event_name == 'pull_request'
+      uses: actions/upload-artifact@v4
+      with:
+        name: circom-artifacts
+        path: artifacts/
+        retention-days: 5
+
+    # Create Release only on push to main
+    - name: Create Release
+      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+      uses: softprops/action-gh-release@v1
+      with:
+        files: circom-artifacts.zip
+        name: Circuit Artifacts ${{ github.sha }}
+        tag_name: v${{ github.run_number }}
+        body: |
+          Automated release of compiled Circom circuits
+          Commit: ${{ github.sha }}
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

circuits/json_mask_array_index.circom

@@ -0,0 +1,71 @@
+pragma circom 2.1.9;
+
+include "parser-attestor/circuits/json/interpreter.circom";
+
+template JsonMaskArrayIndexNIVC(TOTAL_BYTES, DATA_BYTES, MAX_STACK_HEIGHT) {
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~~ Set sizes at compile time ~~
+    // Total number of variables in the parser for each byte of data
+    assert(MAX_STACK_HEIGHT >= 2);
+    var PER_ITERATION_DATA_LENGTH = MAX_STACK_HEIGHT * 2 + 2;
+    var TOTAL_BYTES_USED          = DATA_BYTES * (PER_ITERATION_DATA_LENGTH + 1);
+    // ------------------------------------------------------------------------------------------------------------------ //
+
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~ Unravel from previous NIVC step ~
+    // Read in from previous NIVC step (JsonParseNIVC)
+    signal input step_in[TOTAL_BYTES];
+
+    // Grab the raw data bytes from the `step_in` variable
+    signal data[DATA_BYTES];
+    for (var i = 0 ; i < DATA_BYTES ; i++) {
+        data[i] <== step_in[i];
+    }
+
+    // Decode the encoded data in `step_in` back into parser variables
+    signal stack[DATA_BYTES][MAX_STACK_HEIGHT][2];
+    signal parsingData[DATA_BYTES][2];
+    for (var i = 0 ; i < DATA_BYTES ; i++) {
+        for (var j = 0 ; j < MAX_STACK_HEIGHT ; j++) {
+            stack[i][j][0] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + j * 2];
+            stack[i][j][1] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + j * 2 + 1];
+        }
+        parsingData[i][0] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + MAX_STACK_HEIGHT * 2];
+        parsingData[i][1] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + MAX_STACK_HEIGHT * 2 + 1];
+    }
+    // ------------------------------------------------------------------------------------------------------------------ //
+
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~ Array index masking ~
+    signal input index;
+
+    // value starting index in `data`
+    signal value_starting_index[DATA_BYTES];
+    signal mask[DATA_BYTES];
+
+    signal parsing_array[DATA_BYTES];
+    signal or[DATA_BYTES];
+
+    parsing_array[0] <== InsideArrayIndexObject()(stack[0][0], stack[0][1], parsingData[0][0], parsingData[0][1], index);
+    mask[0]          <== data[0] * parsing_array[0];
+
+    for(var data_idx = 1; data_idx < DATA_BYTES; data_idx++) {
+        parsing_array[data_idx] <== InsideArrayIndexObject()(stack[data_idx][0], stack[data_idx][1], parsingData[data_idx][0], parsingData[data_idx][1], index);
+
+        or[data_idx] <== OR()(parsing_array[data_idx], parsing_array[data_idx - 1]);
+        mask[data_idx] <== data[data_idx] * or[data_idx];
+    }
+
+    // Write the `step_out` with masked data
+    signal output step_out[TOTAL_BYTES];
+    for (var i = 0 ; i < DATA_BYTES ; i++) {
+        step_out[i] <== mask[i];
+    }
+    // Append the parser state back on `step_out`
+    for (var i = DATA_BYTES ; i < TOTAL_BYTES ; i++) {
+        step_out[i] <== step_in[i];
+    }
+    // No need to pad as this is currently when TOTAL_BYTES == TOTAL_BYTES_USED
+}
+
+component main { public [step_in] } = JsonMaskArrayIndexNIVC(4160, 320, 5);

circuits/json_mask_object.circom

@@ -0,0 +1,110 @@
+pragma circom 2.1.9;
+
+include "parser-attestor/circuits/json/interpreter.circom";
+
+template JsonMaskObjectNIVC(TOTAL_BYTES, DATA_BYTES, MAX_STACK_HEIGHT, maxKeyLen) {
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~~ Set sizes at compile time ~~
+    // Total number of variables in the parser for each byte of data
+    assert(MAX_STACK_HEIGHT >= 2);
+    var PER_ITERATION_DATA_LENGTH = MAX_STACK_HEIGHT * 2 + 2;
+    var TOTAL_BYTES_USED          = DATA_BYTES * (PER_ITERATION_DATA_LENGTH + 1); // data + parser vars
+    // ------------------------------------------------------------------------------------------------------------------ //
+
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~ Unravel from previous NIVC step ~
+    // Read in from previous NIVC step (JsonParseNIVC)
+    signal input step_in[TOTAL_BYTES];
+
+    // Grab the raw data bytes from the `step_in` variable
+    signal data[DATA_BYTES];
+    for (var i = 0 ; i < DATA_BYTES ; i++) {
+        data[i] <== step_in[i];
+    }
+
+    // Decode the encoded data in `step_in` back into parser variables
+    signal stack[DATA_BYTES][MAX_STACK_HEIGHT][2];
+    signal parsingData[DATA_BYTES][2];
+    for (var i = 0 ; i < DATA_BYTES ; i++) {
+        for (var j = 0 ; j < MAX_STACK_HEIGHT ; j++) {
+            stack[i][j][0] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + j * 2];
+            stack[i][j][1] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + j * 2 + 1];
+        }
+        parsingData[i][0] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + MAX_STACK_HEIGHT * 2];
+        parsingData[i][1] <== step_in[DATA_BYTES + i * PER_ITERATION_DATA_LENGTH + MAX_STACK_HEIGHT * 2 + 1];
+    }
+    // ------------------------------------------------------------------------------------------------------------------ //
+
+    // ------------------------------------------------------------------------------------------------------------------ //
+    // ~ Object masking ~
+    // Key data to use to point to which object to extract
+    signal input key[maxKeyLen];
+    signal input keyLen;
+
+    // flag determining whether this byte is matched value
+    signal is_value_match[DATA_BYTES - maxKeyLen];
+    // final mask
+    signal mask[DATA_BYTES - maxKeyLen];
+
+
+    // signal parsing_object_value[DATA_BYTES - maxKeyLen];
+    signal is_key_match[DATA_BYTES - maxKeyLen];
+    signal is_key_match_for_value[DATA_BYTES + 1 - maxKeyLen];
+    is_key_match_for_value[0] <== 0;
+    signal is_next_pair_at_depth[DATA_BYTES - maxKeyLen];
+    signal or[DATA_BYTES - maxKeyLen];
+
+    // Signals to detect if we are parsing a key or value with initial setup
+    signal parsing_key[DATA_BYTES - maxKeyLen];
+    signal parsing_value[DATA_BYTES - maxKeyLen];
+    // TODO: Can't these just be 0 since the start of object can't be either of these?
+    // parsing_key[0] <== InsideKey()(stack[0][0], parsingData[0][0], parsingData[0][1]);
+    // parsing_value[0] <== InsideValueObject()(stack[0][0], stack[0][1], parsingData[0][0], parsingData[0][1]);
+
+    // Initialize values knowing 0th bit of data will never be a key/value
+    parsing_key[0]   <== 0;
+    parsing_value[0] <== 0;
+    is_key_match[0]  <== 0;
+
+    is_next_pair_at_depth[0]  <== NextKVPairAtDepth(MAX_STACK_HEIGHT, 0)(stack[0], data[0]);
+    is_key_match_for_value[1] <== Mux1()([is_key_match_for_value[0] * (1-is_next_pair_at_depth[0]), is_key_match[0] * (1-is_next_pair_at_depth[0])], is_key_match[0]);
+    is_value_match[0]         <== parsing_value[0] * is_key_match_for_value[1];
+
+    mask[0] <== data[0] * is_value_match[0];
+
+    for(var data_idx = 1; data_idx < DATA_BYTES - maxKeyLen; data_idx++) {
+        parsing_key[data_idx] <== InsideKey()(stack[data_idx][0], parsingData[data_idx][0], parsingData[data_idx][1]);
+        parsing_value[data_idx] <== InsideValueObject()(stack[data_idx][0], stack[data_idx][1], parsingData[data_idx][0], parsingData[data_idx][1]);
+
+        // to get correct value, check:
+        // - key matches at current index and depth of key is as specified
+        // - whether next KV pair starts
+        // - whether key matched for a value (propogate key match until new KV pair of lower depth starts)
+        is_key_match[data_idx] <== KeyMatchAtIndex(DATA_BYTES, maxKeyLen, data_idx)(data, key, keyLen, parsing_key[data_idx]);
+        is_next_pair_at_depth[data_idx] <== NextKVPairAtDepth(MAX_STACK_HEIGHT, 0)(stack[data_idx], data[data_idx]);
+        is_key_match_for_value[data_idx+1] <== Mux1()([is_key_match_for_value[data_idx] * (1-is_next_pair_at_depth[data_idx]), is_key_match[data_idx] * (1-is_next_pair_at_depth[data_idx])], is_key_match[data_idx]);
+        is_value_match[data_idx] <== is_key_match_for_value[data_idx+1] * parsing_value[data_idx];
+
+        or[data_idx] <== OR()(is_value_match[data_idx], is_value_match[data_idx - 1]);
+
+        // mask = currently parsing value and all subsequent keys matched
+        mask[data_idx] <== data[data_idx] * or[data_idx];
+
+    }
+
+    // Write the `step_out` with masked data
+    signal output step_out[TOTAL_BYTES];
+    for (var i = 0 ; i < DATA_BYTES - maxKeyLen ; i++) {
+        step_out[i] <== mask[i];
+    }
+    for (var i = 0 ; i < maxKeyLen ; i++) {
+        step_out[DATA_BYTES - maxKeyLen + i] <== 0;
+    }
+    // Append the parser state back on `step_out`
+    for (var i = DATA_BYTES ; i < TOTAL_BYTES ; i++) {
+        step_out[i] <== step_in[i];
+    }
+    // No need to pad as this is currently when TOTAL_BYTES == TOTAL_BYTES_USED
+}
+
+component main { public [step_in] } = JsonMaskObjectNIVC(4160, 320, 5, 10);