Remove zkvm exit symbol. - #57
Merged
Merged
Conversation
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull request overview
This PR updates the Zesu documentation to reflect a change in the zkVM host integration contract: zkvm_exit is no longer required as a runtime symbol, and execution termination is now handled via main’s return value (with panics trapping).
Changes:
- Removes
zkvm_exitfrom the documented runtime symbol contract and adds a new “Exit status and panics” section describing return-value-based termination. - Updates “Obtain the guest program” and “Architecture” docs to clarify that the host entry point must call
mainand convert its return value into the zkVM halt sequence. - Fixes references to the zkVM standards repository link (now
eth-act/zkevm-standards).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/zkvm-symbols.mdx | Removes zkvm_exit from the runtime symbol table and documents the new termination/panic semantics. |
| docs/get-started/get-guest-program.mdx | Clarifies host entry-point responsibilities and updates the standards link. |
| docs/concepts/architecture.mdx | Updates the runtime symbol contract description, adds termination semantics note, and updates the standards link. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
alexandratran
approved these changes
Aug 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This update removes the
zkvm_exitsymbol.Fixes: #55
Note
Low Risk
Documentation-only changes to the zkVM host integration contract; integrators must update entry points if they still rely on zkvm_exit.
Overview
Updates zkVM integration docs so termination is no longer part of the host symbol contract: runtime symbols cover only
zkvm_logand heap bounds (ZKVM_HEAP_POS/ZKVM_HEAP_TOP), andzkvm_exitis removed from the reference table.Hosts are now expected to call Zesu's
main, map its0/ non-zero return value to the zkVM halt path, and follow the execution termination semantics standard. A new Exit status and panics section spells out success/failure returns, panic behavior (zkvm_log+ trap), and a migration note for integrations that still definezkvm_exit.Get started and architecture pages add the same entry-point obligation, and zkVM standards links are corrected to
zkevm-standards.Reviewed by Cursor Bugbot for commit 6596b5e. Bugbot is set up for automated code reviews on this repo. Configure here.