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