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