Skip to content

[Docs Update] stacks-core PR #6575: Add vm_error field to block replay RPC #1741

@claude

Description

@claude

Source PR

What Changed

Added a new vm_error field to the block replay RPC endpoint transaction responses. This optional field contains runtime error messages when a transaction execution fails, providing better debugging information for failed transactions.

Documentation Impact

Files Needing Updates

  • /docs/reference/rpc-api.md - Update block replay endpoint documentation to mention the new vm_error field

Recommended Changes

In /docs/reference/rpc-api.md

Section: Block Replay RPC endpoint (around line 242-244)

Since the block replay endpoint documentation references the OpenAPI spec, consider adding documentation about this field or ensuring the OpenAPI spec properly documents the vm_error field:

Add a note about the vm_error field:
vm_error field added: Block replay responses now include an optional vm_error field in transaction objects that contains error messages when transaction execution fails, helping with debugging failed transactions.

Note: This change is part of ongoing improvements to the block replay endpoint. See also PR #6638 which adds additional fields to this endpoint.

Priority

Medium - API enhancement that helps developers debug transaction failures


Auto-generated by docs sync monitor

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