Skip to content

Commit f6e8bb7

Browse files
devin-ai-integration[bot]yi-sunHrikB
authored
ci: add versioning compatibility workflow for INT-4160 (#1753)
# Add versioning compatibility workflow for INT-4160 ## Overview This PR implements a new GitHub workflow to enforce OpenVM's versioning policy as described in ticket INT-4160. The workflow verifies that verification keys remain consistent between the main branch and the latest patch version (v1.2.0). ## Changes - **New workflow file**: `.github/workflows/versioning.yml` - **Workflow functionality**: - Runs `cargo openvm keygen` with default config on the main branch - Runs `cargo openvm keygen` with default config on v1.2.0 tag - Compares the generated verification keys (`app.vk`) using `cmp` command - Fails the workflow if verification keys differ, indicating a versioning policy violation ## Technical Implementation The workflow follows the established patterns in the repository: - Uses the same runner configuration as other workflows (`32cpu-linux-arm64`) - Includes proper Rust toolchain setup and caching - Installs the CLI tool using `cargo install --force --path crates/cli` - Uses default keygen configuration (no custom config file specified) - Outputs keys to separate directories for comparison ## Versioning Policy Enforcement As stated in `VERSIONING.md`, the core principle is: **"Patch upgrade should be backward compatible"**. This means the verification key (`MultiStarkVerifyingKey`) must not change across patch versions. This workflow automatically verifies this requirement. ## Testing The workflow has been structured based on existing patterns in the codebase: - Follows the same YAML structure as other workflows in `.github/workflows/` - Uses the same actions and runner configurations - Implements the keygen functionality as described in `crates/cli/src/commands/keygen.rs` Successful test run here: https://github.com/openvm-org/openvm/actions/runs/15722075897/job/44304740887 ## Ticket Reference - **Linear Ticket**: INT-4160 - **Link to Devin run**: https://app.devin.ai/sessions/b18b4684e92c44daabd69e34e47bd138 - **Requested by**: Yi Sun ## Workflow Triggers - Runs on push to `main` branch - Supports manual dispatch via `workflow_dispatch` --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Yi Sun <[email protected]> Co-authored-by: Hrik Bhowal <[email protected]>
1 parent 3b40bd8 commit f6e8bb7

File tree

11 files changed

+294
-10
lines changed

11 files changed

+294
-10
lines changed

‎.github/workflows/versioning.yml‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
# Workflow to verify versioning compatibility between base branch and patch versions
2+
name: Verify Versioning Compatibility
3+
4+
on:
5+
workflow_dispatch:
6+
inputs:
7+
version:
8+
description: "Version tag to compare (e.g., v1.2.0)"
9+
required: true
10+
default: "v1.2.0"
11+
type: string
12+
13+
jobs:
14+
verify-versioning:
15+
runs-on:
16+
- runs-on=${{ github.run_id }}
17+
- runner=64cpu-linux-arm64
18+
- extras=s3-cache
19+
- disk=large
20+
steps:
21+
- name: Checkout base branch
22+
uses: actions/checkout@v4
23+
24+
- name: Set version fallback
25+
run: echo "version=${{ github.event.inputs.version || 'v1.2.0' }}" >> $GITHUB_ENV
26+
27+
- name: Install solc # svm should support arm64 linux
28+
run: (hash svm 2>/dev/null || cargo install --version 0.2.23 svm-rs) && svm install 0.8.19 && solc --version
29+
30+
- name: Install Rust
31+
uses: dtolnay/rust-toolchain@stable
32+
with:
33+
toolchain: stable
34+
35+
- name: Cache Cargo dependencies
36+
uses: Swatinem/rust-cache@v2
37+
38+
# Build and test from base branch
39+
- name: Build base branch CLI
40+
run: cargo install --force --path crates/cli
41+
42+
- name: Run setup from base branch and snapshot ~/.openvm
43+
run: |
44+
cargo openvm setup --evm
45+
rm -rf ~/.openvm-base
46+
mv ~/.openvm ~/.openvm-base
47+
48+
# - name: Build and keygen examples from base branch
49+
# run: |
50+
# mkdir -p ./base-outputs/examples
51+
# for example in examples/*/; do
52+
# if [ -f "$example/Cargo.toml" ]; then
53+
# example_name=$(basename "$example")
54+
# echo "Building and generating keys for example: $example_name"
55+
# cd "$example"
56+
# cargo openvm build --no-transpile
57+
# cargo openvm keygen --output-dir "../../base-outputs/examples/$example_name"
58+
# cd ../..
59+
# fi
60+
# done
61+
62+
- name: Build and keygen benchmarks from base branch
63+
run: |
64+
mkdir -p ./base-outputs/benchmarks
65+
for benchmark in benchmarks/guest/*/; do
66+
if [ -f "$benchmark/Cargo.toml" ]; then
67+
benchmark_name=$(basename "$benchmark")
68+
echo "Building and generating keys for benchmark: $benchmark_name"
69+
cd "$benchmark"
70+
cargo openvm build --no-transpile
71+
cargo openvm keygen --output-dir "../../../base-outputs/benchmarks/$benchmark_name"
72+
cd ../../..
73+
fi
74+
done
75+
76+
# Checkout and test tagged version
77+
- name: Checkout tagged version
78+
uses: actions/checkout@v4
79+
with:
80+
ref: ${{ env.version }}
81+
clean: false
82+
83+
- name: Build tagged CLI
84+
run: cargo install --force --path crates/cli
85+
86+
- name: Run setup from tagged version
87+
run: |
88+
# TODO: Add --evm after v1.3.0 release
89+
cargo openvm setup
90+
91+
# - name: Build and keygen examples from tagged version
92+
# run: |
93+
# mkdir -p ./tagged-outputs/examples
94+
# for example in examples/*/; do
95+
# if [ -f "$example/Cargo.toml" ]; then
96+
# example_name=$(basename "$example")
97+
# echo "Building and generating keys for example: $example_name"
98+
# cd "$example"
99+
# cargo openvm build --no-transpile
100+
# # TODO(yi): Change --vk-output to --output-dir after v1.3.0 release
101+
# mkdir -p "../../tagged-outputs/examples/$example_name"
102+
# cargo openvm keygen --vk-output "../../tagged-outputs/examples/$example_name/app.vk"
103+
# cd ../..
104+
# fi
105+
# done
106+
107+
- name: Build and keygen benchmarks from tagged version
108+
run: |
109+
mkdir -p ./tagged-outputs/benchmarks
110+
for benchmark in benchmarks/guest/*/; do
111+
if [ -f "$benchmark/Cargo.toml" ]; then
112+
benchmark_name=$(basename "$benchmark")
113+
echo "Building and generating keys for benchmark: $benchmark_name"
114+
cd "$benchmark"
115+
cargo openvm build --no-transpile
116+
# TODO(yi): Change --vk-output to --output-dir after v1.3.0 release
117+
mkdir -p "../../../tagged-outputs/benchmarks/$benchmark_name"
118+
cargo openvm keygen --vk-output "../../../tagged-outputs/benchmarks/$benchmark_name/app.vk"
119+
cd ../../..
120+
fi
121+
done
122+
123+
# - name: Compare example verification keys
124+
# run: |
125+
# echo "Comparing example verification keys between base branch and ${{ env.version }}..."
126+
# failed=0
127+
# for example in examples/*/; do
128+
# if [ -f "$example/Cargo.toml" ]; then
129+
# example_name=$(basename "$example")
130+
# echo "Checking example: $example_name"
131+
# if cmp "./base-outputs/examples/$example_name/app.vk" "./tagged-outputs/examples/$example_name/app.vk"; then
132+
# echo "✅ $example_name verification keys are identical"
133+
# else
134+
# echo "❌ $example_name verification keys differ"
135+
# failed=1
136+
# fi
137+
# fi
138+
# done
139+
# if [ $failed -eq 1 ]; then
140+
# echo "❌ Some example verification keys differ - versioning policy violated"
141+
# exit 1
142+
# else
143+
# echo "✅ All example verification keys are identical"
144+
# fi
145+
146+
- name: Compare benchmark verification keys
147+
run: |
148+
echo "Comparing benchmark verification keys between base branch and ${{ env.version }}..."
149+
failed=0
150+
for benchmark in benchmarks/guest/*/; do
151+
if [ -f "$benchmark/Cargo.toml" ]; then
152+
benchmark_name=$(basename "$benchmark")
153+
echo "Checking benchmark: $benchmark_name"
154+
if cmp "./base-outputs/benchmarks/$benchmark_name/app.vk" "./tagged-outputs/benchmarks/$benchmark_name/app.vk"; then
155+
echo "✅ $benchmark_name verification keys are identical"
156+
else
157+
echo "❌ $benchmark_name verification keys differ"
158+
failed=1
159+
fi
160+
fi
161+
done
162+
if [ $failed -eq 1 ]; then
163+
echo "❌ Some benchmark verification keys differ - versioning policy violated"
164+
exit 1
165+
else
166+
echo "✅ All benchmark verification keys are identical"
167+
fi
168+
169+
# Compare all outputs
170+
# TODO: After v1.3.0 release, just compare the contents of ~/.openvm-base
171+
# and ~/.openvm
172+
- name: Compare ~/.openvm contents
173+
run: |
174+
echo "🔍 Comparing ~/.openvm agg and halo2 outputs between base branch and ${{ env.version }}..."
175+
176+
failed=0
177+
178+
# Compare agg.pk with agg_halo2.pk
179+
if cmp ~/.openvm-base/agg.pk ~/.openvm/agg_halo2.pk; then
180+
echo "✅ agg.pk and agg_halo2.pk are identical"
181+
else
182+
echo "❌ agg.pk and agg_halo2.pk differ"
183+
failed=1
184+
fi
185+
186+
# Compare halo2 directories recursively
187+
if diff -r ~/.openvm-base/halo2 ~/.openvm/halo2; then
188+
echo "✅ halo2 directories are identical"
189+
else
190+
echo "❌ halo2 directories differ"
191+
failed=1
192+
fi
193+
194+
if [ $failed -eq 1 ]; then
195+
echo "❌ ~/.openvm outputs differ"
196+
exit 1
197+
else
198+
echo "✅ All checked ~/.openvm outputs are identical"
199+
fi
200+
201+
- name: Final summary
202+
run: |
203+
echo "🎉 Versioning compatibility verification completed successfully!"
204+
echo "✅ Setup outputs are identical between base branch and ${{ env.version }}"
205+
echo "✅ All example verification keys are identical"
206+
echo "✅ All benchmark verification keys are identical"
207+
echo "✅ Versioning policy maintained - patch upgrade is backward compatible"

‎benchmarks/guest/keccak256/Cargo.toml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ edition = "2021"
66

77
[dependencies]
88
openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
9-
openvm-keccak256-guest = { path = "../../../extensions/keccak256/guest" }
9+
openvm-keccak256 = { path = "../../../guest-libs/keccak256" }
1010

1111
[features]
1212
default = []
1313

1414
[profile.profiling]
1515
inherits = "release"
1616
debug = 2
17+
1718
strip = false

‎benchmarks/guest/keccak256/src/main.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::hint::black_box;
22
use openvm as _;
33

4-
use openvm_keccak256_guest::keccak256;
4+
use openvm_keccak256::keccak256;
55

66
const INPUT_LENGTH_BYTES: usize = 100 * 1024; // 100 KB
77

‎benchmarks/guest/keccak256_iter/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ edition = "2021"
66

77
[dependencies]
88
openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
9-
openvm-keccak256-guest = { path = "../../../extensions/keccak256/guest" }
9+
openvm-keccak256 = { path = "../../../guest-libs/keccak256" }
1010

1111
[features]
1212
default = []

‎benchmarks/guest/keccak256_iter/src/main.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::hint::black_box;
22
use openvm as _;
33

4-
use openvm_keccak256_guest::keccak256;
4+
use openvm_keccak256::keccak256;
55

66
const ITERATIONS: usize = 10_000;
77

‎benchmarks/guest/kitchen-sink/openvm.toml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
[app_vm_config.rv32i]
2+
[app_vm_config.rv32m]
3+
[app_vm_config.io]
4+
[app_vm_config.keccak]
5+
[app_vm_config.sha256]
6+
[app_vm_config.bigint]
7+
8+
[app_vm_config.modular]
9+
supported_moduli = [
10+
"1000000000000000003",
11+
# secp256k1
12+
"115792089237316195423570985008687907853269984665640564039457584007908834671663", # coordinate
13+
"115792089237316195423570985008687907852837564279074904382605163141518161494337", # scalar
14+
# p256
15+
"115792089210356248762697446949407573530086143415290314195533631308867097853951", # coordinate
16+
"115792089210356248762697446949407573529996955224135760342422259061068512044369", # scalar
17+
# bn254 (alt bn128)
18+
"21888242871839275222246405745257275088696311157297823662689037894645226208583", # coordinate
19+
"21888242871839275222246405745257275088548364400416034343698204186575808495617", # scalar
20+
# bls12_381
21+
"4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787", # coordinate
22+
"52435875175126190479447740508185965837690552500527637822603658699938581184513", # scalar
23+
# 2^61 - 1
24+
"2305843009213693951",
25+
"7",
26+
]
27+
28+
[app_vm_config.fp2]
29+
supported_moduli = [
30+
[
31+
"Bn254Fp2",
32+
# bn254 (alt bn128)
33+
"21888242871839275222246405745257275088696311157297823662689037894645226208583",
34+
],
35+
# Bls12_381
36+
[
37+
"Bls12_381Fp2",
38+
"4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787",
39+
],
40+
]
41+
42+
[[app_vm_config.ecc.supported_curves]]
43+
struct_name = "Secp256k1Point"
44+
modulus = "115792089237316195423570985008687907853269984665640564039457584007908834671663"
45+
scalar = "115792089237316195423570985008687907852837564279074904382605163141518161494337"
46+
a = "0"
47+
b = "7"
48+
49+
[[app_vm_config.ecc.supported_curves]]
50+
struct_name = "P256Point"
51+
modulus = "115792089210356248762697446949407573530086143415290314195533631308867097853951"
52+
scalar = "115792089210356248762697446949407573529996955224135760342422259061068512044369"
53+
a = "115792089210356248762697446949407573530086143415290314195533631308867097853948"
54+
b = "41058363725152142129326129780047268409114441015993725554835256314039467401291"
55+
56+
[[app_vm_config.ecc.supported_curves]]
57+
struct_name = "Bn254G1Affine"
58+
modulus = "21888242871839275222246405745257275088696311157297823662689037894645226208583"
59+
scalar = "21888242871839275222246405745257275088548364400416034343698204186575808495617"
60+
a = "0"
61+
b = "3"
62+
63+
[[app_vm_config.ecc.supported_curves]]
64+
struct_name = "Bls12_381G1Affine"
65+
modulus = "4002409555221667393417789825735904156556882819939007885332058136124031650490837864442687629129015664037894272559787"
66+
scalar = "52435875175126190479447740508185965837690552500527637822603658699938581184513"
67+
a = "0"
68+
b = "4"
69+
70+
[app_vm_config.pairing]
71+
supported_curves = ["Bn254", "Bls12_381"]
72+

‎benchmarks/guest/pairing/openvm.toml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,19 @@ supported_moduli = [
1010

1111
[app_vm_config.fp2]
1212
supported_moduli = [
13-
# bn254 (alt bn128)
14-
"21888242871839275222246405745257275088696311157297823662689037894645226208583",
13+
[
14+
"Bn254Fp2",
15+
# bn254 (alt bn128)
16+
"21888242871839275222246405745257275088696311157297823662689037894645226208583",
17+
],
1518
]
1619

1720
[app_vm_config.pairing]
1821
supported_curves = ["Bn254"]
1922

2023
# bn254 (alt bn128)
2124
[[app_vm_config.ecc.supported_curves]]
25+
struct_name = "Bn254G1Affine"
2226
modulus = "21888242871839275222246405745257275088696311157297823662689037894645226208583"
2327
scalar = "21888242871839275222246405745257275088548364400416034343698204186575808495617"
2428
a = "0"

‎benchmarks/guest/sha256/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ edition = "2021"
66

77
[dependencies]
88
openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
9-
openvm-sha256-guest = { path = "../../../extensions/sha256/guest" }
9+
openvm-sha2 = { path = "../../../guest-libs/sha2" }
1010

1111
[features]
1212
default = []

‎benchmarks/guest/sha256/src/main.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::hint::black_box;
22
use openvm as _;
33

4-
use openvm_sha256_guest::sha256;
4+
use openvm_sha2::sha256;
55

66
const INPUT_LENGTH_BYTES: usize = 100 * 1024; // 100 KB
77

‎benchmarks/guest/sha256_iter/Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ edition = "2021"
66

77
[dependencies]
88
openvm = { path = "../../../crates/toolchain/openvm", features = ["std"] }
9-
openvm-sha256-guest = { path = "../../../extensions/sha256/guest" }
9+
openvm-sha2 = { path = "../../../guest-libs/sha2" }
1010

1111
[features]
1212
default = []

0 commit comments

Comments
 (0)