rpc: Fail to return undocumented or misdocumented JSON #23083

pull MarcoFalke wants to merge 2 commits into bitcoin:master from MarcoFalke:2108-docRpc changing 3 files +57 −10
  1. MarcoFalke commented at 8:59 AM on September 24, 2021: member

    This avoids documentation shortcomings such as the ones fixed in commit 56c4ac55f606cc37b30d5b68e155d4cc2b7c0c2c, e7b6272b305386a264adf2c04b7bebfb8499070f, 138d55e6a0241f126916fde6ac9177c7e2a119c4, 577bd51a4b8de066466a445192c1c653872657e2, f8c84e047c61200fae4cc1d85688e113bf270409, 0ee9a00f90e81a6978b30bdb250a37cbfa6da022, 13f41855c5fedf11d4a2525f2f0dd214533e5e62, or faecb2ee0a0ad3eb8303cfc84a87dc02ec553c43

  2. MarcoFalke cross-referenced this on Sep 24, 2021 from issue RPC documentation cleanup ideas by MarcoFalke
  3. fanquake added the label RPC/REST/ZMQ on Sep 24, 2021
  4. MarcoFalke closed this on Sep 24, 2021
  5. MarcoFalke reopened this on Sep 24, 2021
  6. MarcoFalke force-pushed on Sep 24, 2021
  7. MarcoFalke force-pushed on Sep 24, 2021
  8. DrahtBot cross-referenced this on Dec 2, 2021 from issue MOVEONLY: Move wallet backup and encryption RPCs out of rpcwallet by meshcollider
  9. DrahtBot commented at 3:35 PM on December 2, 2021: contributor

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    No conflicts as of last run.

  10. MarcoFalke cross-referenced this on Dec 2, 2021 from issue doc: Document optional RPC result fields by MarcoFalke
  11. MarcoFalke force-pushed on Dec 2, 2021
  12. MarcoFalke force-pushed on Dec 2, 2021
  13. MarcoFalke force-pushed on Dec 3, 2021
  14. DrahtBot cross-referenced this on Dec 6, 2021 from issue Split up rpcwallet by meshcollider
  15. MarcoFalke cross-referenced this on Dec 7, 2021 from issue doc: Add missing optional to MempoolEntryDescription by MarcoFalke
  16. MarcoFalke referenced this in commit 13f41855c5 on Dec 7, 2021
  17. sidhujag referenced this in commit 638b9de672 on Dec 7, 2021
  18. DrahtBot added the label Needs rebase on Dec 8, 2021
  19. MarcoFalke force-pushed on Dec 8, 2021
  20. DrahtBot removed the label Needs rebase on Dec 8, 2021
  21. MarcoFalke cross-referenced this on Dec 8, 2021 from issue doc: Add missing optional to getblockfrompeer by MarcoFalke
  22. MarcoFalke force-pushed on Dec 8, 2021
  23. MarcoFalke cross-referenced this on Dec 8, 2021 from issue scripted-diff: Use named args in RPC docs by MarcoFalke
  24. MarcoFalke force-pushed on Dec 8, 2021
  25. MarcoFalke force-pushed on Dec 8, 2021
  26. RandyMcMillan referenced this in commit b119053182 on Dec 23, 2021
  27. MarcoFalke cross-referenced this on Jan 4, 2022 from issue doc: Mark proprietary array optional by MarcoFalke
  28. promag commented at 10:04 PM on March 15, 2022: member

    Concept ACK

  29. MarcoFalke cross-referenced this on Mar 16, 2022 from issue doc: Fix getblockchaininfo/getdeploymentinfo RPC docs by MarcoFalke
  30. MarcoFalke referenced this in commit 138d55e6a0 on Mar 22, 2022
  31. MarcoFalke force-pushed on Mar 22, 2022
  32. MarcoFalke cross-referenced this on Mar 22, 2022 from issue rpc: Exclude descriptor when address is excluded by MarcoFalke
  33. MarcoFalke commented at 11:10 AM on March 22, 2022: member

    I opened this less than 6 months ago and this already found 7 bugs (see linked pulls and OP)

  34. fanquake referenced this in commit e7b6272b30 on Mar 24, 2022
  35. rpc: Add m_skip_type_check to RPCResult
    Used in the next commit.
    f4bc4a705a
  36. rpc: Fail to return undocumented or misdocumented JSON fc892c3a80
  37. MarcoFalke force-pushed on Mar 24, 2022
  38. laanwj added this to the "Blockers" column in a project
  39. MarcoFalke cross-referenced this on Mar 28, 2022 from issue Fix getpeerinfo doc by MarcoFalke
  40. fanquake referenced this in commit 56c4ac55f6 on Mar 28, 2022
  41. in src/wallet/rpc/wallet.cpp:59 in fc892c3a80 
      55 | @@ -56,7 +56,7 @@ static RPCHelpMan getwalletinfo()
  56 |                          {
  57 |                              {RPCResult::Type::NUM, "duration", "elapsed seconds since scan start"},
  58 |                              {RPCResult::Type::NUM, "progress", "scanning progress percentage [0.0, 1.0]"},
  59 | -                        }},
  60 | +                        }, /*skip_type_check=*/true},
    fanquake commented at 11:04 AM on March 28, 2022:

    Can / will this be removed in future?

  42. fanquake approved
  43. fanquake commented at 11:16 AM on March 28, 2022: member

    ACK fc892c3a80091fbeaa2b5a6ec5bdaa31359b42de - tested that this catches issue, i.e #24691:

    test_framework.authproxy.JSONRPCException: Internal bug detected: 'std::any_of(m_results.m_results.begin(), m_results.m_results.end(), [ret](const RPCResult& res) { return res.MatchesType(ret); })'
rpc/util.cpp:587 (HandleRequest)
You may report this issue here: https://github.com/bitcoin/bitcoin/issues
 (-1)

    This has been sitting catching bugs, too-long, to remain un-merged.

  44. fanquake merged this on Mar 28, 2022
  45. fanquake closed this on Mar 28, 2022
  46. MarcoFalke deleted the branch on Mar 28, 2022
  47. fanquake cross-referenced this on Mar 28, 2022 from issue Put undocumented JSON failure mode behind a runtime flag by fanquake
  48. fanquake removed this from the "Blockers" column in a project
  49. sidhujag referenced this in commit d66d0d3aeb on Apr 2, 2022
  50. sidhujag referenced this in commit 3b238d5d44 on Apr 3, 2022
  51. sidhujag referenced this in commit 32e152c768 on Apr 3, 2022
  52. domob1812 referenced this in commit f87ded8b95 on Apr 7, 2022
  53. bitcoin locked this on Mar 28, 2023
Contributors
MarcoFalkeDrahtBotpromagfanquake
Labels
RPC/REST/ZMQ
Linked (view graph)
#22798 doc: Fix RPC result documentation#22799 RPC documentation cleanup ideas#23652 doc: Document optional RPC result fields#23694 doc: Add missing optional to MempoolEntryDescription#23702 doc: Add missing optional to getblockfrompeer#23703 scripted-diff: Use named args in RPC docs#23975 doc: Mark proprietary array optional#24579 doc: Fix getblockchaininfo/getdeploymentinfo RPC docs#24636 rpc: Exclude descriptor when address is excluded#24691 Fix getpeerinfo doc#24695 Put undocumented JSON failure mode behind a runtime flag
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-05-20 06:53 UTC