rpc: Fail to return undocumented or misdocumented JSON #23083

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. fanquake added the label RPC/REST/ZMQ on Sep 24, 2021
3. MarcoFalke closed this on Sep 24, 2021

   ---

4. MarcoFalke reopened this on Sep 24, 2021

   ---

5. MarcoFalke force-pushed on Sep 24, 2021
6. MarcoFalke force-pushed on Sep 24, 2021
7. 
   DrahtBot commented at 3:35 pm on December 2, 2021: member

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

   Conflicts

   No conflicts as of last run.

8. MarcoFalke force-pushed on Dec 2, 2021
9. MarcoFalke force-pushed on Dec 2, 2021
10. MarcoFalke force-pushed on Dec 3, 2021
11. MarcoFalke referenced this in commit 13f41855c5 on Dec 7, 2021
12. sidhujag referenced this in commit 638b9de672 on Dec 7, 2021
13. DrahtBot added the label Needs rebase on Dec 8, 2021
14. MarcoFalke force-pushed on Dec 8, 2021
15. DrahtBot removed the label Needs rebase on Dec 8, 2021
16. MarcoFalke force-pushed on Dec 8, 2021
17. MarcoFalke force-pushed on Dec 8, 2021
18. MarcoFalke force-pushed on Dec 8, 2021
19. RandyMcMillan referenced this in commit b119053182 on Dec 23, 2021
20. 
    promag commented at 10:04 pm on March 15, 2022: member

    Concept ACK
21. MarcoFalke referenced this in commit 138d55e6a0 on Mar 22, 2022
22. MarcoFalke force-pushed on Mar 22, 2022
23. 
    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)
24. fanquake referenced this in commit e7b6272b30 on Mar 24, 2022
25. rpc: Add m_skip_type_check to RPCResult

    Used in the next commit.

    f4bc4a705a
26. rpc: Fail to return undocumented or misdocumented JSON fc892c3a80
27. MarcoFalke force-pushed on Mar 24, 2022
28. laanwj added this to the "Blockers" column in a project

    ---

29. fanquake referenced this in commit 56c4ac55f6 on Mar 28, 2022
30. 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?
31. fanquake approved
32. 
    fanquake commented at 11:16 am on March 28, 2022: member

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

    0test_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); })'
    1rpc/util.cpp:587 (HandleRequest)
    2You may report this issue here: https://github.com/bitcoin/bitcoin/issues
    3 (-1)
    

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

33. fanquake merged this on Mar 28, 2022
34. fanquake closed this on Mar 28, 2022

    ---

35. MarcoFalke deleted the branch on Mar 28, 2022
36. fanquake removed this from the "Blockers" column in a project

    ---

37. sidhujag referenced this in commit d66d0d3aeb on Apr 2, 2022
38. sidhujag referenced this in commit 3b238d5d44 on Apr 3, 2022
39. sidhujag referenced this in commit 32e152c768 on Apr 3, 2022
40. domob1812 referenced this in commit f87ded8b95 on Apr 7, 2022
41. DrahtBot locked this on Mar 28, 2023

Contributors
MarcoFalke DrahtBot promag fanquake

Labels
RPC/REST/ZMQ