RPC: Document "asm" and "hex" fields for scripts & fix getblock help #25691

pull luke-jr wants to merge 2 commits into bitcoin:master from luke-jr:docfix_getblock&asmhex changing 2 files +22 −21

luke-jr commented at 3:45 AM on July 25, 2022: member

Inspired by #24718
Bugfix: RPC/blockchain: Correct type of "value" in getblock docs; add missing "desc" 2cdd4df140
DrahtBot added the label RPC/REST/ZMQ on Jul 25, 2022
RPC: Document "asm" and "hex" fields for scripts 56d92447d0
luke-jr force-pushed on Jul 25, 2022
kristapsk approved
kristapsk commented at 9:28 AM on July 25, 2022: contributor

cr utACK 56d92447d0e75f459511bf48e105efae0dffc6b6
MarcoFalke merged this on Jul 25, 2022
MarcoFalke closed this on Jul 25, 2022

in src/rpc/blockchain.cpp:621 in 56d92447d0

 619 |                  {RPCResult::Type::OBJ, "scriptPubKey", "",
 620 |                  {
 621 | -                    {RPCResult::Type::STR, "asm", "The asm"},
 622 | -                    {RPCResult::Type::STR_HEX, "hex", "The hex"},
 623 | +                    {RPCResult::Type::STR, "asm", "Disassembly of the public key script"},
 624 | +                    {RPCResult::Type::STR, "desc", "Inferred descriptor for the output"},

MarcoFalke commented at 9:44 AM on July 25, 2022:

We should probably get rid of RPCResult::Type::ELISION to have the test check for invalid docs here

luke-jr commented at 4:10 PM on July 25, 2022:

But then the docs themselves would be less helpful. Maybe there's a better way? (A flag for elided fields in place of a description?)

sidhujag referenced this in commit 98ee840576 on Jul 25, 2022
bitcoin locked this on Jul 25, 2023

Contributors

Labels

Linked (view graph)

#24718 rpc: getblock/getrawtransaction/decode*/gettxout fixups