feat: capture app stacks for bb usage

.github/workflows/ci3-external.yml

@@ -16,7 +16,7 @@ jobs:
   ci-external:
     runs-on: ubuntu-latest
     # exclusive with ci3.yml, only run on forks.
-    if: github.event.pull_request.head.repo.full_name != github.repository
+    if: github.event.pull_request.head.repo.fork
     steps:
       #############
       # Prepare Env
@@ -28,14 +28,11 @@ jobs:
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
       - name: Fail If Draft
-        if: github.event.pull_request.draft && (github.event.action != 'labeled' || github.event.label.name != 'trigger-workflow')
+        if: github.event.pull_request.draft
         run: echo "CI is not run on drafts." && exit 1
 
       - name: External Contributor Checks
         # Run only if a pull request event type and we have a forked repository origin.
-        if: |
-          (github.event_name == 'pull_request' || github.event_name == 'pull_request_target') &&
-          github.event.pull_request.head.repo.full_name != github.repository
         run: |
           set -o pipefail
           git fetch origin ${{ github.event.pull_request.base.ref }} --depth=1 &>/dev/null
@@ -48,7 +45,7 @@ jobs:
             echo "Error: External PRs can only target master, targeted: ${{ github.event.pull_request.base.ref }}."
             exit 1
           fi
-          labeled="${{contains(github.event.pull_request.labels.*.name, 'ci-external') || contains(github.event.pull_request.labels.*.name, 'ci-external-once')}}"
+          labeled="${{contains(github.event.pull_request.labels.*.name, 'ci-external') || github.event.label.name == 'ci-external-once'}}"
           if [ "$labeled" = false ]; then
             echo "External PRs need the 'ci-external' or 'ci-external-once' labels to run."
             exit 1

.github/workflows/ci3.yml

@@ -25,8 +25,9 @@ concurrency:
 jobs:
   ci:
     runs-on: ubuntu-latest
-    # exclusive with ci3-external.yml: if it is a pull request target only run if it is NOT a fork.
-    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository
+    # exclusive with ci3-external.yml: never run on forks
+    # (github.event.pull_request.head.repo.fork resolves to nil if not a pull request)
+    if: github.event.pull_request.head.repo.fork != true
     environment: ${{ startsWith(github.ref, 'refs/tags/v') && 'master' || '' }}
     strategy:
       fail-fast: false
@@ -89,12 +90,11 @@ jobs:
       - name: Download benchmarks
         if: matrix.settings.arch == 'amd64' && github.event_name == 'push' && github.ref_name == 'master'
         run: |
-          ./ci3/cache_download barretenberg-bench-results-$(git rev-parse HEAD).tar.gz
-          ./ci3/cache_download yarn-project-bench-results-$(git rev-parse HEAD).tar.gz
-          # ./ci3/cache_download yarn-project-p2p-bench-results-$(git rev-parse HEAD).tar.gz
+          # Note: sets SKIP_BB_BENCH in GITHUB_ENV for below step.
+          ./ci.sh gh-bench
 
       - name: Store barretenberg benchmark result
-        if: matrix.settings.arch == 'amd64' && github.event_name == 'push' && github.ref_name == 'master'
+        if: matrix.settings.arch == 'amd64' && github.event_name == 'push' && github.ref_name == 'master' && env.SKIP_BB_BENCH != 'true'
         continue-on-error: true
         uses: benchmark-action/github-action-benchmark@4de1bed97a47495fc4c5404952da0499e31f5c29
         with:

.test_patterns.yml

@@ -160,8 +160,23 @@ tests:
     owners:
       - *leila
 
-  - regex: "spartan/bootstrap.sh test-local"
-    skip: true
+  - regex: "spartan/bootstrap.sh test-kind-upgrade-rollup-version"
+    owners:
+      - *adam
+
+  - regex: "spartan/bootstrap.sh test-cli-upgrade-with-lock"
+    owners:
+      - *adam
+
+  - regex: "spartan/bootstrap.sh test-kind-smoke"
+    owners:
+      - *adam
+
+  - regex: "spartan/bootstrap.sh test-kind-transfer"
+    owners:
+      - *adam
+
+  - regex: "spartan/bootstrap.sh test-prod-deployment"
     owners:
       - *adam
 

.vscode/settings.json

@@ -181,5 +181,11 @@
   "typescript.tsserver.maxTsServerMemory": 4096,
   "typescript.tsdk": "yarn-project/node_modules/typescript/lib",
   "markdown.extension.toc.levels": "2..6",
-  "noir.nargoPath": "${workspaceFolder}/noir/noir-repo/target/release/nargo"
+  "noir.nargoPath": "${workspaceFolder}/noir/noir-repo/target/release/nargo",
+  "auto-close-tag.activationOnLanguage": [
+    "xml",
+    "markdown",
+    "HTML (EEx)",
+    "HTML (Eex)"
+  ]
 }

aztec-up/bin/.aztec-run

@@ -13,7 +13,8 @@
 # Such stuff belongs in higher level e.g. `aztec` or `aztec-wallet` scripts.
 set -euo pipefail
 
-CONTAINER_NAME=$1
+# Can be overriden by env var CONTAINER_NAME, e.g. to start two sandboxes.
+CONTAINER_NAME=${CONTAINER_NAME:-$1}
 shift
 
 VERSION=${VERSION:-"latest"}

barretenberg/README.md

@@ -4,8 +4,6 @@
 > [!WARNING]
 > :warning: **<https://github.com/AztecProtocol/barretenberg> is a mirror-only repository, please only use <https://github.com/AztecProtocol/aztec-packages>. Do not use this for any purpose other than reference.** :warning:
 
-![banner](../.github/img/bb_banner.png)
-
 # Barretenberg
 
 Barretenberg (or `bb` for short) is an optimized elliptic curve library for the bn128 curve, and a PLONK SNARK prover.
@@ -473,6 +471,11 @@ command script import ~/aztec-packages/barretenberg/cpp/scripts/lldb_format.py
 
 Now when you `print` things with e.g. `print bigfield_t.get_value()` or inspect in VSCode (if you opened the debug console and put in these commands) then you will get pretty-printing of these types. This can be expanded fairly easily with more types if needed.
 
+
+#### Debugging and profiling realistic ClientIVC flows
+
+To download realistic ClientIVC benchmark inputs from last master, use `./barretenberg/cpp/bootstrap.sh download_e2e_ivc_inputs` and run ClientIVC proving with --input runtime_stack on those inputs. By default, tries to pull from last master, but you can pass a historic commit as an argument.
+
 #### Using Tracy to Profile Memory/CPU/Gate Counts
 
 Tracy is a tool that gives us an in-depth look at certain performance related metrics, including memory, CPU usage, time, and circuit gate counts.

barretenberg/acir_tests/bench_acir_tests.sh

@@ -3,7 +3,6 @@ set -e
 
 cd "$(dirname "$0")"
 
-set -x
 TEST_NAMES=("$@")
 THREADS=(1 4 16 32 64)
 BENCHMARKS=$LOG_FILE

barretenberg/bootstrap.sh

@@ -5,24 +5,46 @@ source $(git rev-parse --show-toplevel)/ci3/source
 # Download ignition up front to ensure no race conditions at runtime.
 [ -n "${SKIP_BB_CRS:-}" ] || ./scripts/download_bb_crs.sh
 
-./bbup/bootstrap.sh $@
-./cpp/bootstrap.sh $@
-./ts/bootstrap.sh $@
-./acir_tests/bootstrap.sh $@
+function bootstrap_all {
+  ./bbup/bootstrap.sh $@
+  ./cpp/bootstrap.sh $@
+  ./ts/bootstrap.sh $@
+  ./acir_tests/bootstrap.sh $@
+}
 
-cmd=${1:-}
-if [ "$cmd" == "bench" ]; then
-    rm -rf bench-out && mkdir -p bench-out
-    ./scripts/combine_benchmarks.py \
-    native ./cpp/bench-out/client_ivc_17_in_20_release.json \
-    native ./cpp/bench-out/client_ivc_release.json \
-    native ./cpp/bench-out/ultra_honk_release.json \
-    wasm ./cpp/bench-out/client_ivc_wasm.json \
-    wasm ./cpp/bench-out/ultra_honk_wasm.json \
-    "" ./cpp/bench-out/client_ivc_op_count.json \
-    "" ./cpp/bench-out/client_ivc_op_count_time.json \
-    wasm ./acir_tests/bench-out/ultra_honk_rec_wasm_memory.txt \
+function hash {
+  cache_content_hash "^barretenberg"
+}
+
+function bench {
+  rm -rf bench-out && mkdir -p bench-out
+  local hash=$(hash)
+  if cache_download barretenberg-bench-results-$hash.tar.gz; then
+    return
+  fi
+  bootstrap_all bench
+  ./scripts/combine_benchmarks.py \
+    ./cpp/bench-out/*.json \
+    ./acir_tests/bench-out/*.txt \
     > ./bench-out/bb-bench.json
+  cache_upload barretenberg-bench-results-$hash.tar.gz ./bench-out/bb-bench.json
+}
+
+cmd=${1:-}
+[ -n "$cmd" ] && shift
 
-  cache_upload barretenberg-bench-results-$COMMIT_HASH.tar.gz ./bench-out/bb-bench.json
-fi
+case "$cmd" in
+  hash)
+    hash
+    ;;
+  ""|clean|ci|fast|test|test_cmds|release)
+    bootstrap_all $cmd $@
+    ;;
+  bench)
+    bench
+    ;;
+  *)
+    echo "Unknown command: $cmd"
+    exit 1
+  ;;
+esac

barretenberg/cpp/.gitignore

@@ -8,6 +8,7 @@ srs_db/*/bn254_g*
 CMakeUserPresets.json
 .vscode/settings.json
 acir_tests
+client-ivc-inputs-out
 # we may download go in scripts/collect_heap_information.sh
 go*.tar.gz
 barretenberg_modules.dot

barretenberg/cpp/bootstrap.sh

@@ -7,6 +7,7 @@ cmd=${1:-}
 export preset=clang16-assert
 export pic_preset="clang16-pic"
 export hash=$(cache_content_hash .rebuild_patterns)
+export capture_ivc_folder=../../yarn-project/end-to-end/private-flows-ivc-inputs-out
 
 # Injects version number into a given bb binary.
 # Means we don't actually need to rebuild bb to release a new version if code hasn't changed.
@@ -173,7 +174,7 @@ function test_cmds {
       grep -v 'DISABLED_' | \
       while read -r test; do
         echo -e "$hash barretenberg/cpp/scripts/run_test.sh $bin_name $test"
-      done
+      done || (echo "Failed to list tests in $bin" && exit 1)
   done
 }
 
@@ -205,6 +206,10 @@ function bench {
 
   rm -rf bench-out && mkdir -p bench-out
 
+  # A bit pattern breaking, but the best code to instrument our private IVC flows exists in yarn-project,
+  # while the best code for benchmarking these IVC flows exists here.
+  # ../../yarn-project/end-to-end/bootstrap.sh generate_private_ivc_inputs
+
   # Ultra honk.
   function ultra_honk_release {
     ./build/bin/ultra_honk_bench \
@@ -245,14 +250,44 @@ function bench {
         --benchmark_out=./bench-out/client_ivc_wasm.json \
         --benchmark_filter="ClientIVCBench/Full/6$"
   }
+  function client_ivc_flow {
+    set -eu
+    local flow=$1
+    local inputs_folder="$capture_ivc_folder/$flow"
+    local start=$(date +%s%N)
+    local maybe_allow_fail="false"
+    # TODO(AD) this should verify!
+    if [ "$flow" == "amm-add-liquidity" ]; then
+      maybe_allow_fail="true"
+    fi
+    mkdir -p "bench-out/$flow-proof-files"
+    ./build/bin/bb prove -o "bench-out/$flow-proof-files" -b "$inputs_folder/acir.msgpack" -w "$inputs_folder/witnesses.msgpack" --scheme client_ivc --input_type runtime_stack || $maybe_allow_fail
+    echo "$flow has proven."
+    local end=$(date +%s%N)
+    local elapsed_ns=$(( end - start ))
+    local elapsed_ms=$(( elapsed_ns / 1000000 ))
+    cat > "./bench-out/$flow-ivc.json" <<EOF
+    {
+      "benchmarks": [
+      {
+        "name": "$flow-ivc-proof",
+        "time_unit": "ms",
+        "real_time": ${elapsed_ms}
+      }
+      ]
+    }
+EOF
+  }
+
   function run_benchmark {
+    set -eu
     local start_core=$(( ($1 - 1) * HARDWARE_CONCURRENCY ))
     local end_core=$(( start_core + (HARDWARE_CONCURRENCY - 1) ))
     echo taskset -c $start_core-$end_core bash -c "$2"
     taskset -c $start_core-$end_core bash -c "$2"
   }
 
-  export -f ultra_honk_release ultra_honk_wasm client_ivc_17_in_20_release client_ivc_release client_ivc_op_count client_ivc_op_count_time client_ivc_wasm run_benchmark
+  export -f ultra_honk_release ultra_honk_wasm client_ivc_17_in_20_release client_ivc_release client_ivc_op_count client_ivc_op_count_time client_ivc_wasm client_ivc_flow run_benchmark
 
   local num_cpus=$(get_num_cpus)
   local jobs=$((num_cpus / HARDWARE_CONCURRENCY))
@@ -266,6 +301,8 @@ function bench {
     client_ivc_op_count_time \
     client_ivc_wasm
 
+  # Split up the flows into chunks to run in parallel - otherwise we run out of CPUs to pin.
+  parallel -v --line-buffer --tag --jobs "$jobs" run_benchmark {#} '"client_ivc_flow {}"' ::: $(ls "$capture_ivc_folder")
 }
 
 # Upload assets to release.
@@ -291,6 +328,18 @@ case "$cmd" in
     build
     test
     ;;
+  download_e2e_ivc_inputs)
+    # Download the inputs for the private flows.
+    # Takes an optional master commit to download them from. Otherwise, downloads from latest master commit.
+    git fetch origin master
+    # Setting this env var will cause the script to download the inputs from the given commit (through the behavior of cache_content_hash).
+    export AZTEC_CACHE_COMMIT=${1:-origin/master}
+
+    # Error if the inputs are not found in cache.
+    export DOWNLOAD_ONLY=${DOWNLOAD_ONLY:-1}
+    ../../yarn-project/end-to-end/bootstrap.sh generate_private_ivc_inputs
+    echo "Downloaded inputs for private flows to $capture_ivc_folder"
+    ;;
   "hash")
     echo $hash
     ;;

barretenberg/cpp/scripts/_benchmark_remote_lock.sh

@@ -32,4 +32,4 @@ echo "Benchmarking lock created at ~/BENCHMARK_IN_PROGRESS."
 trap cleanup EXIT
 trap cleanup INT # handle ctrl-c
 
-# don't exit, the caller script will run
+# don't exit, the caller script will run

barretenberg/cpp/src/barretenberg/client_ivc/client_ivc.hpp

@@ -58,7 +58,7 @@ class ClientIVC {
     using DataBusDepot = stdlib::DataBusDepot<ClientCircuit>;
 
     /**
-     * @brief A full  proof for the IVC scheme containing a Mega proof showing correctness of the hiding circuit (which
+     * @brief A full proof for the IVC scheme containing a Mega proof showing correctness of the hiding circuit (which
      * recursive verified the last folding and decider proof) and a Goblin proof (translator VM, ECCVM and last merge
      * proof).
      *