Branch data Line data Source code
1 : : // Copyright (c) 2009-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <chain.h>
6 : : #include <clientversion.h>
7 : : #include <core_io.h>
8 : : #include <hash.h>
9 : : #include <interfaces/chain.h>
10 : : #include <key_io.h>
11 : : #include <merkleblock.h>
12 : : #include <node/types.h>
13 : : #include <rpc/util.h>
14 : : #include <script/descriptor.h>
15 : : #include <script/script.h>
16 : : #include <script/solver.h>
17 : : #include <sync.h>
18 : : #include <uint256.h>
19 : : #include <util/bip32.h>
20 : : #include <util/fs.h>
21 : : #include <util/time.h>
22 : : #include <util/translation.h>
23 : : #include <wallet/rpc/util.h>
24 : : #include <wallet/wallet.h>
25 : :
26 : : #include <cstdint>
27 : : #include <fstream>
28 : : #include <tuple>
29 : : #include <string>
30 : :
31 : : #include <univalue.h>
32 : :
33 : :
34 : :
35 : : using interfaces::FoundBlock;
36 : :
37 : : namespace wallet {
38 : 836 : RPCHelpMan importprunedfunds()
39 : : {
40 : 836 : return RPCHelpMan{
41 : 836 : "importprunedfunds",
42 [ + - ]: 1672 : "Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.\n",
43 : : {
44 [ + - + - ]: 1672 : {"rawtransaction", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A raw transaction in hex funding an already-existing address in wallet"},
45 [ + - + - ]: 1672 : {"txoutproof", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex output from gettxoutproof that contains the transaction"},
46 : : },
47 [ + - + - : 1672 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
48 [ + - + - ]: 2508 : RPCExamples{""},
49 : 836 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
50 : : {
51 : 7 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
52 [ - + ]: 7 : if (!pwallet) return UniValue::VNULL;
53 : :
54 [ + - ]: 7 : CMutableTransaction tx;
55 [ + - + - : 7 : if (!DecodeHexTx(tx, request.params[0].get_str())) {
+ - + + ]
56 [ + - + - ]: 2 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
57 : : }
58 : :
59 [ + - + - : 12 : DataStream ssMB{ParseHexV(request.params[1], "proof")};
+ - ]
60 [ + - ]: 6 : CMerkleBlock merkleBlock;
61 [ + - ]: 6 : ssMB >> merkleBlock;
62 : :
63 : : //Search partial merkle tree in proof for our transaction and index in valid block
64 : 6 : std::vector<Txid> vMatch;
65 : 6 : std::vector<unsigned int> vIndex;
66 [ + - + + ]: 6 : if (merkleBlock.txn.ExtractMatches(vMatch, vIndex) != merkleBlock.header.hashMerkleRoot) {
67 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Something wrong with merkleblock");
68 : : }
69 : :
70 [ + - ]: 5 : LOCK(pwallet->cs_wallet);
71 : 5 : int height;
72 [ + - + - : 5 : if (!pwallet->chain().findAncestorByHash(pwallet->GetLastBlockHash(), merkleBlock.header.GetHash(), FoundBlock().height(height))) {
+ + ]
73 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found in chain");
74 : : }
75 : :
76 : 4 : std::vector<Txid>::const_iterator it;
77 [ + - + + ]: 4 : if ((it = std::find(vMatch.begin(), vMatch.end(), tx.GetHash())) == vMatch.end()) {
78 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction given doesn't exist in proof");
79 : : }
80 : :
81 [ + - ]: 3 : unsigned int txnIndex = vIndex[it - vMatch.begin()];
82 : :
83 [ + - ]: 3 : CTransactionRef tx_ref = MakeTransactionRef(tx);
84 [ + - + + ]: 3 : if (pwallet->IsMine(*tx_ref)) {
85 [ + - + - ]: 4 : pwallet->AddToWallet(std::move(tx_ref), TxStateConfirmed{merkleBlock.header.GetHash(), height, static_cast<int>(txnIndex)});
86 [ - + ]: 2 : return UniValue::VNULL;
87 : : }
88 : :
89 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "No addresses in wallet correspond to included transaction");
90 [ + - ]: 29 : },
91 [ + - + - : 5016 : };
+ + - - ]
92 [ + - + - : 3344 : }
- - ]
93 : :
94 : 832 : RPCHelpMan removeprunedfunds()
95 : : {
96 : 832 : return RPCHelpMan{
97 : 832 : "removeprunedfunds",
98 [ + - ]: 1664 : "Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.\n",
99 : : {
100 [ + - + - ]: 1664 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex-encoded id of the transaction you are deleting"},
101 : : },
102 [ + - + - : 1664 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
103 : 832 : RPCExamples{
104 [ + - + - : 1664 : HelpExampleCli("removeprunedfunds", "\"a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5\"") +
+ - ]
105 : 832 : "\nAs a JSON-RPC call\n"
106 [ + - + - : 3328 : + HelpExampleRpc("removeprunedfunds", "\"a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5\"")
+ - + - ]
107 [ + - ]: 832 : },
108 : 832 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
109 : : {
110 : 3 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
111 [ - + ]: 3 : if (!pwallet) return UniValue::VNULL;
112 : :
113 [ + - ]: 3 : LOCK(pwallet->cs_wallet);
114 : :
115 [ + - + - ]: 3 : Txid hash{Txid::FromUint256(ParseHashV(request.params[0], "txid"))};
116 : 3 : std::vector<Txid> vHash;
117 [ + - ]: 3 : vHash.push_back(hash);
118 [ + - + + ]: 3 : if (auto res = pwallet->RemoveTxs(vHash); !res) {
119 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, util::ErrorString(res).original);
120 : 1 : }
121 : :
122 : 2 : return UniValue::VNULL;
123 [ + - ]: 8 : },
124 [ + - + - : 4160 : };
+ + - - ]
125 [ + - ]: 1664 : }
126 : :
127 : 717 : static int64_t GetImportTimestamp(const UniValue& data, int64_t now)
128 : : {
129 [ + - ]: 1434 : if (data.exists("timestamp")) {
130 [ + - ]: 717 : const UniValue& timestamp = data["timestamp"];
131 [ + + ]: 717 : if (timestamp.isNum()) {
132 : 210 : return timestamp.getInt<int64_t>();
133 [ + - - + ]: 507 : } else if (timestamp.isStr() && timestamp.get_str() == "now") {
134 : : return now;
135 : : }
136 [ # # # # : 0 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Expected number or \"now\" timestamp value for key. got type %s", uvTypeName(timestamp.type())));
# # ]
137 : : }
138 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Missing required timestamp field for key");
139 : : }
140 : :
141 : 715 : static UniValue ProcessDescriptorImport(CWallet& wallet, const UniValue& data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
142 : : {
143 : 715 : UniValue warnings(UniValue::VARR);
144 : 715 : UniValue result(UniValue::VOBJ);
145 : :
146 : 715 : try {
147 [ + - + + ]: 1430 : if (!data.exists("desc")) {
148 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Descriptor not found.");
149 : : }
150 : :
151 [ + - + - : 714 : const std::string& descriptor = data["desc"].get_str();
+ - ]
152 [ + - + + : 1744 : const bool active = data.exists("active") ? data["active"].get_bool() : false;
+ - + - +
- ]
153 [ + - + - : 715 : const std::string label{LabelFromValue(data["label"])};
+ + ]
154 : :
155 : : // Parse descriptor string
156 : 713 : FlatSigningProvider keys;
157 [ - + ]: 713 : std::string error;
158 [ - + + - ]: 713 : auto parsed_descs = Parse(descriptor, keys, error, /* require_checksum = */ true);
159 [ + + ]: 713 : if (parsed_descs.empty()) {
160 [ + - ]: 8 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
161 : : }
162 : 705 : std::optional<bool> internal;
163 [ + - + + ]: 1410 : if (data.exists("internal")) {
164 [ - + + + ]: 112 : if (parsed_descs.size() > 1) {
165 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Cannot have multipath descriptor while also specifying \'internal\'");
166 : : }
167 [ + - + - : 111 : internal = data["internal"].get_bool();
+ - ]
168 : : }
169 : :
170 : : // Range check
171 : 704 : std::optional<bool> is_ranged;
172 : 704 : int64_t range_start = 0, range_end = 1, next_index = 0;
173 [ + - + - : 966 : if (!parsed_descs.at(0)->IsRange() && data.exists("range")) {
+ + + - +
- + + +
+ ]
174 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should not be specified for an un-ranged descriptor");
175 [ + - + - : 703 : } else if (parsed_descs.at(0)->IsRange()) {
+ + ]
176 [ + - + + ]: 884 : if (data.exists("range")) {
177 [ + - + - : 120 : auto range = ParseDescriptorRange(data["range"]);
+ + ]
178 : 110 : range_start = range.first;
179 : 110 : range_end = range.second + 1; // Specified range end is inclusive, but we need range end as exclusive
180 : : } else {
181 [ + - + - ]: 327 : warnings.push_back("Range not given, using default keypool range");
182 : 327 : range_start = 0;
183 : 327 : range_end = wallet.m_keypool_size;
184 : : }
185 : 437 : next_index = range_start;
186 : 437 : is_ranged = true;
187 : :
188 [ + - + + ]: 874 : if (data.exists("next_index")) {
189 [ + - + - : 71 : next_index = data["next_index"].getInt<int64_t>();
+ - ]
190 : : // bound checks
191 [ - + ]: 71 : if (next_index < range_start || next_index >= range_end) {
192 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "next_index is out of range");
193 : : }
194 : : }
195 : : }
196 : :
197 : : // Active descriptors must be ranged
198 [ + + + - : 995 : if (active && !parsed_descs.at(0)->IsRange()) {
+ + ]
199 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Active descriptors must be ranged");
200 : : }
201 : :
202 : : // Multipath descriptors should not have a label
203 [ - + + + : 751 : if (parsed_descs.size() > 1 && data.exists("label")) {
+ - + - +
+ + + ]
204 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Multipath descriptors should not have a label");
205 : : }
206 : :
207 : : // Ranged descriptors should not have a label
208 [ + + + - : 1132 : if (is_ranged.has_value() && is_ranged.value() && data.exists("label")) {
+ - + - +
+ + + ]
209 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Ranged descriptors should not have a label");
210 : : }
211 : :
212 [ + + + + : 787 : bool desc_internal = internal.has_value() && internal.value();
+ + ]
213 : : // Internal addresses should not have a label either
214 [ + - + - : 787 : if (desc_internal && data.exists("label")) {
+ + + + ]
215 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Internal addresses should not have a label");
216 : : }
217 : :
218 : : // Combo descriptor check
219 [ + + + - : 987 : if (active && !parsed_descs.at(0)->IsSingleType()) {
+ + ]
220 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, "Combo descriptors cannot be set to active");
221 : : }
222 : :
223 : : // If the wallet disabled private keys, abort if private keys exist
224 [ + - + + : 692 : if (wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && !keys.keys.empty()) {
+ + ]
225 [ + - + - ]: 6 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import private keys to a wallet with private keys disabled");
226 : : }
227 : :
228 [ - + + + ]: 1427 : for (size_t j = 0; j < parsed_descs.size(); ++j) {
229 [ - + ]: 745 : auto parsed_desc = std::move(parsed_descs[j]);
230 [ - + + + ]: 745 : if (parsed_descs.size() == 2) {
231 : 100 : desc_internal = j == 1;
232 [ + + ]: 645 : } else if (parsed_descs.size() > 2) {
233 [ + - ]: 9 : CHECK_NONFATAL(!desc_internal);
234 : : }
235 : : // Need to ExpandPrivate to check if private keys are available for all pubkeys
236 : 745 : FlatSigningProvider expand_keys;
237 : 745 : std::vector<CScript> scripts;
238 [ + - + + ]: 745 : if (!parsed_desc->Expand(0, keys, scripts, expand_keys)) {
239 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot expand descriptor. Probably because of hardened derivations without private keys provided");
240 : : }
241 [ + - ]: 744 : parsed_desc->ExpandPrivate(0, keys, expand_keys);
242 : :
243 [ + - + + ]: 746 : for (const auto& w : parsed_desc->Warnings()) {
244 [ + - + - ]: 2 : warnings.push_back(w);
245 : 744 : }
246 : :
247 : : // Check if all private keys are provided
248 : 744 : bool have_all_privkeys = !expand_keys.keys.empty();
249 [ + + ]: 1195 : for (const auto& entry : expand_keys.origins) {
250 : 825 : const CKeyID& key_id = entry.first;
251 : 825 : CKey key;
252 [ + - + + ]: 825 : if (!expand_keys.GetKey(key_id, key)) {
253 : 374 : have_all_privkeys = false;
254 : 374 : break;
255 : : }
256 : 825 : }
257 : :
258 : : // If private keys are enabled, check some things.
259 [ + - + + ]: 744 : if (!wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
260 [ + + ]: 554 : if (keys.keys.empty()) {
261 [ + - + - ]: 6 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import descriptor without private keys to a wallet with private keys enabled");
262 : : }
263 [ + + ]: 551 : if (!have_all_privkeys) {
264 [ + - + - ]: 192 : warnings.push_back("Not all private keys provided. Some wallet functionality may return unexpected errors");
265 : : }
266 : : }
267 : :
268 [ + - + - ]: 741 : WalletDescriptor w_desc(std::move(parsed_desc), timestamp, range_start, range_end, next_index);
269 : :
270 : : // Add descriptor to the wallet
271 [ + - ]: 741 : auto spk_manager_res = wallet.AddWalletDescriptor(w_desc, keys, label, desc_internal);
272 : :
273 [ + + ]: 741 : if (!spk_manager_res) {
274 [ + - + - : 9 : throw JSONRPCError(RPC_WALLET_ERROR, strprintf("Could not add descriptor '%s': %s", descriptor, util::ErrorString(spk_manager_res).original));
+ - ]
275 : : }
276 : :
277 [ + + ]: 738 : auto& spk_manager = spk_manager_res.value().get();
278 : :
279 : : // Set descriptor as active if necessary
280 [ + + ]: 738 : if (active) {
281 [ + - + + ]: 346 : if (!w_desc.descriptor->GetOutputType()) {
282 [ + - + - ]: 1 : warnings.push_back("Unknown output type, cannot set descriptor to active.");
283 : : } else {
284 [ + - + - : 345 : wallet.AddActiveScriptPubKeyMan(spk_manager.GetID(), *w_desc.descriptor->GetOutputType(), desc_internal);
+ - ]
285 : : }
286 : : } else {
287 [ + - + + ]: 392 : if (w_desc.descriptor->GetOutputType()) {
288 [ + - + - : 218 : wallet.DeactivateScriptPubKeyMan(spk_manager.GetID(), *w_desc.descriptor->GetOutputType(), desc_internal);
+ - ]
289 : : }
290 : : }
291 : 762 : }
292 : :
293 [ + - + - : 1364 : result.pushKV("success", UniValue(true));
+ - ]
294 [ - + ]: 777 : } catch (const UniValue& e) {
295 [ + - + - : 66 : result.pushKV("success", UniValue(false));
+ - ]
296 [ + - + - : 66 : result.pushKV("error", e);
+ - ]
297 : 33 : }
298 [ + - ]: 715 : PushWarnings(warnings, result);
299 : 715 : return result;
300 : 715 : }
301 : :
302 : 1463 : RPCHelpMan importdescriptors()
303 : : {
304 : 1463 : return RPCHelpMan{
305 : 1463 : "importdescriptors",
306 [ + - ]: 2926 : "Import 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"
307 : : "When importing descriptors with multipath key expressions, if the multipath specifier contains exactly two elements, the descriptor produced from the second element will be imported as an internal descriptor.\n"
308 : : "\nNote: This call can take over an hour to complete if using an early timestamp; during that time, other rpc calls\n"
309 : : "may report that the imported keys, addresses or scripts exist but related transactions are still missing.\n"
310 : : "The rescan is significantly faster if block filters are available (using startup option \"-blockfilterindex=1\").\n",
311 : : {
312 [ + - + - ]: 2926 : {"requests", RPCArg::Type::ARR, RPCArg::Optional::NO, "Data to be imported",
313 : : {
314 [ + - + - ]: 2926 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
315 : : {
316 [ + - + - ]: 2926 : {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "Descriptor to import."},
317 [ + - + - : 4389 : {"active", RPCArg::Type::BOOL, RPCArg::Default{false}, "Set this descriptor to be the active descriptor for the corresponding output type/externality"},
+ - ]
318 [ + - + - ]: 2926 : {"range", RPCArg::Type::RANGE, RPCArg::Optional::OMITTED, "If a ranged descriptor is used, this specifies the end or the range (in the form [begin,end]) to import"},
319 [ + - + - ]: 2926 : {"next_index", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "If a ranged descriptor is set to active, this specifies the next index to generate addresses from"},
320 [ + - + - ]: 2926 : {"timestamp", RPCArg::Type::NUM, RPCArg::Optional::NO, "Time from which to start rescanning the blockchain for this descriptor, in " + UNIX_EPOCH_TIME + "\n"
321 : : "Use the string \"now\" to substitute the current synced blockchain time.\n"
322 : : "\"now\" can be specified to bypass scanning, for outputs which are known to never have been used, and\n"
323 : : "0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest timestamp\n"
324 : 1463 : "of all descriptors being imported will be scanned as well as the mempool.",
325 [ + - ]: 2926 : RPCArgOptions{.type_str={"timestamp | \"now\"", "integer / string"}}
326 : : },
327 [ + - + - : 4389 : {"internal", RPCArg::Type::BOOL, RPCArg::Default{false}, "Whether matching outputs should be treated as not incoming payments (e.g. change)"},
+ - ]
328 [ + - + - : 4389 : {"label", RPCArg::Type::STR, RPCArg::Default{""}, "Label to assign to the address, only allowed with internal=false. Disabled for ranged descriptors"},
+ - ]
329 : : },
330 : : },
331 : : },
332 [ + - ]: 1463 : RPCArgOptions{.oneline_description="requests"}},
333 : : },
334 [ + - ]: 2926 : RPCResult{
335 [ + - + - ]: 2926 : RPCResult::Type::ARR, "", "Response is an array with the same size as the input that has the execution result",
336 : : {
337 [ + - + - ]: 2926 : {RPCResult::Type::OBJ, "", "",
338 : : {
339 [ + - + - ]: 2926 : {RPCResult::Type::BOOL, "success", ""},
340 [ + - + - ]: 2926 : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "",
341 : : {
342 [ + - + - ]: 2926 : {RPCResult::Type::STR, "", ""},
343 : : }},
344 [ + - + - ]: 2926 : {RPCResult::Type::OBJ, "error", /*optional=*/true, "",
345 : : {
346 [ + - + - ]: 2926 : {RPCResult::Type::ELISION, "", "JSONRPC error"},
347 : : }},
348 : : }},
349 : : }
350 [ + - + - : 19019 : },
+ - + - +
- + + + +
+ + + + -
- - - - -
- - ]
351 : 1463 : RPCExamples{
352 [ + - + - : 2926 : HelpExampleCli("importdescriptors", "'[{ \"desc\": \"<my descriptor>\", \"timestamp\":1455191478, \"internal\": true }, "
+ - ]
353 : 1463 : "{ \"desc\": \"<my descriptor 2>\", \"label\": \"example 2\", \"timestamp\": 1455191480 }]'") +
354 [ + - + - : 4389 : HelpExampleCli("importdescriptors", "'[{ \"desc\": \"<my descriptor>\", \"timestamp\":1455191478, \"active\": true, \"range\": [0,100], \"label\": \"<my bech32 wallet>\" }]'")
+ - + - ]
355 [ + - ]: 1463 : },
356 : 1463 : [&](const RPCHelpMan& self, const JSONRPCRequest& main_request) -> UniValue
357 : : {
358 : 634 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(main_request);
359 [ - + ]: 634 : if (!pwallet) return UniValue::VNULL;
360 [ + - ]: 634 : CWallet& wallet{*pwallet};
361 : :
362 : : // Make sure the results are valid at least up to the most recent block
363 : : // the user could have gotten from another RPC command prior to now
364 [ + - ]: 634 : wallet.BlockUntilSyncedToCurrentChain();
365 : :
366 : 634 : WalletRescanReserver reserver(*pwallet);
367 [ - + ]: 634 : if (!reserver.reserve(/*with_passphrase=*/true)) {
368 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
369 : : }
370 : :
371 : : // Ensure that the wallet is not locked for the remainder of this RPC, as
372 : : // the passphrase is used to top up the keypool.
373 [ + - ]: 634 : LOCK(pwallet->m_relock_mutex);
374 : :
375 [ + - ]: 634 : const UniValue& requests = main_request.params[0];
376 : 634 : const int64_t minimum_timestamp = 1;
377 : 634 : int64_t now = 0;
378 : 634 : int64_t lowest_timestamp = 0;
379 : 634 : bool rescan = false;
380 : 634 : UniValue response(UniValue::VARR);
381 : 634 : {
382 [ + - ]: 634 : LOCK(pwallet->cs_wallet);
383 [ + - ]: 634 : EnsureWalletIsUnlocked(*pwallet);
384 : :
385 [ + - + - ]: 634 : CHECK_NONFATAL(pwallet->chain().findBlock(pwallet->GetLastBlockHash(), FoundBlock().time(lowest_timestamp).mtpTime(now)));
386 : :
387 : : // Get all timestamps and extract the lowest timestamp
388 [ + - + + ]: 1349 : for (const UniValue& request : requests.getValues()) {
389 : : // This throws an error if "timestamp" doesn't exist
390 [ + - + + ]: 715 : const int64_t timestamp = std::max(GetImportTimestamp(request, now), minimum_timestamp);
391 [ + - ]: 715 : const UniValue result = ProcessDescriptorImport(*pwallet, request, timestamp);
392 [ + - + - ]: 715 : response.push_back(result);
393 : :
394 [ + + ]: 715 : if (lowest_timestamp > timestamp ) {
395 : 491 : lowest_timestamp = timestamp;
396 : : }
397 : :
398 : : // If we know the chain tip, and at least one request was successful then allow rescan
399 [ + + + - : 1350 : if (!rescan && result["success"].get_bool()) {
+ - + - +
+ + + -
- ]
400 : 602 : rescan = true;
401 : : }
402 : 715 : }
403 [ + - ]: 634 : pwallet->ConnectScriptPubKeyManNotifiers();
404 [ + - ]: 634 : pwallet->RefreshAllTXOs();
405 : 0 : }
406 : :
407 : : // Rescan the blockchain using the lowest timestamp
408 [ + + ]: 634 : if (rescan) {
409 [ + - ]: 602 : int64_t scanned_time = pwallet->RescanFromTime(lowest_timestamp, reserver, /*update=*/true);
410 [ + - ]: 602 : pwallet->ResubmitWalletTransactions(node::TxBroadcast::MEMPOOL_NO_BROADCAST, /*force=*/true);
411 : :
412 [ - + ]: 602 : if (pwallet->IsAbortingRescan()) {
413 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted by user.");
414 : : }
415 : :
416 [ + + ]: 602 : if (scanned_time > lowest_timestamp) {
417 [ + - + - ]: 1 : std::vector<UniValue> results = response.getValues();
418 [ + - ]: 1 : response.clear();
419 [ + - ]: 1 : response.setArray();
420 : :
421 : : // Compose the response
422 [ - + + + ]: 2 : for (unsigned int i = 0; i < requests.size(); ++i) {
423 [ + - + - ]: 1 : const UniValue& request = requests.getValues().at(i);
424 : :
425 : : // If the descriptor timestamp is within the successfully scanned
426 : : // range, or if the import result already has an error set, let
427 : : // the result stand unmodified. Otherwise replace the result
428 : : // with an error message.
429 [ + - + - : 2 : if (scanned_time <= GetImportTimestamp(request, now) || results.at(i).exists("error")) {
+ - + - +
- + - - +
- - ]
430 [ # # # # : 0 : response.push_back(results.at(i));
# # ]
431 : : } else {
432 : 1 : std::string error_msg{strprintf("Rescan failed for descriptor with timestamp %d. There "
433 : : "was an error reading a block from time %d, which is after or within %d seconds "
434 : : "of key creation, and could contain transactions pertaining to the desc. As a "
435 : : "result, transactions and coins using this desc may not appear in the wallet.",
436 [ + - + - ]: 1 : GetImportTimestamp(request, now), scanned_time - TIMESTAMP_WINDOW - 1, TIMESTAMP_WINDOW)};
437 [ + - - + ]: 1 : if (pwallet->chain().havePruned()) {
438 [ # # ]: 0 : error_msg += strprintf(" This error could be caused by pruning or data corruption "
439 : : "(see bitcoind log for details) and could be dealt with by downloading and "
440 : 0 : "rescanning the relevant blocks (see -reindex option and rescanblockchain RPC).");
441 [ + - + - ]: 1 : } else if (pwallet->chain().hasAssumedValidChain()) {
442 [ + - ]: 2 : error_msg += strprintf(" This error is likely caused by an in-progress assumeutxo "
443 : : "background sync. Check logs or getchainstates RPC for assumeutxo background "
444 : 1 : "sync progress and try again later.");
445 : : } else {
446 [ # # ]: 0 : error_msg += strprintf(" This error could potentially caused by data corruption. If "
447 : 0 : "the issue persists you may want to reindex (see -reindex option).");
448 : : }
449 : :
450 : 1 : UniValue result = UniValue(UniValue::VOBJ);
451 [ + - + - : 2 : result.pushKV("success", UniValue(false));
+ - ]
452 [ + - + - : 2 : result.pushKV("error", JSONRPCError(RPC_MISC_ERROR, error_msg));
+ - ]
453 [ + - ]: 1 : response.push_back(std::move(result));
454 : 1 : }
455 : : }
456 : 1 : }
457 : : }
458 : :
459 : 634 : return response;
460 [ + - ]: 1902 : },
461 [ + - + - : 24871 : };
+ - + - +
+ + + + +
- - - - -
- ]
462 [ + - + - : 32186 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- - - -
- ]
463 : :
464 : 993 : RPCHelpMan listdescriptors()
465 : : {
466 : 993 : return RPCHelpMan{
467 : 993 : "listdescriptors",
468 [ + - ]: 1986 : "List all descriptors present in a wallet.\n",
469 : : {
470 [ + - + - : 2979 : {"private", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show private descriptors."}
+ - ]
471 : : },
472 [ + - + - : 3972 : RPCResult{RPCResult::Type::OBJ, "", "", {
+ - ]
473 [ + - + - ]: 1986 : {RPCResult::Type::STR, "wallet_name", "Name of wallet this operation was performed on"},
474 [ + - + - ]: 1986 : {RPCResult::Type::ARR, "descriptors", "Array of descriptor objects (sorted by descriptor string representation)",
475 : : {
476 [ + - + - ]: 1986 : {RPCResult::Type::OBJ, "", "", {
477 [ + - + - ]: 1986 : {RPCResult::Type::STR, "desc", "Descriptor string representation"},
478 [ + - + - ]: 1986 : {RPCResult::Type::NUM, "timestamp", "The creation time of the descriptor"},
479 [ + - + - ]: 1986 : {RPCResult::Type::BOOL, "active", "Whether this descriptor is currently used to generate new addresses"},
480 [ + - + - ]: 1986 : {RPCResult::Type::BOOL, "internal", /*optional=*/true, "True if this descriptor is used to generate change addresses. False if this descriptor is used to generate receiving addresses; defined only for active descriptors"},
481 [ + - + - ]: 1986 : {RPCResult::Type::ARR_FIXED, "range", /*optional=*/true, "Defined only for ranged descriptors", {
482 [ + - + - ]: 1986 : {RPCResult::Type::NUM, "", "Range start inclusive"},
483 [ + - + - ]: 1986 : {RPCResult::Type::NUM, "", "Range end inclusive"},
484 : : }},
485 [ + - + - ]: 1986 : {RPCResult::Type::NUM, "next", /*optional=*/true, "Same as next_index field. Kept for compatibility reason."},
486 [ + - + - ]: 1986 : {RPCResult::Type::NUM, "next_index", /*optional=*/true, "The next index to generate addresses from; defined only for ranged descriptors"},
487 : : }},
488 : : }}
489 [ + - + - : 24825 : }},
+ - + - +
- + + + +
+ + + + -
- - - - -
- - ]
490 : 993 : RPCExamples{
491 [ + - + - : 1986 : HelpExampleCli("listdescriptors", "") + HelpExampleRpc("listdescriptors", "")
+ - + - +
- + - +
- ]
492 [ + - + - : 3972 : + HelpExampleCli("listdescriptors", "true") + HelpExampleRpc("listdescriptors", "true")
+ - + - +
- + - + -
+ - ]
493 [ + - ]: 993 : },
494 : 993 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
495 : : {
496 [ - + ]: 164 : const std::shared_ptr<const CWallet> wallet = GetWalletForJSONRPCRequest(request);
497 [ - + ]: 163 : if (!wallet) return UniValue::VNULL;
498 : :
499 [ + - + + : 163 : const bool priv = !request.params[0].isNull() && request.params[0].get_bool();
+ - + - +
+ ]
500 : 68 : if (priv) {
501 [ + + ]: 68 : EnsureWalletIsUnlocked(*wallet);
502 : : }
503 : :
504 [ + - ]: 162 : LOCK(wallet->cs_wallet);
505 : :
506 [ + - ]: 162 : const auto active_spk_mans = wallet->GetActiveScriptPubKeyMans();
507 : :
508 [ - - ]: 3322 : struct WalletDescInfo {
509 : : std::string descriptor;
510 : : uint64_t creation_time;
511 : : bool active;
512 : : std::optional<bool> internal;
513 : : std::optional<std::pair<int64_t,int64_t>> range;
514 : : int64_t next_index;
515 : : };
516 : :
517 : 162 : std::vector<WalletDescInfo> wallet_descriptors;
518 [ + - + + ]: 1346 : for (const auto& spk_man : wallet->GetAllScriptPubKeyMans()) {
519 [ + - ]: 1185 : const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man);
520 [ - + ]: 1185 : if (!desc_spk_man) {
521 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Unexpected ScriptPubKey manager type.");
522 : : }
523 [ + - ]: 1185 : LOCK(desc_spk_man->cs_desc_man);
524 [ + - ]: 1185 : const auto& wallet_descriptor = desc_spk_man->GetWalletDescriptor();
525 [ + - ]: 1185 : std::string descriptor;
526 [ + - + + ]: 1185 : if (!desc_spk_man->GetDescriptorString(descriptor, priv)) {
527 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, "Can't get descriptor string.");
528 : : }
529 [ + - ]: 1184 : const bool is_range = wallet_descriptor.descriptor->IsRange();
530 [ - + ]: 2368 : wallet_descriptors.push_back({
531 : : descriptor,
532 : 1184 : wallet_descriptor.creation_time,
533 : 1184 : active_spk_mans.contains(desc_spk_man),
534 [ + - ]: 1184 : wallet->IsInternalScriptPubKeyMan(desc_spk_man),
535 [ + + ]: 1184 : is_range ? std::optional(std::make_pair(wallet_descriptor.range_start, wallet_descriptor.range_end)) : std::nullopt,
536 : 1184 : wallet_descriptor.next_index
537 : : });
538 [ + - ]: 2371 : }
539 : :
540 : 161 : std::sort(wallet_descriptors.begin(), wallet_descriptors.end(), [](const auto& a, const auto& b) {
541 [ - - - - : 3116 : return a.descriptor < b.descriptor;
+ + - - -
- - - - -
- - - - -
- - - +
+ ]
542 : : });
543 : :
544 : 161 : UniValue descriptors(UniValue::VARR);
545 [ + + ]: 1345 : for (const WalletDescInfo& info : wallet_descriptors) {
546 : 1184 : UniValue spk(UniValue::VOBJ);
547 [ + - + - : 2368 : spk.pushKV("desc", info.descriptor);
+ - ]
548 [ + - + - : 2368 : spk.pushKV("timestamp", info.creation_time);
+ - ]
549 [ + - + - : 2368 : spk.pushKV("active", info.active);
+ - ]
550 [ + + ]: 1184 : if (info.internal.has_value()) {
551 [ + - + - : 2274 : spk.pushKV("internal", info.internal.value());
+ - ]
552 : : }
553 [ + + ]: 1184 : if (info.range.has_value()) {
554 : 1153 : UniValue range(UniValue::VARR);
555 [ + - + - ]: 1153 : range.push_back(info.range->first);
556 [ + - + - ]: 1153 : range.push_back(info.range->second - 1);
557 [ + - + - ]: 2306 : spk.pushKV("range", std::move(range));
558 [ + - + - : 2306 : spk.pushKV("next", info.next_index);
+ - ]
559 [ + - + - : 2306 : spk.pushKV("next_index", info.next_index);
+ - ]
560 : 1153 : }
561 [ + - ]: 1184 : descriptors.push_back(std::move(spk));
562 : 1184 : }
563 : :
564 : 161 : UniValue response(UniValue::VOBJ);
565 [ + - + - : 322 : response.pushKV("wallet_name", wallet->GetName());
+ - ]
566 [ + - + - ]: 322 : response.pushKV("descriptors", std::move(descriptors));
567 : :
568 : 161 : return response;
569 [ + - + - : 2854 : },
+ - ]
570 [ + - + - : 4965 : };
+ + - - ]
571 [ + - + - : 13902 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - - - -
- - - ]
572 : :
573 : 896 : RPCHelpMan backupwallet()
574 : : {
575 : 896 : return RPCHelpMan{
576 : 896 : "backupwallet",
577 [ + - ]: 1792 : "Safely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.\n",
578 : : {
579 [ + - + - ]: 1792 : {"destination", RPCArg::Type::STR, RPCArg::Optional::NO, "The destination directory or file"},
580 : : },
581 [ + - + - : 1792 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - + - ]
582 : 896 : RPCExamples{
583 [ + - + - : 1792 : HelpExampleCli("backupwallet", "\"backup.dat\"")
+ - ]
584 [ + - + - : 3584 : + HelpExampleRpc("backupwallet", "\"backup.dat\"")
+ - + - ]
585 [ + - ]: 896 : },
586 : 896 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
587 : : {
588 [ - + ]: 67 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
589 [ - + ]: 67 : if (!pwallet) return UniValue::VNULL;
590 : :
591 : : // Make sure the results are valid at least up to the most recent block
592 : : // the user could have gotten from another RPC command prior to now
593 [ + - ]: 67 : pwallet->BlockUntilSyncedToCurrentChain();
594 : :
595 [ + - ]: 67 : LOCK(pwallet->cs_wallet);
596 : :
597 [ + - + - : 67 : std::string strDest = request.params[0].get_str();
- + ]
598 [ + - + + ]: 67 : if (!pwallet->BackupWallet(strDest)) {
599 [ + - + - ]: 8 : throw JSONRPCError(RPC_WALLET_ERROR, "Error: Wallet backup failed!");
600 : : }
601 : :
602 : 63 : return UniValue::VNULL;
603 [ + - ]: 197 : },
604 [ + - + - : 4480 : };
+ + - - ]
605 [ + - ]: 1792 : }
606 : :
607 : :
608 : 865 : RPCHelpMan restorewallet()
609 : : {
610 : 865 : return RPCHelpMan{
611 : 865 : "restorewallet",
612 [ + - ]: 1730 : "Restores and loads a wallet from backup.\n"
613 : : "\nThe rescan is significantly faster if block filters are available"
614 : : "\n(using startup option \"-blockfilterindex=1\").\n",
615 : : {
616 [ + - + - ]: 1730 : {"wallet_name", RPCArg::Type::STR, RPCArg::Optional::NO, "The name that will be applied to the restored wallet"},
617 [ + - + - ]: 1730 : {"backup_file", RPCArg::Type::STR, RPCArg::Optional::NO, "The backup file that will be used to restore the wallet."},
618 [ + - + - ]: 1730 : {"load_on_startup", RPCArg::Type::BOOL, RPCArg::Optional::OMITTED, "Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged."},
619 : : },
620 [ + - ]: 1730 : RPCResult{
621 [ + - + - ]: 1730 : RPCResult::Type::OBJ, "", "",
622 : : {
623 [ + - + - ]: 1730 : {RPCResult::Type::STR, "name", "The wallet name if restored successfully."},
624 [ + - + - ]: 1730 : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to restoring and loading the wallet.",
625 : : {
626 [ + - + - ]: 1730 : {RPCResult::Type::STR, "", ""},
627 : : }},
628 : : }
629 [ + - + - : 6055 : },
+ - + + +
+ - - -
- ]
630 : 865 : RPCExamples{
631 [ + - + - : 1730 : HelpExampleCli("restorewallet", "\"testwallet\" \"home\\backups\\backup-file.bak\"")
+ - ]
632 [ + - + - : 3460 : + HelpExampleRpc("restorewallet", "\"testwallet\" \"home\\backups\\backup-file.bak\"")
+ - + - ]
633 [ + - + - : 6055 : + HelpExampleCliNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak\""}, {"load_on_startup", true}})
+ - + - +
+ - - ]
634 [ + - + - : 6055 : + HelpExampleRpcNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak\""}, {"load_on_startup", true}})
+ - + - +
+ - - ]
635 [ + - ]: 865 : },
636 : 865 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
637 : : {
638 : :
639 : 36 : WalletContext& context = EnsureWalletContext(request.context);
640 : :
641 [ - + ]: 36 : auto backup_file = fs::u8path(request.params[1].get_str());
642 : :
643 [ + - + - : 36 : std::string wallet_name = request.params[0].get_str();
- + ]
644 : :
645 [ + - + - : 36 : std::optional<bool> load_on_start = request.params[2].isNull() ? std::nullopt : std::optional<bool>(request.params[2].get_bool());
- - - - ]
646 : :
647 : 36 : DatabaseStatus status;
648 [ + - ]: 36 : bilingual_str error;
649 : 36 : std::vector<bilingual_str> warnings;
650 : :
651 [ + - ]: 36 : const std::shared_ptr<CWallet> wallet = RestoreWallet(context, backup_file, wallet_name, load_on_start, status, error, warnings);
652 : :
653 [ + + + + ]: 72 : HandleWalletError(wallet, status, error);
654 : :
655 : 20 : UniValue obj(UniValue::VOBJ);
656 [ + - + - : 40 : obj.pushKV("name", wallet->GetName());
+ - ]
657 [ + - ]: 20 : PushWarnings(warnings, obj);
658 : :
659 [ + - ]: 20 : return obj;
660 : :
661 : 108 : },
662 [ + - + - : 6055 : };
+ + - - ]
663 [ + - + - : 9515 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
- - - - -
- - - ]
664 : : } // namespace wallet
|
