Skip to content

Remove zkvm exit symbol. - #57

Merged
bgravenorst merged 1 commit into
mainfrom
DOC-55
Aug 31, 2026
Merged

Remove zkvm exit symbol.#57
bgravenorst merged 1 commit into
mainfrom
DOC-55

Conversation

@bgravenorst

@bgravenorst bgravenorst commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

This update removes the zkvm_exit symbol.

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_log and heap bounds (ZKVM_HEAP_POS / ZKVM_HEAP_TOP), and zkvm_exit is removed from the reference table.

Hosts are now expected to call Zesu's main, map its 0 / 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 define zkvm_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.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Copilot AI lite review requested due to automatic review settings August 30, 2026 22:52
@bgravenorst
bgravenorst requested a review from a team as a code owner August 30, 2026 22:52
@vercel

vercel Bot commented Aug 30, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
doc-zesu Ready Ready Preview Aug 30, 2026 10:52pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_exit from 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 main and 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.

@garyschulte garyschulte left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@bgravenorst
bgravenorst merged commit dc2cf86 into main Aug 31, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove zkvm_exit runtime symbol

4 participants