Skip to content

Commit ca48a46

Browse files
committed
rpc: doc: mention rescan speedup using blockfilterindex=1 in affected wallet RPCs
1 parent 3449880 commit ca48a46

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

src/wallet/rpc/backup.cpp

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1589,7 +1589,8 @@ RPCHelpMan importdescriptors()
15891589
return RPCHelpMan{"importdescriptors",
15901590
"\nImport descriptors. This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported. Requires a new wallet backup.\n"
15911591
"\nNote: This call can take over an hour to complete if using an early timestamp; during that time, other rpc calls\n"
1592-
"may report that the imported keys, addresses or scripts exist but related transactions are still missing.\n",
1592+
"may report that the imported keys, addresses or scripts exist but related transactions are still missing.\n"
1593+
"The rescan is significantly faster if block filters are available (using startup option \"-blockfilterindex=1\").\n",
15931594
{
15941595
{"requests", RPCArg::Type::ARR, RPCArg::Optional::NO, "Data to be imported",
15951596
{
@@ -1887,7 +1888,9 @@ RPCHelpMan restorewallet()
18871888
{
18881889
return RPCHelpMan{
18891890
"restorewallet",
1890-
"\nRestore and loads a wallet from backup.\n",
1891+
"\nRestore and loads a wallet from backup.\n"
1892+
"\nThe rescan is significantly faster if a descriptor wallet is restored"
1893+
"\nand block filters are available (using startup option \"-blockfilterindex=1\").\n",
18911894
{
18921895
{"wallet_name", RPCArg::Type::STR, RPCArg::Optional::NO, "The name that will be applied to the restored wallet"},
18931896
{"backup_file", RPCArg::Type::STR, RPCArg::Optional::NO, "The backup file that will be used to restore the wallet."},

src/wallet/rpc/transactions.cpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -839,7 +839,9 @@ RPCHelpMan rescanblockchain()
839839
{
840840
return RPCHelpMan{"rescanblockchain",
841841
"\nRescan the local blockchain for wallet related transactions.\n"
842-
"Note: Use \"getwalletinfo\" to query the scanning progress.\n",
842+
"Note: Use \"getwalletinfo\" to query the scanning progress.\n"
843+
"The rescan is significantly faster when used on a descriptor wallet\n"
844+
"and block filters are available (using startup option \"-blockfilterindex=1\").\n",
843845
{
844846
{"start_height", RPCArg::Type::NUM, RPCArg::Default{0}, "block height where the rescan should start"},
845847
{"stop_height", RPCArg::Type::NUM, RPCArg::Optional::OMITTED_NAMED_ARG, "the last block height that should be scanned. If none is provided it will rescan up to the tip at return time of this call."},

0 commit comments

Comments
 (0)