psbt: clarify PSBT, PSBTInput, PSBTOutput unserialization flows #32419

pull rkrux wants to merge 1 commits into bitcoin:master from rkrux:psbt-deser changing 1 files +18 −9
  1. rkrux commented at 11:41 am on May 5, 2025: contributor

    The unserialization flows of the PSBT types work based on few underlying assumptions of functions from serialize.h & stream.h that takes some to understand when read the first time.

    Add few comments that highlight these assumptions hopefully making it easier to grasp. Also, mention key/value format types as per BIP 174.

  2. psbt: clarify PSBT, PSBTInput, PSBTOutput unserialization flows
    The unserialization flows of the PSBT types work based on few underlying
    assumptions of functions from `serialize.h` & `stream.h` that takes some
    to understand when read the first time.
    
    Add few comments that highlight these assumptions hopefully making it easier
    to grasp. Also, mention key/value format types as per BIP 174.
    d31158d364
  3. DrahtBot commented at 11:41 am on May 5, 2025: contributor

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

    Code Coverage & Benchmarks

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

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK theStack
    Concept ACK w0xlt

    If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

  4. DrahtBot added the label PSBT on May 5, 2025
  5. theStack commented at 4:55 pm on May 6, 2025: contributor

    Concept ACK

    Makes sense to me to provide at least a brief description of how the key data is structured and deserialized, since this is not intuitive at all (as I also noticed in the course of reviewing #31247 a while ago).

  6. w0xlt commented at 6:33 pm on May 7, 2025: contributor

    Concept ACK

    Agreed #32419 (comment)

  7. theStack approved
  8. theStack commented at 1:14 pm on May 9, 2025: contributor

    ACK d31158d3646f3c7e4832b9ca50f6ffe02800ff4c

    The introduced comments match my understanding of the deserialization of PSBT types and will hopefully help reviewing future code introduced/touched in this area. It’s not ideal that the same comments are copied at three places, but don’t have a better idea how to avoid this (still better to have duplicated documentation than no documentation).

  9. DrahtBot requested review from w0xlt on May 9, 2025


rkrux DrahtBot theStack w0xlt


w0xlt

Labels
PSBT


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: 2025-05-31 03:12 UTC

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