RPC: getpeerinfo: Deprecate "whitelisted" field (replaced by "permissions")

Author: luke-jr

src/rpc/net.cpp

@@ -127,7 +127,8 @@ static RPCHelpMan getpeerinfo()
                             {
                                 {RPCResult::Type::NUM, "n", "The heights of blocks we're currently asking from this peer"},
                             }},
-                            {RPCResult::Type::BOOL, "whitelisted", "Whether the peer is whitelisted"},
+                            {RPCResult::Type::BOOL, "whitelisted", /* optional */ true, "Whether the peer is whitelisted with default permissions\n"
+                                                                                        "(DEPRECATED, returned only if config option -deprecatedrpc=whitelisted is passed)"},
                             {RPCResult::Type::NUM, "minfeefilter", "The minimum fee rate for transactions this peer accepts"},
                             {RPCResult::Type::OBJ_DYN, "bytessent_per_msg", "",
                             {
@@ -216,7 +217,10 @@ static RPCHelpMan getpeerinfo()
             }
             obj.pushKV("inflight", heights);
         }
-        obj.pushKV("whitelisted", stats.m_legacyWhitelisted);
+        if (IsDeprecatedRPCEnabled("whitelisted")) {
+            // whitelisted is deprecated in v0.21 for removal in v0.22
+            obj.pushKV("whitelisted", stats.m_legacyWhitelisted);
+        }
         UniValue permissions(UniValue::VARR);
         for (const auto& permission : NetPermissions::ToStrings(stats.m_permissionFlags)) {
             permissions.push_back(permission);

test/functional/p2p_blocksonly.py

@@ -59,7 +59,7 @@ def run_test(self):
 
         self.log.info('Check that txs from peers with relay-permission are not rejected and relayed to others')
         self.log.info("Restarting node 0 with relay permission and blocksonly")
-        self.restart_node(0, ["-persistmempool=0", "[email protected]", "-blocksonly"])
+        self.restart_node(0, ["-persistmempool=0", "[email protected]", "-blocksonly", '-deprecatedrpc=whitelisted'])
         assert_equal(self.nodes[0].getrawmempool(), [])
         first_peer = self.nodes[0].add_p2p_connection(P2PInterface())
         second_peer = self.nodes[0].add_p2p_connection(P2PInterface())

test/functional/p2p_permissions.py

@@ -42,6 +42,13 @@ def run_test(self):
             ["relay", "noban", "mempool", "download"],
             True)
 
+        self.checkpermission(
+            # check without deprecatedrpc=whitelisted
+            ["-whitelist=127.0.0.1"],
+            # Make sure the default values in the command line documentation match the ones here
+            ["relay", "noban", "mempool", "download"],
+            None)
+
         self.checkpermission(
             # no permission (even with forcerelay)
             ["[email protected]", "-whitelistforcerelay=1"],
@@ -80,6 +87,12 @@ def run_test(self):
             ["noban", "mempool", "download"],
             False)
 
+        self.checkpermission(
+            # check without deprecatedrpc=whitelisted
+            ["-whitelist=noban,[email protected]", "-whitelistrelay"],
+            ["noban", "mempool", "download"],
+            None)
+
         self.checkpermission(
             # legacy whitelistforcerelay should be ignored
             ["-whitelist=noban,[email protected]", "-whitelistforcerelay"],
@@ -149,10 +162,15 @@ def check_tx_relay(self):
         )
 
     def checkpermission(self, args, expectedPermissions, whitelisted):
+        if whitelisted is not None:
+            args = [*args, '-deprecatedrpc=whitelisted']
         self.restart_node(1, args)
         connect_nodes(self.nodes[0], 1)
         peerinfo = self.nodes[1].getpeerinfo()[0]
-        assert_equal(peerinfo['whitelisted'], whitelisted)
+        if whitelisted is None:
+            assert 'whitelisted' not in peerinfo
+        else:
+            assert_equal(peerinfo['whitelisted'], whitelisted)
         assert_equal(len(expectedPermissions), len(peerinfo['permissions']))
         for p in expectedPermissions:
             if not p in peerinfo['permissions']: