Skip to content

Commit fe7e9eb

Browse files
committed
Add JSDoc for CS/zkApp performance regression script
1 parent a7de4d5 commit fe7e9eb

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

tests/perf-regression/perf-regression.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,19 @@
1+
/**
2+
* Performance regression framework for constraint systems (CS) and zkApp
3+
* instances.
4+
*
5+
* This script benchmarks compile-time performance and validates digests for a
6+
* fixed set of zkApps and CS examples. It supports two modes:
7+
* - **Dump**: record baseline digests and compile times into
8+
* {@link tests/perf-regression/perf-regression.json}
9+
* - **Check**: compare current results against stored baselines and fail on
10+
* regressions or digest mismatches
11+
*
12+
* Unlike {@link src/lib/testing/perf-regression.ts}, which records results for
13+
* each ZkProgram examples separately, this file iterates over imported CS/zkApp
14+
* instances and updates their digests and compile times as a whole.
15+
*/
16+
117
import fs from 'fs';
218
import path from 'path';
319
import { Voting_ } from '../../src/examples/zkapps/voting/voting.js';

0 commit comments

Comments
 (0)