docs: update CHANGELOG with breaking changes since v1.2.0#1732

devin-ai-integration · 2025-06-12T13:13:09Z

Update CHANGELOG with breaking changes since v1.2.0

This PR updates the CHANGELOG.md file to document all breaking interface changes between tag v1.2.0 and the current main branch, following the Keep a Changelog format.

Changes Made

Added comprehensive [Unreleased] section documenting breaking changes in CLI, SDK, and Library Interfaces
Included migration guides for each category of breaking changes
Preserved existing version history while updating format to follow Keep a Changelog convention

Breaking Changes Documented

CLI

New init command for project initialization
New commit command for viewing executable commits
Setup command renamed from EvmProvingSetupCmd to SetupCmd
All CLI commit outputs now consistently formatted in hexadecimal
Prove command now uses binary name for default output file paths

SDK

Import path change for DEFAULT_MAX_NUM_PUBLIC_VALUES
Configuration structure updates in AggregationTreeConfig

Library Interfaces

Major guest bindings refactor removing guest library components from this repository
Impact on benchmarks and examples that depend on guest libraries

Complete Commit List (v1.2.0 to main)

chore(ecc-guest): placeholder trait and function implementations for patch compilation (chore(ecc-guest): placeholder trait and function implementations for patch compilation #1720) (Jonathan Wang)
docs: update division typo in ISA.md (docs: update division typo in ISA.md #1726) (stephenh-axiom-xyz)
chore: macro crate should use workspace version (chore: macro crate should use workspace version #1723) (Jonathan Wang)
fix(cli): generate openvm_init.rs before building (fix(cli): generate openvm_init.rs before building #1721) (Jonathan Wang)
docs: Add comment explaining the is_identity optimization (docs: Add comment explaining the is_identity optimization #1716) (Avaneesh-axiom)
fix(sw-macro): host set_up_once undefined (fix(sw-macro): host set_up_once undefined #1717) (Jonathan Wang)
chore: change to dual license (chore: change to dual license #1713) (Yi Sun)
chore(ci): patch examples to use local crates (chore(ci): patch examples to use local crates #1712) (Jonathan Wang)
fix(ci): remove hashFiles from guest-lib-tests (fix(ci): remove hashFiles from guest-lib-tests #1710) (Jonathan Wang)
chore(ecc-guest): remove k256, p256 modules and fix guest-libs to allow patching (chore(ecc-guest): remove k256, p256 modules and fix guest-libs to allow patching #1708) (Jonathan Wang)
chore: move directory (Jonathan Wang)
feat: optimize Group::is_identity (feat: optimize Group::is_identity #1709) (Avaneesh-axiom)
chore: update workspace to v1.2.1-rc.0 (Jonathan Wang)
perf(ecc-guest): optimize setup handling in ecc guest bindings (perf(ecc-guest): optimize setup handling in ecc guest bindings #1706) (Jonathan Wang)
perf: update stark-backend commit (Jonathan Wang)
feat: Patch ecdsa VerifyingKey::recover_from_prehash to skip message verification (feat: Patch ecdsa VerifyingKey::recover_from_prehash to skip message verification #1691) (Avaneesh-axiom)
refactor: guest bindings (refactor: guest bindings #1613) (Jonathan Wang)
refactor: guest bindings (refactor: guest bindings #1613) (Avaneesh-axiom)
feat: ensure all CLI commit outputs are in hex + fix verify STARK (feat: ensure all CLI commit outputs are in hex + fix verify STARK #1697) (stephenh-axiom-xyz)
feat: CLI prove use bin name for output path + e2e stark verify (feat: CLI prove use bin name for output path #1675) (stephenh-axiom-xyz)
feat: init command for cargo openvm (feat: init command for cargo openvm #1670) (stephenh-axiom-xyz)
feat: commit command for cargo openvm (feat: commit command for cargo openvm #1667) (stephenh-axiom-xyz)
feat: cargo CLI update target directory (feat: cargo CLI update target directory #1662) (stephenh-axiom-xyz)
chore: add entry point to book examples without openvm::init!() (chore: add entry point to book examples without openvm::init!() #1663) (stephenh-axiom-xyz)
docs: add CHANGELOG.md (docs: add CHANGELOG.md #1660) (HrikB)
fix: verifier read dir (fix: verifier read dir #1658) (HrikB)
refactor: CLI Build & Setup (refactor: CLI Build & Setup #1649) (Xinding Wei)
feat: helper functions for verify_openvm_stark (feat: helper functions for verify_openvm_stark #1631) (Xinding Wei)
feat: Macro define_verify_openvm_stark (feat: Macro define_verify_openvm_stark #1620) (Xinding Wei)
feat: Root Verifier ASM (feat: Root Verifier ASM #1615) (Xinding Wei)
feat: Add Rv32HintLoadByKey (feat: Add Rv32HintLoadByKey #1606) (Xinding Wei)
feat: Add e2e stark proof support (feat: Add e2e stark proof support #1597) (Xinding Wei)
feat: openvm build can build multiple targets + additional cargo options (feat: openvm build can build multiple targets + additional cargo options #1647) (stephenh-axiom-xyz)
chore: update getrandom to v0.3 in openvm lib (chore: update getrandom to v0.3 in openvm lib #1635) (Jonathan Wang)
feat: Lazily call setup function for moduli and curves on first use (feat: Lazily call setup function for moduli and curves on first use #1603) (Avaneesh-axiom)
feat: Build script for calling init macros (feat: Build script for calling init macros #1596) (Avaneesh-axiom)
refactor: ELF and Program (refactor: ELF and Program #1638) (Xinding Wei)

Fixes INT-4185

Link to Devin run: https://app.devin.ai/sessions/75c7bcb2466641609349ad3d02c31edd

Requested by: Jonathan Wang

Co-Authored-By: Jonathan Wang <jpw@intrinsictech.xyz>

devin-ai-integration · 2025-06-12T13:13:12Z

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

Disable automatic comment and CI monitoring

Co-Authored-By: Jonathan Wang <jpw@intrinsictech.xyz>

- Remove inaccurate setup command rename entry - Specify commands affected by hex output format changes - Add concrete examples for prove command output path changes - Add build command output location changes - Remove SDK entries that don't represent breaking changes Co-Authored-By: Jonathan Wang <jpw@intrinsictech.xyz>

- Correct guest bindings description to mention setup_* function removal - Add details about on-demand initialization and openvm::init!() macro - Improve CLI migration section with actionable guidance - Address GitHub PR feedback from Jonathan Wang Co-Authored-By: Jonathan Wang <jpw@intrinsictech.xyz>

devin-ai-integration · 2025-06-20T14:37:09Z

Closing due to inactivity for more than 7 days.

github-actions · 2025-07-14T21:32:57Z

group	app.proof_time_ms	app.cycles	app.cells_used	leaf.proof_time_ms	leaf.cycles	leaf.cells_used
verify_fibair	(-13 [-1.1%]) 1,207	322,677	17,339,868	-	-	-
fibonacci	2,659	1,500,277	50,589,503	-	-	-
regex	(-43 [-0.5%]) 7,808	4,165,226	166,511,152	-	-	-
ecrecover	(+29 [+2.5%]) 1,175	136,241	8,089,998	-	-	-
pairing	(-34 [-0.8%]) 4,452	1,862,964	97,277,783	-	-	-

Commit: 11ae20c

Benchmark Workflow

docs: update CHANGELOG with breaking changes since v1.2.0

2594b6a

Co-Authored-By: Jonathan Wang <jpw@intrinsictech.xyz>

jonathanpwang reviewed Jun 12, 2025

View reviewed changes