doc: document ZMQ notification behavior during reorgs and evictions #35480

pull fernandguil wants to merge 1 commits into bitcoin:master from fernandguil:doc/zmq-notification-behavior changing 1 files +19 −0
  1. fernandguil commented at 6:06 PM on June 7, 2026: contributor

    Partially addresses #14278.

    Expands doc/zmq.md to document notification behavior that is implemented in the source but not described anywhere in the docs:

    rawtx / hashtx

    • These topics re-publish transactions from disconnected blocks during a reorg
    • They are suppressed for historical blocks connected to the assumeutxo background validation chainstate (consistent with rawblock/hashblock)

    sequence (R removals)

    • Clarify that R covers all mempool removal reasons except block inclusion: EXPIRY, SIZELIMIT, REORG, CONFLICT, REPLACED (RBF)
    • Explicitly note that block-inclusion removals are not reported via R; subscribers should use rawblock/hashblock for those

    Reorg ordering

    • Document the sequence of events during a reorg: D (block disconnected) → R (evicted mempool txs) → C (block connected)

    All behavior described here is derived directly from src/zmq/zmqnotificationinterface.cpp and src/txmempool.cpp.

  2. doc: document ZMQ notification behavior during reorgs and evictions
    Expand zmq.md to describe:
    - rawtx/hashtx are re-published for transactions in disconnected blocks
      during a reorg, and suppressed for assumeutxo background chainstate blocks
    - sequence 'R' notifications cover all mempool removal reasons except block
      inclusion (EXPIRY, SIZELIMIT, REORG, CONFLICT, REPLACED)
    - the ordering of sequence events during a reorg (D -> R -> C)
    
    This addresses part of #14278.
    e526939fdf
  3. DrahtBot added the label Docs on Jun 7, 2026
  4. DrahtBot commented at 6:07 PM on June 7, 2026: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    <!--006a51241073e994b41acfe9ec718e94-->

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35480.

    <!--021abf342d371248e50ceaed478a90ca-->

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    <!--5faf32d7da4f0f540f40219e4f7537a3-->


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-06-13 21:30 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me