Merge branch 'shigoto/performance-regression-framework' into shigoto/performance-regression-migrate-tests

Author: Shigoto-dev19

CHANGELOG.md

@@ -20,8 +20,6 @@ This project adheres to
 
 ### Added
 
-- Added a new internal framework for testing proving and compilation time
-  regression. https://github.com/o1-labs/o1js/pull/2451
 - Internal o1js and protocol constants, hashes and prefixes are now exported via
   the `Core´ namespace. https://github.com/o1-labs/o1js/pull/2421
 - Support for string type input to `Transaction.fromJSON`

package.json

@@ -83,7 +83,7 @@
     "e2e:run-server": "node dist/web/server.js",
     "e2e:install": "npx playwright install --with-deps",
     "e2e:show-report": "npx playwright show-report tests/report",
-    "update-changelog": "./update-changelog.sh",
+    "update-changelog": "./scripts/changelog/update-changelog.sh",
     "prepare": "husky"
   },
   "author": "O(1) Labs",

fix-changelog-links.cjs scripts/changelog/fix-changelog-links.cjsfix-changelog-links.cjs renamed to scripts/changelog/fix-changelog-links.cjs

@@ -19,7 +19,7 @@
 # Ensure that you have the necessary permissions to commit and push changes to the repository.
 
 # Step 1: Capture the latest version
-latest_version=$(grep -oP '\[\K[0-9]+\.[0-9]+\.[0-9]+(?=\])' CHANGELOG.md | head -1)
+latest_version=$(grep -o '\[\K[0-9]+\.[0-9]+\.[0-9]+(?=\])' CHANGELOG.md | head -1)
 echo "Latest version: $latest_version"
 
 # Step 2: Bump the patch version
@@ -37,11 +37,17 @@ current_date=$(date +%Y-%m-%d)
 echo "Current date: $current_date"
 
 # Step 5: Extract the second SHA from the compare URL of the latest version
-previous_commit=$(grep -m 1 -oP '\[.*?\]\(https://github.com/o1-labs/o1js/compare/[a-f0-9]+\.\.\.\K[a-f0-9]+(?=\))' CHANGELOG.md)
+previous_commit=$(grep -m 1 -o '\[.*?\]\(https://github.com/o1-labs/o1js/compare/[a-f0-9]+\.\.\.\K[a-f0-9]+(?=\))' CHANGELOG.md)
 echo "Previous commit: $previous_commit"
 
 # Step 6: Update the CHANGELOG
 sed -i "s/\[Unreleased\](.*\.\.\.HEAD)/\[Unreleased\](https:\/\/github.com\/o1-labs\/o1js\/compare\/$current_commit...HEAD)\n\n## \[$new_version\](https:\/\/github.com\/o1-labs\/o1js\/compare\/$previous_commit...$current_commit) - $current_date/" CHANGELOG.md
 
-# Step 7: Auto-fix compare URLs for all past versions
-node fix-changelog-links.cjs
+# Step 7: Auto-fix compare URLs for all past versions, if -r is set
+while getopts "r" opt; do
+  case $opt in
+    r)
+      node scripts/changelog/fix-changelog-links.cjs
+      ;;
+  esac
+done

update-changelog.sh scripts/changelog/update-changelog.shupdate-changelog.sh renamed to scripts/changelog/update-changelog.sh

@@ -1,18 +1,19 @@
 import { Bytes12, BLAKE2BProgram } from './blake2b.js';
-import { perfStart, perfEnd } from '../../../lib/testing/perf-regression.js';
+import { Performance } from '../../../lib/testing/perf-regression.js';
 
 const cs = await BLAKE2BProgram.analyzeMethods();
-perfStart('compile', BLAKE2BProgram.name, cs);
+const perfBlake2b = Performance.create(BLAKE2BProgram.name, cs);
+perfBlake2b.start('compile');
 await BLAKE2BProgram.compile();
-perfEnd();
+perfBlake2b.end();
 
 let preimage = Bytes12.fromString('hello world!');
 
 console.log('blake2b rows:', (await BLAKE2BProgram.analyzeMethods()).blake2b.rows);
 
-perfStart('prove', BLAKE2BProgram.name, cs, 'blake2b');
+perfBlake2b.start('prove', 'blake2b');
 let { proof } = await BLAKE2BProgram.blake2b(preimage);
-perfEnd();
+perfBlake2b.end();
 
 let isValid = await BLAKE2BProgram.verify(proof);
 

src/examples/crypto/blake2b/run.ts

@@ -1,6 +1,7 @@
 import { Secp256k1, Ecdsa, keccakAndEcdsa, ecdsa, ecdsaEthers, Bytes32 } from './ecdsa.js';
 import assert from 'assert';
-import { perfStart, perfEnd } from '../../../lib/testing/perf-regression.js';
+import { Performance } from '../../../lib/testing/perf-regression.js';
+
 // create an example ecdsa signature
 
 let privateKey = Secp256k1.Scalar.random();
@@ -24,13 +25,14 @@ console.log(cs.verifyEcdsa.summary());
 
 // compile and prove
 
-perfStart('compile', keccakAndEcdsa.name, cs);
+const perfKeccakEcdsa = Performance.create(keccakAndEcdsa.name, cs);
+perfKeccakEcdsa.start('compile');
 await keccakAndEcdsa.compile();
-perfEnd();
+perfKeccakEcdsa.end();
 
-perfStart('prove', keccakAndEcdsa.name, cs, 'verifyEcdsa');
+perfKeccakEcdsa.start('prove', 'verifyEcdsa');
 let { proof } = await keccakAndEcdsa.verifyEcdsa(message, signature, publicKey);
-perfEnd();
+perfKeccakEcdsa.end();
 
 proof.publicOutput.assertTrue('signature verifies');
 assert(await keccakAndEcdsa.verify(proof), 'proof verifies');
@@ -62,13 +64,14 @@ console.timeEnd('ethers verify only (build constraint system)');
 console.log(csEcdsaEthers.verifyEthers.summary());
 
 // compile and prove
-perfStart('compile', ecdsaEthers.name, csEcdsaEthers);
+const perfEcdsaEthers = Performance.create(ecdsaEthers.name, csEcdsaEthers);
+perfEcdsaEthers.start('compile');
 await ecdsaEthers.compile();
-perfEnd();
+perfEcdsaEthers.end();
 
-perfStart('prove', ecdsaEthers.name, csEcdsaEthers, 'verifyEthers');
+perfEcdsaEthers.start('prove', 'verifyEthers');
 let { proof: proofE } = await ecdsaEthers.verifyEthers(msgBytes, signatureE, publicKeyE);
-perfEnd();
+perfEcdsaEthers.end();
 
 proofE.publicOutput.assertTrue('signature verifies');
 assert(await ecdsaEthers.verify(proofE), 'proof verifies');

src/examples/crypto/ecdsa/run.ts

@@ -1,7 +1,7 @@
 import { ZkProgram } from 'o1js';
 import { Bigint2048, rsaVerify65537 } from './rsa.js';
 import { sha256Bigint, generateRsaParams, rsaSign } from './utils.js';
-import { perfStart, perfEnd } from '../../../lib/testing/perf-regression.js';
+import { Performance } from '../../../lib/testing/perf-regression.js';
 
 let rsaZkProgram = ZkProgram({
   name: 'rsa-verify',
@@ -23,9 +23,11 @@ console.log(cs.verifyRsa65537.summary());
 
 const forceRecompileEnabled = false;
 
-perfStart('compile', rsaZkProgram.name);
+const perfRsa = Performance.create(rsaZkProgram.name, cs);
+
+perfRsa.start('compile');
 await rsaZkProgram.compile({ forceRecompile: forceRecompileEnabled });
-perfEnd();
+perfRsa.end();
 
 console.time('generate RSA parameters and inputs (2048 bits)');
 const input = await sha256Bigint('How are you!');
@@ -35,9 +37,9 @@ const signature = Bigint2048.from(rsaSign(input, params.d, params.n));
 const modulus = Bigint2048.from(params.n);
 console.timeEnd('generate RSA parameters and inputs (2048 bits)');
 
-perfStart('prove', rsaZkProgram.name, cs, 'verifyRsa65537');
+perfRsa.start('prove', 'verifyRsa65537');
 let { proof } = await rsaZkProgram.verifyRsa65537(message, signature, modulus);
-perfEnd();
+perfRsa.end();
 
 console.time('verify');
 await rsaZkProgram.verify(proof);

src/examples/crypto/rsa/run.ts

@@ -1,18 +1,21 @@
 import { Bytes12, SHA256Program } from './sha256.js';
-import { perfStart, perfEnd } from '../../../lib/testing/perf-regression.js';
+import { Performance } from '../../../lib/testing/perf-regression.js';
 
 const cs = await SHA256Program.analyzeMethods();
-perfStart('compile', SHA256Program.name, cs);
+const perfSha256 = Performance.create(SHA256Program.name, cs);
+
+perfSha256.start('compile');
 await SHA256Program.compile();
-perfEnd();
+perfSha256.end();
 
 let preimage = Bytes12.fromString('hello world!');
 
 console.log('sha256 rows:', (await SHA256Program.analyzeMethods()).sha256.rows);
 
-perfStart('prove', SHA256Program.name, cs, 'sha256');
+perfSha256.start('prove', 'sha256');
 let { proof } = await SHA256Program.sha256(preimage);
-perfEnd();
+perfSha256.end();
+
 let isValid = await SHA256Program.verify(proof);
 
 console.log('digest:', proof.publicOutput.toHex());