DIP-0026: accept the multi-payout object as a JSON string (dash-cli)

ParsePayoutParam only recognized the {"address": basisPoints} payout form when it
arrived as a UniValue object, which is the case over JSON-RPC and named arguments.
dash-cli passes the payout argument as a plain string (it is not in the
rpc/client.cpp conversion table), so the documented object form sent via dash-cli
arrived as a string, fell through to the single-address branch, and failed with
"invalid payout address: {...}".

Accept the object whether it arrives as a UniValue object or as a JSON string: if a
string payout begins with '{', parse it and require a JSON object, otherwise treat it
as a single address. A base58/bech32 address never begins with '{', so the two forms
are unambiguous, and the legacy single-address CLI form is unchanged.

The functional test now sends one conversion's shares as a JSON string (the dash-cli
path) in addition to the dict form, so both arrival shapes are covered.

Author: hilawe

src/rpc/evo.cpp

@@ -410,7 +410,26 @@ static uint16_t ParsePayoutParam(const UniValue& param, const uint16_t max_versi
     scriptPayoutRet = CScript();
     payoutSharesRet.clear();
 
-    if (param.isObject()) {
+    // The DIP0026 multi-payout form is a {"address": basisPoints} object. It can arrive either as a
+    // UniValue object (named arguments / JSON-RPC callers) or as a JSON string, because dash-cli
+    // passes this argument as a string (the payout arg is not in the rpc/client.cpp conversion
+    // table). Accept both. A single payout address is base58/bech32 and never begins with '{', so
+    // the single-address and object forms are unambiguous.
+    UniValue parsed_obj;
+    if (param.isStr()) {
+        const std::string& s{param.get_str()};
+        const size_t first{s.find_first_not_of(" \t\n\r")};
+        if (first != std::string::npos && s[first] == '{') {
+            if (!parsed_obj.read(s) || !parsed_obj.isObject()) {
+                throw JSONRPCError(RPC_INVALID_PARAMETER,
+                                   "payout must be a single address or a JSON object like "
+                                   "{\"address\": basisPoints}");
+            }
+        }
+    }
+    const UniValue& shares{param.isObject() ? param : parsed_obj};
+
+    if (shares.isObject()) {
         if (max_version < ProTxVersion::MultiPayout) {
             throw JSONRPCError(RPC_INVALID_PARAMETER,
                                "multi-party payouts (DIP0026) are not available yet (v25 is not active)");
@@ -423,12 +442,12 @@ static uint16_t ParsePayoutParam(const UniValue& param, const uint16_t max_versi
         // duplicate scripts to mirror consensus. CheckPayoutShares remains the authoritative gate.
         int64_t total_bps{0};
         std::set<CScript> seen_scripts;
-        for (const std::string& addr : param.getKeys()) {
+        for (const std::string& addr : shares.getKeys()) {
             const CTxDestination dest = DecodeDestination(addr);
             if (!IsValidDestination(dest)) {
                 throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("invalid payout address: %s", addr));
             }
-            const int64_t bps = param[addr].getInt<int64_t>();
+            const int64_t bps = shares[addr].getInt<int64_t>();
             if (bps <= 0 || bps > PayoutShare::TOTAL_BASIS_POINTS) {
                 throw JSONRPCError(RPC_INVALID_PARAMETER,
                                    strprintf("payout share for %s must be between 1 and %d basis points", addr,

test/functional/feature_dip0026_multipayout.py

@@ -44,6 +44,8 @@
      payees, cross-version mixing) are covered by the unit reject-matrix instead.
 """
 
+import json
+
 from test_framework.test_framework import DashTestFramework, MasternodeInfo
 from test_framework.util import (
     assert_equal,
@@ -304,14 +306,20 @@ def reject_payout(shares, msg):
         # coinbase additionally has an operator output. The split check below ignores
         # that output (different address) and validates only the owner-share split of
         # the already-operator-reduced owner reward reported by getblocktemplate.
-        self.log.info("convert mninfo[1] to a 2-way multi-payout via update_registrar")
+        #
+        # The shares here are passed as a JSON STRING rather than a dict, on purpose: dash-cli
+        # delivers the object form as a string (the payout arg is not in the rpc/client.cpp JSON
+        # conversion table), so this exercises ParsePayoutParam's string-to-object path that the dict
+        # form (real JSON-RPC object) does not. mninfo[0] above used the dict form, so both arrival
+        # shapes are covered.
+        self.log.info("convert mninfo[1] to a 2-way multi-payout via update_registrar (JSON-string form)")
         mn_b = self.mninfo[1]
         self.upgrade_mn_to_extaddr(node, mn_b)
         b1, b2 = node.getnewaddress(), node.getnewaddress()
         shares_b = {b1: 3333, b2: 6667}  # ordered; sums to 10000
         assert_equal(sum(shares_b.values()), TOTAL_BASIS_POINTS)
         node.sendtoaddress(mn_b.fundsAddr, 0.001)  # ensure a spendable fee output for the ProUpRegTx
-        txid = mn_b.update_registrar(node, submit=True, rewards_address=shares_b,
+        txid = mn_b.update_registrar(node, submit=True, rewards_address=json.dumps(shares_b),
                                      fundsAddr=mn_b.fundsAddr)
         assert txid is not None
         self.bump_mocktime(10 * 60 + 1)