Merge #6482: feat!: remove deprecated command-line option -platform-user

PastaPastaPasta · PastaPastaPasta · commit 265d9b5f9f5a · 2025-02-12T23:14:17.000-06:00
254f126 docs: added release notes for removal of -platform-user (Konstantin Akimov) 404656c feat!: remove deprecated command-line option `-platform-user` (Konstantin Akimov) ebca98b chore: removed functional test rpc_deprecated_platform_filter.py (Konstantin Akimov) Pull request description: ## Issue being fixed or feature implemented This command-line option has never been used for platform, marked as deprecated in v22. Time to remove it. ## What was done? Removed deprecated command line option `-platform-user` and related code ## How Has This Been Tested? ## Breaking Changes Removed deprecated command line option `-platform-user` and related code ## 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 _(for repository code-owners and collaborators only)_ ACKs for top commit: UdjinM6: utACK 254f126 PastaPastaPasta: utACK 254f126 Tree-SHA512: 57c50085b0727f3579c167bbccee4bc544932cf26f10ea321afa3b36d353e454c093c0690d15de4d661b9f52739b3e88929aa1ccb8e12f9205046a395bd6b28d
diff --git a/doc/release-notes-6482.md b/doc/release-notes-6482.md
@@ -0,0 +1,7 @@
+## Command-line Options
+
+### Changes in Existing Command-line Options
+
+- **`-platform-user`**
+  - Removed in v23, since deprecated in v22 and has never been used by platform
+
diff --git a/src/httprpc.cpp b/src/httprpc.cpp
@@ -122,9 +122,6 @@ static bool JSONErrorReply(RpcHttpRequest& rpcRequest, const UniValue& objError,
         nStatus = HTTP_BAD_REQUEST;
     else if (code == RPC_METHOD_NOT_FOUND)
         nStatus = HTTP_NOT_FOUND;
-    else if (code == RPC_PLATFORM_RESTRICTION) {
-        nStatus = HTTP_FORBIDDEN;
-    }
 
     std::string strReply = JSONRPCReply(NullUniValue, objError, id);
 
diff --git a/src/init.cpp b/src/init.cpp
@@ -1511,7 +1511,6 @@ bool AppInitMain(NodeContext& node, interfaces::BlockAndHeaderTipInfo* tip_info)
     /* Register RPC commands regardless of -server setting so they will be
      * available in the GUI RPC console even if external calls are disabled.
      */
-    tableRPC.InitPlatformRestrictions();
     RegisterAllCoreRPCCommands(tableRPC);
     for (const auto& client : node.chain_clients) {
         client->registerRpcs();
diff --git a/src/rpc/protocol.h b/src/rpc/protocol.h
@@ -48,7 +48,6 @@ enum RPCErrorCode
     RPC_VERIFY_ALREADY_IN_CHAIN     = -27, //!< Transaction already in chain
     RPC_IN_WARMUP                   = -28, //!< Client still warming up
     RPC_METHOD_DEPRECATED           = -32, //!< RPC method is deprecated
-    RPC_PLATFORM_RESTRICTION        = -33, //!< This RPC command cannot be run by platform-user
 
     //! Aliases for backward compatibility
     RPC_TRANSACTION_ERROR           = RPC_VERIFY_ERROR,
diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp
@@ -6,10 +6,6 @@
 
 #include <rpc/server.h>
 
-#include <chainparams.h>
-#include <node/context.h>
-#include <rpc/blockchain.h>
-#include <rpc/server_util.h>
 #include <rpc/util.h>
 #include <shutdown.h>
 #include <sync.h>
@@ -20,7 +16,6 @@
 
 #include <boost/signals2/signal.hpp>
 
-#include <algorithm>
 #include <atomic>
 #include <cassert>
 #include <chrono>
@@ -37,10 +32,7 @@ static RPCTimerInterface* timerInterface = nullptr;
 /* Map of name to timer. */
 static Mutex g_deadline_timers_mutex;
 static std::map<std::string, std::unique_ptr<RPCTimerBase> > deadlineTimers GUARDED_BY(g_deadline_timers_mutex);
-static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler, const std::multimap<std::string, std::vector<UniValue>>& mapPlatformRestrictions);
-
-// Any commands submitted by this user will have their commands filtered based on the mapPlatformRestrictions
-static const std::string defaultPlatformUser = "platform-user";
+static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler);
 
 struct RPCCommandExecutionInfo
 {
@@ -150,21 +142,6 @@ std::string CRPCTable::help(const std::string& strCommand, const JSONRPCRequest&
     return strRet;
 }
 
-void CRPCTable::InitPlatformRestrictions()
-{
-    mapPlatformRestrictions = {
-        {"getassetunlockstatuses", {}},
-        {"getbestblockhash", {}},
-        {"getblockhash", {}},
-        {"getblockcount", {}},
-        {"getbestchainlock", {}},
-        {"quorum sign", {static_cast<uint8_t>(Params().GetConsensus().llmqTypePlatform)}},
-        {"quorum verify", {}},
-        {"submitchainlock", {}},
-        {"verifyislock", {}},
-    };
-}
-
 static RPCHelpMan help()
 {
     return RPCHelpMan{"help",
@@ -507,10 +484,10 @@ static inline JSONRPCRequest transformNamedArguments(const JSONRPCRequest& in, c
     return out;
 }
 
-static bool ExecuteCommands(const std::vector<const CRPCCommand*>& commands, const JSONRPCRequest& request, UniValue& result, const std::multimap<std::string, std::vector<UniValue>>& mapPlatformRestrictions)
+static bool ExecuteCommands(const std::vector<const CRPCCommand*>& commands, const JSONRPCRequest& request, UniValue& result)
 {
     for (const auto& command : commands) {
-        if (ExecuteCommand(*command, request, result, &command == &commands.back(), mapPlatformRestrictions)) {
+        if (ExecuteCommand(*command, request, result, &command == &commands.back())) {
             return true;
         }
     }
@@ -542,78 +519,15 @@ UniValue CRPCTable::execute(const JSONRPCRequest &request) const
     if (it != mapCommands.end()) {
         UniValue result;
         const JSONRPCRequest new_request{subcommand.empty() ? request : request.squashed() };
-        if (ExecuteCommands(it->second, new_request, result, mapPlatformRestrictions)) {
+        if (ExecuteCommands(it->second, new_request, result)) {
             return result;
         }
     }
     throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Method not found");
 }
 
-static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler, const std::multimap<std::string, std::vector<UniValue>>& mapPlatformRestrictions)
-{
-    const NodeContext& node = EnsureAnyNodeContext(request.context);
-    // Before executing the RPC Command, filter commands from platform rpc user
-    if (node.mn_activeman && request.authUser == gArgs.GetArg("-deprecated-platform-user", defaultPlatformUser)) {
-        // replace this with structured binding in c++20
-        std::string command_name = command.name;
-        const auto& it = mapPlatformRestrictions.equal_range(command_name);
-        const auto& allowed_begin = it.first;
-        const auto& allowed_end = it.second;
-        /**
-         * allowed_begin and allowed_end are iterators that represent a range of [method_name, vec_params]
-         * For example, assume allowed = `quorum sign platformLlmqType`, `quorum verify` and `verifyislock`
-         * this range will look like:
-         *
-         * if request.strMethod == "quorum":
-         * [
-         *      "quorum sign", [platformLlmqType],
-         *      "quorum verify", []
-         * ]
-         * if request.strMethod == "verifyislock"
-         * [
-         *      "verifyislock", []
-         * ]
-         */
-
-        // If the requested method is not available in mapPlatformRestrictions
-        if (allowed_begin == allowed_end) {
-            throw JSONRPCError(RPC_PLATFORM_RESTRICTION, strprintf("Method \"%s\" prohibited", request.strMethod));
-        }
-
-        auto isValidRequest = [&request, &allowed_begin, &allowed_end]() {
-            for (auto itRequest = allowed_begin; itRequest != allowed_end; ++itRequest) {
-                // This is an individual group of parameters that is valid
-                // This will look something like `["sign", platformLlmqType]` from above.
-                const auto& vecAllowedParam = itRequest->second;
-                // An empty vector of allowed parameters represents that any parameter is allowed.
-                if (vecAllowedParam.empty()) {
-                    return true;
-                }
-                if (request.params.empty()) {
-                    throw JSONRPCError(RPC_PLATFORM_RESTRICTION, strprintf("Method \"%s\" has parameter restrictions.", request.strMethod));
-                }
-
-                if (request.params.size() < vecAllowedParam.size()) {
-                    continue;
-                }
-
-                if (std::equal(vecAllowedParam.begin(), vecAllowedParam.end(),
-                               request.params.getValues().begin(),
-                               [](const UniValue& left, const UniValue& right) {
-                                   return left.type() == right.type() && left.getValStr() == right.getValStr();
-                               })) {
-                    return true;
-                }
-            }
-            return false;
-        };
-
-        // Try if any of the mapPlatformRestrictions entries matches the current request
-        if (!isValidRequest()) {
-            throw JSONRPCError(RPC_PLATFORM_RESTRICTION, "Request doesn't comply with the parameter restrictions.");
-        }
-    }
-
+static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler)
+{
     try
     {
         RPCCommandExecution execution(request.strMethod);
@@ -647,7 +561,7 @@ UniValue CRPCTable::dumpArgMap(const JSONRPCRequest& args_request) const
         // TODO: implement mapping argument to type for composite commands
         if (cmd.first.find(' ') != std::string::npos) continue;
         UniValue result;
-        if (ExecuteCommands(cmd.second, request, result, mapPlatformRestrictions)) {
+        if (ExecuteCommands(cmd.second, request, result)) {
             for (const auto& values : result.getValues()) {
                 ret.push_back(values);
             }
diff --git a/src/rpc/server.h b/src/rpc/server.h
@@ -124,13 +124,10 @@ class CRPCTable
 {
 private:
     std::map<std::string, std::vector<const CRPCCommand*>> mapCommands;
-    std::multimap<std::string, std::vector<UniValue>> mapPlatformRestrictions;
 public:
     CRPCTable();
     std::string help(const std::string& name, const JSONRPCRequest& helpreq) const;
 
-    void InitPlatformRestrictions();
-
     /**
      * Execute a method.
      * @param request The JSONRPCRequest to execute
diff --git a/test/functional/rpc_deprecated_platform_filter.py b/test/functional/rpc_deprecated_platform_filter.py
diff --git a/test/functional/test_runner.py b/test/functional/test_runner.py
@@ -340,7 +340,6 @@
     'wallet_send.py --descriptors',
     'wallet_create_tx.py --descriptors',
     'p2p_fingerprint.py',
-    'rpc_deprecated_platform_filter.py',
     'rpc_external_queue.py',
     'rpc_wipewallettxes.py',
     'feature_uacomment.py',
diff --git a/test/lint/lint-circular-dependencies.py b/test/lint/lint-circular-dependencies.py
@@ -89,7 +89,6 @@
     "qt/guiutil -> qt/optionsdialog -> qt/guiutil",
     "qt/guiutil -> qt/optionsdialog -> qt/optionsmodel -> qt/guiutil",
     "qt/guiutil -> qt/qvalidatedlineedit -> qt/guiutil",
-    "rpc/blockchain -> rpc/server -> rpc/blockchain"
 )
 
 CODE_DIR = "src"

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,6 @@`
`89`	`89`	`"qt/guiutil -> qt/optionsdialog -> qt/guiutil",`
`90`	`90`	`"qt/guiutil -> qt/optionsdialog -> qt/optionsmodel -> qt/guiutil",`
`91`	`91`	`"qt/guiutil -> qt/qvalidatedlineedit -> qt/guiutil",`
`92`		`- "rpc/blockchain -> rpc/server -> rpc/blockchain"`
`93`	`92`	`)`
`94`	`93`
`95`	`94`	`CODE_DIR = "src"`