Branch data Line data Source code
1 : : // Copyright (c) 2009-2022 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 <bitcoin-build-config.h> // IWYU pragma: keep
6 : :
7 : : #include <chain.h>
8 : : #include <clientversion.h>
9 : : #include <core_io.h>
10 : : #include <hash.h>
11 : : #include <interfaces/chain.h>
12 : : #include <key_io.h>
13 : : #include <merkleblock.h>
14 : : #include <rpc/util.h>
15 : : #include <script/descriptor.h>
16 : : #include <script/script.h>
17 : : #include <script/solver.h>
18 : : #include <sync.h>
19 : : #include <uint256.h>
20 : : #include <util/bip32.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 : : using util::SplitString;
38 : :
39 : : namespace wallet {
40 : 0 : std::string static EncodeDumpString(const std::string &str) {
41 : 0 : std::stringstream ret;
42 [ # # ]: 0 : for (const unsigned char c : str) {
43 [ # # ]: 0 : if (c <= 32 || c >= 128 || c == '%') {
44 [ # # # # ]: 0 : ret << '%' << HexStr({&c, 1});
45 : : } else {
46 [ # # ]: 0 : ret << c;
47 : : }
48 : : }
49 [ # # ]: 0 : return ret.str();
50 : 0 : }
51 : :
52 : 0 : static std::string DecodeDumpString(const std::string &str) {
53 : 0 : std::stringstream ret;
54 [ # # ]: 0 : for (unsigned int pos = 0; pos < str.length(); pos++) {
55 [ # # ]: 0 : unsigned char c = str[pos];
56 [ # # # # ]: 0 : if (c == '%' && pos+2 < str.length()) {
57 : 0 : c = (((str[pos+1]>>6)*9+((str[pos+1]-'0')&15)) << 4) |
58 : 0 : ((str[pos+2]>>6)*9+((str[pos+2]-'0')&15));
59 : 0 : pos += 2;
60 : : }
61 [ # # ]: 0 : ret << c;
62 : : }
63 [ # # ]: 0 : return ret.str();
64 : 0 : }
65 : :
66 : 0 : static bool GetWalletAddressesForKey(const LegacyScriptPubKeyMan* spk_man, const CWallet& wallet, const CKeyID& keyid, std::string& strAddr, std::string& strLabel) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
67 : : {
68 : 0 : bool fLabelFound = false;
69 : 0 : CKey key;
70 [ # # ]: 0 : spk_man->GetKey(keyid, key);
71 [ # # # # : 0 : for (const auto& dest : GetAllDestinationsForKey(key.GetPubKey())) {
# # ]
72 [ # # ]: 0 : const auto* address_book_entry = wallet.FindAddressBookEntry(dest);
73 [ # # ]: 0 : if (address_book_entry) {
74 [ # # ]: 0 : if (!strAddr.empty()) {
75 [ # # ]: 0 : strAddr += ",";
76 : : }
77 [ # # ]: 0 : strAddr += EncodeDestination(dest);
78 [ # # # # ]: 0 : strLabel = EncodeDumpString(address_book_entry->GetLabel());
79 : 0 : fLabelFound = true;
80 : : }
81 : 0 : }
82 [ # # ]: 0 : if (!fLabelFound) {
83 [ # # # # : 0 : strAddr = EncodeDestination(GetDestinationForKey(key.GetPubKey(), wallet.m_default_address_type));
# # ]
84 : : }
85 : 0 : return fLabelFound;
86 : 0 : }
87 : :
88 : : static const int64_t TIMESTAMP_MIN = 0;
89 : :
90 : 0 : static void RescanWallet(CWallet& wallet, const WalletRescanReserver& reserver, int64_t time_begin = TIMESTAMP_MIN, bool update = true)
91 : : {
92 : 0 : int64_t scanned_time = wallet.RescanFromTime(time_begin, reserver, update);
93 [ # # ]: 0 : if (wallet.IsAbortingRescan()) {
94 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted by user.");
95 [ # # ]: 0 : } else if (scanned_time > time_begin) {
96 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Rescan was unable to fully rescan the blockchain. Some transactions may be missing.");
97 : : }
98 : 0 : }
99 : :
100 : 0 : static void EnsureBlockDataFromTime(const CWallet& wallet, int64_t timestamp)
101 : : {
102 : 0 : auto& chain{wallet.chain()};
103 [ # # ]: 0 : if (!chain.havePruned()) {
104 : : return;
105 : : }
106 : :
107 : 0 : int height{0};
108 : 0 : const bool found{chain.findFirstBlockWithTimeAndHeight(timestamp - TIMESTAMP_WINDOW, 0, FoundBlock().height(height))};
109 : :
110 [ # # ]: 0 : uint256 tip_hash{WITH_LOCK(wallet.cs_wallet, return wallet.GetLastBlockHash())};
111 [ # # # # ]: 0 : if (found && !chain.hasBlocks(tip_hash, height)) {
112 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, strprintf("Pruned blocks from height %d required to import keys. Use RPC call getblockchaininfo to determine your pruned height.", height));
113 : : }
114 : : }
115 : :
116 : 0 : RPCHelpMan importprivkey()
117 : : {
118 : 0 : return RPCHelpMan{"importprivkey",
119 : : "\nAdds a private key (as returned by dumpprivkey) to your wallet. Requires a new wallet backup.\n"
120 : : "Hint: use importmulti to import more than one private key.\n"
121 : : "\nNote: This call can take over an hour to complete if rescan is true, during that time, other rpc calls\n"
122 : : "may report that the imported key exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes.\n"
123 : : "The rescan parameter can be set to false if the key was never used to create transactions. If it is set to false,\n"
124 : : "but the key was used to create transactions, rescanblockchain needs to be called with the appropriate block range.\n"
125 : : "Note: Use \"getwalletinfo\" to query the scanning progress.\n"
126 : : "Note: This command is only compatible with legacy wallets. Use \"importdescriptors\" with \"combo(X)\" for descriptor wallets.\n",
127 : : {
128 [ # # ]: 0 : {"privkey", RPCArg::Type::STR, RPCArg::Optional::NO, "The private key (see dumpprivkey)"},
129 [ # # ]: 0 : {"label", RPCArg::Type::STR, RPCArg::DefaultHint{"current label if address exists, otherwise \"\""}, "An optional label"},
130 [ # # ]: 0 : {"rescan", RPCArg::Type::BOOL, RPCArg::Default{true}, "Scan the chain and mempool for wallet transactions."},
131 : : },
132 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
133 : 0 : RPCExamples{
134 : : "\nDump a private key\n"
135 [ # # # # : 0 : + HelpExampleCli("dumpprivkey", "\"myaddress\"") +
# # # # ]
136 : 0 : "\nImport the private key with rescan\n"
137 [ # # # # : 0 : + HelpExampleCli("importprivkey", "\"mykey\"") +
# # # # ]
138 : 0 : "\nImport using a label and without rescan\n"
139 [ # # # # : 0 : + HelpExampleCli("importprivkey", "\"mykey\" \"testing\" false") +
# # # # ]
140 : 0 : "\nImport using default blank label and without rescan\n"
141 [ # # # # : 0 : + HelpExampleCli("importprivkey", "\"mykey\" \"\" false") +
# # # # ]
142 : 0 : "\nAs a JSON-RPC call\n"
143 [ # # # # : 0 : + HelpExampleRpc("importprivkey", "\"mykey\", \"testing\", false")
# # # # ]
144 [ # # ]: 0 : },
145 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
146 : : {
147 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
148 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
149 : :
150 [ # # # # ]: 0 : if (pwallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
151 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import private keys to a wallet with private keys disabled");
152 : : }
153 : :
154 [ # # ]: 0 : EnsureLegacyScriptPubKeyMan(*pwallet, true);
155 : :
156 [ # # ]: 0 : WalletRescanReserver reserver(*pwallet);
157 : 0 : bool fRescan = true;
158 : 0 : {
159 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
160 : :
161 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
162 : :
163 [ # # # # : 0 : std::string strSecret = request.params[0].get_str();
# # ]
164 [ # # # # ]: 0 : const std::string strLabel{LabelFromValue(request.params[1])};
165 : :
166 : : // Whether to perform rescan after import
167 [ # # # # ]: 0 : if (!request.params[2].isNull())
168 [ # # # # ]: 0 : fRescan = request.params[2].get_bool();
169 : :
170 [ # # # # : 0 : if (fRescan && pwallet->chain().havePruned()) {
# # ]
171 : : // Exit early and print an error.
172 : : // If a block is pruned after this check, we will import the key(s),
173 : : // but fail the rescan with a generic error.
174 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Rescan is disabled when blocks are pruned");
175 : : }
176 : :
177 [ # # # # ]: 0 : if (fRescan && !reserver.reserve()) {
178 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
179 : : }
180 : :
181 [ # # ]: 0 : CKey key = DecodeSecret(strSecret);
182 [ # # # # : 0 : if (!key.IsValid()) throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key encoding");
# # ]
183 : :
184 [ # # ]: 0 : CPubKey pubkey = key.GetPubKey();
185 [ # # # # ]: 0 : CHECK_NONFATAL(key.VerifyPubKey(pubkey));
186 [ # # ]: 0 : CKeyID vchAddress = pubkey.GetID();
187 : 0 : {
188 [ # # ]: 0 : pwallet->MarkDirty();
189 : :
190 : : // We don't know which corresponding address will be used;
191 : : // label all new addresses, and label existing addresses if a
192 : : // label was passed.
193 [ # # # # ]: 0 : for (const auto& dest : GetAllDestinationsForKey(pubkey)) {
194 [ # # # # : 0 : if (!request.params[1].isNull() || !pwallet->FindAddressBookEntry(dest)) {
# # # # ]
195 [ # # ]: 0 : pwallet->SetAddressBook(dest, strLabel, AddressPurpose::RECEIVE);
196 : : }
197 : 0 : }
198 : :
199 : : // Use timestamp of 1 to scan the whole chain
200 [ # # # # : 0 : if (!pwallet->ImportPrivKeys({{vchAddress, key}}, 1)) {
# # # # #
# ]
201 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding key to wallet");
202 : : }
203 : :
204 : : // Add the wpkh script for this key if possible
205 [ # # ]: 0 : if (pubkey.IsCompressed()) {
206 [ # # # # : 0 : pwallet->ImportScripts({GetScriptForDestination(WitnessV0KeyHash(vchAddress))}, /*timestamp=*/0);
# # # # #
# ]
207 : : }
208 : : }
209 [ # # ]: 0 : }
210 [ # # ]: 0 : if (fRescan) {
211 [ # # ]: 0 : RescanWallet(*pwallet, reserver);
212 : : }
213 : :
214 : 0 : return UniValue::VNULL;
215 [ # # # # : 0 : },
# # ]
216 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # #
# ]
217 [ # # # # : 0 : }
# # # # #
# ]
218 : :
219 : 0 : RPCHelpMan importaddress()
220 : : {
221 : 0 : return RPCHelpMan{"importaddress",
222 : : "\nAdds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.\n"
223 : : "\nNote: This call can take over an hour to complete if rescan is true, during that time, other rpc calls\n"
224 : : "may report that the imported address exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes.\n"
225 : : "The rescan parameter can be set to false if the key was never used to create transactions. If it is set to false,\n"
226 : : "but the key was used to create transactions, rescanblockchain needs to be called with the appropriate block range.\n"
227 : : "If you have the full public key, you should call importpubkey instead of this.\n"
228 : : "Hint: use importmulti to import more than one address.\n"
229 : : "\nNote: If you import a non-standard raw script in hex form, outputs sending to it will be treated\n"
230 : : "as change, and not show up in many RPCs.\n"
231 : : "Note: Use \"getwalletinfo\" to query the scanning progress.\n"
232 : : "Note: This command is only compatible with legacy wallets. Use \"importdescriptors\" for descriptor wallets.\n",
233 : : {
234 [ # # ]: 0 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The Bitcoin address (or hex-encoded script)"},
235 [ # # ]: 0 : {"label", RPCArg::Type::STR, RPCArg::Default{""}, "An optional label"},
236 [ # # ]: 0 : {"rescan", RPCArg::Type::BOOL, RPCArg::Default{true}, "Scan the chain and mempool for wallet transactions."},
237 [ # # ]: 0 : {"p2sh", RPCArg::Type::BOOL, RPCArg::Default{false}, "Add the P2SH version of the script as well"},
238 : : },
239 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
240 : 0 : RPCExamples{
241 : : "\nImport an address with rescan\n"
242 [ # # # # : 0 : + HelpExampleCli("importaddress", "\"myaddress\"") +
# # # # ]
243 : 0 : "\nImport using a label without rescan\n"
244 [ # # # # : 0 : + HelpExampleCli("importaddress", "\"myaddress\" \"testing\" false") +
# # # # ]
245 : 0 : "\nAs a JSON-RPC call\n"
246 [ # # # # : 0 : + HelpExampleRpc("importaddress", "\"myaddress\", \"testing\", false")
# # # # ]
247 [ # # ]: 0 : },
248 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
249 : : {
250 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
251 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
252 : :
253 [ # # ]: 0 : EnsureLegacyScriptPubKeyMan(*pwallet, true);
254 : :
255 [ # # # # ]: 0 : const std::string strLabel{LabelFromValue(request.params[1])};
256 : :
257 : : // Whether to perform rescan after import
258 : 0 : bool fRescan = true;
259 [ # # # # ]: 0 : if (!request.params[2].isNull())
260 [ # # # # ]: 0 : fRescan = request.params[2].get_bool();
261 : :
262 [ # # # # : 0 : if (fRescan && pwallet->chain().havePruned()) {
# # ]
263 : : // Exit early and print an error.
264 : : // If a block is pruned after this check, we will import the key(s),
265 : : // but fail the rescan with a generic error.
266 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Rescan is disabled when blocks are pruned");
267 : : }
268 : :
269 [ # # ]: 0 : WalletRescanReserver reserver(*pwallet);
270 [ # # # # ]: 0 : if (fRescan && !reserver.reserve()) {
271 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
272 : : }
273 : :
274 : : // Whether to import a p2sh version, too
275 : 0 : bool fP2SH = false;
276 [ # # # # ]: 0 : if (!request.params[3].isNull())
277 [ # # # # ]: 0 : fP2SH = request.params[3].get_bool();
278 : :
279 : 0 : {
280 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
281 : :
282 [ # # # # : 0 : CTxDestination dest = DecodeDestination(request.params[0].get_str());
# # ]
283 [ # # # # ]: 0 : if (IsValidDestination(dest)) {
284 [ # # ]: 0 : if (fP2SH) {
285 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Cannot use the p2sh flag with an address - use a script instead");
286 : : }
287 [ # # ]: 0 : if (OutputTypeFromDestination(dest) == OutputType::BECH32M) {
288 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Bech32m addresses cannot be imported into legacy wallets");
289 : : }
290 : :
291 [ # # ]: 0 : pwallet->MarkDirty();
292 : :
293 [ # # # # : 0 : pwallet->ImportScriptPubKeys(strLabel, {GetScriptForDestination(dest)}, /*have_solving_data=*/false, /*apply_label=*/true, /*timestamp=*/1);
# # # # #
# ]
294 [ # # # # : 0 : } else if (IsHex(request.params[0].get_str())) {
# # # # ]
295 [ # # # # : 0 : std::vector<unsigned char> data(ParseHex(request.params[0].get_str()));
# # ]
296 : 0 : CScript redeem_script(data.begin(), data.end());
297 : :
298 [ # # # # ]: 0 : std::set<CScript> scripts = {redeem_script};
299 [ # # # # ]: 0 : pwallet->ImportScripts(scripts, /*timestamp=*/0);
300 : :
301 [ # # ]: 0 : if (fP2SH) {
302 [ # # # # : 0 : scripts.insert(GetScriptForDestination(ScriptHash(redeem_script)));
# # ]
303 : : }
304 : :
305 [ # # ]: 0 : pwallet->ImportScriptPubKeys(strLabel, scripts, /*have_solving_data=*/false, /*apply_label=*/true, /*timestamp=*/1);
306 : 0 : } else {
307 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid Bitcoin address or script");
308 : : }
309 [ # # ]: 0 : }
310 [ # # ]: 0 : if (fRescan)
311 : : {
312 [ # # ]: 0 : RescanWallet(*pwallet, reserver);
313 [ # # ]: 0 : pwallet->ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
314 : : }
315 : :
316 : 0 : return UniValue::VNULL;
317 [ # # # # ]: 0 : },
318 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
319 [ # # # # : 0 : }
# # # # #
# # # ]
320 : :
321 : 0 : RPCHelpMan importprunedfunds()
322 : : {
323 : 0 : return RPCHelpMan{"importprunedfunds",
324 : : "\nImports 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",
325 : : {
326 [ # # ]: 0 : {"rawtransaction", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "A raw transaction in hex funding an already-existing address in wallet"},
327 [ # # ]: 0 : {"txoutproof", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex output from gettxoutproof that contains the transaction"},
328 : : },
329 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
330 [ # # # # ]: 0 : RPCExamples{""},
331 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
332 : : {
333 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
334 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
335 : :
336 [ # # ]: 0 : CMutableTransaction tx;
337 [ # # # # : 0 : if (!DecodeHexTx(tx, request.params[0].get_str())) {
# # # # ]
338 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "TX decode failed. Make sure the tx has at least one input.");
339 : : }
340 [ # # ]: 0 : uint256 hashTx = tx.GetHash();
341 : :
342 [ # # # # : 0 : DataStream ssMB{ParseHexV(request.params[1], "proof")};
# # ]
343 [ # # ]: 0 : CMerkleBlock merkleBlock;
344 [ # # ]: 0 : ssMB >> merkleBlock;
345 : :
346 : : //Search partial merkle tree in proof for our transaction and index in valid block
347 : 0 : std::vector<uint256> vMatch;
348 : 0 : std::vector<unsigned int> vIndex;
349 [ # # # # ]: 0 : if (merkleBlock.txn.ExtractMatches(vMatch, vIndex) != merkleBlock.header.hashMerkleRoot) {
350 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Something wrong with merkleblock");
351 : : }
352 : :
353 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
354 : 0 : int height;
355 [ # # # # : 0 : if (!pwallet->chain().findAncestorByHash(pwallet->GetLastBlockHash(), merkleBlock.header.GetHash(), FoundBlock().height(height))) {
# # ]
356 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Block not found in chain");
357 : : }
358 : :
359 : 0 : std::vector<uint256>::const_iterator it;
360 [ # # ]: 0 : if ((it = std::find(vMatch.begin(), vMatch.end(), hashTx)) == vMatch.end()) {
361 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Transaction given doesn't exist in proof");
362 : : }
363 : :
364 [ # # ]: 0 : unsigned int txnIndex = vIndex[it - vMatch.begin()];
365 : :
366 [ # # ]: 0 : CTransactionRef tx_ref = MakeTransactionRef(tx);
367 [ # # # # ]: 0 : if (pwallet->IsMine(*tx_ref)) {
368 [ # # # # ]: 0 : pwallet->AddToWallet(std::move(tx_ref), TxStateConfirmed{merkleBlock.header.GetHash(), height, static_cast<int>(txnIndex)});
369 [ # # ]: 0 : return UniValue::VNULL;
370 : : }
371 : :
372 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "No addresses in wallet correspond to included transaction");
373 [ # # ]: 0 : },
374 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# ]
375 [ # # # # : 0 : }
# # # # ]
376 : :
377 : 0 : RPCHelpMan removeprunedfunds()
378 : : {
379 : 0 : return RPCHelpMan{"removeprunedfunds",
380 : : "\nDeletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.\n",
381 : : {
382 [ # # ]: 0 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The hex-encoded id of the transaction you are deleting"},
383 : : },
384 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
385 : 0 : RPCExamples{
386 [ # # # # : 0 : HelpExampleCli("removeprunedfunds", "\"a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5\"") +
# # ]
387 : 0 : "\nAs a JSON-RPC call\n"
388 [ # # # # : 0 : + HelpExampleRpc("removeprunedfunds", "\"a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5\"")
# # # # ]
389 [ # # ]: 0 : },
390 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
391 : : {
392 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
393 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
394 : :
395 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
396 : :
397 [ # # # # ]: 0 : uint256 hash(ParseHashV(request.params[0], "txid"));
398 : 0 : std::vector<uint256> vHash;
399 [ # # ]: 0 : vHash.push_back(hash);
400 [ # # # # ]: 0 : if (auto res = pwallet->RemoveTxs(vHash); !res) {
401 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, util::ErrorString(res).original);
402 : 0 : }
403 : :
404 : 0 : return UniValue::VNULL;
405 [ # # ]: 0 : },
406 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
407 [ # # # # ]: 0 : }
408 : :
409 : 0 : RPCHelpMan importpubkey()
410 : : {
411 : 0 : return RPCHelpMan{"importpubkey",
412 : : "\nAdds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.\n"
413 : : "Hint: use importmulti to import more than one public key.\n"
414 : : "\nNote: This call can take over an hour to complete if rescan is true, during that time, other rpc calls\n"
415 : : "may report that the imported pubkey exists but related transactions are still missing, leading to temporarily incorrect/bogus balances and unspent outputs until rescan completes.\n"
416 : : "The rescan parameter can be set to false if the key was never used to create transactions. If it is set to false,\n"
417 : : "but the key was used to create transactions, rescanblockchain needs to be called with the appropriate block range.\n"
418 : : "Note: Use \"getwalletinfo\" to query the scanning progress.\n"
419 : : "Note: This command is only compatible with legacy wallets. Use \"importdescriptors\" with \"combo(X)\" for descriptor wallets.\n",
420 : : {
421 [ # # ]: 0 : {"pubkey", RPCArg::Type::STR, RPCArg::Optional::NO, "The hex-encoded public key"},
422 [ # # ]: 0 : {"label", RPCArg::Type::STR, RPCArg::Default{""}, "An optional label"},
423 [ # # ]: 0 : {"rescan", RPCArg::Type::BOOL, RPCArg::Default{true}, "Scan the chain and mempool for wallet transactions."},
424 : : },
425 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
426 : 0 : RPCExamples{
427 : : "\nImport a public key with rescan\n"
428 [ # # # # : 0 : + HelpExampleCli("importpubkey", "\"mypubkey\"") +
# # # # ]
429 : 0 : "\nImport using a label without rescan\n"
430 [ # # # # : 0 : + HelpExampleCli("importpubkey", "\"mypubkey\" \"testing\" false") +
# # # # ]
431 : 0 : "\nAs a JSON-RPC call\n"
432 [ # # # # : 0 : + HelpExampleRpc("importpubkey", "\"mypubkey\", \"testing\", false")
# # # # ]
433 [ # # ]: 0 : },
434 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
435 : : {
436 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
437 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
438 : :
439 [ # # ]: 0 : EnsureLegacyScriptPubKeyMan(*pwallet, true);
440 : :
441 [ # # # # ]: 0 : const std::string strLabel{LabelFromValue(request.params[1])};
442 : :
443 : : // Whether to perform rescan after import
444 : 0 : bool fRescan = true;
445 [ # # # # ]: 0 : if (!request.params[2].isNull())
446 [ # # # # ]: 0 : fRescan = request.params[2].get_bool();
447 : :
448 [ # # # # : 0 : if (fRescan && pwallet->chain().havePruned()) {
# # ]
449 : : // Exit early and print an error.
450 : : // If a block is pruned after this check, we will import the key(s),
451 : : // but fail the rescan with a generic error.
452 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Rescan is disabled when blocks are pruned");
453 : : }
454 : :
455 [ # # ]: 0 : WalletRescanReserver reserver(*pwallet);
456 [ # # # # ]: 0 : if (fRescan && !reserver.reserve()) {
457 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
458 : : }
459 : :
460 [ # # # # : 0 : CPubKey pubKey = HexToPubKey(request.params[0].get_str());
# # ]
461 : :
462 : 0 : {
463 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
464 : :
465 [ # # ]: 0 : std::set<CScript> script_pub_keys;
466 [ # # # # ]: 0 : for (const auto& dest : GetAllDestinationsForKey(pubKey)) {
467 [ # # # # ]: 0 : script_pub_keys.insert(GetScriptForDestination(dest));
468 : 0 : }
469 : :
470 [ # # ]: 0 : pwallet->MarkDirty();
471 : :
472 [ # # ]: 0 : pwallet->ImportScriptPubKeys(strLabel, script_pub_keys, /*have_solving_data=*/true, /*apply_label=*/true, /*timestamp=*/1);
473 : :
474 [ # # # # : 0 : pwallet->ImportPubKeys({{pubKey.GetID(), false}}, {{pubKey.GetID(), pubKey}} , /*key_origins=*/{}, /*add_keypool=*/false, /*timestamp=*/1);
# # # # #
# ]
475 [ # # ]: 0 : }
476 [ # # ]: 0 : if (fRescan)
477 : : {
478 [ # # ]: 0 : RescanWallet(*pwallet, reserver);
479 [ # # ]: 0 : pwallet->ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
480 : : }
481 : :
482 : 0 : return UniValue::VNULL;
483 : 0 : },
484 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # #
# ]
485 [ # # # # : 0 : }
# # # # #
# ]
486 : :
487 : :
488 : 0 : RPCHelpMan importwallet()
489 : : {
490 : 0 : return RPCHelpMan{"importwallet",
491 : : "\nImports keys from a wallet dump file (see dumpwallet). Requires a new wallet backup to include imported keys.\n"
492 : : "Note: Blockchain and Mempool will be rescanned after a successful import. Use \"getwalletinfo\" to query the scanning progress.\n"
493 : : "Note: This command is only compatible with legacy wallets.\n",
494 : : {
495 [ # # ]: 0 : {"filename", RPCArg::Type::STR, RPCArg::Optional::NO, "The wallet file"},
496 : : },
497 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
498 : 0 : RPCExamples{
499 : : "\nDump the wallet\n"
500 [ # # # # : 0 : + HelpExampleCli("dumpwallet", "\"test\"") +
# # # # ]
501 : 0 : "\nImport the wallet\n"
502 [ # # # # : 0 : + HelpExampleCli("importwallet", "\"test\"") +
# # # # ]
503 : 0 : "\nImport using the json rpc call\n"
504 [ # # # # : 0 : + HelpExampleRpc("importwallet", "\"test\"")
# # # # ]
505 [ # # ]: 0 : },
506 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
507 : : {
508 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
509 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
510 : :
511 [ # # ]: 0 : EnsureLegacyScriptPubKeyMan(*pwallet, true);
512 : :
513 : 0 : WalletRescanReserver reserver(*pwallet);
514 [ # # ]: 0 : if (!reserver.reserve()) {
515 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
516 : : }
517 : :
518 : 0 : int64_t nTimeBegin = 0;
519 : 0 : bool fGood = true;
520 : 0 : {
521 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
522 : :
523 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
524 : :
525 [ # # ]: 0 : std::ifstream file;
526 [ # # # # : 0 : file.open(fs::u8path(request.params[0].get_str()), std::ios::in | std::ios::ate);
# # ]
527 [ # # ]: 0 : if (!file.is_open()) {
528 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot open wallet dump file");
529 : : }
530 [ # # # # ]: 0 : CHECK_NONFATAL(pwallet->chain().findBlock(pwallet->GetLastBlockHash(), FoundBlock().time(nTimeBegin)));
531 : :
532 [ # # # # ]: 0 : int64_t nFilesize = std::max((int64_t)1, (int64_t)file.tellg());
533 [ # # ]: 0 : file.seekg(0, file.beg);
534 : :
535 : : // Use uiInterface.ShowProgress instead of pwallet.ShowProgress because pwallet.ShowProgress has a cancel button tied to AbortRescan which
536 : : // we don't want for this progress bar showing the import progress. uiInterface.ShowProgress does not have a cancel button.
537 [ # # # # : 0 : pwallet->chain().showProgress(strprintf("%s " + _("Importing…").translated, pwallet->GetDisplayName()), 0, false); // show progress dialog in GUI
# # # # #
# ]
538 : 0 : std::vector<std::tuple<CKey, int64_t, bool, std::string>> keys;
539 : 0 : std::vector<std::pair<CScript, int64_t>> scripts;
540 [ # # ]: 0 : while (file.good()) {
541 [ # # # # : 0 : pwallet->chain().showProgress("", std::max(1, std::min(50, (int)(((double)file.tellg() / (double)nFilesize) * 100))), false);
# # # # #
# ]
542 [ # # ]: 0 : std::string line;
543 [ # # ]: 0 : std::getline(file, line);
544 [ # # # # ]: 0 : if (line.empty() || line[0] == '#')
545 : 0 : continue;
546 : :
547 [ # # ]: 0 : std::vector<std::string> vstr = SplitString(line, ' ');
548 [ # # ]: 0 : if (vstr.size() < 2)
549 : 0 : continue;
550 [ # # ]: 0 : CKey key = DecodeSecret(vstr[0]);
551 [ # # ]: 0 : if (key.IsValid()) {
552 [ # # ]: 0 : int64_t nTime = ParseISO8601DateTime(vstr[1]);
553 : 0 : std::string strLabel;
554 : 0 : bool fLabel = true;
555 [ # # ]: 0 : for (unsigned int nStr = 2; nStr < vstr.size(); nStr++) {
556 [ # # ]: 0 : if (vstr[nStr].front() == '#')
557 : : break;
558 [ # # ]: 0 : if (vstr[nStr] == "change=1")
559 : 0 : fLabel = false;
560 [ # # ]: 0 : if (vstr[nStr] == "reserve=1")
561 : 0 : fLabel = false;
562 [ # # # # ]: 0 : if (vstr[nStr].substr(0,6) == "label=") {
563 [ # # # # ]: 0 : strLabel = DecodeDumpString(vstr[nStr].substr(6));
564 : 0 : fLabel = true;
565 : : }
566 : : }
567 [ # # ]: 0 : nTimeBegin = std::min(nTimeBegin, nTime);
568 [ # # ]: 0 : keys.emplace_back(key, nTime, fLabel, strLabel);
569 [ # # # # ]: 0 : } else if(IsHex(vstr[0])) {
570 [ # # ]: 0 : std::vector<unsigned char> vData(ParseHex(vstr[0]));
571 : 0 : CScript script = CScript(vData.begin(), vData.end());
572 [ # # ]: 0 : int64_t birth_time = ParseISO8601DateTime(vstr[1]);
573 [ # # # # ]: 0 : if (birth_time > 0) nTimeBegin = std::min(nTimeBegin, birth_time);
574 [ # # ]: 0 : scripts.emplace_back(script, birth_time);
575 : 0 : }
576 : 0 : }
577 [ # # ]: 0 : file.close();
578 [ # # ]: 0 : EnsureBlockDataFromTime(*pwallet, nTimeBegin);
579 : : // We now know whether we are importing private keys, so we can error if private keys are disabled
580 [ # # # # : 0 : if (keys.size() > 0 && pwallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
# # ]
581 [ # # # # ]: 0 : pwallet->chain().showProgress("", 100, false); // hide progress dialog in GUI
582 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Importing wallets is disabled when private keys are disabled");
583 : : }
584 : 0 : double total = (double)(keys.size() + scripts.size());
585 : 0 : double progress = 0;
586 [ # # ]: 0 : for (const auto& key_tuple : keys) {
587 [ # # # # : 0 : pwallet->chain().showProgress("", std::max(50, std::min(75, (int)((progress / total) * 100) + 50)), false);
# # # # ]
588 [ # # ]: 0 : const CKey& key = std::get<0>(key_tuple);
589 : 0 : int64_t time = std::get<1>(key_tuple);
590 : 0 : bool has_label = std::get<2>(key_tuple);
591 [ # # ]: 0 : std::string label = std::get<3>(key_tuple);
592 : :
593 [ # # ]: 0 : CPubKey pubkey = key.GetPubKey();
594 [ # # # # ]: 0 : CHECK_NONFATAL(key.VerifyPubKey(pubkey));
595 [ # # ]: 0 : CKeyID keyid = pubkey.GetID();
596 : :
597 [ # # # # : 0 : pwallet->WalletLogPrintf("Importing %s...\n", EncodeDestination(PKHash(keyid)));
# # ]
598 : :
599 [ # # # # : 0 : if (!pwallet->ImportPrivKeys({{keyid, key}}, time)) {
# # # # #
# ]
600 [ # # # # : 0 : pwallet->WalletLogPrintf("Error importing key for %s\n", EncodeDestination(PKHash(keyid)));
# # ]
601 : 0 : fGood = false;
602 : 0 : continue;
603 : : }
604 : :
605 [ # # ]: 0 : if (has_label)
606 [ # # # # ]: 0 : pwallet->SetAddressBook(PKHash(keyid), label, AddressPurpose::RECEIVE);
607 : 0 : progress++;
608 : 0 : }
609 [ # # ]: 0 : for (const auto& script_pair : scripts) {
610 [ # # # # : 0 : pwallet->chain().showProgress("", std::max(50, std::min(75, (int)((progress / total) * 100) + 50)), false);
# # # # ]
611 : 0 : const CScript& script = script_pair.first;
612 : 0 : int64_t time = script_pair.second;
613 : :
614 [ # # # # : 0 : if (!pwallet->ImportScripts({script}, time)) {
# # # # ]
615 [ # # # # : 0 : pwallet->WalletLogPrintf("Error importing script %s\n", HexStr(script));
# # ]
616 : 0 : fGood = false;
617 : 0 : continue;
618 : : }
619 : :
620 : 0 : progress++;
621 : : }
622 [ # # # # ]: 0 : pwallet->chain().showProgress("", 100, false); // hide progress dialog in GUI
623 [ # # ]: 0 : }
624 [ # # # # ]: 0 : pwallet->chain().showProgress("", 100, false); // hide progress dialog in GUI
625 [ # # ]: 0 : RescanWallet(*pwallet, reserver, nTimeBegin, /*update=*/false);
626 [ # # ]: 0 : pwallet->MarkDirty();
627 : :
628 [ # # ]: 0 : if (!fGood)
629 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding some keys/scripts to wallet");
630 : :
631 : 0 : return UniValue::VNULL;
632 [ # # # # : 0 : },
# # ]
633 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
634 [ # # # # ]: 0 : }
635 : :
636 : 0 : RPCHelpMan dumpprivkey()
637 : : {
638 : 0 : return RPCHelpMan{"dumpprivkey",
639 : : "\nReveals the private key corresponding to 'address'.\n"
640 : : "Then the importprivkey can be used with this output\n"
641 : : "Note: This command is only compatible with legacy wallets.\n",
642 : : {
643 [ # # ]: 0 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address for the private key"},
644 : : },
645 : 0 : RPCResult{
646 : : RPCResult::Type::STR, "key", "The private key"
647 [ # # # # : 0 : },
# # ]
648 : 0 : RPCExamples{
649 [ # # # # : 0 : HelpExampleCli("dumpprivkey", "\"myaddress\"")
# # ]
650 [ # # # # : 0 : + HelpExampleCli("importprivkey", "\"mykey\"")
# # # # ]
651 [ # # # # : 0 : + HelpExampleRpc("dumpprivkey", "\"myaddress\"")
# # # # ]
652 [ # # ]: 0 : },
653 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
654 : : {
655 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
656 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
657 : :
658 [ # # ]: 0 : const LegacyScriptPubKeyMan& spk_man = EnsureConstLegacyScriptPubKeyMan(*pwallet);
659 : :
660 [ # # # # ]: 0 : LOCK2(pwallet->cs_wallet, spk_man.cs_KeyStore);
661 : :
662 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
663 : :
664 [ # # # # : 0 : std::string strAddress = request.params[0].get_str();
# # ]
665 [ # # ]: 0 : CTxDestination dest = DecodeDestination(strAddress);
666 [ # # # # ]: 0 : if (!IsValidDestination(dest)) {
667 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid Bitcoin address");
668 : : }
669 [ # # ]: 0 : auto keyid = GetKeyForDestination(spk_man, dest);
670 [ # # ]: 0 : if (keyid.IsNull()) {
671 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Address does not refer to a key");
672 : : }
673 : 0 : CKey vchSecret;
674 [ # # # # ]: 0 : if (!spk_man.GetKey(keyid, vchSecret)) {
675 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Private key for address " + strAddress + " is not known");
676 : : }
677 [ # # # # ]: 0 : return EncodeSecret(vchSecret);
678 [ # # # # ]: 0 : },
679 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
680 [ # # # # ]: 0 : }
681 : :
682 : :
683 : 0 : RPCHelpMan dumpwallet()
684 : : {
685 : 0 : return RPCHelpMan{"dumpwallet",
686 : : "\nDumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files.\n"
687 : : "Imported scripts are included in the dumpfile, but corresponding BIP173 addresses, etc. may not be added automatically by importwallet.\n"
688 : : "Note that if your wallet contains keys which are not derived from your HD seed (e.g. imported keys), these are not covered by\n"
689 : : "only backing up the seed itself, and must be backed up too (e.g. ensure you back up the whole dumpfile).\n"
690 : : "Note: This command is only compatible with legacy wallets.\n",
691 : : {
692 [ # # ]: 0 : {"filename", RPCArg::Type::STR, RPCArg::Optional::NO, "The filename with path (absolute path recommended)"},
693 : : },
694 : 0 : RPCResult{
695 : : RPCResult::Type::OBJ, "", "",
696 : : {
697 : : {RPCResult::Type::STR, "filename", "The filename with full absolute path"},
698 : : }
699 [ # # # # : 0 : },
# # # # #
# # # # #
# # # # ]
700 : 0 : RPCExamples{
701 [ # # # # : 0 : HelpExampleCli("dumpwallet", "\"test\"")
# # ]
702 [ # # # # : 0 : + HelpExampleRpc("dumpwallet", "\"test\"")
# # # # ]
703 [ # # ]: 0 : },
704 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
705 : : {
706 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
707 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
708 : :
709 [ # # ]: 0 : const CWallet& wallet = *pwallet;
710 [ # # ]: 0 : const LegacyScriptPubKeyMan& spk_man = EnsureConstLegacyScriptPubKeyMan(wallet);
711 : :
712 : : // Make sure the results are valid at least up to the most recent block
713 : : // the user could have gotten from another RPC command prior to now
714 [ # # ]: 0 : wallet.BlockUntilSyncedToCurrentChain();
715 : :
716 [ # # ]: 0 : LOCK(wallet.cs_wallet);
717 : :
718 [ # # ]: 0 : EnsureWalletIsUnlocked(wallet);
719 : :
720 [ # # # # : 0 : fs::path filepath = fs::u8path(request.params[0].get_str());
# # ]
721 [ # # ]: 0 : filepath = fs::absolute(filepath);
722 : :
723 : : /* Prevent arbitrary files from being overwritten. There have been reports
724 : : * that users have overwritten wallet files this way:
725 : : * https://github.com/bitcoin/bitcoin/issues/9934
726 : : * It may also avoid other security issues.
727 : : */
728 [ # # # # ]: 0 : if (fs::exists(filepath)) {
729 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, filepath.utf8string() + " already exists. If you are sure this is what you want, move it out of the way first");
730 : : }
731 : :
732 [ # # ]: 0 : std::ofstream file;
733 [ # # ]: 0 : file.open(filepath);
734 [ # # ]: 0 : if (!file.is_open())
735 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Cannot open wallet dump file");
736 : :
737 [ # # ]: 0 : std::map<CKeyID, int64_t> mapKeyBirth;
738 [ # # ]: 0 : wallet.GetKeyBirthTimes(mapKeyBirth);
739 : :
740 : 0 : int64_t block_time = 0;
741 [ # # # # ]: 0 : CHECK_NONFATAL(wallet.chain().findBlock(wallet.GetLastBlockHash(), FoundBlock().time(block_time)));
742 : :
743 : : // Note: To avoid a lock order issue, access to cs_main must be locked before cs_KeyStore.
744 : : // So we do the two things in this function that lock cs_main first: GetKeyBirthTimes, and findBlock.
745 [ # # ]: 0 : LOCK(spk_man.cs_KeyStore);
746 : :
747 [ # # ]: 0 : const std::map<CKeyID, int64_t>& mapKeyPool = spk_man.GetAllReserveKeys();
748 [ # # ]: 0 : std::set<CScriptID> scripts = spk_man.GetCScripts();
749 : :
750 : : // sort time/key pairs
751 : 0 : std::vector<std::pair<int64_t, CKeyID> > vKeyBirth;
752 [ # # ]: 0 : vKeyBirth.reserve(mapKeyBirth.size());
753 [ # # ]: 0 : for (const auto& entry : mapKeyBirth) {
754 [ # # ]: 0 : vKeyBirth.emplace_back(entry.second, entry.first);
755 : : }
756 : 0 : mapKeyBirth.clear();
757 : 0 : std::sort(vKeyBirth.begin(), vKeyBirth.end());
758 : :
759 : : // produce output
760 [ # # # # ]: 0 : file << strprintf("# Wallet dump created by %s %s\n", CLIENT_NAME, FormatFullVersion());
761 [ # # # # : 0 : file << strprintf("# * Created on %s\n", FormatISO8601DateTime(GetTime()));
# # ]
762 [ # # # # ]: 0 : file << strprintf("# * Best block at time of backup was %i (%s),\n", wallet.GetLastBlockHeight(), wallet.GetLastBlockHash().ToString());
763 [ # # # # ]: 0 : file << strprintf("# mined on %s\n", FormatISO8601DateTime(block_time));
764 [ # # ]: 0 : file << "\n";
765 : :
766 : : // add the base58check encoded extended master if the wallet uses HD
767 : 0 : CKeyID seed_id = spk_man.GetHDChain().seed_id;
768 [ # # ]: 0 : if (!seed_id.IsNull())
769 : : {
770 : 0 : CKey seed;
771 [ # # # # ]: 0 : if (spk_man.GetKey(seed_id, seed)) {
772 [ # # ]: 0 : CExtKey masterKey;
773 [ # # # # ]: 0 : masterKey.SetSeed(seed);
774 : :
775 [ # # # # : 0 : file << "# extended private masterkey: " << EncodeExtKey(masterKey) << "\n\n";
# # ]
776 : 0 : }
777 : 0 : }
778 [ # # ]: 0 : for (std::vector<std::pair<int64_t, CKeyID> >::const_iterator it = vKeyBirth.begin(); it != vKeyBirth.end(); it++) {
779 : 0 : const CKeyID &keyid = it->second;
780 [ # # ]: 0 : std::string strTime = FormatISO8601DateTime(it->first);
781 [ # # ]: 0 : std::string strAddr;
782 : 0 : std::string strLabel;
783 : 0 : CKey key;
784 [ # # # # ]: 0 : if (spk_man.GetKey(keyid, key)) {
785 : 0 : CKeyMetadata metadata;
786 : 0 : const auto it{spk_man.mapKeyMetadata.find(keyid)};
787 [ # # # # ]: 0 : if (it != spk_man.mapKeyMetadata.end()) metadata = it->second;
788 [ # # # # ]: 0 : file << strprintf("%s %s ", EncodeSecret(key), strTime);
789 [ # # # # ]: 0 : if (GetWalletAddressesForKey(&spk_man, wallet, keyid, strAddr, strLabel)) {
790 [ # # ]: 0 : file << strprintf("label=%s", strLabel);
791 [ # # ]: 0 : } else if (keyid == seed_id) {
792 [ # # ]: 0 : file << "hdseed=1";
793 [ # # ]: 0 : } else if (mapKeyPool.count(keyid)) {
794 [ # # ]: 0 : file << "reserve=1";
795 [ # # ]: 0 : } else if (metadata.hdKeypath == "s") {
796 [ # # ]: 0 : file << "inactivehdseed=1";
797 : : } else {
798 [ # # ]: 0 : file << "change=1";
799 : : }
800 [ # # # # : 0 : file << strprintf(" # addr=%s%s\n", strAddr, (metadata.has_key_origin ? " hdkeypath="+WriteHDKeypath(metadata.key_origin.path, /*apostrophe=*/true) : ""));
# # # # #
# # # #
# ]
801 : 0 : }
802 : 0 : }
803 [ # # ]: 0 : file << "\n";
804 [ # # ]: 0 : for (const CScriptID &scriptid : scripts) {
805 : 0 : CScript script;
806 [ # # ]: 0 : std::string create_time = "0";
807 [ # # # # ]: 0 : std::string address = EncodeDestination(ScriptHash(scriptid));
808 : : // get birth times for scripts with metadata
809 : 0 : auto it = spk_man.m_script_metadata.find(scriptid);
810 [ # # ]: 0 : if (it != spk_man.m_script_metadata.end()) {
811 [ # # ]: 0 : create_time = FormatISO8601DateTime(it->second.nCreateTime);
812 : : }
813 [ # # # # ]: 0 : if(spk_man.GetCScript(scriptid, script)) {
814 [ # # # # : 0 : file << strprintf("%s %s script=1", HexStr(script), create_time);
# # ]
815 [ # # ]: 0 : file << strprintf(" # addr=%s\n", address);
816 : : }
817 : 0 : }
818 [ # # ]: 0 : file << "\n";
819 [ # # ]: 0 : file << "# End of dump\n";
820 [ # # ]: 0 : file.close();
821 : :
822 : 0 : UniValue reply(UniValue::VOBJ);
823 [ # # # # : 0 : reply.pushKV("filename", filepath.utf8string());
# # # # ]
824 : :
825 : 0 : return reply;
826 [ # # # # ]: 0 : },
827 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
828 [ # # # # : 0 : }
# # # # ]
829 : :
830 : : struct ImportData
831 : : {
832 : : // Input data
833 : : std::unique_ptr<CScript> redeemscript; //!< Provided redeemScript; will be moved to `import_scripts` if relevant.
834 : : std::unique_ptr<CScript> witnessscript; //!< Provided witnessScript; will be moved to `import_scripts` if relevant.
835 : :
836 : : // Output data
837 : : std::set<CScript> import_scripts;
838 : : std::map<CKeyID, bool> used_keys; //!< Import these private keys if available (the value indicates whether if the key is required for solvability)
839 : : std::map<CKeyID, std::pair<CPubKey, KeyOriginInfo>> key_origins;
840 : : };
841 : :
842 : : enum class ScriptContext
843 : : {
844 : : TOP, //!< Top-level scriptPubKey
845 : : P2SH, //!< P2SH redeemScript
846 : : WITNESS_V0, //!< P2WSH witnessScript
847 : : };
848 : :
849 : : // Analyse the provided scriptPubKey, determining which keys and which redeem scripts from the ImportData struct are needed to spend it, and mark them as used.
850 : : // Returns an error string, or the empty string for success.
851 : : // NOLINTNEXTLINE(misc-no-recursion)
852 : 0 : static std::string RecurseImportData(const CScript& script, ImportData& import_data, const ScriptContext script_ctx)
853 : : {
854 : : // Use Solver to obtain script type and parsed pubkeys or hashes:
855 : 0 : std::vector<std::vector<unsigned char>> solverdata;
856 [ # # ]: 0 : TxoutType script_type = Solver(script, solverdata);
857 : :
858 [ # # # # : 0 : switch (script_type) {
# # # #
# ]
859 : 0 : case TxoutType::PUBKEY: {
860 : 0 : CPubKey pubkey(solverdata[0]);
861 [ # # # # ]: 0 : import_data.used_keys.emplace(pubkey.GetID(), false);
862 [ # # ]: 0 : return "";
863 : : }
864 : 0 : case TxoutType::PUBKEYHASH: {
865 [ # # ]: 0 : CKeyID id = CKeyID(uint160(solverdata[0]));
866 [ # # ]: 0 : import_data.used_keys[id] = true;
867 [ # # ]: 0 : return "";
868 : : }
869 : 0 : case TxoutType::SCRIPTHASH: {
870 [ # # # # : 0 : if (script_ctx == ScriptContext::P2SH) throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Trying to nest P2SH inside another P2SH");
# # ]
871 [ # # # # : 0 : if (script_ctx == ScriptContext::WITNESS_V0) throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Trying to nest P2SH inside a P2WSH");
# # ]
872 [ # # ]: 0 : CHECK_NONFATAL(script_ctx == ScriptContext::TOP);
873 [ # # ]: 0 : CScriptID id = CScriptID(uint160(solverdata[0]));
874 [ # # ]: 0 : auto subscript = std::move(import_data.redeemscript); // Remove redeemscript from import_data to check for superfluous script later.
875 [ # # # # ]: 0 : if (!subscript) return "missing redeemscript";
876 [ # # # # : 0 : if (CScriptID(*subscript) != id) return "redeemScript does not match the scriptPubKey";
# # ]
877 [ # # ]: 0 : import_data.import_scripts.emplace(*subscript);
878 [ # # ]: 0 : return RecurseImportData(*subscript, import_data, ScriptContext::P2SH);
879 : 0 : }
880 : : case TxoutType::MULTISIG: {
881 [ # # ]: 0 : for (size_t i = 1; i + 1< solverdata.size(); ++i) {
882 : 0 : CPubKey pubkey(solverdata[i]);
883 [ # # # # ]: 0 : import_data.used_keys.emplace(pubkey.GetID(), false);
884 : : }
885 [ # # ]: 0 : return "";
886 : : }
887 : 0 : case TxoutType::WITNESS_V0_SCRIPTHASH: {
888 [ # # # # : 0 : if (script_ctx == ScriptContext::WITNESS_V0) throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Trying to nest P2WSH inside another P2WSH");
# # ]
889 [ # # ]: 0 : CScriptID id{RIPEMD160(solverdata[0])};
890 [ # # ]: 0 : auto subscript = std::move(import_data.witnessscript); // Remove redeemscript from import_data to check for superfluous script later.
891 [ # # # # ]: 0 : if (!subscript) return "missing witnessscript";
892 [ # # # # : 0 : if (CScriptID(*subscript) != id) return "witnessScript does not match the scriptPubKey or redeemScript";
# # ]
893 [ # # ]: 0 : if (script_ctx == ScriptContext::TOP) {
894 [ # # ]: 0 : import_data.import_scripts.emplace(script); // Special rule for IsMine: native P2WSH requires the TOP script imported (see script/ismine.cpp)
895 : : }
896 [ # # ]: 0 : import_data.import_scripts.emplace(*subscript);
897 [ # # ]: 0 : return RecurseImportData(*subscript, import_data, ScriptContext::WITNESS_V0);
898 : 0 : }
899 : 0 : case TxoutType::WITNESS_V0_KEYHASH: {
900 [ # # # # : 0 : if (script_ctx == ScriptContext::WITNESS_V0) throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Trying to nest P2WPKH inside P2WSH");
# # ]
901 [ # # ]: 0 : CKeyID id = CKeyID(uint160(solverdata[0]));
902 [ # # ]: 0 : import_data.used_keys[id] = true;
903 [ # # ]: 0 : if (script_ctx == ScriptContext::TOP) {
904 [ # # ]: 0 : import_data.import_scripts.emplace(script); // Special rule for IsMine: native P2WPKH requires the TOP script imported (see script/ismine.cpp)
905 : : }
906 [ # # ]: 0 : return "";
907 : : }
908 : 0 : case TxoutType::NULL_DATA:
909 [ # # ]: 0 : return "unspendable script";
910 : 0 : case TxoutType::NONSTANDARD:
911 : 0 : case TxoutType::WITNESS_UNKNOWN:
912 : 0 : case TxoutType::WITNESS_V1_TAPROOT:
913 : 0 : case TxoutType::ANCHOR:
914 [ # # ]: 0 : return "unrecognized script";
915 : : } // no default case, so the compiler can warn about missing cases
916 [ # # ]: 0 : NONFATAL_UNREACHABLE();
917 : 0 : }
918 : :
919 : 0 : static UniValue ProcessImportLegacy(ImportData& import_data, std::map<CKeyID, CPubKey>& pubkey_map, std::map<CKeyID, CKey>& privkey_map, std::set<CScript>& script_pub_keys, bool& have_solving_data, const UniValue& data, std::vector<std::pair<CKeyID, bool>>& ordered_pubkeys)
920 : : {
921 : 0 : UniValue warnings(UniValue::VARR);
922 : :
923 : : // First ensure scriptPubKey has either a script or JSON with "address" string
924 [ # # # # ]: 0 : const UniValue& scriptPubKey = data["scriptPubKey"];
925 [ # # ]: 0 : bool isScript = scriptPubKey.getType() == UniValue::VSTR;
926 [ # # # # : 0 : if (!isScript && !(scriptPubKey.getType() == UniValue::VOBJ && scriptPubKey.exists("address"))) {
# # # # #
# # # ]
927 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "scriptPubKey must be string with script or JSON with address string");
928 : : }
929 [ # # # # : 0 : const std::string& output = isScript ? scriptPubKey.get_str() : scriptPubKey["address"].get_str();
# # # # #
# # # ]
930 : :
931 : : // Optional fields.
932 [ # # # # : 0 : const std::string& strRedeemScript = data.exists("redeemscript") ? data["redeemscript"].get_str() : "";
# # # # #
# # # # #
# # ]
933 [ # # # # : 0 : const std::string& witness_script_hex = data.exists("witnessscript") ? data["witnessscript"].get_str() : "";
# # # # #
# # # # #
# # ]
934 [ # # # # : 0 : const UniValue& pubKeys = data.exists("pubkeys") ? data["pubkeys"].get_array() : UniValue();
# # # # #
# # # ]
935 [ # # # # : 0 : const UniValue& keys = data.exists("keys") ? data["keys"].get_array() : UniValue();
# # # # #
# # # ]
936 [ # # # # : 0 : const bool internal = data.exists("internal") ? data["internal"].get_bool() : false;
# # # # #
# ]
937 [ # # # # : 0 : const bool watchOnly = data.exists("watchonly") ? data["watchonly"].get_bool() : false;
# # # # #
# ]
938 : :
939 [ # # # # ]: 0 : if (data.exists("range")) {
940 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should not be specified for a non-descriptor import");
941 : : }
942 : :
943 : : // Generate the script and destination for the scriptPubKey provided
944 : 0 : CScript script;
945 [ # # ]: 0 : if (!isScript) {
946 [ # # ]: 0 : CTxDestination dest = DecodeDestination(output);
947 [ # # # # ]: 0 : if (!IsValidDestination(dest)) {
948 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid address \"" + output + "\"");
949 : : }
950 [ # # ]: 0 : if (OutputTypeFromDestination(dest) == OutputType::BECH32M) {
951 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Bech32m addresses cannot be imported into legacy wallets");
952 : : }
953 [ # # ]: 0 : script = GetScriptForDestination(dest);
954 : 0 : } else {
955 [ # # # # ]: 0 : if (!IsHex(output)) {
956 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid scriptPubKey \"" + output + "\"");
957 : : }
958 [ # # ]: 0 : std::vector<unsigned char> vData(ParseHex(output));
959 : 0 : script = CScript(vData.begin(), vData.end());
960 : 0 : CTxDestination dest;
961 [ # # # # : 0 : if (!ExtractDestination(script, dest) && !internal) {
# # ]
962 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Internal must be set to true for nonstandard scriptPubKey imports.");
963 : : }
964 : 0 : }
965 [ # # ]: 0 : script_pub_keys.emplace(script);
966 : :
967 : : // Parse all arguments
968 [ # # ]: 0 : if (strRedeemScript.size()) {
969 [ # # # # ]: 0 : if (!IsHex(strRedeemScript)) {
970 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid redeem script \"" + strRedeemScript + "\": must be hex string");
971 : : }
972 [ # # ]: 0 : auto parsed_redeemscript = ParseHex(strRedeemScript);
973 [ # # ]: 0 : import_data.redeemscript = std::make_unique<CScript>(parsed_redeemscript.begin(), parsed_redeemscript.end());
974 : 0 : }
975 [ # # ]: 0 : if (witness_script_hex.size()) {
976 [ # # # # ]: 0 : if (!IsHex(witness_script_hex)) {
977 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid witness script \"" + witness_script_hex + "\": must be hex string");
978 : : }
979 [ # # ]: 0 : auto parsed_witnessscript = ParseHex(witness_script_hex);
980 [ # # ]: 0 : import_data.witnessscript = std::make_unique<CScript>(parsed_witnessscript.begin(), parsed_witnessscript.end());
981 : 0 : }
982 [ # # ]: 0 : for (size_t i = 0; i < pubKeys.size(); ++i) {
983 [ # # # # : 0 : CPubKey pubkey = HexToPubKey(pubKeys[i].get_str());
# # ]
984 [ # # # # ]: 0 : pubkey_map.emplace(pubkey.GetID(), pubkey);
985 [ # # # # ]: 0 : ordered_pubkeys.emplace_back(pubkey.GetID(), internal);
986 : : }
987 [ # # ]: 0 : for (size_t i = 0; i < keys.size(); ++i) {
988 [ # # # # ]: 0 : const auto& str = keys[i].get_str();
989 [ # # ]: 0 : CKey key = DecodeSecret(str);
990 [ # # ]: 0 : if (!key.IsValid()) {
991 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key encoding");
992 : : }
993 [ # # ]: 0 : CPubKey pubkey = key.GetPubKey();
994 [ # # ]: 0 : CKeyID id = pubkey.GetID();
995 [ # # ]: 0 : if (pubkey_map.count(id)) {
996 : 0 : pubkey_map.erase(id);
997 : : }
998 [ # # ]: 0 : privkey_map.emplace(id, key);
999 : 0 : }
1000 : :
1001 : :
1002 : : // Verify and process input data
1003 [ # # # # : 0 : have_solving_data = import_data.redeemscript || import_data.witnessscript || pubkey_map.size() || privkey_map.size();
# # # # ]
1004 [ # # ]: 0 : if (have_solving_data) {
1005 : : // Match up data in import_data with the scriptPubKey in script.
1006 [ # # ]: 0 : auto error = RecurseImportData(script, import_data, ScriptContext::TOP);
1007 : :
1008 : : // Verify whether the watchonly option corresponds to the availability of private keys.
1009 : 0 : bool spendable = std::all_of(import_data.used_keys.begin(), import_data.used_keys.end(), [&](const std::pair<CKeyID, bool>& used_key){ return privkey_map.count(used_key.first) > 0; });
1010 [ # # ]: 0 : if (!watchOnly && !spendable) {
1011 [ # # # # ]: 0 : warnings.push_back("Some private keys are missing, outputs will be considered watchonly. If this is intentional, specify the watchonly flag.");
1012 : : }
1013 [ # # ]: 0 : if (watchOnly && spendable) {
1014 [ # # # # ]: 0 : warnings.push_back("All private keys are provided, outputs will be considered spendable. If this is intentional, do not specify the watchonly flag.");
1015 : : }
1016 : :
1017 : : // Check that all required keys for solvability are provided.
1018 [ # # ]: 0 : if (error.empty()) {
1019 [ # # ]: 0 : for (const auto& require_key : import_data.used_keys) {
1020 [ # # ]: 0 : if (!require_key.second) continue; // Not a required key
1021 [ # # # # ]: 0 : if (pubkey_map.count(require_key.first) == 0 && privkey_map.count(require_key.first) == 0) {
1022 [ # # ]: 0 : error = "some required keys are missing";
1023 : : }
1024 : : }
1025 : : }
1026 : :
1027 [ # # ]: 0 : if (!error.empty()) {
1028 [ # # # # : 0 : warnings.push_back("Importing as non-solvable: " + error + ". If this is intentional, don't provide any keys, pubkeys, witnessscript, or redeemscript.");
# # ]
1029 : 0 : import_data = ImportData();
1030 : 0 : pubkey_map.clear();
1031 : 0 : privkey_map.clear();
1032 : 0 : have_solving_data = false;
1033 : : } else {
1034 : : // RecurseImportData() removes any relevant redeemscript/witnessscript from import_data, so we can use that to discover if a superfluous one was provided.
1035 [ # # # # : 0 : if (import_data.redeemscript) warnings.push_back("Ignoring redeemscript as this is not a P2SH script.");
# # ]
1036 [ # # # # : 0 : if (import_data.witnessscript) warnings.push_back("Ignoring witnessscript as this is not a (P2SH-)P2WSH script.");
# # ]
1037 [ # # ]: 0 : for (auto it = privkey_map.begin(); it != privkey_map.end(); ) {
1038 : 0 : auto oldit = it++;
1039 [ # # ]: 0 : if (import_data.used_keys.count(oldit->first) == 0) {
1040 [ # # # # ]: 0 : warnings.push_back("Ignoring irrelevant private key.");
1041 : 0 : privkey_map.erase(oldit);
1042 : : }
1043 : : }
1044 [ # # ]: 0 : for (auto it = pubkey_map.begin(); it != pubkey_map.end(); ) {
1045 : 0 : auto oldit = it++;
1046 : 0 : auto key_data_it = import_data.used_keys.find(oldit->first);
1047 [ # # # # ]: 0 : if (key_data_it == import_data.used_keys.end() || !key_data_it->second) {
1048 [ # # # # : 0 : warnings.push_back("Ignoring public key \"" + HexStr(oldit->first) + "\" as it doesn't appear inside P2PKH or P2WPKH.");
# # # # ]
1049 : 0 : pubkey_map.erase(oldit);
1050 : : }
1051 : : }
1052 : : }
1053 : 0 : }
1054 : :
1055 : 0 : return warnings;
1056 : 0 : }
1057 : :
1058 : 0 : static UniValue ProcessImportDescriptor(ImportData& import_data, std::map<CKeyID, CPubKey>& pubkey_map, std::map<CKeyID, CKey>& privkey_map, std::set<CScript>& script_pub_keys, bool& have_solving_data, const UniValue& data, std::vector<std::pair<CKeyID, bool>>& ordered_pubkeys)
1059 : : {
1060 : 0 : UniValue warnings(UniValue::VARR);
1061 : :
1062 [ # # # # : 0 : const std::string& descriptor = data["desc"].get_str();
# # ]
1063 : 0 : FlatSigningProvider keys;
1064 [ # # ]: 0 : std::string error;
1065 [ # # ]: 0 : auto parsed_descs = Parse(descriptor, keys, error, /* require_checksum = */ true);
1066 [ # # ]: 0 : if (parsed_descs.empty()) {
1067 [ # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
1068 : : }
1069 [ # # # # ]: 0 : if (parsed_descs.at(0)->GetOutputType() == OutputType::BECH32M) {
1070 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Bech32m descriptors cannot be imported into legacy wallets");
1071 : : }
1072 : :
1073 : 0 : std::optional<bool> internal;
1074 [ # # # # ]: 0 : if (data.exists("internal")) {
1075 [ # # ]: 0 : if (parsed_descs.size() > 1) {
1076 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Cannot have multipath descriptor while also specifying \'internal\'");
1077 : : }
1078 [ # # # # : 0 : internal = data["internal"].get_bool();
# # ]
1079 : : }
1080 : :
1081 [ # # # # ]: 0 : have_solving_data = parsed_descs.at(0)->IsSolvable();
1082 [ # # # # : 0 : const bool watch_only = data.exists("watchonly") ? data["watchonly"].get_bool() : false;
# # # # #
# ]
1083 : :
1084 : 0 : int64_t range_start = 0, range_end = 0;
1085 [ # # # # : 0 : if (!parsed_descs.at(0)->IsRange() && data.exists("range")) {
# # # # #
# # # #
# ]
1086 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should not be specified for an un-ranged descriptor");
1087 [ # # # # : 0 : } else if (parsed_descs.at(0)->IsRange()) {
# # ]
1088 [ # # # # ]: 0 : if (!data.exists("range")) {
1089 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Descriptor is ranged, please specify the range");
1090 : : }
1091 [ # # # # : 0 : std::tie(range_start, range_end) = ParseDescriptorRange(data["range"]);
# # ]
1092 : : }
1093 : :
1094 [ # # # # : 0 : const UniValue& priv_keys = data.exists("keys") ? data["keys"].get_array() : UniValue();
# # # # #
# # # ]
1095 : :
1096 [ # # ]: 0 : for (size_t j = 0; j < parsed_descs.size(); ++j) {
1097 [ # # ]: 0 : const auto& parsed_desc = parsed_descs.at(j);
1098 [ # # # # ]: 0 : bool desc_internal = internal.has_value() && internal.value();
1099 [ # # ]: 0 : if (parsed_descs.size() == 2) {
1100 : 0 : desc_internal = j == 1;
1101 [ # # ]: 0 : } else if (parsed_descs.size() > 2) {
1102 [ # # ]: 0 : CHECK_NONFATAL(!desc_internal);
1103 : : }
1104 : : // Expand all descriptors to get public keys and scripts, and private keys if available.
1105 [ # # ]: 0 : for (int i = range_start; i <= range_end; ++i) {
1106 : 0 : FlatSigningProvider out_keys;
1107 : 0 : std::vector<CScript> scripts_temp;
1108 [ # # ]: 0 : parsed_desc->Expand(i, keys, scripts_temp, out_keys);
1109 [ # # ]: 0 : std::copy(scripts_temp.begin(), scripts_temp.end(), std::inserter(script_pub_keys, script_pub_keys.end()));
1110 [ # # ]: 0 : for (const auto& key_pair : out_keys.pubkeys) {
1111 [ # # ]: 0 : ordered_pubkeys.emplace_back(key_pair.first, desc_internal);
1112 : : }
1113 : :
1114 [ # # ]: 0 : for (const auto& x : out_keys.scripts) {
1115 [ # # ]: 0 : import_data.import_scripts.emplace(x.second);
1116 : : }
1117 : :
1118 [ # # ]: 0 : parsed_desc->ExpandPrivate(i, keys, out_keys);
1119 : :
1120 [ # # ]: 0 : std::copy(out_keys.pubkeys.begin(), out_keys.pubkeys.end(), std::inserter(pubkey_map, pubkey_map.end()));
1121 [ # # ]: 0 : std::copy(out_keys.keys.begin(), out_keys.keys.end(), std::inserter(privkey_map, privkey_map.end()));
1122 [ # # ]: 0 : import_data.key_origins.insert(out_keys.origins.begin(), out_keys.origins.end());
1123 : 0 : }
1124 : : }
1125 : :
1126 [ # # ]: 0 : for (size_t i = 0; i < priv_keys.size(); ++i) {
1127 [ # # # # ]: 0 : const auto& str = priv_keys[i].get_str();
1128 [ # # ]: 0 : CKey key = DecodeSecret(str);
1129 [ # # ]: 0 : if (!key.IsValid()) {
1130 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key encoding");
1131 : : }
1132 [ # # ]: 0 : CPubKey pubkey = key.GetPubKey();
1133 [ # # ]: 0 : CKeyID id = pubkey.GetID();
1134 : :
1135 : : // Check if this private key corresponds to a public key from the descriptor
1136 [ # # ]: 0 : if (!pubkey_map.count(id)) {
1137 [ # # # # ]: 0 : warnings.push_back("Ignoring irrelevant private key.");
1138 : : } else {
1139 [ # # ]: 0 : privkey_map.emplace(id, key);
1140 : : }
1141 : 0 : }
1142 : :
1143 : : // Check if all the public keys have corresponding private keys in the import for spendability.
1144 : : // This does not take into account threshold multisigs which could be spendable without all keys.
1145 : : // Thus, threshold multisigs without all keys will be considered not spendable here, even if they are,
1146 : : // perhaps triggering a false warning message. This is consistent with the current wallet IsMine check.
1147 : 0 : bool spendable = std::all_of(pubkey_map.begin(), pubkey_map.end(),
1148 : 0 : [&](const std::pair<CKeyID, CPubKey>& used_key) {
1149 : 0 : return privkey_map.count(used_key.first) > 0;
1150 [ # # # # : 0 : }) && std::all_of(import_data.key_origins.begin(), import_data.key_origins.end(),
# # ]
1151 : 0 : [&](const std::pair<CKeyID, std::pair<CPubKey, KeyOriginInfo>>& entry) {
1152 : 0 : return privkey_map.count(entry.first) > 0;
1153 : 0 : });
1154 [ # # ]: 0 : if (!watch_only && !spendable) {
1155 [ # # # # ]: 0 : warnings.push_back("Some private keys are missing, outputs will be considered watchonly. If this is intentional, specify the watchonly flag.");
1156 : : }
1157 [ # # ]: 0 : if (watch_only && spendable) {
1158 [ # # # # ]: 0 : warnings.push_back("All private keys are provided, outputs will be considered spendable. If this is intentional, do not specify the watchonly flag.");
1159 : : }
1160 : :
1161 : 0 : return warnings;
1162 : 0 : }
1163 : :
1164 : 0 : static UniValue ProcessImport(CWallet& wallet, const UniValue& data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
1165 : : {
1166 : 0 : UniValue warnings(UniValue::VARR);
1167 : 0 : UniValue result(UniValue::VOBJ);
1168 : :
1169 : 0 : try {
1170 [ # # # # : 0 : const bool internal = data.exists("internal") ? data["internal"].get_bool() : false;
# # # # #
# ]
1171 : : // Internal addresses should not have a label
1172 [ # # # # : 0 : if (internal && data.exists("label")) {
# # # # #
# ]
1173 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Internal addresses should not have a label");
1174 : : }
1175 [ # # # # : 0 : const std::string label{LabelFromValue(data["label"])};
# # ]
1176 [ # # # # : 0 : const bool add_keypool = data.exists("keypool") ? data["keypool"].get_bool() : false;
# # # # #
# ]
1177 : :
1178 : : // Add to keypool only works with privkeys disabled
1179 [ # # # # : 0 : if (add_keypool && !wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
# # ]
1180 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Keys can only be imported to the keypool when private keys are disabled");
1181 : : }
1182 : :
1183 : 0 : ImportData import_data;
1184 [ # # ]: 0 : std::map<CKeyID, CPubKey> pubkey_map;
1185 : 0 : std::map<CKeyID, CKey> privkey_map;
1186 [ # # ]: 0 : std::set<CScript> script_pub_keys;
1187 : 0 : std::vector<std::pair<CKeyID, bool>> ordered_pubkeys;
1188 : 0 : bool have_solving_data;
1189 : :
1190 [ # # # # : 0 : if (data.exists("scriptPubKey") && data.exists("desc")) {
# # # # #
# # # # #
# # ]
1191 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Both a descriptor and a scriptPubKey should not be provided.");
1192 [ # # # # ]: 0 : } else if (data.exists("scriptPubKey")) {
1193 [ # # ]: 0 : warnings = ProcessImportLegacy(import_data, pubkey_map, privkey_map, script_pub_keys, have_solving_data, data, ordered_pubkeys);
1194 [ # # # # ]: 0 : } else if (data.exists("desc")) {
1195 [ # # ]: 0 : warnings = ProcessImportDescriptor(import_data, pubkey_map, privkey_map, script_pub_keys, have_solving_data, data, ordered_pubkeys);
1196 : : } else {
1197 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Either a descriptor or scriptPubKey must be provided.");
1198 : : }
1199 : :
1200 : : // If private keys are disabled, abort if private keys are being imported
1201 [ # # # # : 0 : if (wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && !privkey_map.empty()) {
# # ]
1202 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import private keys to a wallet with private keys disabled");
1203 : : }
1204 : :
1205 : : // Check whether we have any work to do
1206 [ # # ]: 0 : for (const CScript& script : script_pub_keys) {
1207 [ # # # # ]: 0 : if (wallet.IsMine(script) & ISMINE_SPENDABLE) {
1208 [ # # # # : 0 : throw JSONRPCError(RPC_WALLET_ERROR, "The wallet already contains the private key for this address or script (\"" + HexStr(script) + "\")");
# # # # ]
1209 : : }
1210 : : }
1211 : :
1212 : : // All good, time to import
1213 [ # # ]: 0 : wallet.MarkDirty();
1214 [ # # # # : 0 : if (!wallet.ImportScripts(import_data.import_scripts, timestamp)) {
# # ]
1215 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding script to wallet");
1216 : : }
1217 [ # # # # ]: 0 : if (!wallet.ImportPrivKeys(privkey_map, timestamp)) {
1218 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding key to wallet");
1219 : : }
1220 [ # # # # ]: 0 : if (!wallet.ImportPubKeys(ordered_pubkeys, pubkey_map, import_data.key_origins, add_keypool, timestamp)) {
1221 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding address to wallet");
1222 : : }
1223 [ # # # # ]: 0 : if (!wallet.ImportScriptPubKeys(label, script_pub_keys, have_solving_data, !internal, timestamp)) {
1224 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error adding address to wallet");
1225 : : }
1226 : :
1227 [ # # # # : 0 : result.pushKV("success", UniValue(true));
# # ]
1228 [ # # ]: 0 : } catch (const UniValue& e) {
1229 [ - - - - : 0 : result.pushKV("success", UniValue(false));
- - ]
1230 [ - - - - : 0 : result.pushKV("error", e);
- - ]
1231 : 0 : } catch (...) {
1232 [ - - - - : 0 : result.pushKV("success", UniValue(false));
- - ]
1233 : :
1234 [ - - - - : 0 : result.pushKV("error", JSONRPCError(RPC_MISC_ERROR, "Missing required fields"));
- - - - ]
1235 [ - - ]: 0 : }
1236 [ # # ]: 0 : PushWarnings(warnings, result);
1237 : 0 : return result;
1238 : 0 : }
1239 : :
1240 : 0 : static int64_t GetImportTimestamp(const UniValue& data, int64_t now)
1241 : : {
1242 [ # # ]: 0 : if (data.exists("timestamp")) {
1243 [ # # ]: 0 : const UniValue& timestamp = data["timestamp"];
1244 [ # # ]: 0 : if (timestamp.isNum()) {
1245 : 0 : return timestamp.getInt<int64_t>();
1246 [ # # # # ]: 0 : } else if (timestamp.isStr() && timestamp.get_str() == "now") {
1247 : : return now;
1248 : : }
1249 [ # # # # : 0 : throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Expected number or \"now\" timestamp value for key. got type %s", uvTypeName(timestamp.type())));
# # ]
1250 : : }
1251 [ # # # # ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, "Missing required timestamp field for key");
1252 : : }
1253 : :
1254 : 0 : RPCHelpMan importmulti()
1255 : : {
1256 : 0 : return RPCHelpMan{"importmulti",
1257 : : "\nImport addresses/scripts (with private or public keys, redeem script (P2SH)), optionally rescanning the blockchain from the earliest creation time of the imported scripts. Requires a new wallet backup.\n"
1258 : : "If an address/script is imported without all of the private keys required to spend from that address, it will be watchonly. The 'watchonly' option must be set to true in this case or a warning will be returned.\n"
1259 : : "Conversely, if all the private keys are provided and the address/script is spendable, the watchonly option must be set to false, or a warning will be returned.\n"
1260 : : "\nNote: This call can take over an hour to complete if rescan is true, during that time, other rpc calls\n"
1261 : : "may report that the imported keys, addresses or scripts exist but related transactions are still missing.\n"
1262 : : "The rescan parameter can be set to false if the key was never used to create transactions. If it is set to false,\n"
1263 : : "but the key was used to create transactions, rescanblockchain needs to be called with the appropriate block range.\n"
1264 : : "Note: Use \"getwalletinfo\" to query the scanning progress.\n"
1265 : : "Note: This command is only compatible with legacy wallets. Use \"importdescriptors\" for descriptor wallets.\n",
1266 : : {
1267 [ # # ]: 0 : {"requests", RPCArg::Type::ARR, RPCArg::Optional::NO, "Data to be imported",
1268 : : {
1269 [ # # ]: 0 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
1270 : : {
1271 [ # # ]: 0 : {"desc", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Descriptor to import. If using descriptor, do not also provide address/scriptPubKey, scripts, or pubkeys"},
1272 [ # # ]: 0 : {"scriptPubKey", RPCArg::Type::STR, RPCArg::Optional::NO, "Type of scriptPubKey (string for script, json for address). Should not be provided if using a descriptor",
1273 [ # # ]: 0 : RPCArgOptions{.type_str={"\"<script>\" | { \"address\":\"<address>\" }", "string / json"}}
1274 : : },
1275 [ # # ]: 0 : {"timestamp", RPCArg::Type::NUM, RPCArg::Optional::NO, "Creation time of the key expressed in " + UNIX_EPOCH_TIME + ",\n"
1276 : : "or the string \"now\" to substitute the current synced blockchain time. The timestamp of the oldest\n"
1277 : : "key will determine how far back blockchain rescans need to begin for missing wallet transactions.\n"
1278 : : "\"now\" can be specified to bypass scanning, for keys which are known to never have been used, and\n"
1279 : : "0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest key\n"
1280 : 0 : "creation time of all keys being imported by the importmulti call will be scanned.",
1281 [ # # ]: 0 : RPCArgOptions{.type_str={"timestamp | \"now\"", "integer / string"}}
1282 : : },
1283 [ # # ]: 0 : {"redeemscript", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Allowed only if the scriptPubKey is a P2SH or P2SH-P2WSH address/scriptPubKey"},
1284 [ # # ]: 0 : {"witnessscript", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Allowed only if the scriptPubKey is a P2SH-P2WSH or P2WSH address/scriptPubKey"},
1285 : 0 : {"pubkeys", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Array of strings giving pubkeys to import. They must occur in P2PKH or P2WPKH scripts. They are not required when the private key is also provided (see the \"keys\" argument).",
1286 : : {
1287 [ # # ]: 0 : {"pubKey", RPCArg::Type::STR, RPCArg::Optional::OMITTED, ""},
1288 : : }
1289 : : },
1290 : 0 : {"keys", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "Array of strings giving private keys to import. The corresponding public keys must occur in the output or redeemscript.",
1291 : : {
1292 [ # # ]: 0 : {"key", RPCArg::Type::STR, RPCArg::Optional::OMITTED, ""},
1293 : : }
1294 : : },
1295 [ # # ]: 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"},
1296 [ # # ]: 0 : {"internal", RPCArg::Type::BOOL, RPCArg::Default{false}, "Stating whether matching outputs should be treated as not incoming payments (also known as change)"},
1297 [ # # ]: 0 : {"watchonly", RPCArg::Type::BOOL, RPCArg::Default{false}, "Stating whether matching outputs should be considered watchonly."},
1298 [ # # ]: 0 : {"label", RPCArg::Type::STR, RPCArg::Default{""}, "Label to assign to the address, only allowed with internal=false"},
1299 [ # # ]: 0 : {"keypool", RPCArg::Type::BOOL, RPCArg::Default{false}, "Stating whether imported public keys should be added to the keypool for when users request new addresses. Only allowed when wallet private keys are disabled"},
1300 : : },
1301 : : },
1302 : : },
1303 [ # # # # ]: 0 : RPCArgOptions{.oneline_description="requests"}},
1304 [ # # ]: 0 : {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
1305 : : {
1306 [ # # ]: 0 : {"rescan", RPCArg::Type::BOOL, RPCArg::Default{true}, "Scan the chain and mempool for wallet transactions after all imports."},
1307 : : },
1308 [ # # # # ]: 0 : RPCArgOptions{.oneline_description="options"}},
1309 : : },
1310 : 0 : RPCResult{
1311 : : RPCResult::Type::ARR, "", "Response is an array with the same size as the input that has the execution result",
1312 : : {
1313 : : {RPCResult::Type::OBJ, "", "",
1314 : : {
1315 : : {RPCResult::Type::BOOL, "success", ""},
1316 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "",
1317 : : {
1318 : : {RPCResult::Type::STR, "", ""},
1319 : : }},
1320 : : {RPCResult::Type::OBJ, "error", /*optional=*/true, "",
1321 : : {
1322 : : {RPCResult::Type::ELISION, "", "JSONRPC error"},
1323 : : }},
1324 : : }},
1325 : : }
1326 [ # # # # : 0 : },
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
1327 : 0 : RPCExamples{
1328 [ # # # # : 0 : HelpExampleCli("importmulti", "'[{ \"scriptPubKey\": { \"address\": \"<my address>\" }, \"timestamp\":1455191478 }, "
# # ]
1329 : 0 : "{ \"scriptPubKey\": { \"address\": \"<my 2nd address>\" }, \"label\": \"example 2\", \"timestamp\": 1455191480 }]'") +
1330 [ # # # # : 0 : HelpExampleCli("importmulti", "'[{ \"scriptPubKey\": { \"address\": \"<my address>\" }, \"timestamp\":1455191478 }]' '{ \"rescan\": false}'")
# # # # ]
1331 [ # # ]: 0 : },
1332 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& mainRequest) -> UniValue
1333 : : {
1334 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(mainRequest);
1335 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
1336 [ # # ]: 0 : CWallet& wallet{*pwallet};
1337 : :
1338 : : // Make sure the results are valid at least up to the most recent block
1339 : : // the user could have gotten from another RPC command prior to now
1340 [ # # ]: 0 : wallet.BlockUntilSyncedToCurrentChain();
1341 : :
1342 [ # # ]: 0 : EnsureLegacyScriptPubKeyMan(*pwallet, true);
1343 : :
1344 [ # # ]: 0 : const UniValue& requests = mainRequest.params[0];
1345 : :
1346 : : //Default options
1347 : 0 : bool fRescan = true;
1348 : :
1349 [ # # # # ]: 0 : if (!mainRequest.params[1].isNull()) {
1350 [ # # ]: 0 : const UniValue& options = mainRequest.params[1];
1351 : :
1352 [ # # # # ]: 0 : if (options.exists("rescan")) {
1353 [ # # # # : 0 : fRescan = options["rescan"].get_bool();
# # ]
1354 : : }
1355 : : }
1356 : :
1357 [ # # ]: 0 : WalletRescanReserver reserver(*pwallet);
1358 [ # # # # ]: 0 : if (fRescan && !reserver.reserve()) {
1359 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
1360 : : }
1361 : :
1362 : 0 : int64_t now = 0;
1363 : 0 : bool fRunScan = false;
1364 : 0 : int64_t nLowestTimestamp = 0;
1365 : 0 : UniValue response(UniValue::VARR);
1366 : 0 : {
1367 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
1368 : :
1369 : : // Check all requests are watchonly
1370 : 0 : bool is_watchonly{true};
1371 [ # # ]: 0 : for (size_t i = 0; i < requests.size(); ++i) {
1372 [ # # ]: 0 : const UniValue& request = requests[i];
1373 [ # # # # : 0 : if (!request.exists("watchonly") || !request["watchonly"].get_bool()) {
# # # # #
# # # # #
# # # # #
# ]
1374 : : is_watchonly = false;
1375 : : break;
1376 : : }
1377 : : }
1378 : : // Wallet does not need to be unlocked if all requests are watchonly
1379 [ # # # # ]: 0 : if (!is_watchonly) EnsureWalletIsUnlocked(wallet);
1380 : :
1381 : : // Verify all timestamps are present before importing any keys.
1382 [ # # # # ]: 0 : CHECK_NONFATAL(pwallet->chain().findBlock(pwallet->GetLastBlockHash(), FoundBlock().time(nLowestTimestamp).mtpTime(now)));
1383 [ # # # # ]: 0 : for (const UniValue& data : requests.getValues()) {
1384 [ # # ]: 0 : GetImportTimestamp(data, now);
1385 : : }
1386 : :
1387 : 0 : const int64_t minimumTimestamp = 1;
1388 : :
1389 [ # # # # ]: 0 : for (const UniValue& data : requests.getValues()) {
1390 [ # # # # ]: 0 : const int64_t timestamp = std::max(GetImportTimestamp(data, now), minimumTimestamp);
1391 [ # # ]: 0 : const UniValue result = ProcessImport(*pwallet, data, timestamp);
1392 [ # # # # ]: 0 : response.push_back(result);
1393 : :
1394 [ # # ]: 0 : if (!fRescan) {
1395 : 0 : continue;
1396 : : }
1397 : :
1398 : : // If at least one request was successful then allow rescan.
1399 [ # # # # : 0 : if (result["success"].get_bool()) {
# # # # ]
1400 : 0 : fRunScan = true;
1401 : : }
1402 : :
1403 : : // Get the lowest timestamp.
1404 [ # # ]: 0 : if (timestamp < nLowestTimestamp) {
1405 : 0 : nLowestTimestamp = timestamp;
1406 : : }
1407 : 0 : }
1408 : 0 : }
1409 [ # # # # ]: 0 : if (fRescan && fRunScan && requests.size()) {
1410 [ # # ]: 0 : int64_t scannedTime = pwallet->RescanFromTime(nLowestTimestamp, reserver, /*update=*/true);
1411 [ # # ]: 0 : pwallet->ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
1412 : :
1413 [ # # ]: 0 : if (pwallet->IsAbortingRescan()) {
1414 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted by user.");
1415 : : }
1416 [ # # ]: 0 : if (scannedTime > nLowestTimestamp) {
1417 [ # # # # ]: 0 : std::vector<UniValue> results = response.getValues();
1418 [ # # ]: 0 : response.clear();
1419 [ # # ]: 0 : response.setArray();
1420 : 0 : size_t i = 0;
1421 [ # # # # ]: 0 : for (const UniValue& request : requests.getValues()) {
1422 : : // If key creation date is within the successfully scanned
1423 : : // range, or if the import result already has an error set, let
1424 : : // the result stand unmodified. Otherwise replace the result
1425 : : // with an error message.
1426 [ # # # # : 0 : if (scannedTime <= GetImportTimestamp(request, now) || results.at(i).exists("error")) {
# # # # #
# # # #
# ]
1427 [ # # # # : 0 : response.push_back(results.at(i));
# # ]
1428 : : } else {
1429 : 0 : UniValue result = UniValue(UniValue::VOBJ);
1430 [ # # # # : 0 : result.pushKV("success", UniValue(false));
# # ]
1431 [ # # # # ]: 0 : result.pushKV(
1432 : : "error",
1433 [ # # ]: 0 : JSONRPCError(
1434 : : RPC_MISC_ERROR,
1435 : 0 : strprintf("Rescan failed for key with creation timestamp %d. There was an error reading a "
1436 : : "block from time %d, which is after or within %d seconds of key creation, and "
1437 : : "could contain transactions pertaining to the key. As a result, transactions "
1438 : : "and coins using this key may not appear in the wallet. This error could be "
1439 : : "caused by pruning or data corruption (see bitcoind log for details) and could "
1440 : : "be dealt with by downloading and rescanning the relevant blocks (see -reindex "
1441 : : "option and rescanblockchain RPC).",
1442 [ # # # # ]: 0 : GetImportTimestamp(request, now), scannedTime - TIMESTAMP_WINDOW - 1, TIMESTAMP_WINDOW)));
1443 [ # # ]: 0 : response.push_back(std::move(result));
1444 : 0 : }
1445 : 0 : ++i;
1446 : : }
1447 : 0 : }
1448 : : }
1449 : :
1450 : 0 : return response;
1451 : 0 : },
1452 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # #
# ]
1453 [ # # # # : 0 : }
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
1454 : :
1455 : 0 : static UniValue ProcessDescriptorImport(CWallet& wallet, const UniValue& data, const int64_t timestamp) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
1456 : : {
1457 : 0 : UniValue warnings(UniValue::VARR);
1458 : 0 : UniValue result(UniValue::VOBJ);
1459 : :
1460 : 0 : try {
1461 [ # # # # ]: 0 : if (!data.exists("desc")) {
1462 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Descriptor not found.");
1463 : : }
1464 : :
1465 [ # # # # : 0 : const std::string& descriptor = data["desc"].get_str();
# # ]
1466 [ # # # # : 0 : const bool active = data.exists("active") ? data["active"].get_bool() : false;
# # # # #
# ]
1467 [ # # # # : 0 : const std::string label{LabelFromValue(data["label"])};
# # ]
1468 : :
1469 : : // Parse descriptor string
1470 : 0 : FlatSigningProvider keys;
1471 [ # # ]: 0 : std::string error;
1472 [ # # ]: 0 : auto parsed_descs = Parse(descriptor, keys, error, /* require_checksum = */ true);
1473 [ # # ]: 0 : if (parsed_descs.empty()) {
1474 [ # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, error);
1475 : : }
1476 : 0 : std::optional<bool> internal;
1477 [ # # # # ]: 0 : if (data.exists("internal")) {
1478 [ # # ]: 0 : if (parsed_descs.size() > 1) {
1479 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Cannot have multipath descriptor while also specifying \'internal\'");
1480 : : }
1481 [ # # # # : 0 : internal = data["internal"].get_bool();
# # ]
1482 : : }
1483 : :
1484 : : // Range check
1485 : 0 : int64_t range_start = 0, range_end = 1, next_index = 0;
1486 [ # # # # : 0 : if (!parsed_descs.at(0)->IsRange() && data.exists("range")) {
# # # # #
# # # #
# ]
1487 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Range should not be specified for an un-ranged descriptor");
1488 [ # # # # : 0 : } else if (parsed_descs.at(0)->IsRange()) {
# # ]
1489 [ # # # # ]: 0 : if (data.exists("range")) {
1490 [ # # # # : 0 : auto range = ParseDescriptorRange(data["range"]);
# # ]
1491 : 0 : range_start = range.first;
1492 : 0 : range_end = range.second + 1; // Specified range end is inclusive, but we need range end as exclusive
1493 : : } else {
1494 [ # # # # ]: 0 : warnings.push_back("Range not given, using default keypool range");
1495 : 0 : range_start = 0;
1496 : 0 : range_end = wallet.m_keypool_size;
1497 : : }
1498 : 0 : next_index = range_start;
1499 : :
1500 [ # # # # ]: 0 : if (data.exists("next_index")) {
1501 [ # # # # : 0 : next_index = data["next_index"].getInt<int64_t>();
# # ]
1502 : : // bound checks
1503 [ # # ]: 0 : if (next_index < range_start || next_index >= range_end) {
1504 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "next_index is out of range");
1505 : : }
1506 : : }
1507 : : }
1508 : :
1509 : : // Active descriptors must be ranged
1510 [ # # # # : 0 : if (active && !parsed_descs.at(0)->IsRange()) {
# # ]
1511 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Active descriptors must be ranged");
1512 : : }
1513 : :
1514 : : // Multipath descriptors should not have a label
1515 [ # # # # : 0 : if (parsed_descs.size() > 1 && data.exists("label")) {
# # # # #
# ]
1516 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Multipath descriptors should not have a label");
1517 : : }
1518 : :
1519 : : // Ranged descriptors should not have a label
1520 [ # # # # : 0 : if (data.exists("range") && data.exists("label")) {
# # # # #
# # # # #
# # ]
1521 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Ranged descriptors should not have a label");
1522 : : }
1523 : :
1524 : : // Internal addresses should not have a label either
1525 [ # # # # : 0 : if (internal && data.exists("label")) {
# # # # #
# ]
1526 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Internal addresses should not have a label");
1527 : : }
1528 : :
1529 : : // Combo descriptor check
1530 [ # # # # : 0 : if (active && !parsed_descs.at(0)->IsSingleType()) {
# # ]
1531 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Combo descriptors cannot be set to active");
1532 : : }
1533 : :
1534 : : // If the wallet disabled private keys, abort if private keys exist
1535 [ # # # # : 0 : if (wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS) && !keys.keys.empty()) {
# # ]
1536 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import private keys to a wallet with private keys disabled");
1537 : : }
1538 : :
1539 [ # # ]: 0 : for (size_t j = 0; j < parsed_descs.size(); ++j) {
1540 [ # # ]: 0 : auto parsed_desc = std::move(parsed_descs[j]);
1541 [ # # # # ]: 0 : bool desc_internal = internal.has_value() && internal.value();
1542 [ # # ]: 0 : if (parsed_descs.size() == 2) {
1543 : 0 : desc_internal = j == 1;
1544 [ # # ]: 0 : } else if (parsed_descs.size() > 2) {
1545 [ # # ]: 0 : CHECK_NONFATAL(!desc_internal);
1546 : : }
1547 : : // Need to ExpandPrivate to check if private keys are available for all pubkeys
1548 : 0 : FlatSigningProvider expand_keys;
1549 : 0 : std::vector<CScript> scripts;
1550 [ # # # # ]: 0 : if (!parsed_desc->Expand(0, keys, scripts, expand_keys)) {
1551 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot expand descriptor. Probably because of hardened derivations without private keys provided");
1552 : : }
1553 [ # # ]: 0 : parsed_desc->ExpandPrivate(0, keys, expand_keys);
1554 : :
1555 : : // Check if all private keys are provided
1556 : 0 : bool have_all_privkeys = !expand_keys.keys.empty();
1557 [ # # ]: 0 : for (const auto& entry : expand_keys.origins) {
1558 : 0 : const CKeyID& key_id = entry.first;
1559 : 0 : CKey key;
1560 [ # # # # ]: 0 : if (!expand_keys.GetKey(key_id, key)) {
1561 : 0 : have_all_privkeys = false;
1562 : 0 : break;
1563 : : }
1564 : 0 : }
1565 : :
1566 : : // If private keys are enabled, check some things.
1567 [ # # # # ]: 0 : if (!wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
1568 [ # # ]: 0 : if (keys.keys.empty()) {
1569 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot import descriptor without private keys to a wallet with private keys enabled");
1570 : : }
1571 [ # # ]: 0 : if (!have_all_privkeys) {
1572 [ # # # # ]: 0 : warnings.push_back("Not all private keys provided. Some wallet functionality may return unexpected errors");
1573 : : }
1574 : : }
1575 : :
1576 [ # # # # ]: 0 : WalletDescriptor w_desc(std::move(parsed_desc), timestamp, range_start, range_end, next_index);
1577 : :
1578 : : // Check if the wallet already contains the descriptor
1579 [ # # ]: 0 : auto existing_spk_manager = wallet.GetDescriptorScriptPubKeyMan(w_desc);
1580 [ # # ]: 0 : if (existing_spk_manager) {
1581 [ # # # # ]: 0 : if (!existing_spk_manager->CanUpdateToWalletDescriptor(w_desc, error)) {
1582 [ # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, error);
1583 : : }
1584 : : }
1585 : :
1586 : : // Add descriptor to the wallet
1587 [ # # ]: 0 : auto spk_manager = wallet.AddWalletDescriptor(w_desc, keys, label, desc_internal);
1588 [ # # ]: 0 : if (spk_manager == nullptr) {
1589 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, strprintf("Could not add descriptor '%s'", descriptor));
1590 : : }
1591 : :
1592 : : // Set descriptor as active if necessary
1593 [ # # ]: 0 : if (active) {
1594 [ # # # # ]: 0 : if (!w_desc.descriptor->GetOutputType()) {
1595 [ # # # # ]: 0 : warnings.push_back("Unknown output type, cannot set descriptor to active.");
1596 : : } else {
1597 [ # # # # : 0 : wallet.AddActiveScriptPubKeyMan(spk_manager->GetID(), *w_desc.descriptor->GetOutputType(), desc_internal);
# # ]
1598 : : }
1599 : : } else {
1600 [ # # # # ]: 0 : if (w_desc.descriptor->GetOutputType()) {
1601 [ # # # # : 0 : wallet.DeactivateScriptPubKeyMan(spk_manager->GetID(), *w_desc.descriptor->GetOutputType(), desc_internal);
# # ]
1602 : : }
1603 : : }
1604 : 0 : }
1605 : :
1606 [ # # # # : 0 : result.pushKV("success", UniValue(true));
# # ]
1607 [ # # ]: 0 : } catch (const UniValue& e) {
1608 [ - - - - : 0 : result.pushKV("success", UniValue(false));
- - ]
1609 [ - - - - : 0 : result.pushKV("error", e);
- - ]
1610 : 0 : }
1611 [ # # ]: 0 : PushWarnings(warnings, result);
1612 : 0 : return result;
1613 : 0 : }
1614 : :
1615 : 0 : RPCHelpMan importdescriptors()
1616 : : {
1617 : 0 : return RPCHelpMan{"importdescriptors",
1618 : : "\nImport descriptors. This will trigger a rescan of the blockchain based on the earliest timestamp of all descriptors being imported. Requires a new wallet backup.\n"
1619 : : "When importing descriptors with multipath key expressions, if the multipath specifier contains exactly two elements, the descriptor produced from the second elements will be imported as an internal descriptor.\n"
1620 : : "\nNote: This call can take over an hour to complete if using an early timestamp; during that time, other rpc calls\n"
1621 : : "may report that the imported keys, addresses or scripts exist but related transactions are still missing.\n"
1622 : : "The rescan is significantly faster if block filters are available (using startup option \"-blockfilterindex=1\").\n",
1623 : : {
1624 [ # # ]: 0 : {"requests", RPCArg::Type::ARR, RPCArg::Optional::NO, "Data to be imported",
1625 : : {
1626 [ # # ]: 0 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
1627 : : {
1628 [ # # ]: 0 : {"desc", RPCArg::Type::STR, RPCArg::Optional::NO, "Descriptor to import."},
1629 [ # # ]: 0 : {"active", RPCArg::Type::BOOL, RPCArg::Default{false}, "Set this descriptor to be the active descriptor for the corresponding output type/externality"},
1630 [ # # ]: 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"},
1631 [ # # ]: 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"},
1632 [ # # ]: 0 : {"timestamp", RPCArg::Type::NUM, RPCArg::Optional::NO, "Time from which to start rescanning the blockchain for this descriptor, in " + UNIX_EPOCH_TIME + "\n"
1633 : : "Use the string \"now\" to substitute the current synced blockchain time.\n"
1634 : : "\"now\" can be specified to bypass scanning, for outputs which are known to never have been used, and\n"
1635 : : "0 can be specified to scan the entire blockchain. Blocks up to 2 hours before the earliest timestamp\n"
1636 : 0 : "of all descriptors being imported will be scanned as well as the mempool.",
1637 [ # # ]: 0 : RPCArgOptions{.type_str={"timestamp | \"now\"", "integer / string"}}
1638 : : },
1639 [ # # ]: 0 : {"internal", RPCArg::Type::BOOL, RPCArg::Default{false}, "Whether matching outputs should be treated as not incoming payments (e.g. change)"},
1640 [ # # ]: 0 : {"label", RPCArg::Type::STR, RPCArg::Default{""}, "Label to assign to the address, only allowed with internal=false. Disabled for ranged descriptors"},
1641 : : },
1642 : : },
1643 : : },
1644 [ # # # # ]: 0 : RPCArgOptions{.oneline_description="requests"}},
1645 : : },
1646 : 0 : RPCResult{
1647 : : RPCResult::Type::ARR, "", "Response is an array with the same size as the input that has the execution result",
1648 : : {
1649 : : {RPCResult::Type::OBJ, "", "",
1650 : : {
1651 : : {RPCResult::Type::BOOL, "success", ""},
1652 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "",
1653 : : {
1654 : : {RPCResult::Type::STR, "", ""},
1655 : : }},
1656 : : {RPCResult::Type::OBJ, "error", /*optional=*/true, "",
1657 : : {
1658 : : {RPCResult::Type::ELISION, "", "JSONRPC error"},
1659 : : }},
1660 : : }},
1661 : : }
1662 [ # # # # : 0 : },
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
1663 : 0 : RPCExamples{
1664 [ # # # # : 0 : HelpExampleCli("importdescriptors", "'[{ \"desc\": \"<my descriptor>\", \"timestamp\":1455191478, \"internal\": true }, "
# # ]
1665 : 0 : "{ \"desc\": \"<my descriptor 2>\", \"label\": \"example 2\", \"timestamp\": 1455191480 }]'") +
1666 [ # # # # : 0 : HelpExampleCli("importdescriptors", "'[{ \"desc\": \"<my descriptor>\", \"timestamp\":1455191478, \"active\": true, \"range\": [0,100], \"label\": \"<my bech32 wallet>\" }]'")
# # # # ]
1667 [ # # ]: 0 : },
1668 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& main_request) -> UniValue
1669 : : {
1670 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(main_request);
1671 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
1672 [ # # ]: 0 : CWallet& wallet{*pwallet};
1673 : :
1674 : : // Make sure the results are valid at least up to the most recent block
1675 : : // the user could have gotten from another RPC command prior to now
1676 [ # # ]: 0 : wallet.BlockUntilSyncedToCurrentChain();
1677 : :
1678 : : // Make sure wallet is a descriptor wallet
1679 [ # # # # ]: 0 : if (!pwallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
1680 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "importdescriptors is not available for non-descriptor wallets");
1681 : : }
1682 : :
1683 : 0 : WalletRescanReserver reserver(*pwallet);
1684 [ # # ]: 0 : if (!reserver.reserve(/*with_passphrase=*/true)) {
1685 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
1686 : : }
1687 : :
1688 : : // Ensure that the wallet is not locked for the remainder of this RPC, as
1689 : : // the passphrase is used to top up the keypool.
1690 [ # # ]: 0 : LOCK(pwallet->m_relock_mutex);
1691 : :
1692 [ # # ]: 0 : const UniValue& requests = main_request.params[0];
1693 : 0 : const int64_t minimum_timestamp = 1;
1694 : 0 : int64_t now = 0;
1695 : 0 : int64_t lowest_timestamp = 0;
1696 : 0 : bool rescan = false;
1697 : 0 : UniValue response(UniValue::VARR);
1698 : 0 : {
1699 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
1700 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
1701 : :
1702 [ # # # # ]: 0 : CHECK_NONFATAL(pwallet->chain().findBlock(pwallet->GetLastBlockHash(), FoundBlock().time(lowest_timestamp).mtpTime(now)));
1703 : :
1704 : : // Get all timestamps and extract the lowest timestamp
1705 [ # # # # ]: 0 : for (const UniValue& request : requests.getValues()) {
1706 : : // This throws an error if "timestamp" doesn't exist
1707 [ # # # # ]: 0 : const int64_t timestamp = std::max(GetImportTimestamp(request, now), minimum_timestamp);
1708 [ # # ]: 0 : const UniValue result = ProcessDescriptorImport(*pwallet, request, timestamp);
1709 [ # # # # ]: 0 : response.push_back(result);
1710 : :
1711 [ # # ]: 0 : if (lowest_timestamp > timestamp ) {
1712 : 0 : lowest_timestamp = timestamp;
1713 : : }
1714 : :
1715 : : // If we know the chain tip, and at least one request was successful then allow rescan
1716 [ # # # # : 0 : if (!rescan && result["success"].get_bool()) {
# # # # #
# # # #
# ]
1717 : 0 : rescan = true;
1718 : : }
1719 : 0 : }
1720 [ # # ]: 0 : pwallet->ConnectScriptPubKeyManNotifiers();
1721 : 0 : }
1722 : :
1723 : : // Rescan the blockchain using the lowest timestamp
1724 [ # # ]: 0 : if (rescan) {
1725 [ # # ]: 0 : int64_t scanned_time = pwallet->RescanFromTime(lowest_timestamp, reserver, /*update=*/true);
1726 [ # # ]: 0 : pwallet->ResubmitWalletTransactions(/*relay=*/false, /*force=*/true);
1727 : :
1728 [ # # ]: 0 : if (pwallet->IsAbortingRescan()) {
1729 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Rescan aborted by user.");
1730 : : }
1731 : :
1732 [ # # ]: 0 : if (scanned_time > lowest_timestamp) {
1733 [ # # # # ]: 0 : std::vector<UniValue> results = response.getValues();
1734 [ # # ]: 0 : response.clear();
1735 [ # # ]: 0 : response.setArray();
1736 : :
1737 : : // Compose the response
1738 [ # # ]: 0 : for (unsigned int i = 0; i < requests.size(); ++i) {
1739 [ # # # # ]: 0 : const UniValue& request = requests.getValues().at(i);
1740 : :
1741 : : // If the descriptor timestamp is within the successfully scanned
1742 : : // range, or if the import result already has an error set, let
1743 : : // the result stand unmodified. Otherwise replace the result
1744 : : // with an error message.
1745 [ # # # # : 0 : if (scanned_time <= GetImportTimestamp(request, now) || results.at(i).exists("error")) {
# # # # #
# # # # #
# # ]
1746 [ # # # # : 0 : response.push_back(results.at(i));
# # ]
1747 : : } else {
1748 : 0 : UniValue result = UniValue(UniValue::VOBJ);
1749 [ # # # # : 0 : result.pushKV("success", UniValue(false));
# # ]
1750 [ # # # # ]: 0 : result.pushKV(
1751 : : "error",
1752 [ # # ]: 0 : JSONRPCError(
1753 : : RPC_MISC_ERROR,
1754 : 0 : strprintf("Rescan failed for descriptor with timestamp %d. There was an error reading a "
1755 : : "block from time %d, which is after or within %d seconds of key creation, and "
1756 : : "could contain transactions pertaining to the desc. As a result, transactions "
1757 : : "and coins using this desc may not appear in the wallet. This error could be "
1758 : : "caused by pruning or data corruption (see bitcoind log for details) and could "
1759 : : "be dealt with by downloading and rescanning the relevant blocks (see -reindex "
1760 : : "option and rescanblockchain RPC).",
1761 [ # # # # ]: 0 : GetImportTimestamp(request, now), scanned_time - TIMESTAMP_WINDOW - 1, TIMESTAMP_WINDOW)));
1762 [ # # ]: 0 : response.push_back(std::move(result));
1763 : 0 : }
1764 : : }
1765 : 0 : }
1766 : : }
1767 : :
1768 : 0 : return response;
1769 [ # # ]: 0 : },
1770 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# ]
1771 [ # # # # : 0 : }
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # ]
1772 : :
1773 : 0 : RPCHelpMan listdescriptors()
1774 : : {
1775 : 0 : return RPCHelpMan{
1776 : : "listdescriptors",
1777 : : "\nList descriptors imported into a descriptor-enabled wallet.\n",
1778 : : {
1779 [ # # ]: 0 : {"private", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show private descriptors."}
1780 : : },
1781 : 0 : RPCResult{RPCResult::Type::OBJ, "", "", {
1782 : : {RPCResult::Type::STR, "wallet_name", "Name of wallet this operation was performed on"},
1783 : : {RPCResult::Type::ARR, "descriptors", "Array of descriptor objects (sorted by descriptor string representation)",
1784 : : {
1785 : : {RPCResult::Type::OBJ, "", "", {
1786 : : {RPCResult::Type::STR, "desc", "Descriptor string representation"},
1787 : : {RPCResult::Type::NUM, "timestamp", "The creation time of the descriptor"},
1788 : : {RPCResult::Type::BOOL, "active", "Whether this descriptor is currently used to generate new addresses"},
1789 : : {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"},
1790 : : {RPCResult::Type::ARR_FIXED, "range", /*optional=*/true, "Defined only for ranged descriptors", {
1791 : : {RPCResult::Type::NUM, "", "Range start inclusive"},
1792 : : {RPCResult::Type::NUM, "", "Range end inclusive"},
1793 : : }},
1794 : : {RPCResult::Type::NUM, "next", /*optional=*/true, "Same as next_index field. Kept for compatibility reason."},
1795 : : {RPCResult::Type::NUM, "next_index", /*optional=*/true, "The next index to generate addresses from; defined only for ranged descriptors"},
1796 : : }},
1797 : : }}
1798 [ # # # # : 0 : }},
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1799 : 0 : RPCExamples{
1800 [ # # # # : 0 : HelpExampleCli("listdescriptors", "") + HelpExampleRpc("listdescriptors", "")
# # # # #
# # # #
# ]
1801 [ # # # # : 0 : + HelpExampleCli("listdescriptors", "true") + HelpExampleRpc("listdescriptors", "true")
# # # # #
# # # # #
# # ]
1802 [ # # ]: 0 : },
1803 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1804 : : {
1805 [ # # ]: 0 : const std::shared_ptr<const CWallet> wallet = GetWalletForJSONRPCRequest(request);
1806 [ # # ]: 0 : if (!wallet) return UniValue::VNULL;
1807 : :
1808 [ # # # # ]: 0 : if (!wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
1809 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "listdescriptors is not available for non-descriptor wallets");
1810 : : }
1811 : :
1812 [ # # # # : 0 : const bool priv = !request.params[0].isNull() && request.params[0].get_bool();
# # # # #
# ]
1813 : 0 : if (priv) {
1814 [ # # ]: 0 : EnsureWalletIsUnlocked(*wallet);
1815 : : }
1816 : :
1817 [ # # ]: 0 : LOCK(wallet->cs_wallet);
1818 : :
1819 [ # # ]: 0 : const auto active_spk_mans = wallet->GetActiveScriptPubKeyMans();
1820 : :
1821 [ # # ]: 0 : struct WalletDescInfo {
1822 : : std::string descriptor;
1823 : : uint64_t creation_time;
1824 : : bool active;
1825 : : std::optional<bool> internal;
1826 : : std::optional<std::pair<int64_t,int64_t>> range;
1827 : : int64_t next_index;
1828 : : };
1829 : :
1830 : 0 : std::vector<WalletDescInfo> wallet_descriptors;
1831 [ # # # # ]: 0 : for (const auto& spk_man : wallet->GetAllScriptPubKeyMans()) {
1832 [ # # ]: 0 : const auto desc_spk_man = dynamic_cast<DescriptorScriptPubKeyMan*>(spk_man);
1833 [ # # ]: 0 : if (!desc_spk_man) {
1834 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Unexpected ScriptPubKey manager type.");
1835 : : }
1836 [ # # ]: 0 : LOCK(desc_spk_man->cs_desc_man);
1837 [ # # ]: 0 : const auto& wallet_descriptor = desc_spk_man->GetWalletDescriptor();
1838 [ # # ]: 0 : std::string descriptor;
1839 [ # # # # ]: 0 : if (!desc_spk_man->GetDescriptorString(descriptor, priv)) {
1840 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Can't get descriptor string.");
1841 : : }
1842 [ # # ]: 0 : const bool is_range = wallet_descriptor.descriptor->IsRange();
1843 : 0 : wallet_descriptors.push_back({
1844 : : descriptor,
1845 : 0 : wallet_descriptor.creation_time,
1846 : 0 : active_spk_mans.count(desc_spk_man) != 0,
1847 [ # # ]: 0 : wallet->IsInternalScriptPubKeyMan(desc_spk_man),
1848 [ # # ]: 0 : is_range ? std::optional(std::make_pair(wallet_descriptor.range_start, wallet_descriptor.range_end)) : std::nullopt,
1849 : 0 : wallet_descriptor.next_index
1850 : : });
1851 [ # # ]: 0 : }
1852 : :
1853 : 0 : std::sort(wallet_descriptors.begin(), wallet_descriptors.end(), [](const auto& a, const auto& b) {
1854 [ # # # # : 0 : return a.descriptor < b.descriptor;
# # # # #
# # # # #
# # # # #
# # # #
# ]
1855 : : });
1856 : :
1857 : 0 : UniValue descriptors(UniValue::VARR);
1858 [ # # ]: 0 : for (const WalletDescInfo& info : wallet_descriptors) {
1859 : 0 : UniValue spk(UniValue::VOBJ);
1860 [ # # # # : 0 : spk.pushKV("desc", info.descriptor);
# # ]
1861 [ # # # # : 0 : spk.pushKV("timestamp", info.creation_time);
# # ]
1862 [ # # # # : 0 : spk.pushKV("active", info.active);
# # ]
1863 [ # # ]: 0 : if (info.internal.has_value()) {
1864 [ # # # # : 0 : spk.pushKV("internal", info.internal.value());
# # ]
1865 : : }
1866 [ # # ]: 0 : if (info.range.has_value()) {
1867 : 0 : UniValue range(UniValue::VARR);
1868 [ # # # # ]: 0 : range.push_back(info.range->first);
1869 [ # # # # ]: 0 : range.push_back(info.range->second - 1);
1870 [ # # # # ]: 0 : spk.pushKV("range", std::move(range));
1871 [ # # # # : 0 : spk.pushKV("next", info.next_index);
# # ]
1872 [ # # # # : 0 : spk.pushKV("next_index", info.next_index);
# # ]
1873 : 0 : }
1874 [ # # ]: 0 : descriptors.push_back(std::move(spk));
1875 : 0 : }
1876 : :
1877 : 0 : UniValue response(UniValue::VOBJ);
1878 [ # # # # : 0 : response.pushKV("wallet_name", wallet->GetName());
# # ]
1879 [ # # # # ]: 0 : response.pushKV("descriptors", std::move(descriptors));
1880 : :
1881 : 0 : return response;
1882 [ # # # # : 0 : },
# # # # ]
1883 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
1884 [ # # # # : 0 : }
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1885 : :
1886 : 0 : RPCHelpMan backupwallet()
1887 : : {
1888 : 0 : return RPCHelpMan{"backupwallet",
1889 : : "\nSafely copies the current wallet file to the specified destination, which can either be a directory or a path with a filename.\n",
1890 : : {
1891 [ # # ]: 0 : {"destination", RPCArg::Type::STR, RPCArg::Optional::NO, "The destination directory or file"},
1892 : : },
1893 [ # # # # : 0 : RPCResult{RPCResult::Type::NONE, "", ""},
# # ]
1894 : 0 : RPCExamples{
1895 [ # # # # : 0 : HelpExampleCli("backupwallet", "\"backup.dat\"")
# # ]
1896 [ # # # # : 0 : + HelpExampleRpc("backupwallet", "\"backup.dat\"")
# # # # ]
1897 [ # # ]: 0 : },
1898 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1899 : : {
1900 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
1901 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
1902 : :
1903 : : // Make sure the results are valid at least up to the most recent block
1904 : : // the user could have gotten from another RPC command prior to now
1905 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
1906 : :
1907 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
1908 : :
1909 [ # # # # : 0 : std::string strDest = request.params[0].get_str();
# # ]
1910 [ # # # # ]: 0 : if (!pwallet->BackupWallet(strDest)) {
1911 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Error: Wallet backup failed!");
1912 : : }
1913 : :
1914 : 0 : return UniValue::VNULL;
1915 [ # # ]: 0 : },
1916 [ # # # # : 0 : };
# # # # #
# # # # #
# # ]
1917 [ # # # # ]: 0 : }
1918 : :
1919 : :
1920 : 0 : RPCHelpMan restorewallet()
1921 : : {
1922 : 0 : return RPCHelpMan{
1923 : : "restorewallet",
1924 : : "\nRestores and loads a wallet from backup.\n"
1925 : : "\nThe rescan is significantly faster if a descriptor wallet is restored"
1926 : : "\nand block filters are available (using startup option \"-blockfilterindex=1\").\n",
1927 : : {
1928 [ # # ]: 0 : {"wallet_name", RPCArg::Type::STR, RPCArg::Optional::NO, "The name that will be applied to the restored wallet"},
1929 [ # # ]: 0 : {"backup_file", RPCArg::Type::STR, RPCArg::Optional::NO, "The backup file that will be used to restore the wallet."},
1930 [ # # ]: 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."},
1931 : : },
1932 : 0 : RPCResult{
1933 : : RPCResult::Type::OBJ, "", "",
1934 : : {
1935 : : {RPCResult::Type::STR, "name", "The wallet name if restored successfully."},
1936 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to restoring and loading the wallet.",
1937 : : {
1938 : : {RPCResult::Type::STR, "", ""},
1939 : : }},
1940 : : }
1941 [ # # # # : 0 : },
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # #
# ]
1942 : 0 : RPCExamples{
1943 [ # # # # : 0 : HelpExampleCli("restorewallet", "\"testwallet\" \"home\\backups\\backup-file.bak\"")
# # ]
1944 [ # # # # : 0 : + HelpExampleRpc("restorewallet", "\"testwallet\" \"home\\backups\\backup-file.bak\"")
# # # # ]
1945 [ # # # # : 0 : + HelpExampleCliNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak\""}, {"load_on_startup", true}})
# # # # #
# # # ]
1946 [ # # # # : 0 : + HelpExampleRpcNamed("restorewallet", {{"wallet_name", "testwallet"}, {"backup_file", "home\\backups\\backup-file.bak\""}, {"load_on_startup", true}})
# # # # #
# # # ]
1947 [ # # ]: 0 : },
1948 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
1949 : : {
1950 : :
1951 : 0 : WalletContext& context = EnsureWalletContext(request.context);
1952 : :
1953 : 0 : auto backup_file = fs::u8path(request.params[1].get_str());
1954 : :
1955 [ # # # # : 0 : std::string wallet_name = request.params[0].get_str();
# # ]
1956 : :
1957 [ # # # # : 0 : std::optional<bool> load_on_start = request.params[2].isNull() ? std::nullopt : std::optional<bool>(request.params[2].get_bool());
# # # # ]
1958 : :
1959 : 0 : DatabaseStatus status;
1960 [ # # ]: 0 : bilingual_str error;
1961 : 0 : std::vector<bilingual_str> warnings;
1962 : :
1963 [ # # ]: 0 : const std::shared_ptr<CWallet> wallet = RestoreWallet(context, backup_file, wallet_name, load_on_start, status, error, warnings);
1964 : :
1965 [ # # # # ]: 0 : HandleWalletError(wallet, status, error);
1966 : :
1967 : 0 : UniValue obj(UniValue::VOBJ);
1968 [ # # # # : 0 : obj.pushKV("name", wallet->GetName());
# # ]
1969 [ # # ]: 0 : PushWarnings(warnings, obj);
1970 : :
1971 [ # # ]: 0 : return obj;
1972 : :
1973 : 0 : },
1974 [ # # # # : 0 : };
# # # # #
# # # # #
# # # # #
# # # #
# ]
1975 [ # # # # : 0 : }
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # # # #
# # ]
1976 : : } // namespace wallet
|
