RPC: introduce 'getblockfileinfo' RPC command

furszy · furszy · commit 24bfe4e1a076 · 2023-10-18T11:12:14.000-03:00
Simple command to retrieve information about a certain block file
diff --git a/src/node/blockstorage.cpp b/src/node/blockstorage.cpp
@@ -644,7 +644,7 @@ void BlockManager::CleanupBlockRevFiles() const
 CBlockFileInfo* BlockManager::GetBlockFileInfo(size_t n)
 {
     LOCK(cs_LastBlockFile);
-
+    if (n > m_blockfile_info.size()-1) return nullptr;
     return &m_blockfile_info.at(n);
 }
 
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp
@@ -2869,6 +2869,45 @@ return RPCHelpMan{
     };
 }
 
+static RPCHelpMan getblockfileinfo()
+{
+    return RPCHelpMan{
+            "getblockfileinfo",
+            "Retrieves information about a certain block file.",
+            {
+                {"file_number", RPCArg::Type::NUM, RPCArg::Optional::NO, "block file number"},
+            },
+            RPCResult{
+                    RPCResult::Type::OBJ, "", "",
+                    {
+                        {RPCResult::Type::NUM, "blocks_num", "the number of blocks stored in the file"},
+                        {RPCResult::Type::NUM, "lowest_block", "the height of the lowest block inside the file"},
+                        {RPCResult::Type::NUM, "highest_block", "the height of the highest block inside the file"},
+                        {RPCResult::Type::NUM, "data_size", "the number of used bytes in the block file"},
+                        {RPCResult::Type::NUM, "undo_size", "the number of used bytes in the undo file"},
+                    }
+            },
+            RPCExamples{ HelpExampleCli("getblockfileinfo", "0") },
+            [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue {
+                NodeContext& node = EnsureAnyNodeContext(request.context);
+
+                int block_num = request.params[0].getInt<int>();
+                if (block_num < 0) throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid block number");
+
+                CBlockFileInfo* info = node.chainman->m_blockman.GetBlockFileInfo(block_num);
+                if (!info) throw JSONRPCError(RPC_INVALID_PARAMETER, "block file not found");
+
+                UniValue result(UniValue::VOBJ);
+                result.pushKV("blocks_num", info->nBlocks);
+                result.pushKV("lowest_block", info->nHeightFirst);
+                result.pushKV("highest_block", info->nHeightLast);
+                result.pushKV("data_size", info->nSize);
+                result.pushKV("undo_size", info->nUndoSize);
+
+                return result;
+            }
+    };
+}
 
 void RegisterBlockchainRPCCommands(CRPCTable& t)
 {
@@ -2896,6 +2935,7 @@ void RegisterBlockchainRPCCommands(CRPCTable& t)
         {"blockchain", &dumptxoutset},
         {"blockchain", &loadtxoutset},
         {"blockchain", &getchainstates},
+        {"hidden", &getblockfileinfo},
         {"hidden", &invalidateblock},
         {"hidden", &reconsiderblock},
         {"hidden", &waitfornewblock},
diff --git a/src/rpc/client.cpp b/src/rpc/client.cpp
@@ -242,6 +242,7 @@ static const CRPCConvertParam vRPCConvertParams[] =
     { "verifychain", 1, "nblocks" },
     { "getblockstats", 0, "hash_or_height" },
     { "getblockstats", 1, "stats" },
+    { "getblockfileinfo", 0, "file_number" },
     { "pruneblockchain", 0, "height" },
     { "keypoolrefill", 0, "newsize" },
     { "getrawmempool", 0, "verbose" },
diff --git a/src/test/fuzz/rpc.cpp b/src/test/fuzz/rpc.cpp
@@ -120,6 +120,7 @@ const std::vector<std::string> RPC_COMMANDS_SAFE_FOR_FUZZING{
     "getblockfrompeer", // when no peers are connected, no p2p message is sent
     "getblockhash",
     "getblockheader",
+    "getblockfileinfo",
     "getblockstats",
     "getblocktemplate",
     "getchaintips",

Original file line number	Diff line number	Diff line change
`@@ -644,7 +644,7 @@ void BlockManager::CleanupBlockRevFiles() const`
`644`	`644`	`CBlockFileInfo* BlockManager::GetBlockFileInfo(size_t n)`
`645`	`645`	`{`
`646`	`646`	`LOCK(cs_LastBlockFile);`
`647`		`-`
	`647`	`+ if (n > m_blockfile_info.size()-1) return nullptr;`
`648`	`648`	`return &m_blockfile_info.at(n);`
`649`	`649`	`}`
`650`	`650`