Merge bitcoin/bitcoin#32419: psbt: clarify PSBT, PSBTInput, PSBTOutput unserialization flows

d31158d364 psbt: clarify PSBT, PSBTInput, PSBTOutput unserialization flows (rkrux)

Pull request description:

  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.

ACKs for top commit:
  achow101:
    ACK d31158d364
  theStack:
    ACK d31158d364

Tree-SHA512: 45111ef7f0258ebbc41d058b3ef2a72472774ab2878caf2d71d7b57b27549c46a51ccbeda5fe164bcf4f7ec10627bbae6e7763aa80b1e66912703a2088682817
This commit is contained in:
Ava Chow
2025-11-17 14:08:20 -08:00

View File

@@ -468,7 +468,8 @@ struct PSBTInput
// Read loop
bool found_sep = false;
while(!s.empty()) {
// Read
// Read the key of format "<keylen><keytype><keydata>" after which
// "key" will contain "<keytype><keydata>"
std::vector<unsigned char> key;
s >> key;
@@ -479,11 +480,13 @@ struct PSBTInput
break;
}
// Type is compact size uint at beginning of key
// "skey" is used so that "key" is unchanged after reading keytype below
SpanReader skey{key};
// keytype is of the format compact size uint at the beginning of "key"
uint64_t type = ReadCompactSize(skey);
// Do stuff based on type
// Do stuff based on keytype "type", i.e., key checks, reading values of the
// format "<valuelen><valuedata>" from the stream "s", and value checks
switch(type) {
case PSBT_IN_NON_WITNESS_UTXO:
{
@@ -957,7 +960,8 @@ struct PSBTOutput
// Read loop
bool found_sep = false;
while(!s.empty()) {
// Read
// Read the key of format "<keylen><keytype><keydata>" after which
// "key" will contain "<keytype><keydata>"
std::vector<unsigned char> key;
s >> key;
@@ -968,11 +972,13 @@ struct PSBTOutput
break;
}
// Type is compact size uint at beginning of key
// "skey" is used so that "key" is unchanged after reading keytype below
SpanReader skey{key};
// keytype is of the format compact size uint at the beginning of "key"
uint64_t type = ReadCompactSize(skey);
// Do stuff based on type
// Do stuff based on keytype "type", i.e., key checks, reading values of the
// format "<valuelen><valuedata>" from the stream "s", and value checks
switch(type) {
case PSBT_OUT_REDEEMSCRIPT:
{
@@ -1220,7 +1226,8 @@ struct PartiallySignedTransaction
// Read global data
bool found_sep = false;
while(!s.empty()) {
// Read
// Read the key of format "<keylen><keytype><keydata>" after which
// "key" will contain "<keytype><keydata>"
std::vector<unsigned char> key;
s >> key;
@@ -1231,11 +1238,13 @@ struct PartiallySignedTransaction
break;
}
// Type is compact size uint at beginning of key
// "skey" is used so that "key" is unchanged after reading keytype below
SpanReader skey{key};
// keytype is of the format compact size uint at the beginning of "key"
uint64_t type = ReadCompactSize(skey);
// Do stuff based on type
// Do stuff based on keytype "type", i.e., key checks, reading values of the
// format "<valuelen><valuedata>" from the stream "s", and value checks
switch(type) {
case PSBT_GLOBAL_UNSIGNED_TX:
{