[Docs Update] stacks-core PR #6638: Fix event.committed and add new fields to block replay RPC

[claude]

Source PR

• Repository: stacks-network/stacks-core
• PR: #6638 - Fix event.committed in replay block RPC
• URL: Fix event.committed in replay block RPC stacks-core#6638
• Merged: 2025-11-03

What Changed

Fixed a bug where event.committed was hardcoded to true in the block replay RPC endpoint. The field now correctly reflects whether the transaction was committed or aborted. Additionally, added two new response fields: result_hex (transaction result as hex-encoded Clarity value) and post_condition_aborted (boolean indicating if transaction was aborted by post-conditions).

Documentation Impact

Files Needing Updates

• /docs/reference/rpc-api.md - Update block replay endpoint documentation to reflect schema changes
• New documentation may be needed for detailed RPC response schemas if not covered by OpenAPI spec

Recommended Changes

In /docs/reference/rpc-api.md

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

The current documentation only shows the OpenAPI operation without details. Consider adding a note about the recent changes:

Add after the OpenAPI operation block:
Recent Changes:

• Fixed bug where event.committed was always true - now correctly reflects transaction commit status
• Added result_hex field: transaction result encoded as Clarity hex string
• Added post_condition_aborted field: boolean indicating if transaction was aborted by post-conditions

These fields help consumers better understand transaction execution results and handle failed transactions.

Alternative approach: If the OpenAPI spec is the canonical source, ensure the spec is updated to reflect these changes and consider adding examples that show the new fields.

Priority

Medium - API changes that affect developers using the block replay endpoint, but it's a specialized debugging/analysis endpoint

---

Auto-generated by docs sync monitor