Skip to content

No error code / error reference anywhere across the docs #5

Description

@therevealer

Location:
Site-wide, but conspicuously absent at /build/aleo-instructions/reference/, /build/aleo-instructions/reference/finalize-operations/, /build/aleo-instructions/reference/programs/, and all SDK guides

Problem:
Multiple pages reference runtime errors and halting behavior:

  • Finalize ops: "Attempting to access [program_owner] will result in a runtime error."
  • Standard operations table is full of halts on overflow, halts on zero, halts on non-residues, halts past boundary.
  • leo deploy, leo execute, the Account API, the Delegated Proving API all surface errors implicitly.

No page lists error codes, exception types, the halt taxonomy, or what an end-user/operator sees when one of these failures triggers. There is no "Errors" reference.

Consequence:
A developer hitting a runtime halt has nothing to grep for in the docs. Agents writing error handling have no error type to catch and no documented retry semantics.

The fix:
Add an /build/reference/errors/ page that enumerates AVM halt categories, Leo compiler errors, SDK exception types, and REST API error responses, each with a code, a one-line cause, and a recommended remediation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions