[Wallet] Add RPC call “rescanblockchain ” #7061

537+         pIndexRescan = chainActive.Genesis();
538+
539+    //We can't rescan beyond non-pruned blocks, stop and throw an error
540+    if (fPruneMode)
541+    {
542+        if (fPruneMode)

1086@@ -1084,6 +1087,8 @@ int CWallet::ScanForWalletTransactions(CBlockIndex* pindexStart, bool fUpdate)
1087                 if (AddToWalletIfInvolvingMe(tx, &block, fUpdate))
1088                     ret++;
1089             }
1090+            if (pindex == pindexStop)

366@@ -367,7 +367,7 @@ std::string HelpMessage(HelpMessageMode mode)
367 #ifndef WIN32
368     strUsage += HelpMessageOpt("-pid=<file>", strprintf(_("Specify pid file (default: %s)"), BITCOIN_PID_FILENAME));
369 #endif
370-    strUsage += HelpMessageOpt("-prune=<n>", strprintf(_("Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is incompatible with -txindex and -rescan. "
371+    strUsage += HelpMessageOpt("-prune=<n>", strprintf(_("Reduce storage requirements by enabling pruning (deleting) of old blocks. This allows the pruneblockchain RPC to be called to delete specific blocks, and enables automatic pruning of old blocks if a target size in MiB is provided. This mode is incompatible with -txindex"

1159+    if (request.fHelp || request.params.size() > 2)
1160+        throw std::runtime_error(
1161+            "rescanblockchain (\"start-height\") (\"stop-height\")\n"
1162+            "\nRescan the local blockchain for wallet related transactions.\n"
1163+            "\nArguments:\n"
1164+            "1. \"start-height\"    (number, optional) blockheight where the rescan should start\n"

1187+        CBlockIndex *block = chainActive.Tip();
1188+        while (block && block->pprev && (block->pprev->nStatus & BLOCK_HAVE_DATA))
1189+            block = block->pprev;
1190+
1191+        if (pIndexStart->nHeight < block->nHeight)
1192+            throw JSONRPCError(RPC_WALLET_ERROR, "Can't rescan beyond pruned data.");

1180+
1181+    if (!pIndexStart)
1182+         pIndexStart = chainActive.Genesis();
1183+
1184+    //We can't rescan beyond non-pruned blocks, stop and throw an error
1185+    if (fPruneMode)

89@@ -90,7 +90,7 @@ Reduce storage requirements by enabling pruning (deleting) of old
90 blocks. This allows the pruneblockchain RPC to be called to
91 delete specific blocks, and enables automatic pruning of old
92 blocks if a target size in MiB is provided. This mode is
93-incompatible with \fB\-txindex\fR and \fB\-rescan\fR. Warning: Reverting this
94+incompatible with \fB\-txindex\fR. Warning: Reverting this

3870@@ -3865,7 +3871,7 @@ CWallet* CWallet::CreateWalletFromFile(const std::string walletFile)
3871     RegisterValidationInterface(walletInstance);
3872 
3873     CBlockIndex *pindexRescan = chainActive.Genesis();
3874-    if (!GetBoolArg("-rescan", false))

1511@@ -1508,6 +1512,9 @@ CBlockIndex* CWallet::ScanForWalletTransactions(CBlockIndex* pindexStart, bool f
1512             } else {
1513                 ret = nullptr;
1514             }
1515+            if (pindex == pindexStop) {

1467@@ -1468,11 +1468,15 @@ void CWalletTx::GetAmounts(std::list<COutputEntry>& listReceived,
1468  * before CWallet::nTimeFirstKey). Returns null if there is no such range, or

1488@@ -1485,7 +1489,7 @@ CBlockIndex* CWallet::ScanForWalletTransactions(CBlockIndex* pindexStart, bool f
1489         while (pindex && nTimeFirstKey && (pindex->GetBlockTime() < (nTimeFirstKey - TIMESTAMP_WINDOW)))
1490             pindex = chainActive.Next(pindex);
1491 
1492-        ShowProgress(_("Rescanning..."), 0); // show rescan progress in GUI as dialog or on splashscreen, if -rescan on startup
1493+        ShowProgress(_("Rescanning..."), 0); // show rescan progress in GUI as dialog or on splashscreen

1170+
1171+    LOCK2(cs_main, pwallet->cs_wallet);
1172+
1173+    CBlockIndex *pIndexStart = NULL;
1174+    CBlockIndex *pIndexStop = NULL;
1175+    if (request.params.size() > 0 && request.params[0].isNum())

1193+    }
1194+
1195+    if (pwallet)
1196+        pwallet->ScanForWalletTransactions(pIndexStart, pIndexStop, true);
1197+
1198+    return NullUniValue;

1173+    CBlockIndex *pIndexStart = NULL;
1174+    CBlockIndex *pIndexStop = NULL;
1175+    if (request.params.size() > 0 && request.params[0].isNum())
1176+        pIndexStart = chainActive[request.params[0].get_int()];
1177+
1178+    if (request.params.size() > 1 && request.params[1].isNum())

166@@ -167,8 +167,8 @@ bool CDB::Recover(const std::string& filename, void *callbackDataIn, bool (*reco
167     // Call Salvage with fAggressive=true to
168     // get as much data as possible.
169     // Rewrite salvaged data to fresh wallet file
170-    // Set -rescan so any missing transactions will be
171-    // found.
172+    // call rescanblockchain (RPC) so any missing

1183+
1184+    LOCK2(cs_main, pwallet->cs_wallet);
1185+
1186+    CBlockIndex *pIndexStart = NULL;
1187+    CBlockIndex *pIndexStop = NULL;
1188+    if (request.params.size() > 0 && request.params[0].isNum()) {

1198+    }
1199+
1200+    //We can't rescan beyond non-pruned blocks, stop and throw an error
1201+    if (fPruneMode) {
1202+        CBlockIndex *block = chainActive.Tip();
1203+        while (block && block->pprev && (block->pprev->nStatus & BLOCK_HAVE_DATA)) {

1171+    if (request.fHelp || request.params.size() > 2) {
1172+        throw std::runtime_error(
1173+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"
1174+            "\nRescan the local blockchain for wallet related transactions.\n"
1175+            "\nArguments:\n"
1176+            "1. \"startHeight\"    (number, optional) blockheight where the rescan should start\n"

1172+        throw std::runtime_error(
1173+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"
1174+            "\nRescan the local blockchain for wallet related transactions.\n"
1175+            "\nArguments:\n"
1176+            "1. \"startHeight\"    (number, optional) blockheight where the rescan should start\n"
1177+            "2. \"stopHeight\"     (number, optional) blockheight where the rescan should stop\n"

1168+        return NullUniValue;
1169+    }
1170+
1171+    if (request.fHelp || request.params.size() > 2) {
1172+        throw std::runtime_error(
1173+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"

1171+    if (request.fHelp || request.params.size() > 2) {
1172+        throw std::runtime_error(
1173+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"
1174+            "\nRescan the local blockchain for wallet related transactions.\n"
1175+            "\nArguments:\n"
1176+            "1. \"startheight\"    (number, optional) blockheight where the rescan should start\n"

1183+
1184+    LOCK2(cs_main, pwallet->cs_wallet);
1185+
1186+    CBlockIndex *pindexStart = NULL;
1187+    CBlockIndex *pindexStop = NULL;
1188+    if (request.params[0].isNum()) {

1190+    }
1191+    if (!pindexStart) {
1192+        pindexStart = chainActive.Genesis();
1193+    }
1194+
1195+    if (request.params[1].isNum()) {

1196+        pindexStop = chainActive[request.params[1].get_int()];
1197+    }
1198+
1199+    if (pindexStop && pindexStop->nHeight < pindexStart->nHeight) {
1200+        // Flip the parameters to the expected order
1201+        CBlockIndex * const tmp = pindexStart;

1195+    if (request.params[1].isNum()) {
1196+        pindexStop = chainActive[request.params[1].get_int()];
1197+    }
1198+
1199+    if (pindexStop && pindexStop->nHeight < pindexStart->nHeight) {
1200+        // Flip the parameters to the expected order

1553+CBlockIndex* CWallet::ScanForWalletTransactions(CBlockIndex* pindexStart, CBlockIndex* pindexStop, bool fUpdate)
1554 {
1555     int64_t nNow = GetTime();
1556     const CChainParams& chainParams = Params();
1557 
1558+    if (pindexStop && pindexStop->nHeight < pindexStart->nHeight) {

1204+    }
1205+
1206+    // We can't rescan beyond non-pruned blocks, stop and throw an error
1207+    if (fPruneMode) {
1208+        int nHeight = pindexStart->nHeight;
1209+        while ((!pindexStop) || nHeight <= pindexStop->nHeight) {

1181+            );
1182+    }
1183+
1184+    LOCK2(cs_main, pwallet->cs_wallet);
1185+
1186+    CBlockIndex *pindexStart = NULL;

1192+        pindexStart = chainActive.Genesis();
1193+    }
1194+
1195+    if (request.params[1].isNum()) {
1196+        pindexStop = chainActive[request.params[1].get_int()];
1197+    }

1172+        throw std::runtime_error(
1173+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"
1174+            "\nRescan the local blockchain for wallet related transactions.\n"
1175+            "\nArguments:\n"
1176+            "1. \"startheight\"    (number, optional) blockheight where the rescan should start\n"
1177+            "2. \"stopheight\"     (number, optional) blockheight where the rescan should stop\n"

1219+
1220+    if (pwallet) {
1221+        pwallet->ScanForWalletTransactions(pindexStart, pindexStop, true);
1222+    }
1223+
1224+    return NullUniValue;

1209+        while ((!pindexStop) || nHeight <= pindexStop->nHeight) {
1210+            CBlockIndex * const block = chainActive[nHeight];
1211+            if (!block) {
1212+                break;
1213+            }
1214+            if (!(block->pprev->nStatus & BLOCK_HAVE_DATA)) {

1190+        pindexStart = chainActive[request.params[0].get_int()];
1191+        if (!pindexStart) {
1192+            throw JSONRPCError(RPC_WALLET_ERROR, "Invalid startheight");
1193+        }
1194+    }
1195+    if (!pindexStart) {

1183+    }
1184+
1185+    LOCK2(cs_main, pwallet->cs_wallet);
1186+
1187+    CBlockIndex *pindexStart = nullptr;
1188+    CBlockIndex *pindexStop = nullptr;

1187+    CBlockIndex *pindexStart = nullptr;
1188+    CBlockIndex *pindexStop = nullptr;
1189+    if (!request.params[0].isNull()) {
1190+        pindexStart = chainActive[request.params[0].get_int()];
1191+        if (!pindexStart) {
1192+            throw JSONRPCError(RPC_WALLET_ERROR, "Invalid startheight");

1197+    }
1198+
1199+    if (!request.params[1].isNull()) {
1200+        pindexStop = chainActive[request.params[1].get_int()];
1201+        if (!pindexStop || pindexStop->nHeight < pindexStart->nHeight) {
1202+            throw JSONRPCError(RPC_WALLET_ERROR, "Invalid stopheight");

1209+        while (block) {
1210+            if (block->nHeight <= pindexStart->nHeight) {
1211+                break;
1212+            }
1213+            if (!(block->nStatus & BLOCK_HAVE_DATA)) {
1214+                throw JSONRPCError(RPC_WALLET_ERROR, "Can't rescan beyond pruned data. Use RPC call getblockchaininfo to determine your pruned height.");

1216+            block = block->pprev;
1217+        }
1218+    }
1219+
1220+    CBlockIndex *stopBlock = nullptr;
1221+    if (pwallet) {

1225+            stopBlock = pindexStop ? pindexStop : chainActive.Tip();
1226+        }
1227+    }
1228+
1229+    UniValue response(UniValue::VOBJ);
1230+    response.pushKV("startheight", pindexStart->nHeight);

918@@ -919,7 +919,7 @@ class CWallet final : public CCryptoKeyStore, public CValidationInterface
919     void BlockDisconnected(const std::shared_ptr<const CBlock>& pblock) override;
920     bool AddToWalletIfInvolvingMe(const CTransactionRef& tx, const CBlockIndex* pIndex, int posInBlock, bool fUpdate);
921     int64_t RescanFromTime(int64_t startTime, bool update);
922-    CBlockIndex* ScanForWalletTransactions(CBlockIndex* pindexStart, bool fUpdate = false);
923+    CBlockIndex* ScanForWalletTransactions(CBlockIndex* pindexStart, CBlockIndex* pindexStop = nullptr, bool fUpdate = false);

90@@ -91,6 +91,21 @@ def run_test (self):
91         self.start_node(1, extra_args=self.extra_args[1] + ['-rescan'])
92         assert_equal(self.nodes[1].getbalance(), num_hd_adds + 1)
93 
94+        # Try a RPC based rescan
95+        self.stop_node(1)
96+        shutil.rmtree(tmpdir + "/node1/regtest/blocks")

 97+        shutil.rmtree(tmpdir + "/node1/regtest/chainstate")
 98+        shutil.copyfile(tmpdir + "/hd.bak", tmpdir + "/node1/regtest/wallet.dat")
 99+        self.start_node(1, extra_args=self.extra_args[1])
100+        connect_nodes_bi(self.nodes, 0, 1)
101+        self.sync_all()
102+        out = self.nodes[1].rescanblockchain(0,1)

102+        out = self.nodes[1].rescanblockchain(0,1)
103+        assert_equal(out['startheight'], 0)
104+        assert_equal(out['stopheight'], 1)
105+        out = self.nodes[1].rescanblockchain()
106+        assert_equal(out['startheight'], 0)
107+        assert_equal(self.nodes[1].getbalance(), num_hd_adds + 1)

3235@@ -3235,6 +3236,7 @@ static const CRPCCommand commands[] =
3236     { "wallet",             "removeprunedfunds",        &removeprunedfunds,        {"txid"} },
3237 
3238     { "generating",         "generate",                 &generate,                 {"nblocks","maxtries"} },
3239+    { "wallet",             "rescanblockchain",         &rescanblockchain,         {"startheight", "stopheight"} },

3199+    CBlockIndex *pindexStart = chainActive.Genesis();
3200+    CBlockIndex *pindexStop = nullptr;
3201+    if (!request.params[0].isNull()) {
3202+        pindexStart = chainActive[request.params[0].get_int()];
3203+        if (!pindexStart) {
3204+            throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid startheight");

3206+    }
3207+
3208+    if (!request.params[1].isNull()) {
3209+        pindexStop = chainActive[request.params[1].get_int()];
3210+        if (!pindexStop || pindexStop->nHeight < pindexStart->nHeight) {
3211+            throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid stopheight");

3212+        }
3213+    }
3214+
3215+    // We can't rescan beyond non-pruned blocks, stop and throw an error
3216+    if (fPruneMode) {
3217+        CBlockIndex *block = pindexStop ? pindexStop : chainActive.Tip();

3216+    if (fPruneMode) {
3217+        CBlockIndex *block = pindexStop ? pindexStop : chainActive.Tip();
3218+        while (block) {
3219+            if (block->nHeight <= pindexStart->nHeight) {
3220+                break;
3221+            }

3228+
3229+    CBlockIndex *stopBlock = nullptr;
3230+    stopBlock = pwallet->ScanForWalletTransactions(pindexStart, pindexStop, true);
3231+    if (!stopBlock) {
3232+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex
3233+        stopBlock = pindexStop ? pindexStop : chainActive.Tip();

918@@ -919,7 +919,7 @@ class CWallet final : public CCryptoKeyStore, public CValidationInterface
919     void BlockDisconnected(const std::shared_ptr<const CBlock>& pblock) override;
920     bool AddToWalletIfInvolvingMe(const CTransactionRef& tx, const CBlockIndex* pIndex, int posInBlock, bool fUpdate);
921     int64_t RescanFromTime(int64_t startTime, bool update);
922-    CBlockIndex* ScanForWalletTransactions(CBlockIndex* pindexStart, bool fUpdate = false);
923+    CBlockIndex* ScanForWalletTransactions(CBlockIndex* pindexStart, CBlockIndex* pindexStop, bool fUpdate = false);

3176+        return NullUniValue;
3177+    }
3178+
3179+    if (request.fHelp || request.params.size() > 2) {
3180+        throw std::runtime_error(
3181+            "rescanblockchain (\"startheight\") (\"stopheight\")\n"

3183+            "\nArguments:\n"
3184+            "1. \"start_height\"    (number, optional) block height where the rescan should start\n"
3185+            "2. \"stop_height\"     (number, optional) block height where the rescan should stop\n"
3186+            "\nResult:\n"
3187+            "{\n"
3188+            "  \"start_height\" :   (number) The block height where the rescan has started\n"

3179+    if (request.fHelp || request.params.size() > 2) {
3180+        throw std::runtime_error(
3181+            "rescanblockchain (\"start_height\") (\"stop_height\")\n"
3182+            "\nRescan the local blockchain for wallet related transactions.\n"
3183+            "\nArguments:\n"
3184+            "1. \"start_height\"    (number, optional) block height where the rescan should start\n"

3180+        throw std::runtime_error(
3181+            "rescanblockchain (\"start_height\") (\"stop_height\")\n"
3182+            "\nRescan the local blockchain for wallet related transactions.\n"
3183+            "\nArguments:\n"
3184+            "1. \"start_height\"    (number, optional) block height where the rescan should start\n"
3185+            "2. \"stop_height\"     (number, optional) block height where the rescan should stop\n"

3224+    }
3225+
3226+    CBlockIndex *stopBlock = nullptr;
3227+    stopBlock = pwallet->ScanForWalletTransactions(pindexStart, pindexStop, true);
3228+    if (!stopBlock) {
3229+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex

 9@@ -10,6 +10,7 @@
10     connect_nodes_bi,
11 )
12 import shutil
13+import os

3221+            }
3222+            block = block->pprev;
3223+        }
3224+    }
3225+
3226+    CBlockIndex *stopBlock = nullptr;

3228+    if (!stopBlock) {
3229+        if (pwallet->IsAbortingRescan()) {
3230+            throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted.");
3231+        }
3232+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex
3233+        stopBlock = pindexStop ?: chainActive.Tip();

3227+    stopBlock = pwallet->ScanForWalletTransactions(pindexStart, pindexStop, true);
3228+    if (!stopBlock) {
3229+        if (pwallet->IsAbortingRescan()) {
3230+            throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted.");
3231+        }
3232+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex

3205+        }
3206+    }
3207+
3208+    if (!request.params[1].isNull()) {
3209+        pindexStop = chainActive[request.params[1].get_int()];
3210+        if (!pindexStop || pindexStop->nHeight < pindexStart->nHeight) {

3215+    // We can't rescan beyond non-pruned blocks, stop and throw an error
3216+    if (fPruneMode) {
3217+        CBlockIndex *block = pindexStop ?: chainActive.Tip();
3218+        while (block && block->nHeight > pindexStart->nHeight) {
3219+            if (!(block->nStatus & BLOCK_HAVE_DATA)) {
3220+                throw JSONRPCError(RPC_MISC_ERROR, "Can't rescan beyond pruned data. Use RPC call getblockchaininfo to determine your pruned height.");

3183+            "\nArguments:\n"
3184+            "1. \"start_height\"    (number, optional) block height where the rescan should start\n"
3185+            "2. \"stop_height\"     (number, optional) block height where the rescan should stop\n"
3186+            "\nResult:\n"
3187+            "{\n"
3188+            "  \"start_height\"     (number) The block height where the rescan has started. If omitted, rescan starts from the genesis block.\n"

3184+            "1. \"start_height\"    (number, optional) block height where the rescan should start\n"
3185+            "2. \"stop_height\"     (number, optional) block height where the rescan should stop\n"
3186+            "\nResult:\n"
3187+            "{\n"
3188+            "  \"start_height\"     (number) The block height where the rescan has started. If omitted, rescan starts from the genesis block.\n"
3189+            "  \"stop_height\"      (number) The height of the last rescanned block. If omitted, rescan stops at the chain tip.\n"

3232+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex
3233+        stopBlock = pindexStop ?: chainActive.Tip();
3234+    }
3235+
3236+    UniValue response(UniValue::VOBJ);
3237+    response.pushKV("start_height", pindexStart->nHeight);

3233+        stopBlock = pindexStop ?: chainActive.Tip();
3234+    }
3235+
3236+    UniValue response(UniValue::VOBJ);
3237+    response.pushKV("start_height", pindexStart->nHeight);
3238+    response.pushKV("stop_height", stopBlock->nHeight);

1554@@ -1555,12 +1555,19 @@ int64_t CWallet::RescanFromTime(int64_t startTime, bool update)
1555  * Returns null if scan was successful. Otherwise, if a complete rescan was not
1556  * possible (due to pruning or corruption), returns pointer to the most recent
1557  * block that could not be scanned.
1558+ *
1559+ * If pindexStop is not a nullptr, the scan will stop one block after the block-index

3233+        }
3234+        // if we got a nullptr returned, ScanForWalletTransactions did rescan up to the requested stopindex
3235+        stopBlock = pindexStop ? pindexStop : chainActive.Tip();
3236+    }
3237+    else {
3238+        throw JSONRPCError(RPC_MISC_ERROR, "Rescan failed. Potentially corruputed data files.");

3187+            "{\n"
3188+            "  \"start_height\"     (number) The block height where the rescan has started. If omitted, rescan started from the genesis block.\n"
3189+            "  \"stop_height\"      (number) The height of the last rescanned block. If omitted, rescan stopped at the chain tip.\n"
3190+            "}\n"
3191+            "\nExamples:\n"
3192+            + HelpExampleCli("rescanblockchain", "\"100000 120000\"")

3188+            "  \"start_height\"     (numeric) The block height where the rescan has started. If omitted, rescan started from the genesis block.\n"
3189+            "  \"stop_height\"      (numeric) The height of the last rescanned block. If omitted, rescan stopped at the chain tip.\n"
3190+            "}\n"
3191+            "\nExamples:\n"
3192+            + HelpExampleCli("rescanblockchain", "100000 120000")
3193+            + HelpExampleRpc("rescanblockchain", "100000 120000")

3308@@ -3233,6 +3309,7 @@ static const CRPCCommand commands[] =
3309     { "wallet",             "walletpassphrasechange",   &walletpassphrasechange,   {"oldpassphrase","newpassphrase"} },
3310     { "wallet",             "walletpassphrase",         &walletpassphrase,         {"passphrase","timeout"} },
3311     { "wallet",             "removeprunedfunds",        &removeprunedfunds,        {"txid"} },
3312+    { "wallet",             "rescanblockchain",         &rescanblockchain,         {"start_height", "stop_height"} },

3216+    }
3217+
3218+    // We can't rescan beyond non-pruned blocks, stop and throw an error
3219+    if (fPruneMode) {
3220+        CBlockIndex *block = pindexStop ? pindexStop : chainActive.Tip();
3221+        while (block && block->nHeight > pindexStart->nHeight) {