rpc: add optional blockhash to waitfornewblock

Sjors · Sep 4, 2024 · 53c9118 · 53c9118
1 parent 6c41928
commit 53c9118
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/doc/release-30635.md b/doc/release-30635.md
@@ -0,0 +1,4 @@
+Updated RPCs
+------------
+
+- The waitfornewblock RPC takes an optional `blockhash` argument. (#30635)
diff --git a/src/rpc/blockchain.cpp b/src/rpc/blockchain.cpp
@@ -259,6 +259,7 @@ static RPCHelpMan waitfornewblock()
                 "\nMake sure to use no RPC timeout (bitcoin-cli -rpcclienttimeout=0)",
                 {
                     {"timeout", RPCArg::Type::NUM, RPCArg::Default{0}, "Time in milliseconds to wait for a response. 0 indicates no timeout."},
+                    {"blockhash", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, "Last known block hash. Returns immediately if the tip is different."},
                 },
                 RPCResult{
                     RPCResult::Type::OBJ, "", "",
@@ -280,7 +281,22 @@ static RPCHelpMan waitfornewblock()
     NodeContext& node = EnsureAnyNodeContext(request.context);
     Mining& miner = EnsureMining(node);
 
+   // Use tip as reference block, unless a block hash was provided.
     auto block{CHECK_NONFATAL(miner.getTip()).value()};
+    if (!request.params[1].isNull()) {
+        uint256 hash(ParseHashV(request.params[1], "blockhash"));
+        {
+            ChainstateManager& chainman = EnsureAnyChainman(request.context);
+            LOCK(cs_main);
+            const CBlockIndex* block_index{chainman.m_blockman.LookupBlockIndex(hash)};
+            if (!block_index) {
+                throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found");
+            }
+            block.hash = block_index->GetBlockHash();
+            block.height = block_index->nHeight;
+        }
+    }
+
     if (IsRPCRunning()) {
         block = timeout ? miner.waitTipChanged(block.hash, std::chrono::milliseconds(timeout)) : miner.waitTipChanged(block.hash);
     }

diff --git a/test/functional/rpc_blockchain.py b/test/functional/rpc_blockchain.py
@@ -536,7 +536,7 @@ def _test_waitforblock(self):
         node.reconsiderblock(rollback_hash)
         # The chain has probably already been restored by the time reconsiderblock returns,
         # but poll anyway.
-        self.wait_until(lambda: node.waitfornewblock(timeout=100)['hash'] == current_hash)
+        self.wait_until(lambda: node.waitfornewblock(blockhash=rollback_header['previousblockhash'])['hash'] == current_hash)
 
     def _test_waitforblockheight(self):
         self.log.info("Test waitforblockheight")