Skip to content

Update zkVM symbol reference: document zkvm_abort() panic/exit handling #61

Description

@alexandratran

Consensys-Incorporated/zesu#139 adds a zkvm_abort() function to zkvm/root.zig. zkVM guest panic paths now call
zkvm_abort() instead of raising @trap() directly, so each zkVM host can define its own guest exit behavior on panic. The PR also converts several previously-silent out-of-memory paths (precompiles, bytecode jump-table analysis, EIP-7708 log builders/LOG0–LOG4) into explicit panics that now route through this new exit path, rather than continuing execution or returning masked errors.

docs/reference/zkvm-symbols.mdx currently documents the OLD behavior verbatim — no dedicated abort/exit symbol, panics trigger @trap(). This is now inaccurate and should be updated to describe zkvm_abort(), its signature/semantics, and how zkVM hosts
implement/consume it. Also worth noting the OOM-handling change (silent continuation → explicit panic).

Suggested docs to update: docs/reference/zkvm-symbols.mdx (Exit Handling section); check docs/concepts/witness-retrieval.mdx / architecture.mdx for related OOM-behavior mentions.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions