feat(rpc): Tweak protx info to be able to show info for a specific block (dashpay#4738)

Author: UdjinM6

doc/release-notes-4738.md

@@ -0,0 +1,5 @@
+Updated RPCs
+------------
+
+- `protx info`: It's now possible to get historical data at a specific block by providing its blockhash
+

src/rpc/evo.cpp

@@ -1270,25 +1270,39 @@ static bool CheckWalletOwnsScript(CWallet* pwallet, const CScript& script) {
 }
 #endif
 
-static UniValue BuildDMNListEntry(CWallet* pwallet, const CDeterministicMN& dmn, bool detailed)
+static UniValue BuildDMNListEntry(CWallet* pwallet, const CDeterministicMN& dmn, bool detailed, const ChainstateManager& chainman, const CBlockIndex* pindex = nullptr)
 {
     if (!detailed) {
         return dmn.proTxHash.ToString();
     }
 
     UniValue o = dmn.ToJson();
 
+    CTransactionRef collateralTx{nullptr};
     int confirmations = GetUTXOConfirmations(dmn.collateralOutpoint);
+
+    if (pindex != nullptr) {
+        if (confirmations > -1) {
+            confirmations -= WITH_LOCK(cs_main, return chainman.ActiveChain().Height()) - pindex->nHeight;
+        } else {
+            uint256 minedBlockHash;
+            collateralTx = GetTransaction(/* pindex */ nullptr, /* mempool */ nullptr, dmn.collateralOutpoint.hash, Params().GetConsensus(), minedBlockHash);
+            const CBlockIndex* const pindexMined = WITH_LOCK(cs_main, return chainman.m_blockman.LookupBlockIndex(minedBlockHash));
+            CHECK_NONFATAL(pindexMined != nullptr);
+            CHECK_NONFATAL(pindex->GetAncestor(pindexMined->nHeight) == pindexMined);
+            confirmations = pindex->nHeight - pindexMined->nHeight + 1;
+        }
+    }
     o.pushKV("confirmations", confirmations);
 
 #ifdef ENABLE_WALLET
     bool hasOwnerKey = CheckWalletOwnsKey(pwallet, dmn.pdmnState->keyIDOwner);
     bool hasVotingKey = CheckWalletOwnsKey(pwallet, dmn.pdmnState->keyIDVoting);
 
     bool ownsCollateral = false;
-    uint256 tmpHashBlock;
-    CTransactionRef collateralTx = GetTransaction(/* block_index */ nullptr,  /* mempool */ nullptr, dmn.collateralOutpoint.hash, Params().GetConsensus(), tmpHashBlock);
-    if (collateralTx) {
+    if (Coin coin; GetUTXOCoin(dmn.collateralOutpoint, coin)) {
+        ownsCollateral = CheckWalletOwnsScript(pwallet, coin.out.scriptPubKey);
+    } else if (collateralTx != nullptr) {
         ownsCollateral = CheckWalletOwnsScript(pwallet, collateralTx->vout[dmn.collateralOutpoint.n].scriptPubKey);
     }
 
@@ -1366,7 +1380,7 @@ static UniValue protx_list(const JSONRPCRequest& request, const ChainstateManage
                 CheckWalletOwnsKey(wallet.get(), dmn.pdmnState->keyIDVoting) ||
                 CheckWalletOwnsScript(wallet.get(), dmn.pdmnState->scriptPayout) ||
                 CheckWalletOwnsScript(wallet.get(), dmn.pdmnState->scriptOperatorPayout)) {
-                ret.push_back(BuildDMNListEntry(wallet.get(), dmn, detailed));
+                ret.push_back(BuildDMNListEntry(wallet.get(), dmn, detailed, chainman));
             }
         });
 #endif
@@ -1389,7 +1403,7 @@ static UniValue protx_list(const JSONRPCRequest& request, const ChainstateManage
         bool onlyEvoNodes = type == "evo";
         mnList.ForEachMN(onlyValid, [&](const auto& dmn) {
             if (onlyEvoNodes && dmn.nType != MnType::Evo) return;
-            ret.push_back(BuildDMNListEntry(wallet.get(), dmn, detailed));
+            ret.push_back(BuildDMNListEntry(wallet.get(), dmn, detailed, chainman));
         });
     } else {
         throw JSONRPCError(RPC_INVALID_PARAMETER, "invalid type specified");
@@ -1404,6 +1418,7 @@ static void protx_info_help(const JSONRPCRequest& request)
         "\nReturns detailed information about a deterministic masternode.\n",
         {
             GetRpcArg("proTxHash"),
+            {"blockHash", RPCArg::Type::STR_HEX, /* default*/ "(chain tip)", "The hash of the block to get deterministic masternode state at"},
         },
         RPCResult{
             RPCResult::Type::OBJ, "", "Details about a specific deterministic masternode",
@@ -1417,7 +1432,7 @@ static void protx_info_help(const JSONRPCRequest& request)
     }.Check(request);
 }
 
-static UniValue protx_info(const JSONRPCRequest& request)
+static UniValue protx_info(const JSONRPCRequest& request, const ChainstateManager& chainman)
 {
     protx_info_help(request);
 
@@ -1433,13 +1448,28 @@ static UniValue protx_info(const JSONRPCRequest& request)
         g_txindex->BlockUntilSyncedToCurrentChain();
     }
 
+    CBlockIndex* pindex{nullptr};
+
     uint256 proTxHash(ParseHashV(request.params[0], "proTxHash"));
-    auto mnList = deterministicMNManager->GetListAtChainTip();
+
+    if (request.params[1].isNull()) {
+        LOCK(cs_main);
+        pindex = chainman.ActiveChain().Tip();
+    } else {
+        LOCK(cs_main);
+        uint256 blockHash(ParseHashV(request.params[1], "blockHash"));
+        pindex = chainman.m_blockman.LookupBlockIndex(blockHash);
+        if (pindex == nullptr) {
+            throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
+        }
+    }
+
+    auto mnList = deterministicMNManager->GetListForBlock(pindex);
     auto dmn = mnList.GetMN(proTxHash);
     if (!dmn) {
         throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("%s not found", proTxHash.ToString()));
     }
-    return BuildDMNListEntry(wallet.get(), *dmn, true);
+    return BuildDMNListEntry(wallet.get(), *dmn, true, chainman, pindex);
 }
 
 static void protx_diff_help(const JSONRPCRequest& request)
@@ -1644,7 +1674,7 @@ static UniValue protx(const JSONRPCRequest& request)
     if (command == "protxlist") {
         return protx_list(new_request, chainman);
     } else if (command == "protxinfo") {
-        return protx_info(new_request);
+        return protx_info(new_request, chainman);
     } else if (command == "protxdiff") {
         return protx_diff(new_request, chainman);
     } else if (command == "protxlistdiff") {

test/functional/feature_dip3_deterministicmns.py

@@ -109,18 +109,29 @@ def run_test(self):
             self.assert_mnlists(mns)
 
         self.log.info("test that MNs disappear from the list when the ProTx collateral is spent")
+        # also make sure "protx info" returns correct historical data for spent collaterals
         spend_mns_count = 3
         mns_tmp = [] + mns
         dummy_txins = []
         old_tip = self.nodes[0].getblockcount()
         old_listdiff = self.nodes[0].protx("listdiff", 1, old_tip)
         for i in range(spend_mns_count):
+            old_protx_hash = mns[i].protx_hash
+            old_collateral_address = mns[i].collateral_address
+            old_blockhash = self.nodes[0].getbestblockhash()
+            old_rpc_info = self.nodes[0].protx("info", old_protx_hash)
+            rpc_collateral_address = old_rpc_info["collateralAddress"]
+            assert_equal(rpc_collateral_address, old_collateral_address)
             dummy_txin = self.spend_mn_collateral(mns[i], with_dummy_input_output=True)
             dummy_txins.append(dummy_txin)
             self.nodes[0].generate(1)
             self.sync_all()
             mns_tmp.remove(mns[i])
             self.assert_mnlists(mns_tmp)
+            new_rpc_info = self.nodes[0].protx("info", old_protx_hash, old_blockhash)
+            del old_rpc_info["metaInfo"]
+            del new_rpc_info["metaInfo"]
+            assert_equal(new_rpc_info, old_rpc_info)
         new_listdiff = self.nodes[0].protx("listdiff", 1, old_tip)
         assert_equal(new_listdiff, old_listdiff)