Merge #6886: fix: multiple help string for RPC result

9af4c55 fix: typos and capitalizations (Konstantin Akimov)
690ff3a fix: apply suggestions from code review (Konstantin Akimov)
6e89094 fix: multiple code-review comments (Konstantin Akimov)
661db51 fix: add missing RPC help result for quorum RPCs (Konstantin Akimov)
72284b5 fix: add missing RPC help result for RPC getrawtransactionmulti (Konstantin Akimov)
7d6b606 fix: add missing RPC help result for evo RPCs (Konstantin Akimov)
3b4095c fix: add proper RPC result for governance RPC (Konstantin Akimov)
b216d13 fix: set proper RPCResult for coinjoin RPC (Konstantin Akimov)
b174fe0 fix: add missing RPC help result for RPC mockscheduler (Konstantin Akimov)
cc1a8fd fix: add missing RPC help result for masternode RPCs (Konstantin Akimov)

Pull request description:

  ## Issue being fixed or feature implemented
  For many dash specific RPC we use stub `RPCResults` instead real documentation for returned values.
  It was possible because some important changes from backport bitcoin#20495 has been skipped.

  ## What was done?
  Replaced all stub RPCResults{} in RPC code to real help, or map with ELISION inside.
  For some RPC replaced ELISION to real description.

  ## How Has This Been Tested?
  See PR #6887: done extra testing with backports  bitcoin#20495, bitcoin#25161, bitcoin#25170, bitcoin#24408, bitcoin#25237 and fixed all failures in functional tests.

  ## Breaking Changes
  N/A

  ## Checklist:
  - [x] I have performed a self-review of my own code
  - [ ] I have commented my code, particularly in hard-to-understand areas
  - [ ] I have added or updated relevant unit/integration/functional/e2e tests
  - [ ] I have made corresponding changes to the documentation
  - [x] I have assigned this pull request to a milestone

ACKs for top commit:
  UdjinM6:
    utACK 9af4c55
  kwvg:
    utACK 9af4c55

Tree-SHA512: 7b8842255050a9154ea4e2d8e7245888dfe96543c856b0e299b95e861156a2fc22a20abb882153ede75f901cfe420df344bbfd1c82364a7b44eb357c38fab4bb

Author: PastaPastaPasta

src/rpc/coinjoin.cpp

@@ -58,7 +58,7 @@ static RPCHelpMan coinjoin()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -230,7 +230,7 @@ static RPCHelpMan coinjoinsalt()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {

src/rpc/evo.cpp

@@ -1404,7 +1404,16 @@ static RPCHelpMan protx_list()
             {"detailed", RPCArg::Type::BOOL, RPCArg::Default{false}, "If not specified, only the hashes of the ProTx will be returned."},
             {"height", RPCArg::Type::NUM, RPCArg::DefaultHint{"current chain-tip"}, ""},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::ARR, "", "List of masternodes",
+            {
+                RPCResult{"when detailed=false", RPCResult::Type::STR, "", "ProTx hash"},
+                RPCResult{"when detailed=true", RPCResult::Type::OBJ, "", "",
+                    {
+                        // TODO: document fields of the detailed entry
+                        {RPCResult::Type::ELISION, "", ""}
+                    }},
+            }},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -1511,6 +1520,7 @@ static RPCHelpMan protx_info()
         RPCResult{
             RPCResult::Type::OBJ, "", "Details about a specific deterministic masternode",
             {
+                // TODO: implement proper doc for protx info
                 {RPCResult::Type::ELISION, "", ""}
             }
         },
@@ -1644,8 +1654,40 @@ static RPCHelpMan protx_listdiff()
                        {"baseBlock", RPCArg::Type::NUM, RPCArg::Optional::NO, "The starting block height."},
                        {"block", RPCArg::Type::NUM, RPCArg::Optional::NO, "The ending block height."},
                },
-               RPCResults{},
-               RPCExamples{""},
+                RPCResult {
+                    RPCResult::Type::OBJ, "", "",
+                    {
+                        {RPCResult::Type::NUM, "baseHeight", "Height of base (starting) block"},
+                        {RPCResult::Type::NUM, "blockHeight", "Height of target (ending) block"},
+                        {RPCResult::Type::ARR, "addedMNs", "Added masternodes",
+                            {
+                                {RPCResult::Type::OBJ, "", "",
+                                {
+                                    // TODO: list fields of output for RPC help instead ELISION
+                                    {RPCResult::Type::ELISION, "", ""}
+                                }},
+                            },
+                        },
+                        {RPCResult::Type::ARR, "removedMns", "Removed masternodes",
+                            {
+                                {RPCResult::Type::STR_HEX, "protx", "ProTx of removed masternode"},
+                            },
+                        },
+                        {RPCResult::Type::ARR, "updatedMNs", "Updated masternodes",
+                            {
+                                {RPCResult::Type::OBJ, "", "",
+                                {
+                                    {RPCResult::Type::OBJ, "protx", "ProTx of updated masternode",
+                                    {
+                                        // TODO: list fields of output for RPC help instead ELISION
+                                        {RPCResult::Type::ELISION, "", ""}
+                                    }},
+                                }},
+                            },
+                        },
+                    },
+                },
+                RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
     const NodeContext& node = EnsureAnyNodeContext(request.context);
@@ -1743,7 +1785,7 @@ static RPCHelpMan protx_help()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -1833,7 +1875,7 @@ static RPCHelpMan bls_help()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {

src/rpc/governance.cpp

@@ -43,7 +43,20 @@ static RPCHelpMan gobject_count()
         {
             {"mode", RPCArg::Type::STR, RPCArg::DefaultHint{"json"}, "Output format: json (\"json\") or string in free form (\"all\")"},
         },
-        RPCResults{},
+        {
+            RPCResult{"for mode = json",
+                RPCResult::Type::OBJ, "", "",
+                {
+                    {RPCResult::Type::NUM, "objects_total", "Total number of all governance objects"},
+                    {RPCResult::Type::NUM, "proposals", "Number of governance proposals"},
+                    {RPCResult::Type::NUM, "triggers", "Number of triggers"},
+                    {RPCResult::Type::NUM, "other", "Total number of unknown governance objects"},
+                    {RPCResult::Type::NUM, "erased", "Number of removed (expired) objects"},
+                    {RPCResult::Type::NUM, "votes", "Total number of votes"},
+                }
+            },
+            RPCResult{"for mode = all", RPCResult::Type::STR, "", "Human-friendly summary string for proposals and votes"},
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -71,7 +84,7 @@ static RPCHelpMan gobject_deserialize()
         {
             {"hex_data", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "data in hex string form"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::STR, "", "JSON string of the deserialized governance object"},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -96,7 +109,12 @@ static RPCHelpMan gobject_check()
         {
             {"hex_data", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "data in hex string format"},
         },
-        RPCResults{},
+        RPCResult{"if object is valid",
+            RPCResult::Type::OBJ, "", "",
+            {
+                {RPCResult::Type::STR, "Object status", "OK"},
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -145,7 +163,7 @@ static RPCHelpMan gobject_prepare()
             {"outputHash", RPCArg::Type::STR_HEX, RPCArg::Default{""}, "the single output to submit the proposal fee from"},
             {"outputIndex", RPCArg::Type::NUM, RPCArg::Default{0}, "The output index."},
         },
-        RPCResults{},
+        {RPCResult{"if object valid", RPCResult::Type::STR_HEX, "", "The collateral transaction id (txid)"}},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -254,7 +272,16 @@ static RPCHelpMan gobject_list_prepared()
         {
             {"count", RPCArg::Type::NUM, RPCArg::Default{10}, "Maximum number of objects to return."},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::ARR, "", "list of governance objects",
+            {
+                {RPCResult::Type::OBJ, "", "",
+                {
+                    // TODO: list fields of output for RPC help instead ELISION
+                    {RPCResult::Type::ELISION, "", ""}
+                }},
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -303,7 +330,7 @@ static RPCHelpMan gobject_submit()
             {"data-hex", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "data in hex string form"},
             {"fee-txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "txid of the corresponding proposal fee transaction"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::STR_HEX, "hash", "Hash of the submitted governance object"},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -482,6 +509,23 @@ static bool CheckWalletOwnsKey(const CWallet& wallet, const CKeyID& keyid)
     return wallet.IsMine(script) == isminetype::ISMINE_SPENDABLE;
 }
 
+namespace {
+const RPCResult vote_results{
+    RPCResult::Type::OBJ, "", "",
+        {
+            {RPCResult::Type::STR, "overall", "Total number of successful and failed votes"},
+            {RPCResult::Type::OBJ, "detail", "Detailed information for each vote",
+            {
+                {RPCResult::Type::OBJ, "protx", "ProTx of masternode for voting",
+                {
+                    {RPCResult::Type::STR, "result", "Result of voting: {success|failed}"},
+                    {RPCResult::Type::STR, "errorMessage", /*optional=*/true, "Error message if failed"},
+                }},
+            }},
+        },
+};
+} // anonymous namespace
+
 static RPCHelpMan gobject_vote_many()
 {
     return RPCHelpMan{"gobject vote-many",
@@ -492,7 +536,7 @@ static RPCHelpMan gobject_vote_many()
             {"vote", RPCArg::Type::STR, RPCArg::Optional::NO, "vote, possible values: [funding|valid|delete|endorsed]"},
             {"vote-outcome", RPCArg::Type::STR, RPCArg::Optional::NO, "vote outcome, possible values: [yes|no|abstain]"},
         },
-        RPCResults{},
+        vote_results,
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -545,7 +589,7 @@ static RPCHelpMan gobject_vote_alias()
             {"vote-outcome", RPCArg::Type::STR, RPCArg::Optional::NO, "vote outcome, possible values: [yes|no|abstain]"},
             {"protx-hash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "masternode's proTxHash"},
         },
-        RPCResults{},
+        vote_results,
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -667,7 +711,18 @@ static RPCHelpMan gobject_list_helper(const bool make_a_diff)
             {"signal", RPCArg::Type::STR, RPCArg::Default{"valid"}, "cached signal, possible values: [valid|funding|delete|endorsed|all]"},
             {"type", RPCArg::Type::STR, RPCArg::Default{"all"}, "object type, possible values: [proposals|triggers|all]"},
         },
-        RPCResults{},
+        {
+            RPCResult{"If request is valid",
+                RPCResult::Type::OBJ, "hash", "Object details",
+                {
+                    // TODO: list fields of output for RPC help instead ELISION
+                    {RPCResult::Type::ELISION, "", ""}
+                },
+            },
+            RPCResult{"If request is invalid",
+                RPCResult::Type::STR, "", "Error string"
+            },
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -713,7 +768,15 @@ static RPCHelpMan gobject_get()
         {
             {"governance-hash", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "object id"},
         },
-        RPCResults{},
+        {
+            RPCResult{
+                RPCResult::Type::OBJ, "", "",
+                {
+                    // TODO: list fields of output for RPC help instead ELISION
+                    {RPCResult::Type::ELISION, "", ""}
+                }
+            },
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -809,7 +872,12 @@ static RPCHelpMan gobject_getcurrentvotes()
             {"txid", RPCArg::Type::STR_HEX, RPCArg::Default{""}, "masternode collateral txid"},
             {"vout", RPCArg::Type::STR, RPCArg::Default{""}, "masternode collateral output index, required if <txid> present"},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::OBJ_DYN, "", "Keys are hashes of vote, values are votes",
+            {
+                {RPCResult::Type::STR, "votes", "Human-friendly presentation of vote"},
+            },
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -875,7 +943,7 @@ static RPCHelpMan gobject()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -897,7 +965,7 @@ static RPCHelpMan voteraw()
             {"time", RPCArg::Type::NUM, RPCArg::Optional::NO, ""},
             {"vote-sig", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, ""},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::STR, "", "Result of voting"},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {

src/rpc/masternode.cpp

@@ -49,7 +49,9 @@ static RPCHelpMan masternode_connect()
             {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The address of the masternode to connect"},
             {"v2transport", RPCArg::Type::BOOL, RPCArg::DefaultHint{"set by -v2transport"}, "Attempt to connect using BIP324 v2 transport protocol"},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::STR, "status", "Returns 'successfully connected' if successful"
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -85,7 +87,28 @@ static RPCHelpMan masternode_count()
     return RPCHelpMan{"masternode count",
         "Get information about number of masternodes.\n",
         {},
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::OBJ, "", "",
+            {
+                {RPCResult::Type::NUM, "total", "Total number of Masternodes"},
+                {RPCResult::Type::NUM, "enabled", "Number of enabled Masternodes"},
+                {RPCResult::Type::OBJ, "details", "Breakdown of masternodes by type",
+                    {{RPCResult::Type::OBJ, "", "",
+                    {
+                        {RPCResult::Type::OBJ, "regular", "Details for regular masternodes",
+                            {
+                                {RPCResult::Type::NUM, "total", "Total number of regular Masternodes"},
+                                {RPCResult::Type::NUM, "enabled", "Number of enabled regular Masternodes"}
+                        }},
+                        {RPCResult::Type::OBJ, "evo", "Details for Evo nodes",
+                            {
+                                {RPCResult::Type::NUM, "total", "Total number of Evo nodes"},
+                                {RPCResult::Type::NUM, "enabled", "Number of enabled Evo nodes"}
+                        }},
+                    }},
+                    }}
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -157,7 +180,13 @@ static RPCHelpMan masternode_status()
     return RPCHelpMan{"masternode status",
         "Print masternode status information\n",
         {},
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::OBJ, "", "",
+            {
+                // TODO: implement proper type validator instead ELISION
+                {RPCResult::Type::ELISION, "", ""}
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -232,7 +261,12 @@ static RPCHelpMan masternode_winners()
             {"count", RPCArg::Type::NUM, RPCArg::Default{10}, "number of last winners to return"},
             {"filter", RPCArg::Type::STR, RPCArg::Default{""}, "filter for returned winners"},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::OBJ_DYN, "", "Keys are block heights (as strings); values describe the payees for that height",
+            {
+                {RPCResult::Type::STR, "payee", "Payee for the height"}
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -454,7 +488,7 @@ static RPCHelpMan masternode_help()
         {
             {"command", RPCArg::Type::STR, RPCArg::Optional::NO, "The command to execute"},
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {
@@ -491,7 +525,13 @@ static RPCHelpMan masternodelist_helper(bool is_composite)
             {"mode", RPCArg::Type::STR, RPCArg::DefaultHint{"json"}, "The mode to run list in"},
             {"filter", RPCArg::Type::STR, RPCArg::Default{""}, "Filter results. Partial match by outpoint by default in all modes, additional matches in some modes are also available"},
         },
-        RPCResults{},
+        RPCResult{
+            RPCResult::Type::OBJ, "", "",
+            {
+                // TODO: implement proper type validator instead ELISION
+                {RPCResult::Type::ELISION, "", ""}
+            }
+        },
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {

src/rpc/node.cpp

@@ -827,7 +827,7 @@ static RPCHelpMan mockscheduler()
         {
             {"delta_time", RPCArg::Type::NUM, RPCArg::Optional::NO, "Number of seconds to forward the scheduler into the future." },
         },
-        RPCResults{},
+        RPCResult{RPCResult::Type::NONE, "", ""},
         RPCExamples{""},
         [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
 {