rpc: implement special platform port shim for CDeterministicMNStateDiff

`CDeterministicMNStateDiff` is special because not all of its fields may
be populated, so we may not have all the data we need to report on the
diff.

Author: kwvg

src/evo/dmnstate.cpp

@@ -6,6 +6,7 @@
 
 #include <script/standard.h>
 
+#include <evo/netinfo.h>
 #include <rpc/evo_util.h>
 
 #include <univalue.h>
@@ -75,7 +76,6 @@ UniValue CDeterministicMNStateDiff::ToJson(MnType nType) const
         if (IsServiceDeprecatedRPCEnabled()) {
             obj.pushKV("service", state.netInfo->GetPrimary().ToStringAddrPort());
         }
-        obj.pushKV("addresses", state.netInfo->ToJson());
     }
     if (fields & Field_nRegisteredHeight) {
         obj.pushKV("registeredHeight", state.nRegisteredHeight);
@@ -130,5 +130,37 @@ UniValue CDeterministicMNStateDiff::ToJson(MnType nType) const
             obj.pushKV("platformHTTPPort", state.platformHTTPPort);
         }
     }
+    {
+        const bool has_netinfo = (fields & Field_netInfo);
+
+        UniValue netInfoObj(UniValue::VOBJ);
+        if (has_netinfo) {
+            netInfoObj = state.netInfo->ToJson();
+        }
+        if (nType == MnType::Evo && (!has_netinfo || !state.netInfo->CanStorePlatform())) {
+            auto unknownAddr = [](uint16_t port) -> UniValue {
+                UniValue obj(UniValue::VARR);
+                // We don't know what the address is because it wasn't changed in the
+                // diff but we still need to report the port number in addr:port format
+                obj.push_back(strprintf("255.255.255.255:%d", port));
+                return obj;
+            };
+            if (fields & Field_platformP2PPort) {
+                netInfoObj.pushKV(PurposeToString(NetInfoPurpose::PLATFORM_P2P).data(),
+                                  (has_netinfo)
+                                      ? ArrFromService(CService(state.netInfo->GetPrimary(), state.platformP2PPort))
+                                      : unknownAddr(state.platformP2PPort));
+            }
+            if (fields & Field_platformHTTPPort) {
+                netInfoObj.pushKV(PurposeToString(NetInfoPurpose::PLATFORM_HTTPS).data(),
+                                  (has_netinfo)
+                                      ? ArrFromService(CService(state.netInfo->GetPrimary(), state.platformHTTPPort))
+                                      : unknownAddr(state.platformHTTPPort));
+            }
+        }
+        if (!netInfoObj.empty()) {
+            obj.pushKV("addresses", netInfoObj);
+        }
+    }
     return obj;
 }

test/functional/rpc_netinfo.py

@@ -26,6 +26,8 @@
 # See CRegTestParams in src/chainparams.cpp
 DEFAULT_PORT_PLATFORM_P2P = 22200
 DEFAULT_PORT_PLATFORM_HTTP = 22201
+# See CDeterministicMNStateDiff::ToJson() in src/evo/dmnstate.h
+DMNSTATE_DIFF_DUMMY_ADDR = "255.255.255.255"
 
 class Node:
     mn: MasternodeInfo
@@ -240,14 +242,19 @@ def test_deprecation(self):
         self.connect_nodes(self.node_evo.mn.nodeIdx, self.node_simple.index) # Needed as restarts don't reconnect nodes
 
         # CProUpServTx::ToJson() <- TxToUniv() <- TxToJSON() <- getrawtransaction
-        proupservtx_hash = self.node_evo.update_mn(self, f"127.0.0.1:{self.node_evo.mn.nodePort+1}", DEFAULT_PORT_PLATFORM_P2P, DEFAULT_PORT_PLATFORM_HTTP)
+        # We need to update *thrice*, the first time to incorrect values and the second time, (back) to correct values and the third time, only
+        # updating Platform fields to trigger the conditions needed to report the dummy address
+        proupservtx_hash = self.node_evo.update_mn(self, f"127.0.0.1:{self.node_evo.mn.nodePort + 10}", DEFAULT_PORT_PLATFORM_P2P + 10, DEFAULT_PORT_PLATFORM_HTTP + 10)
         proupservtx_rpc = self.node_evo.node.getrawtransaction(proupservtx_hash, True)
 
-        # We need to update *twice*, the first time to incorrect values and the second time, back to correct values.
-        # This is to make sure that the fields we need to check against are reflected in the diff.
+        # Restore back to defaults
         proupservtx_hash = self.node_evo.update_mn(self, f"127.0.0.1:{self.node_evo.mn.nodePort}", DEFAULT_PORT_PLATFORM_P2P, DEFAULT_PORT_PLATFORM_HTTP)
         proupservtx_rpc = self.node_evo.node.getrawtransaction(proupservtx_hash, True)
 
+        # Revert back to incorrect values but only for Platform fields
+        proupservtx_hash_pl = self.node_evo.update_mn(self, f"127.0.0.1:{self.node_evo.mn.nodePort}", DEFAULT_PORT_PLATFORM_P2P + 10, DEFAULT_PORT_PLATFORM_HTTP + 10)
+        proupservtx_rpc_pl = self.node_evo.node.getrawtransaction(proupservtx_hash_pl, True)
+
         # CSimplifiedMNListEntry::ToJson() <- CSimplifiedMNListDiff::mnList <- CSimplifiedMNListDiff::ToJson() <- protx_diff
         masternode_active_height: int = masternode_status['dmnState']['registeredHeight']
         protx_diff_rpc = self.node_evo.node.protx('diff', masternode_active_height - 1, masternode_active_height)
@@ -256,6 +263,10 @@ def test_deprecation(self):
         proupservtx_height = proupservtx_rpc['height']
         protx_listdiff_rpc = self.node_evo.node.protx('listdiff', proupservtx_height - 1, proupservtx_height)
 
+        # If the core P2P address wasn't updated and the platform fields were, CDeterministicMNStateDiff will return a dummy address
+        proupservtx_height_pl = proupservtx_rpc_pl['height']
+        protx_listdiff_rpc_pl = self.node_evo.node.protx('listdiff', proupservtx_height_pl - 1, proupservtx_height_pl)
+
         self.log.info("Test RPCs return an 'addresses' field")
         assert "addresses" in proregtx_rpc['proRegTx'].keys()
         assert "addresses" in masternode_status['dmnState'].keys()
@@ -269,8 +280,12 @@ def test_deprecation(self):
         self.check_netinfo_fields(proupservtx_rpc['proUpServTx']['addresses'], self.node_evo.mn.nodePort, DEFAULT_PORT_PLATFORM_HTTP, DEFAULT_PORT_PLATFORM_P2P)
         # CSimplifiedMNListEntry doesn't store platform P2P network information before extended addresses
         self.check_netinfo_fields(protx_diff_rpc['mnList'][0]['addresses'], self.node_evo.mn.nodePort, DEFAULT_PORT_PLATFORM_HTTP, None)
-        # TODO: Fix reporting for CDeterministicMNStateDiff
-        self.check_netinfo_fields(protx_listdiff_rpc['updatedMNs'][0][proregtx_hash]['addresses'], self.node_evo.mn.nodePort, None, None)
+        # CDeterministicMNStateDiff will fill in the correct address if the core P2P address was updated *alongside* platform fields
+        self.check_netinfo_fields(protx_listdiff_rpc['updatedMNs'][0][proregtx_hash]['addresses'], self.node_evo.mn.nodePort, DEFAULT_PORT_PLATFORM_HTTP, DEFAULT_PORT_PLATFORM_P2P)
+        # CDeterministicMNStateDiff will use a dummy address if the core P2P address wasn't updated but Platform fields were to ensure changes are reported
+        assert "core_p2p" not in protx_listdiff_rpc_pl['updatedMNs'][0][proregtx_hash]['addresses'].keys()
+        assert_equal(protx_listdiff_rpc_pl['updatedMNs'][0][proregtx_hash]['addresses']['platform_https'][0], f"{DMNSTATE_DIFF_DUMMY_ADDR}:{DEFAULT_PORT_PLATFORM_HTTP + 10}")
+        assert_equal(protx_listdiff_rpc_pl['updatedMNs'][0][proregtx_hash]['addresses']['platform_p2p'][0], f"{DMNSTATE_DIFF_DUMMY_ADDR}:{DEFAULT_PORT_PLATFORM_P2P + 10}")
 
         self.log.info("Test RPCs by default no longer return a 'service' field")
         assert "service" not in proregtx_rpc['proRegTx'].keys()