Branch data Line data Source code
1 : : // Copyright (c) 2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <core_io.h>
9 : : #include <key_io.h>
10 : : #include <rpc/server.h>
11 : : #include <rpc/util.h>
12 : : #include <util/translation.h>
13 : : #include <wallet/context.h>
14 : : #include <wallet/receive.h>
15 : : #include <wallet/rpc/wallet.h>
16 : : #include <wallet/rpc/util.h>
17 : : #include <wallet/wallet.h>
18 : : #include <wallet/walletutil.h>
19 : :
20 : : #include <optional>
21 : :
22 : : #include <univalue.h>
23 : :
24 : :
25 : : namespace wallet {
26 : :
27 : : static const std::map<uint64_t, std::string> WALLET_FLAG_CAVEATS{
28 : : {WALLET_FLAG_AVOID_REUSE,
29 : : "You need to rescan the blockchain in order to correctly mark used "
30 : : "destinations in the past. Until this is done, some destinations may "
31 : : "be considered unused, even if the opposite is the case."},
32 : : };
33 : :
34 : : /** Checks if a CKey is in the given CWallet compressed or otherwise*/
35 : 0 : bool HaveKey(const SigningProvider& wallet, const CKey& key)
36 : : {
37 : 0 : CKey key2;
38 [ # # # # : 0 : key2.Set(key.begin(), key.end(), !key.IsCompressed());
# # ]
39 [ # # # # : 0 : return wallet.HaveKey(key.GetPubKey().GetID()) || wallet.HaveKey(key2.GetPubKey().GetID());
# # # # #
# # # # #
# # ]
40 : 0 : }
41 : :
42 : 1391 : static RPCHelpMan getwalletinfo()
43 : : {
44 : 1391 : return RPCHelpMan{"getwalletinfo",
45 : : "Returns an object containing various wallet state info.\n",
46 : : {},
47 : 0 : RPCResult{
48 : : RPCResult::Type::OBJ, "", "",
49 : : {
50 : : {
51 : : {RPCResult::Type::STR, "walletname", "the wallet name"},
52 : : {RPCResult::Type::NUM, "walletversion", "the wallet version"},
53 : : {RPCResult::Type::STR, "format", "the database format (bdb or sqlite)"},
54 : : {RPCResult::Type::STR_AMOUNT, "balance", "DEPRECATED. Identical to getbalances().mine.trusted"},
55 : : {RPCResult::Type::STR_AMOUNT, "unconfirmed_balance", "DEPRECATED. Identical to getbalances().mine.untrusted_pending"},
56 : : {RPCResult::Type::STR_AMOUNT, "immature_balance", "DEPRECATED. Identical to getbalances().mine.immature"},
57 : : {RPCResult::Type::NUM, "txcount", "the total number of transactions in the wallet"},
58 [ + - ]: 2782 : {RPCResult::Type::NUM_TIME, "keypoololdest", /*optional=*/true, "the " + UNIX_EPOCH_TIME + " of the oldest pre-generated key in the key pool. Legacy wallets only."},
59 : : {RPCResult::Type::NUM, "keypoolsize", "how many new keys are pre-generated (only counts external keys)"},
60 : : {RPCResult::Type::NUM, "keypoolsize_hd_internal", /*optional=*/true, "how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)"},
61 [ + - ]: 2782 : {RPCResult::Type::NUM_TIME, "unlocked_until", /*optional=*/true, "the " + UNIX_EPOCH_TIME + " until which the wallet is unlocked for transfers, or 0 if the wallet is locked (only present for passphrase-encrypted wallets)"},
62 [ + - ]: 2782 : {RPCResult::Type::STR_AMOUNT, "paytxfee", "the transaction fee configuration, set in " + CURRENCY_UNIT + "/kvB"},
63 : : {RPCResult::Type::STR_HEX, "hdseedid", /*optional=*/true, "the Hash160 of the HD seed (only present when HD is enabled)"},
64 : : {RPCResult::Type::BOOL, "private_keys_enabled", "false if privatekeys are disabled for this wallet (enforced watch-only wallet)"},
65 : : {RPCResult::Type::BOOL, "avoid_reuse", "whether this wallet tracks clean/dirty coins in terms of reuse"},
66 : : {RPCResult::Type::OBJ, "scanning", "current scanning details, or false if no scan is in progress",
67 : : {
68 : : {RPCResult::Type::NUM, "duration", "elapsed seconds since scan start"},
69 : : {RPCResult::Type::NUM, "progress", "scanning progress percentage [0.0, 1.0]"},
70 : : }, /*skip_type_check=*/true},
71 : : {RPCResult::Type::BOOL, "descriptors", "whether this wallet uses descriptors for output script management"},
72 : : {RPCResult::Type::BOOL, "external_signer", "whether this wallet is configured to use an external signer such as a hardware wallet"},
73 : : {RPCResult::Type::BOOL, "blank", "Whether this wallet intentionally does not contain any keys, scripts, or descriptors"},
74 : : {RPCResult::Type::NUM_TIME, "birthtime", /*optional=*/true, "The start time for blocks scanning. It could be modified by (re)importing any descriptor with an earlier timestamp."},
75 : : RESULT_LAST_PROCESSED_BLOCK,
76 : : }},
77 [ + - + - : 45903 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ + + + -
- - - ]
78 : 1391 : RPCExamples{
79 [ + - + - : 2782 : HelpExampleCli("getwalletinfo", "")
+ - ]
80 [ + - + - : 5564 : + HelpExampleRpc("getwalletinfo", "")
+ - + - ]
81 [ + - ]: 1391 : },
82 : 591 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
83 : : {
84 [ - + ]: 591 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
85 [ - + ]: 569 : if (!pwallet) return UniValue::VNULL;
86 : :
87 : : // Make sure the results are valid at least up to the most recent block
88 : : // the user could have gotten from another RPC command prior to now
89 [ + - ]: 569 : pwallet->BlockUntilSyncedToCurrentChain();
90 : :
91 [ + - ]: 569 : LOCK(pwallet->cs_wallet);
92 : :
93 : 569 : UniValue obj(UniValue::VOBJ);
94 : :
95 [ + - ]: 569 : size_t kpExternalSize = pwallet->KeypoolCountExternalKeys();
96 [ + - ]: 569 : const auto bal = GetBalance(*pwallet);
97 [ + - + - : 1138 : obj.pushKV("walletname", pwallet->GetName());
+ - ]
98 [ + - + - : 1138 : obj.pushKV("walletversion", pwallet->GetVersion());
+ - + - ]
99 [ + - + - : 1138 : obj.pushKV("format", pwallet->GetDatabase().Format());
+ - + - ]
100 [ + - + - : 1138 : obj.pushKV("balance", ValueFromAmount(bal.m_mine_trusted));
+ - ]
101 [ + - + - : 1138 : obj.pushKV("unconfirmed_balance", ValueFromAmount(bal.m_mine_untrusted_pending));
+ - ]
102 [ + - + - : 1138 : obj.pushKV("immature_balance", ValueFromAmount(bal.m_mine_immature));
+ - ]
103 [ + - + - : 1138 : obj.pushKV("txcount", (int)pwallet->mapWallet.size());
+ - ]
104 [ + - ]: 569 : const auto kp_oldest = pwallet->GetOldestKeyPoolTime();
105 [ - + ]: 569 : if (kp_oldest.has_value()) {
106 [ # # # # : 0 : obj.pushKV("keypoololdest", kp_oldest.value());
# # ]
107 : : }
108 [ + - + - : 1138 : obj.pushKV("keypoolsize", (int64_t)kpExternalSize);
+ - ]
109 : :
110 [ + - ]: 569 : LegacyScriptPubKeyMan* spk_man = pwallet->GetLegacyScriptPubKeyMan();
111 [ - + ]: 569 : if (spk_man) {
112 : 0 : CKeyID seed_id = spk_man->GetHDChain().seed_id;
113 [ # # ]: 0 : if (!seed_id.IsNull()) {
114 [ # # # # : 0 : obj.pushKV("hdseedid", seed_id.GetHex());
# # # # ]
115 : : }
116 : : }
117 : :
118 [ + - + - ]: 569 : if (pwallet->CanSupportFeature(FEATURE_HD_SPLIT)) {
119 [ + - + - : 1138 : obj.pushKV("keypoolsize_hd_internal", (int64_t)(pwallet->GetKeyPoolSize() - kpExternalSize));
+ - + - ]
120 : : }
121 [ + - + + ]: 569 : if (pwallet->IsCrypted()) {
122 [ + - + - : 48 : obj.pushKV("unlocked_until", pwallet->nRelockTime);
+ - ]
123 : : }
124 [ + - + - : 1138 : obj.pushKV("paytxfee", ValueFromAmount(pwallet->m_pay_tx_fee.GetFeePerK()));
+ - ]
125 [ + - + - : 1138 : obj.pushKV("private_keys_enabled", !pwallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS));
+ - + - ]
126 [ + - + - : 1138 : obj.pushKV("avoid_reuse", pwallet->IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE));
+ - + - ]
127 [ - + ]: 569 : if (pwallet->IsScanning()) {
128 : 0 : UniValue scanning(UniValue::VOBJ);
129 [ # # # # : 0 : scanning.pushKV("duration", Ticks<std::chrono::seconds>(pwallet->ScanningDuration()));
# # ]
130 [ # # # # : 0 : scanning.pushKV("progress", pwallet->ScanningProgress());
# # ]
131 [ # # # # ]: 0 : obj.pushKV("scanning", std::move(scanning));
132 : 0 : } else {
133 [ + - + - : 1138 : obj.pushKV("scanning", false);
+ - ]
134 : : }
135 [ + - + - : 1138 : obj.pushKV("descriptors", pwallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
+ - + - ]
136 [ + - + - : 1138 : obj.pushKV("external_signer", pwallet->IsWalletFlagSet(WALLET_FLAG_EXTERNAL_SIGNER));
+ - + - ]
137 [ + - + - : 1138 : obj.pushKV("blank", pwallet->IsWalletFlagSet(WALLET_FLAG_BLANK_WALLET));
+ - + - ]
138 [ + + ]: 569 : if (int64_t birthtime = pwallet->GetBirthTime(); birthtime != UNKNOWN_TIME) {
139 [ + - + - : 1024 : obj.pushKV("birthtime", birthtime);
+ - ]
140 : : }
141 : :
142 [ + - ]: 569 : AppendLastProcessedBlock(obj, *pwallet);
143 : 569 : return obj;
144 [ + - ]: 1707 : },
145 [ + - + - : 8346 : };
+ - + - ]
146 [ + - + - : 31993 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - -
- - - ]
147 : :
148 : 810 : static RPCHelpMan listwalletdir()
149 : : {
150 : 810 : return RPCHelpMan{"listwalletdir",
151 : : "Returns a list of wallets in the wallet directory.\n",
152 : : {},
153 : 0 : RPCResult{
154 : : RPCResult::Type::OBJ, "", "",
155 : : {
156 : : {RPCResult::Type::ARR, "wallets", "",
157 : : {
158 : : {RPCResult::Type::OBJ, "", "",
159 : : {
160 : : {RPCResult::Type::STR, "name", "The wallet name"},
161 : : }},
162 : : }},
163 : : }
164 [ + - + - : 5670 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
+ + + - -
- - - - ]
165 : 810 : RPCExamples{
166 [ + - + - : 1620 : HelpExampleCli("listwalletdir", "")
+ - ]
167 [ + - + - : 3240 : + HelpExampleRpc("listwalletdir", "")
+ - + - ]
168 [ + - ]: 810 : },
169 : 10 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
170 : : {
171 : 10 : UniValue wallets(UniValue::VARR);
172 [ + - + - : 89 : for (const auto& [path, _] : ListDatabases(GetWalletDir())) {
+ + ]
173 : 69 : UniValue wallet(UniValue::VOBJ);
174 [ + - + - : 138 : wallet.pushKV("name", path.utf8string());
+ - + - ]
175 [ + - ]: 69 : wallets.push_back(std::move(wallet));
176 : 79 : }
177 : :
178 : 10 : UniValue result(UniValue::VOBJ);
179 [ + - + - ]: 20 : result.pushKV("wallets", std::move(wallets));
180 : 10 : return result;
181 : 10 : },
182 [ + - + - : 4860 : };
+ - + - ]
183 [ + - + - : 3240 : }
+ - + - ]
184 : :
185 : 878 : static RPCHelpMan listwallets()
186 : : {
187 : 878 : return RPCHelpMan{"listwallets",
188 : : "Returns a list of currently loaded wallets.\n"
189 : : "For full information on the wallet, use \"getwalletinfo\"\n",
190 : : {},
191 : 0 : RPCResult{
192 : : RPCResult::Type::ARR, "", "",
193 : : {
194 : : {RPCResult::Type::STR, "walletname", "the wallet name"},
195 : : }
196 [ + - + - : 2634 : },
+ - + - +
- + - + -
+ + - - ]
197 : 878 : RPCExamples{
198 [ + - + - : 1756 : HelpExampleCli("listwallets", "")
+ - ]
199 [ + - + - : 3512 : + HelpExampleRpc("listwallets", "")
+ - + - ]
200 [ + - ]: 878 : },
201 : 78 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
202 : : {
203 : 78 : UniValue obj(UniValue::VARR);
204 : :
205 [ + - ]: 78 : WalletContext& context = EnsureWalletContext(request.context);
206 [ + - + + ]: 545 : for (const std::shared_ptr<CWallet>& wallet : GetWallets(context)) {
207 [ + - ]: 467 : LOCK(wallet->cs_wallet);
208 [ + - + - : 467 : obj.push_back(wallet->GetName());
+ - ]
209 : 545 : }
210 : :
211 : 78 : return obj;
212 : 0 : },
213 [ + - + - : 5268 : };
+ - + - ]
214 [ + - + - ]: 1756 : }
215 : :
216 : 951 : static RPCHelpMan loadwallet()
217 : : {
218 : 951 : return RPCHelpMan{"loadwallet",
219 : : "\nLoads a wallet from a wallet file or directory."
220 : : "\nNote that all wallet command-line options used when starting bitcoind will be"
221 : : "\napplied to the new wallet.\n",
222 : : {
223 [ + - ]: 951 : {"filename", RPCArg::Type::STR, RPCArg::Optional::NO, "The path to the directory of the wallet to be loaded, either absolute or relative to the \"wallets\" directory. The \"wallets\" directory is set by the -walletdir option and defaults to the \"wallets\" folder within the data directory."},
224 [ + - ]: 951 : {"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."},
225 : : },
226 : 0 : RPCResult{
227 : : RPCResult::Type::OBJ, "", "",
228 : : {
229 : : {RPCResult::Type::STR, "name", "The wallet name if loaded successfully."},
230 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to loading the wallet.",
231 : : {
232 : : {RPCResult::Type::STR, "", ""},
233 : : }},
234 : : }
235 [ + - + - : 5706 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
+ - - -
- ]
236 : 951 : RPCExamples{
237 : : "\nLoad wallet from the wallet dir:\n"
238 [ + - + - : 1902 : + HelpExampleCli("loadwallet", "\"walletname\"")
+ - + - ]
239 [ + - + - : 3804 : + HelpExampleRpc("loadwallet", "\"walletname\"")
+ - + - ]
240 : 951 : + "\nLoad wallet using absolute path (Unix):\n"
241 [ + - + - : 3804 : + HelpExampleCli("loadwallet", "\"/path/to/walletname/\"")
+ - + - ]
242 [ + - + - : 3804 : + HelpExampleRpc("loadwallet", "\"/path/to/walletname/\"")
+ - + - ]
243 : 951 : + "\nLoad wallet using absolute path (Windows):\n"
244 [ + - + - : 3804 : + HelpExampleCli("loadwallet", "\"DriveLetter:\\path\\to\\walletname\\\"")
+ - + - ]
245 [ + - + - : 3804 : + HelpExampleRpc("loadwallet", "\"DriveLetter:\\path\\to\\walletname\\\"")
+ - + - ]
246 [ + - ]: 951 : },
247 : 151 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
248 : : {
249 : 151 : WalletContext& context = EnsureWalletContext(request.context);
250 : 151 : const std::string name(request.params[0].get_str());
251 : :
252 [ + - ]: 151 : DatabaseOptions options;
253 : 151 : DatabaseStatus status;
254 [ + - ]: 151 : ReadDatabaseArgs(*context.args, options);
255 : 151 : options.require_existing = true;
256 [ + - ]: 151 : bilingual_str error;
257 : 151 : std::vector<bilingual_str> warnings;
258 [ + - + + : 151 : std::optional<bool> load_on_start = request.params[1].isNull() ? std::nullopt : std::optional<bool>(request.params[1].get_bool());
+ - + - ]
259 : :
260 : 151 : {
261 [ + - ]: 151 : LOCK(context.wallets_mutex);
262 [ + + - + : 475 : if (std::any_of(context.wallets.begin(), context.wallets.end(), [&name](const auto& wallet) { return wallet->GetName() == name; })) {
- + - + -
+ - + - +
+ + ]
263 [ + - + - ]: 6 : throw JSONRPCError(RPC_WALLET_ALREADY_LOADED, "Wallet \"" + name + "\" is already loaded.");
264 : : }
265 : 2 : }
266 : :
267 [ + - ]: 149 : std::shared_ptr<CWallet> const wallet = LoadWallet(context, name, load_on_start, options, status, error, warnings);
268 : :
269 [ + + + + ]: 298 : HandleWalletError(wallet, status, error);
270 : :
271 : 134 : UniValue obj(UniValue::VOBJ);
272 [ + - + - : 268 : obj.pushKV("name", wallet->GetName());
+ - ]
273 [ + - ]: 134 : PushWarnings(warnings, obj);
274 : :
275 [ + - ]: 134 : return obj;
276 : 319 : },
277 [ + - + - : 11412 : };
+ - + - +
- + - + -
+ - + + -
- ]
278 [ + - + - : 8559 : }
+ - + - +
- + - + -
- - - - ]
279 : :
280 : 808 : static RPCHelpMan setwalletflag()
281 : : {
282 : 808 : std::string flags;
283 [ + + ]: 6464 : for (auto& it : WALLET_FLAG_MAP)
284 [ + + ]: 5656 : if (it.second & MUTABLE_WALLET_FLAGS)
285 [ - + + - ]: 1616 : flags += (flags == "" ? "" : ", ") + it.first;
286 : :
287 [ + - ]: 808 : return RPCHelpMan{"setwalletflag",
288 : : "\nChange the state of the given wallet flag for a wallet.\n",
289 : : {
290 [ + - ]: 1616 : {"flag", RPCArg::Type::STR, RPCArg::Optional::NO, "The name of the flag to change. Current available flags: " + flags},
291 [ + - ]: 1616 : {"value", RPCArg::Type::BOOL, RPCArg::Default{true}, "The new state."},
292 : : },
293 : 0 : RPCResult{
294 : : RPCResult::Type::OBJ, "", "",
295 : : {
296 : : {RPCResult::Type::STR, "flag_name", "The name of the flag that was modified"},
297 : : {RPCResult::Type::BOOL, "flag_state", "The new state of the flag"},
298 : : {RPCResult::Type::STR, "warnings", /*optional=*/true, "Any warnings associated with the change"},
299 : : }
300 [ + - + - : 4040 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + -
- ]
301 : 808 : RPCExamples{
302 [ + - + - : 1616 : HelpExampleCli("setwalletflag", "avoid_reuse")
+ - ]
303 [ + - + - : 3232 : + HelpExampleRpc("setwalletflag", "\"avoid_reuse\"")
+ - + - ]
304 [ + - ]: 808 : },
305 : 8 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
306 : : {
307 : 8 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
308 [ - + ]: 8 : if (!pwallet) return UniValue::VNULL;
309 : :
310 [ + - + - : 8 : std::string flag_str = request.params[0].get_str();
+ - ]
311 [ + - + + : 8 : bool value = request.params[1].isNull() || request.params[1].get_bool();
+ - + - +
+ ]
312 : :
313 [ + + ]: 8 : if (!WALLET_FLAG_MAP.count(flag_str)) {
314 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Unknown wallet flag: %s", flag_str));
315 : : }
316 : :
317 [ + - ]: 7 : auto flag = WALLET_FLAG_MAP.at(flag_str);
318 : :
319 [ + + ]: 7 : if (!(flag & MUTABLE_WALLET_FLAGS)) {
320 [ + - + - ]: 6 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Wallet flag is immutable: %s", flag_str));
321 : : }
322 : :
323 : 4 : UniValue res(UniValue::VOBJ);
324 : :
325 [ + - + + ]: 4 : if (pwallet->IsWalletFlagSet(flag) == value) {
326 [ + + + - : 5 : throw JSONRPCError(RPC_INVALID_PARAMETER, strprintf("Wallet flag is already set to %s: %s", value ? "true" : "false", flag_str));
+ - ]
327 : : }
328 : :
329 [ + - + - : 4 : res.pushKV("flag_name", flag_str);
+ - ]
330 [ + - + - : 4 : res.pushKV("flag_state", value);
+ - ]
331 : :
332 [ + + ]: 2 : if (value) {
333 [ + - ]: 1 : pwallet->SetWalletFlag(flag);
334 : : } else {
335 [ + - ]: 1 : pwallet->UnsetWalletFlag(flag);
336 : : }
337 : :
338 [ + - + + : 2 : if (flag && value && WALLET_FLAG_CAVEATS.count(flag)) {
+ - ]
339 [ + - + - : 2 : res.pushKV("warnings", WALLET_FLAG_CAVEATS.at(flag));
+ - + - ]
340 : : }
341 : :
342 : 2 : return res;
343 : 12 : },
344 [ + - + - : 11312 : };
+ - + - +
- + - + -
+ - + - +
+ - - ]
345 [ + - + - : 8080 : }
+ - + - +
- + - + -
- - - - ]
346 : :
347 : 1304 : static RPCHelpMan createwallet()
348 : : {
349 : 1304 : return RPCHelpMan{
350 : : "createwallet",
351 : : "\nCreates and loads a new wallet.\n",
352 : : {
353 [ + - ]: 1304 : {"wallet_name", RPCArg::Type::STR, RPCArg::Optional::NO, "The name for the new wallet. If this is a path, the wallet will be created at the path location."},
354 [ + - ]: 2608 : {"disable_private_keys", RPCArg::Type::BOOL, RPCArg::Default{false}, "Disable the possibility of private keys (only watchonlys are possible in this mode)."},
355 [ + - ]: 2608 : {"blank", RPCArg::Type::BOOL, RPCArg::Default{false}, "Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed."},
356 [ + - ]: 1304 : {"passphrase", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Encrypt the wallet with this passphrase."},
357 [ + - ]: 2608 : {"avoid_reuse", RPCArg::Type::BOOL, RPCArg::Default{false}, "Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind."},
358 [ + - ]: 2608 : {"descriptors", RPCArg::Type::BOOL, RPCArg::Default{true}, "Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation."
359 : : " Setting to \"false\" will create a legacy wallet; This is only possible with the -deprecatedrpc=create_bdb setting because, the legacy wallet type is being deprecated and"
360 : : " support for creating and opening legacy wallets will be removed in the future."},
361 [ + - ]: 1304 : {"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."},
362 [ + - ]: 2608 : {"external_signer", RPCArg::Type::BOOL, RPCArg::Default{false}, "Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true."},
363 : : },
364 : 0 : RPCResult{
365 : : RPCResult::Type::OBJ, "", "",
366 : : {
367 : : {RPCResult::Type::STR, "name", "The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path."},
368 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to creating and loading the wallet.",
369 : : {
370 : : {RPCResult::Type::STR, "", ""},
371 : : }},
372 : : }
373 [ + - + - : 7824 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
+ - - -
- ]
374 : 1304 : RPCExamples{
375 [ + - + - : 2608 : HelpExampleCli("createwallet", "\"testwallet\"")
+ - ]
376 [ + - + - : 5216 : + HelpExampleRpc("createwallet", "\"testwallet\"")
+ - + - ]
377 [ + - + - : 10432 : + HelpExampleCliNamed("createwallet", {{"wallet_name", "descriptors"}, {"avoid_reuse", true}, {"descriptors", true}, {"load_on_startup", true}})
+ - + - +
+ - - ]
378 [ + - + - : 10432 : + HelpExampleRpcNamed("createwallet", {{"wallet_name", "descriptors"}, {"avoid_reuse", true}, {"descriptors", true}, {"load_on_startup", true}})
+ - + - +
+ - - ]
379 [ + - ]: 1304 : },
380 : 504 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
381 : : {
382 : 504 : WalletContext& context = EnsureWalletContext(request.context);
383 : 504 : uint64_t flags = 0;
384 [ + + + + ]: 504 : if (!request.params[1].isNull() && request.params[1].get_bool()) {
385 : : flags |= WALLET_FLAG_DISABLE_PRIVATE_KEYS;
386 : : }
387 : :
388 [ + + + + ]: 504 : if (!request.params[2].isNull() && request.params[2].get_bool()) {
389 : 163 : flags |= WALLET_FLAG_BLANK_WALLET;
390 : : }
391 [ + - ]: 504 : SecureString passphrase;
392 [ + - ]: 504 : passphrase.reserve(100);
393 : 504 : std::vector<bilingual_str> warnings;
394 [ + - + - ]: 504 : if (!request.params[3].isNull()) {
395 [ + - + - : 504 : passphrase = std::string_view{request.params[3].get_str()};
+ - ]
396 [ + + ]: 504 : if (passphrase.empty()) {
397 : : // Empty string means unencrypted
398 [ + - + - : 984 : warnings.emplace_back(Untranslated("Empty string given as passphrase, wallet will not be encrypted."));
+ - ]
399 : : }
400 : : }
401 : :
402 [ + - + + : 504 : if (!request.params[4].isNull() && request.params[4].get_bool()) {
+ - + - +
+ ]
403 : 3 : flags |= WALLET_FLAG_AVOID_REUSE;
404 : : }
405 [ + - + + ]: 504 : if (self.Arg<bool>("descriptors")) {
406 : 503 : flags |= WALLET_FLAG_DESCRIPTORS;
407 : : } else {
408 [ + - + - : 1 : if (!context.chain->rpcEnableDeprecated("create_bdb")) {
- + ]
409 [ # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "BDB wallet creation is deprecated and will be removed in a future release."
410 [ # # # # ]: 0 : " In this release it can be re-enabled temporarily with the -deprecatedrpc=create_bdb setting.");
411 : : }
412 : : }
413 [ + - + + : 504 : if (!request.params[7].isNull() && request.params[7].get_bool()) {
+ - + - +
+ ]
414 : : #ifdef ENABLE_EXTERNAL_SIGNER
415 : 5 : flags |= WALLET_FLAG_EXTERNAL_SIGNER;
416 : : #else
417 : : throw JSONRPCError(RPC_WALLET_ERROR, "Compiled without external signing support (required for external signing)");
418 : : #endif
419 : : }
420 : :
421 : : #ifndef USE_BDB
422 [ + + ]: 504 : if (!(flags & WALLET_FLAG_DESCRIPTORS)) {
423 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, "Compiled without bdb support (required for legacy wallets)");
424 : : }
425 : : #endif
426 : :
427 [ + - ]: 503 : DatabaseOptions options;
428 : 503 : DatabaseStatus status;
429 [ + - ]: 503 : ReadDatabaseArgs(*context.args, options);
430 : 503 : options.require_create = true;
431 : 503 : options.create_flags = flags;
432 [ + - ]: 503 : options.create_passphrase = passphrase;
433 [ + - ]: 503 : bilingual_str error;
434 [ + - + + : 503 : std::optional<bool> load_on_start = request.params[6].isNull() ? std::nullopt : std::optional<bool>(request.params[6].get_bool());
+ - + - ]
435 [ + - + - : 503 : const std::shared_ptr<CWallet> wallet = CreateWallet(context, request.params[0].get_str(), load_on_start, options, status, error, warnings);
+ + ]
436 [ + + ]: 501 : if (!wallet) {
437 [ + - ]: 9 : RPCErrorCode code = status == DatabaseStatus::FAILED_ENCRYPT ? RPC_WALLET_ENCRYPTION_FAILED : RPC_WALLET_ERROR;
438 [ + - ]: 9 : throw JSONRPCError(code, error.original);
439 : : }
440 : :
441 : 492 : UniValue obj(UniValue::VOBJ);
442 [ + - + - : 984 : obj.pushKV("name", wallet->GetName());
+ - ]
443 [ + - ]: 492 : PushWarnings(warnings, obj);
444 : :
445 [ + - ]: 492 : return obj;
446 : 1016 : },
447 [ + - + - : 52160 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + + -
- ]
448 [ + - + - : 29992 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
- - - - -
- ]
449 : :
450 : 1080 : static RPCHelpMan unloadwallet()
451 : : {
452 : 1080 : return RPCHelpMan{"unloadwallet",
453 : : "Unloads the wallet referenced by the request endpoint, otherwise unloads the wallet specified in the argument.\n"
454 : : "Specifying the wallet name on a wallet endpoint is invalid.",
455 : : {
456 [ + - ]: 2160 : {"wallet_name", RPCArg::Type::STR, RPCArg::DefaultHint{"the wallet name from the RPC endpoint"}, "The name of the wallet to unload. If provided both here and in the RPC endpoint, the two must be identical."},
457 [ + - ]: 1080 : {"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."},
458 : : },
459 : 0 : RPCResult{RPCResult::Type::OBJ, "", "", {
460 : : {RPCResult::Type::ARR, "warnings", /*optional=*/true, "Warning messages, if any, related to unloading the wallet.",
461 : : {
462 : : {RPCResult::Type::STR, "", ""},
463 : : }},
464 [ + - + - : 5400 : }},
+ - + - +
- + - + -
+ - + - +
- + + + +
- - - - ]
465 : 1080 : RPCExamples{
466 [ + - + - : 2160 : HelpExampleCli("unloadwallet", "wallet_name")
+ - ]
467 [ + - + - : 4320 : + HelpExampleRpc("unloadwallet", "wallet_name")
+ - + - ]
468 [ + - ]: 1080 : },
469 : 280 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
470 : : {
471 [ + - ]: 280 : std::string wallet_name;
472 [ + - + + ]: 280 : if (GetWalletNameFromJSONRPCRequest(request, wallet_name)) {
473 [ + - + + : 181 : if (!(request.params[0].isNull() || request.params[0].get_str() == wallet_name)) {
+ - + - +
+ ]
474 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_PARAMETER, "RPC endpoint wallet and wallet_name parameter specify different wallets");
475 : : }
476 : : } else {
477 [ + - + + : 99 : wallet_name = request.params[0].get_str();
+ - ]
478 : : }
479 : :
480 [ + - ]: 276 : WalletContext& context = EnsureWalletContext(request.context);
481 [ + - ]: 276 : std::shared_ptr<CWallet> wallet = GetWallet(context, wallet_name);
482 [ + + ]: 276 : if (!wallet) {
483 [ + - + - ]: 8 : throw JSONRPCError(RPC_WALLET_NOT_FOUND, "Requested wallet does not exist or is not loaded");
484 : : }
485 : :
486 : 272 : std::vector<bilingual_str> warnings;
487 : 272 : {
488 : 272 : WalletRescanReserver reserver(*wallet);
489 [ - + ]: 272 : if (!reserver.reserve()) {
490 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Wallet is currently rescanning. Abort existing rescan or wait.");
491 : : }
492 : :
493 : : // Release the "main" shared pointer and prevent further notifications.
494 : : // Note that any attempt to load the same wallet would fail until the wallet
495 : : // is destroyed (see CheckUniqueFileid).
496 [ + - ]: 272 : std::optional<bool> load_on_start{self.MaybeArg<bool>("load_on_startup")};
497 [ + - - + ]: 272 : if (!RemoveWallet(context, wallet, load_on_start, warnings)) {
498 [ # # # # ]: 0 : throw JSONRPCError(RPC_MISC_ERROR, "Requested wallet already unloaded");
499 : : }
500 : 272 : }
501 : :
502 [ + - ]: 272 : WaitForDeleteWallet(std::move(wallet));
503 : :
504 : 272 : UniValue result(UniValue::VOBJ);
505 [ + - ]: 272 : PushWarnings(warnings, result);
506 : :
507 : 544 : return result;
508 [ - + ]: 276 : },
509 [ + - + - : 15120 : };
+ - + - +
- + - + -
+ - + + -
- ]
510 [ + - + - : 8640 : }
+ - + - +
- + - -
- ]
511 : :
512 : 801 : static RPCHelpMan sethdseed()
513 : : {
514 : 801 : return RPCHelpMan{"sethdseed",
515 : : "\nSet or generate a new HD wallet seed. Non-HD wallets will not be upgraded to being a HD wallet. Wallets that are already\n"
516 : : "HD will have a new HD seed set so that new keys added to the keypool will be derived from this new seed.\n"
517 [ + - ]: 1602 : "\nNote that you will need to MAKE A NEW BACKUP of your wallet after setting the HD wallet seed." + HELP_REQUIRING_PASSPHRASE +
518 : 801 : "Note: This command is only compatible with legacy wallets.\n",
519 : : {
520 [ + - ]: 1602 : {"newkeypool", RPCArg::Type::BOOL, RPCArg::Default{true}, "Whether to flush old unused addresses, including change addresses, from the keypool and regenerate it.\n"
521 : : "If true, the next address from getnewaddress and change address from getrawchangeaddress will be from this new seed.\n"
522 : : "If false, addresses (including change addresses if the wallet already had HD Chain Split enabled) from the existing\n"
523 : : "keypool will be used until it has been depleted."},
524 [ + - ]: 1602 : {"seed", RPCArg::Type::STR, RPCArg::DefaultHint{"random seed"}, "The WIF private key to use as the new HD seed.\n"
525 : : "The seed value can be retrieved using the dumpwallet command. It is the private key marked hdseed=1"},
526 : : },
527 [ + - + - : 1602 : RPCResult{RPCResult::Type::NONE, "", ""},
+ - ]
528 : 801 : RPCExamples{
529 [ + - + - : 1602 : HelpExampleCli("sethdseed", "")
+ - ]
530 [ + - + - : 3204 : + HelpExampleCli("sethdseed", "false")
+ - + - ]
531 [ + - + - : 3204 : + HelpExampleCli("sethdseed", "true \"wifkey\"")
+ - + - ]
532 [ + - + - : 3204 : + HelpExampleRpc("sethdseed", "true, \"wifkey\"")
+ - + - ]
533 [ + - ]: 801 : },
534 : 1 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
535 : : {
536 : 1 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
537 [ - + ]: 1 : if (!pwallet) return UniValue::VNULL;
538 : :
539 [ - + ]: 1 : LegacyScriptPubKeyMan& spk_man = EnsureLegacyScriptPubKeyMan(*pwallet, true);
540 : :
541 [ # # # # ]: 0 : if (pwallet->IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS)) {
542 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot set a HD seed to a wallet with private keys disabled");
543 : : }
544 : :
545 [ # # # # ]: 0 : LOCK2(pwallet->cs_wallet, spk_man.cs_KeyStore);
546 : :
547 : : // Do not do anything to non-HD wallets
548 [ # # # # ]: 0 : if (!pwallet->CanSupportFeature(FEATURE_HD)) {
549 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Cannot set an HD seed on a non-HD wallet. Use the upgradewallet RPC in order to upgrade a non-HD wallet to HD");
550 : : }
551 : :
552 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
553 : :
554 : 0 : bool flush_key_pool = true;
555 [ # # # # ]: 0 : if (!request.params[0].isNull()) {
556 [ # # # # ]: 0 : flush_key_pool = request.params[0].get_bool();
557 : : }
558 : :
559 [ # # ]: 0 : CPubKey master_pub_key;
560 [ # # # # ]: 0 : if (request.params[1].isNull()) {
561 [ # # ]: 0 : master_pub_key = spk_man.GenerateNewSeed();
562 : : } else {
563 [ # # # # : 0 : CKey key = DecodeSecret(request.params[1].get_str());
# # ]
564 [ # # ]: 0 : if (!key.IsValid()) {
565 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid private key");
566 : : }
567 : :
568 [ # # # # ]: 0 : if (HaveKey(spk_man, key)) {
569 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Already have this key (either as an HD seed or as a loose private key)");
570 : : }
571 : :
572 [ # # ]: 0 : master_pub_key = spk_man.DeriveNewSeed(key);
573 : 0 : }
574 : :
575 [ # # ]: 0 : spk_man.SetHDSeed(master_pub_key);
576 [ # # # # ]: 0 : if (flush_key_pool) spk_man.NewKeyPool();
577 : :
578 [ # # ]: 0 : return UniValue::VNULL;
579 [ # # ]: 0 : },
580 [ + - + - : 14418 : };
+ - + - +
- + - + -
+ + - - ]
581 [ + - + - : 4005 : }
+ - - - ]
582 : :
583 : 800 : static RPCHelpMan upgradewallet()
584 : : {
585 : 800 : return RPCHelpMan{"upgradewallet",
586 : : "\nUpgrade the wallet. Upgrades to the latest version if no version number is specified.\n"
587 : : "New keys may be generated and a new wallet backup will need to be made.",
588 : : {
589 [ + - ]: 1600 : {"version", RPCArg::Type::NUM, RPCArg::Default{int{FEATURE_LATEST}}, "The version number to upgrade to. Default is the latest wallet version."}
590 : : },
591 : 0 : RPCResult{
592 : : RPCResult::Type::OBJ, "", "",
593 : : {
594 : : {RPCResult::Type::STR, "wallet_name", "Name of wallet this operation was performed on"},
595 : : {RPCResult::Type::NUM, "previous_version", "Version of wallet before this operation"},
596 : : {RPCResult::Type::NUM, "current_version", "Version of wallet after this operation"},
597 : : {RPCResult::Type::STR, "result", /*optional=*/true, "Description of result, if no error"},
598 : : {RPCResult::Type::STR, "error", /*optional=*/true, "Error message (if there is one)"}
599 : : },
600 [ + - + - : 5600 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
+ - - ]
601 : 800 : RPCExamples{
602 [ + - + - : 1600 : HelpExampleCli("upgradewallet", "169900")
+ - ]
603 [ + - + - : 3200 : + HelpExampleRpc("upgradewallet", "169900")
+ - + - ]
604 [ + - ]: 800 : },
605 : 0 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
606 : : {
607 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
608 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
609 : :
610 [ # # ]: 0 : EnsureWalletIsUnlocked(*pwallet);
611 : :
612 : 0 : int version = 0;
613 [ # # # # ]: 0 : if (!request.params[0].isNull()) {
614 [ # # # # ]: 0 : version = request.params[0].getInt<int>();
615 : : }
616 [ # # ]: 0 : bilingual_str error;
617 [ # # ]: 0 : const int previous_version{pwallet->GetVersion()};
618 [ # # ]: 0 : const bool wallet_upgraded{pwallet->UpgradeWallet(version, error)};
619 [ # # ]: 0 : const int current_version{pwallet->GetVersion()};
620 [ # # ]: 0 : std::string result;
621 : :
622 [ # # ]: 0 : if (wallet_upgraded) {
623 [ # # ]: 0 : if (previous_version == current_version) {
624 [ # # ]: 0 : result = "Already at latest version. Wallet version unchanged.";
625 : : } else {
626 [ # # ]: 0 : result = strprintf("Wallet upgraded successfully from version %i to version %i.", previous_version, current_version);
627 : : }
628 : : }
629 : :
630 : 0 : UniValue obj(UniValue::VOBJ);
631 [ # # # # : 0 : obj.pushKV("wallet_name", pwallet->GetName());
# # ]
632 [ # # # # : 0 : obj.pushKV("previous_version", previous_version);
# # ]
633 [ # # # # : 0 : obj.pushKV("current_version", current_version);
# # ]
634 [ # # ]: 0 : if (!result.empty()) {
635 [ # # # # : 0 : obj.pushKV("result", result);
# # ]
636 : : } else {
637 [ # # ]: 0 : CHECK_NONFATAL(!error.empty());
638 [ # # # # : 0 : obj.pushKV("error", error.original);
# # ]
639 : : }
640 : 0 : return obj;
641 : 0 : },
642 [ + - + - : 8800 : };
+ - + - +
- + - + +
- - ]
643 [ + - + - : 7200 : }
+ - + - +
- + - + -
+ - - - ]
644 : :
645 : 826 : RPCHelpMan simulaterawtransaction()
646 : : {
647 : 826 : return RPCHelpMan{"simulaterawtransaction",
648 : : "\nCalculate the balance change resulting in the signing and broadcasting of the given transaction(s).\n",
649 : : {
650 [ + - ]: 826 : {"rawtxs", RPCArg::Type::ARR, RPCArg::Optional::OMITTED, "An array of hex strings of raw transactions.\n",
651 : : {
652 [ + - ]: 826 : {"rawtx", RPCArg::Type::STR_HEX, RPCArg::Optional::OMITTED, ""},
653 : : },
654 : : },
655 [ + - ]: 826 : {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
656 : : {
657 [ + - ]: 1652 : {"include_watchonly", RPCArg::Type::BOOL, RPCArg::DefaultHint{"true for watch-only wallets, otherwise false"}, "Whether to include watch-only addresses (see RPC importaddress)"},
658 : : },
659 : : },
660 : : },
661 : 0 : RPCResult{
662 : : RPCResult::Type::OBJ, "", "",
663 : : {
664 : : {RPCResult::Type::STR_AMOUNT, "balance_change", "The wallet balance change (negative means decrease)."},
665 : : }
666 [ + - + - : 2478 : },
+ - + - +
- + - + -
+ + - - ]
667 : 826 : RPCExamples{
668 [ + - + - : 1652 : HelpExampleCli("simulaterawtransaction", "[\"myhex\"]")
+ - ]
669 [ + - + - : 3304 : + HelpExampleRpc("simulaterawtransaction", "[\"myhex\"]")
+ - + - ]
670 [ + - ]: 826 : },
671 : 26 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
672 : : {
673 [ - + ]: 26 : const std::shared_ptr<const CWallet> rpc_wallet = GetWalletForJSONRPCRequest(request);
674 [ - + ]: 26 : if (!rpc_wallet) return UniValue::VNULL;
675 [ + - ]: 26 : const CWallet& wallet = *rpc_wallet;
676 : :
677 [ + - ]: 26 : LOCK(wallet.cs_wallet);
678 : :
679 : 26 : UniValue include_watchonly(UniValue::VNULL);
680 [ + - - + ]: 26 : if (request.params[1].isObject()) {
681 [ # # # # ]: 0 : UniValue options = request.params[1];
682 [ # # # # : 0 : RPCTypeCheckObj(options,
# # ]
683 : : {
684 [ # # ]: 0 : {"include_watchonly", UniValueType(UniValue::VBOOL)},
685 : : },
686 : : true, true);
687 : :
688 [ # # # # : 0 : include_watchonly = options["include_watchonly"];
# # ]
689 : 0 : }
690 : :
691 : 26 : isminefilter filter = ISMINE_SPENDABLE;
692 [ + - + + ]: 26 : if (ParseIncludeWatchonly(include_watchonly, wallet)) {
693 : 5 : filter |= ISMINE_WATCH_ONLY;
694 : : }
695 : :
696 [ + - + - ]: 26 : const auto& txs = request.params[0].get_array();
697 : 26 : CAmount changes{0};
698 : 26 : std::map<COutPoint, CAmount> new_utxos; // UTXO:s that were made available in transaction array
699 : 26 : std::set<COutPoint> spent;
700 : :
701 [ + + ]: 54 : for (size_t i = 0; i < txs.size(); ++i) {
702 [ + - ]: 38 : CMutableTransaction mtx;
703 [ + - + - : 38 : if (!DecodeHexTx(mtx, txs[i].get_str(), /* try_no_witness */ true, /* try_witness */ true)) {
+ - - + ]
704 [ # # # # ]: 0 : throw JSONRPCError(RPC_DESERIALIZATION_ERROR, "Transaction hex string decoding failure.");
705 : : }
706 : :
707 : : // Fetch previous transactions (inputs)
708 : 38 : std::map<COutPoint, Coin> coins;
709 [ + + ]: 67 : for (const CTxIn& txin : mtx.vin) {
710 [ + - ]: 29 : coins[txin.prevout]; // Create empty map entry keyed by prevout.
711 : : }
712 [ + - ]: 38 : wallet.chain().findCoins(coins);
713 : :
714 : : // Fetch debit; we are *spending* these; if the transaction is signed and
715 : : // broadcast, we will lose everything in these
716 [ + + ]: 57 : for (const auto& txin : mtx.vin) {
717 : 29 : const auto& outpoint = txin.prevout;
718 [ + + ]: 29 : if (spent.count(outpoint)) {
719 [ + - + - ]: 6 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Transaction(s) are spending the same output more than once");
720 : : }
721 [ + + ]: 26 : if (new_utxos.count(outpoint)) {
722 [ + - ]: 6 : changes -= new_utxos.at(outpoint);
723 : 6 : new_utxos.erase(outpoint);
724 : : } else {
725 [ + - + + ]: 20 : if (coins.at(outpoint).IsSpent()) {
726 [ + - + - ]: 14 : throw JSONRPCError(RPC_INVALID_PARAMETER, "One or more transaction inputs are missing or have been spent already");
727 : : }
728 [ + - ]: 13 : changes -= wallet.GetDebit(txin, filter);
729 : : }
730 [ + - ]: 19 : spent.insert(outpoint);
731 : : }
732 : :
733 : : // Iterate over outputs; we are *receiving* these, if the wallet considers
734 : : // them "mine"; if the transaction is signed and broadcast, we will receive
735 : : // everything in these
736 : : // Also populate new_utxos in case these are spent in later transactions
737 : :
738 [ + - ]: 28 : const auto& hash = mtx.GetHash();
739 [ + + ]: 69 : for (size_t i = 0; i < mtx.vout.size(); ++i) {
740 [ + - ]: 41 : const auto& txout = mtx.vout[i];
741 [ + - ]: 41 : bool is_mine = 0 < (wallet.IsMine(txout) & filter);
742 [ + + + - ]: 41 : changes += new_utxos[COutPoint(hash, i)] = is_mine ? txout.nValue : 0;
743 : : }
744 : 76 : }
745 : :
746 : 16 : UniValue result(UniValue::VOBJ);
747 [ + - + - : 32 : result.pushKV("balance_change", ValueFromAmount(changes));
+ - ]
748 : :
749 : 16 : return result;
750 [ - - - - : 78 : }
+ - ]
751 [ + - + - : 16520 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
+ + + + +
- - - - -
- ]
752 [ + - + - : 9086 : }
+ - + - +
- + - + -
- - ]
753 : :
754 : 839 : static RPCHelpMan migratewallet()
755 : : {
756 : 839 : return RPCHelpMan{"migratewallet",
757 : : "\nMigrate the wallet to a descriptor wallet.\n"
758 : : "A new wallet backup will need to be made.\n"
759 : : "\nThe migration process will create a backup of the wallet before migrating. This backup\n"
760 : : "file will be named <wallet name>-<timestamp>.legacy.bak and can be found in the directory\n"
761 : : "for this wallet. In the event of an incorrect migration, the backup can be restored using restorewallet."
762 : : "\nEncrypted wallets must have the passphrase provided as an argument to this call.\n"
763 : : "\nThis RPC may take a long time to complete. Increasing the RPC client timeout is recommended.",
764 : : {
765 [ + - ]: 1678 : {"wallet_name", RPCArg::Type::STR, RPCArg::DefaultHint{"the wallet name from the RPC endpoint"}, "The name of the wallet to migrate. If provided both here and in the RPC endpoint, the two must be identical."},
766 [ + - ]: 839 : {"passphrase", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "The wallet passphrase"},
767 : : },
768 : 0 : RPCResult{
769 : : RPCResult::Type::OBJ, "", "",
770 : : {
771 : : {RPCResult::Type::STR, "wallet_name", "The name of the primary migrated wallet"},
772 : : {RPCResult::Type::STR, "watchonly_name", /*optional=*/true, "The name of the migrated wallet containing the watchonly scripts"},
773 : : {RPCResult::Type::STR, "solvables_name", /*optional=*/true, "The name of the migrated wallet containing solvable but not watched scripts"},
774 : : {RPCResult::Type::STR, "backup_path", "The location of the backup of the original wallet"},
775 : : }
776 [ + - + - : 5034 : },
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + +
- - ]
777 : 839 : RPCExamples{
778 [ + - + - : 1678 : HelpExampleCli("migratewallet", "")
+ - ]
779 [ + - + - : 3356 : + HelpExampleRpc("migratewallet", "")
+ - + - ]
780 [ + - ]: 839 : },
781 : 39 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
782 : : {
783 [ + - ]: 39 : std::string wallet_name;
784 [ + - + + ]: 39 : if (GetWalletNameFromJSONRPCRequest(request, wallet_name)) {
785 [ + - + + : 2 : if (!(request.params[0].isNull() || request.params[0].get_str() == wallet_name)) {
+ - + - +
- ]
786 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "RPC endpoint wallet and wallet_name parameter specify different wallets");
787 : : }
788 : : } else {
789 [ + - + + ]: 37 : if (request.params[0].isNull()) {
790 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Either RPC endpoint wallet or wallet_name parameter must be provided");
791 : : }
792 [ + - + - : 36 : wallet_name = request.params[0].get_str();
+ - ]
793 : : }
794 : :
795 [ + - ]: 37 : SecureString wallet_pass;
796 [ + - ]: 37 : wallet_pass.reserve(100);
797 [ + - + + ]: 37 : if (!request.params[1].isNull()) {
798 [ + - + - : 3 : wallet_pass = std::string_view{request.params[1].get_str()};
+ - ]
799 : : }
800 : :
801 [ + - ]: 37 : WalletContext& context = EnsureWalletContext(request.context);
802 [ + - ]: 37 : util::Result<MigrationResult> res = MigrateLegacyToDescriptor(wallet_name, wallet_pass, context);
803 [ + + ]: 37 : if (!res) {
804 [ + - + - ]: 14 : throw JSONRPCError(RPC_WALLET_ERROR, util::ErrorString(res).original);
805 : : }
806 : :
807 : 30 : UniValue r{UniValue::VOBJ};
808 [ + - + - : 60 : r.pushKV("wallet_name", res->wallet_name);
+ - ]
809 [ + + ]: 30 : if (res->watchonly_wallet) {
810 [ + - + - : 20 : r.pushKV("watchonly_name", res->watchonly_wallet->GetName());
+ - ]
811 : : }
812 [ + + ]: 30 : if (res->solvables_wallet) {
813 [ + - + - : 10 : r.pushKV("solvables_name", res->solvables_wallet->GetName());
+ - ]
814 : : }
815 [ + - + - : 60 : r.pushKV("backup_path", res->backup_path.utf8string());
+ - + - ]
816 : :
817 : 30 : return r;
818 : 44 : },
819 [ + - + - : 11746 : };
+ - + - +
- + - + -
+ - + + -
- ]
820 [ + - + - : 8390 : }
+ - + - +
- + - + -
+ - - - -
- ]
821 : :
822 : 833 : RPCHelpMan gethdkeys()
823 : : {
824 : 833 : return RPCHelpMan{
825 : : "gethdkeys",
826 : : "\nList all BIP 32 HD keys in the wallet and which descriptors use them.\n",
827 : : {
828 [ + - ]: 833 : {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "", {
829 [ + - ]: 1666 : {"active_only", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show the keys for only active descriptors"},
830 [ + - ]: 1666 : {"private", RPCArg::Type::BOOL, RPCArg::Default{false}, "Show private keys"}
831 : : }},
832 : : },
833 : 0 : RPCResult{RPCResult::Type::ARR, "", "", {
834 : : {
835 : : {RPCResult::Type::OBJ, "", "", {
836 : : {RPCResult::Type::STR, "xpub", "The extended public key"},
837 : : {RPCResult::Type::BOOL, "has_private", "Whether the wallet has the private key for this xpub"},
838 : : {RPCResult::Type::STR, "xprv", /*optional=*/true, "The extended private key if \"private\" is true"},
839 : : {RPCResult::Type::ARR, "descriptors", "Array of descriptor objects that use this HD key",
840 : : {
841 : : {RPCResult::Type::OBJ, "", "", {
842 : : {RPCResult::Type::STR, "desc", "Descriptor string representation"},
843 : : {RPCResult::Type::BOOL, "active", "Whether this descriptor is currently used to generate new addresses"},
844 : : }},
845 : : }},
846 : : }},
847 : : }
848 [ + - + - : 10829 : }},
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + + +
+ + + + +
- - - - -
- - - ]
849 : 833 : RPCExamples{
850 [ + - + - : 1666 : HelpExampleCli("gethdkeys", "") + HelpExampleRpc("gethdkeys", "")
+ - + - +
- + - +
- ]
851 [ + - + - : 8330 : + HelpExampleCliNamed("gethdkeys", {{"active_only", "true"}, {"private", "true"}}) + HelpExampleRpcNamed("gethdkeys", {{"active_only", "true"}, {"private", "true"}})
+ - + - +
- + - + -
+ - + + +
+ - - -
- ]
852 [ + - ]: 833 : },
853 : 33 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
854 : : {
855 [ - + ]: 33 : const std::shared_ptr<const CWallet> wallet = GetWalletForJSONRPCRequest(request);
856 [ - + ]: 33 : if (!wallet) return UniValue::VNULL;
857 : :
858 [ + - - + ]: 33 : if (!wallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
859 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "gethdkeys is not available for non-descriptor wallets");
860 : : }
861 : :
862 [ + - ]: 33 : LOCK(wallet->cs_wallet);
863 : :
864 [ + - + + : 33 : UniValue options{request.params[0].isNull() ? UniValue::VOBJ : request.params[0]};
+ - + - ]
865 [ + - + + : 66 : const bool active_only{options.exists("active_only") ? options["active_only"].get_bool() : false};
+ - + - +
- ]
866 [ + - + + : 66 : const bool priv{options.exists("private") ? options["private"].get_bool() : false};
+ - + - +
- ]
867 [ + + ]: 33 : if (priv) {
868 [ + + ]: 9 : EnsureWalletIsUnlocked(*wallet);
869 : : }
870 : :
871 : :
872 [ + + ]: 32 : std::set<ScriptPubKeyMan*> spkms;
873 [ + + ]: 32 : if (active_only) {
874 [ + - ]: 12 : spkms = wallet->GetActiveScriptPubKeyMans();
875 : : } else {
876 [ + - ]: 52 : spkms = wallet->GetAllScriptPubKeyMans();
877 : : }
878 : :
879 : 32 : std::map<CExtPubKey, std::set<std::tuple<std::string, bool, bool>>> wallet_xpubs;
880 : 32 : std::map<CExtPubKey, CExtKey> wallet_xprvs;
881 [ + + ]: 264 : for (auto* spkm : spkms) {
882 [ + - ]: 232 : auto* desc_spkm{dynamic_cast<DescriptorScriptPubKeyMan*>(spkm)};
883 [ + - ]: 232 : CHECK_NONFATAL(desc_spkm);
884 [ + - ]: 232 : LOCK(desc_spkm->cs_desc_man);
885 [ + - ]: 232 : WalletDescriptor w_desc = desc_spkm->GetWalletDescriptor();
886 : :
887 : : // Retrieve the pubkeys from the descriptor
888 [ + - ]: 232 : std::set<CPubKey> desc_pubkeys;
889 : 232 : std::set<CExtPubKey> desc_xpubs;
890 [ + - ]: 232 : w_desc.descriptor->GetPubKeys(desc_pubkeys, desc_xpubs);
891 [ + + ]: 457 : for (const CExtPubKey& xpub : desc_xpubs) {
892 [ + - ]: 225 : std::string desc_str;
893 [ + - ]: 225 : bool ok = desc_spkm->GetDescriptorString(desc_str, false);
894 [ + - ]: 225 : CHECK_NONFATAL(ok);
895 [ + - + - : 225 : wallet_xpubs[xpub].emplace(desc_str, wallet->IsActiveScriptPubKeyMan(*spkm), desc_spkm->HasPrivKey(xpub.pubkey.GetID()));
+ - + - +
- ]
896 [ + + + - : 225 : if (std::optional<CKey> key = priv ? desc_spkm->GetKey(xpub.pubkey.GetID()) : std::nullopt) {
+ - + + ]
897 [ + - + - ]: 64 : wallet_xprvs[xpub] = CExtKey(xpub, *key);
898 : 225 : }
899 : 225 : }
900 [ + - ]: 464 : }
901 : :
902 : 32 : UniValue response(UniValue::VARR);
903 [ + + ]: 66 : for (const auto& [xpub, descs] : wallet_xpubs) {
904 : 34 : bool has_xprv = false;
905 : 34 : UniValue descriptors(UniValue::VARR);
906 [ + + ]: 259 : for (const auto& [desc, active, has_priv] : descs) {
907 : 225 : UniValue d(UniValue::VOBJ);
908 [ + - + - : 450 : d.pushKV("desc", desc);
+ - ]
909 [ + - + - : 450 : d.pushKV("active", active);
+ - ]
910 : 225 : has_xprv |= has_priv;
911 : :
912 [ + - ]: 225 : descriptors.push_back(std::move(d));
913 : 225 : }
914 : 34 : UniValue xpub_info(UniValue::VOBJ);
915 [ + - + - : 68 : xpub_info.pushKV("xpub", EncodeExtPubKey(xpub));
+ - + - ]
916 [ + - + - : 68 : xpub_info.pushKV("has_private", has_xprv);
+ - ]
917 [ + + ]: 34 : if (priv) {
918 [ + - + - : 16 : xpub_info.pushKV("xprv", EncodeExtKey(wallet_xprvs.at(xpub)));
+ - + - +
- ]
919 : : }
920 [ + - + - ]: 68 : xpub_info.pushKV("descriptors", std::move(descriptors));
921 : :
922 [ + - ]: 34 : response.push_back(std::move(xpub_info));
923 : 34 : }
924 : :
925 : 32 : return response;
926 [ + - ]: 98 : },
927 [ + - + - : 15827 : };
+ - + - +
- + - + -
+ - + - +
- + - + +
+ + - - -
- ]
928 [ + - + - : 14994 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
- - - - -
- - - -
- ]
929 : :
930 : 813 : static RPCHelpMan createwalletdescriptor()
931 : : {
932 : 813 : return RPCHelpMan{"createwalletdescriptor",
933 : : "Creates the wallet's descriptor for the given address type. "
934 : : "The address type must be one that the wallet does not already have a descriptor for."
935 [ + - ]: 1626 : + HELP_REQUIRING_PASSPHRASE,
936 : : {
937 [ + - ]: 813 : {"type", RPCArg::Type::STR, RPCArg::Optional::NO, "The address type the descriptor will produce. Options are \"legacy\", \"p2sh-segwit\", \"bech32\", and \"bech32m\"."},
938 [ + - ]: 813 : {"options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "", {
939 [ + - ]: 1626 : {"internal", RPCArg::Type::BOOL, RPCArg::DefaultHint{"Both external and internal will be generated unless this parameter is specified"}, "Whether to only make one descriptor that is internal (if parameter is true) or external (if parameter is false)"},
940 [ + - ]: 1626 : {"hdkey", RPCArg::Type::STR, RPCArg::DefaultHint{"The HD key used by all other active descriptors"}, "The HD key that the wallet knows the private key of, listed using 'gethdkeys', to use for this descriptor's key"},
941 : : }},
942 : : },
943 : 0 : RPCResult{
944 : : RPCResult::Type::OBJ, "", "",
945 : : {
946 : : {RPCResult::Type::ARR, "descs", "The public descriptors that were added to the wallet",
947 : : {{RPCResult::Type::STR, "", ""}}
948 : : }
949 : : },
950 [ + - + - : 4065 : },
+ - + - +
- + - + -
+ - + - +
- + + + +
- - - - ]
951 : 813 : RPCExamples{
952 [ + - + - : 1626 : HelpExampleCli("createwalletdescriptor", "bech32m")
+ - ]
953 [ + - + - : 3252 : + HelpExampleRpc("createwalletdescriptor", "bech32m")
+ - + - ]
954 [ + - ]: 813 : },
955 : 13 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
956 : : {
957 : 13 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
958 [ - + ]: 13 : if (!pwallet) return UniValue::VNULL;
959 : :
960 : : // Make sure wallet is a descriptor wallet
961 [ + - - + ]: 13 : if (!pwallet->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS)) {
962 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "createwalletdescriptor is not available for non-descriptor wallets");
963 : : }
964 : :
965 [ + - + - : 13 : std::optional<OutputType> output_type = ParseOutputType(request.params[0].get_str());
+ - ]
966 [ + + ]: 13 : if (!output_type) {
967 [ + - + - : 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Unknown address type '%s'", request.params[0].get_str()));
+ - + - ]
968 : : }
969 : :
970 [ + - + + : 12 : UniValue options{request.params[1].isNull() ? UniValue::VOBJ : request.params[1]};
+ - + - ]
971 [ + - + - : 12 : UniValue internal_only{options["internal"]};
+ - ]
972 [ + - + - : 12 : UniValue hdkey{options["hdkey"]};
+ - ]
973 : :
974 : 12 : std::vector<bool> internals;
975 [ + + ]: 12 : if (internal_only.isNull()) {
976 [ + - ]: 10 : internals.push_back(false);
977 [ + - ]: 10 : internals.push_back(true);
978 : : } else {
979 [ + - + - ]: 2 : internals.push_back(internal_only.get_bool());
980 : : }
981 : :
982 [ + - ]: 12 : LOCK(pwallet->cs_wallet);
983 [ + + ]: 12 : EnsureWalletIsUnlocked(*pwallet);
984 : :
985 [ + + ]: 11 : CExtPubKey xpub;
986 [ + + ]: 11 : if (hdkey.isNull()) {
987 [ + - ]: 7 : std::set<CExtPubKey> active_xpubs = pwallet->GetActiveHDPubKeys();
988 [ + + ]: 7 : if (active_xpubs.size() != 1) {
989 [ + - + - ]: 4 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unable to determine which HD key to use from active descriptors. Please specify with 'hdkey'");
990 : : }
991 : 5 : xpub = *active_xpubs.begin();
992 : 7 : } else {
993 [ + - + - ]: 4 : xpub = DecodeExtPubKey(hdkey.get_str());
994 [ + + ]: 4 : if (!xpub.pubkey.IsValid()) {
995 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Unable to parse HD key. Please provide a valid xpub");
996 : : }
997 : : }
998 : :
999 [ + - + - ]: 8 : std::optional<CKey> key = pwallet->GetKey(xpub.pubkey.GetID());
1000 [ + + ]: 8 : if (!key) {
1001 [ + - + - : 2 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, strprintf("Private key for %s is not known", EncodeExtPubKey(xpub)));
+ - ]
1002 : : }
1003 [ + - ]: 7 : CExtKey active_hdkey(xpub, *key);
1004 : :
1005 : 7 : std::vector<std::reference_wrapper<DescriptorScriptPubKeyMan>> spkms;
1006 [ + - ]: 7 : WalletBatch batch{pwallet->GetDatabase()};
1007 [ + - - + ]: 43 : for (bool internal : internals) {
1008 [ + - ]: 12 : WalletDescriptor w_desc = GenerateWalletDescriptor(xpub, *output_type, internal);
1009 [ + - ]: 12 : uint256 w_id = DescriptorID(*w_desc.descriptor);
1010 [ + - + + ]: 12 : if (!pwallet->GetScriptPubKeyMan(w_id)) {
1011 [ + - + - ]: 10 : spkms.emplace_back(pwallet->SetupDescriptorScriptPubKeyMan(batch, active_hdkey, *output_type, internal));
1012 : : }
1013 : 12 : }
1014 [ + + ]: 7 : if (spkms.empty()) {
1015 [ + - + - ]: 2 : throw JSONRPCError(RPC_WALLET_ERROR, "Descriptor already exists");
1016 : : }
1017 : :
1018 : : // Fetch each descspkm from the wallet in order to get the descriptor strings
1019 : 6 : UniValue descs{UniValue::VARR};
1020 [ + + ]: 16 : for (const auto& spkm : spkms) {
1021 [ + - ]: 10 : std::string desc_str;
1022 [ + - ]: 10 : bool ok = spkm.get().GetDescriptorString(desc_str, false);
1023 [ + - ]: 10 : CHECK_NONFATAL(ok);
1024 [ + - + - ]: 10 : descs.push_back(desc_str);
1025 : 10 : }
1026 : 6 : UniValue out{UniValue::VOBJ};
1027 [ + - + - ]: 12 : out.pushKV("descs", std::move(descs));
1028 : 6 : return out;
1029 [ + - ]: 53 : }
1030 [ + - + - : 19512 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ + + + -
- - - ]
1031 [ + - + - : 9756 : }
+ - + - +
- + - + -
+ - - - -
- ]
1032 : :
1033 : : // addresses
1034 : : RPCHelpMan getaddressinfo();
1035 : : RPCHelpMan getnewaddress();
1036 : : RPCHelpMan getrawchangeaddress();
1037 : : RPCHelpMan setlabel();
1038 : : RPCHelpMan listaddressgroupings();
1039 : : RPCHelpMan addmultisigaddress();
1040 : : RPCHelpMan keypoolrefill();
1041 : : RPCHelpMan newkeypool();
1042 : : RPCHelpMan getaddressesbylabel();
1043 : : RPCHelpMan listlabels();
1044 : : #ifdef ENABLE_EXTERNAL_SIGNER
1045 : : RPCHelpMan walletdisplayaddress();
1046 : : #endif // ENABLE_EXTERNAL_SIGNER
1047 : :
1048 : : // backup
1049 : : RPCHelpMan dumpprivkey();
1050 : : RPCHelpMan importprivkey();
1051 : : RPCHelpMan importaddress();
1052 : : RPCHelpMan importpubkey();
1053 : : RPCHelpMan dumpwallet();
1054 : : RPCHelpMan importwallet();
1055 : : RPCHelpMan importprunedfunds();
1056 : : RPCHelpMan removeprunedfunds();
1057 : : RPCHelpMan importmulti();
1058 : : RPCHelpMan importdescriptors();
1059 : : RPCHelpMan listdescriptors();
1060 : : RPCHelpMan backupwallet();
1061 : : RPCHelpMan restorewallet();
1062 : :
1063 : : // coins
1064 : : RPCHelpMan getreceivedbyaddress();
1065 : : RPCHelpMan getreceivedbylabel();
1066 : : RPCHelpMan getbalance();
1067 : : RPCHelpMan getunconfirmedbalance();
1068 : : RPCHelpMan lockunspent();
1069 : : RPCHelpMan listlockunspent();
1070 : : RPCHelpMan getbalances();
1071 : : RPCHelpMan listunspent();
1072 : :
1073 : : // encryption
1074 : : RPCHelpMan walletpassphrase();
1075 : : RPCHelpMan walletpassphrasechange();
1076 : : RPCHelpMan walletlock();
1077 : : RPCHelpMan encryptwallet();
1078 : :
1079 : : // spend
1080 : : RPCHelpMan sendtoaddress();
1081 : : RPCHelpMan sendmany();
1082 : : RPCHelpMan settxfee();
1083 : : RPCHelpMan fundrawtransaction();
1084 : : RPCHelpMan bumpfee();
1085 : : RPCHelpMan psbtbumpfee();
1086 : : RPCHelpMan send();
1087 : : RPCHelpMan sendall();
1088 : : RPCHelpMan walletprocesspsbt();
1089 : : RPCHelpMan walletcreatefundedpsbt();
1090 : : RPCHelpMan signrawtransactionwithwallet();
1091 : :
1092 : : // signmessage
1093 : : RPCHelpMan signmessage();
1094 : :
1095 : : // transactions
1096 : : RPCHelpMan listreceivedbyaddress();
1097 : : RPCHelpMan listreceivedbylabel();
1098 : : RPCHelpMan listtransactions();
1099 : : RPCHelpMan listsinceblock();
1100 : : RPCHelpMan gettransaction();
1101 : : RPCHelpMan abandontransaction();
1102 : : RPCHelpMan rescanblockchain();
1103 : : RPCHelpMan abortrescan();
1104 : :
1105 : 411 : std::span<const CRPCCommand> GetWalletRPCCommands()
1106 : : {
1107 : 411 : static const CRPCCommand commands[]{
1108 : : {"rawtransactions", &fundrawtransaction},
1109 : : {"wallet", &abandontransaction},
1110 : : {"wallet", &abortrescan},
1111 : : {"wallet", &addmultisigaddress},
1112 : : {"wallet", &backupwallet},
1113 : : {"wallet", &bumpfee},
1114 : : {"wallet", &psbtbumpfee},
1115 : : {"wallet", &createwallet},
1116 : : {"wallet", &createwalletdescriptor},
1117 : : {"wallet", &restorewallet},
1118 : : {"wallet", &dumpprivkey},
1119 : : {"wallet", &dumpwallet},
1120 : : {"wallet", &encryptwallet},
1121 : : {"wallet", &getaddressesbylabel},
1122 : : {"wallet", &getaddressinfo},
1123 : : {"wallet", &getbalance},
1124 : : {"wallet", &gethdkeys},
1125 : : {"wallet", &getnewaddress},
1126 : : {"wallet", &getrawchangeaddress},
1127 : : {"wallet", &getreceivedbyaddress},
1128 : : {"wallet", &getreceivedbylabel},
1129 : : {"wallet", &gettransaction},
1130 : : {"wallet", &getunconfirmedbalance},
1131 : : {"wallet", &getbalances},
1132 : : {"wallet", &getwalletinfo},
1133 : : {"wallet", &importaddress},
1134 : : {"wallet", &importdescriptors},
1135 : : {"wallet", &importmulti},
1136 : : {"wallet", &importprivkey},
1137 : : {"wallet", &importprunedfunds},
1138 : : {"wallet", &importpubkey},
1139 : : {"wallet", &importwallet},
1140 : : {"wallet", &keypoolrefill},
1141 : : {"wallet", &listaddressgroupings},
1142 : : {"wallet", &listdescriptors},
1143 : : {"wallet", &listlabels},
1144 : : {"wallet", &listlockunspent},
1145 : : {"wallet", &listreceivedbyaddress},
1146 : : {"wallet", &listreceivedbylabel},
1147 : : {"wallet", &listsinceblock},
1148 : : {"wallet", &listtransactions},
1149 : : {"wallet", &listunspent},
1150 : : {"wallet", &listwalletdir},
1151 : : {"wallet", &listwallets},
1152 : : {"wallet", &loadwallet},
1153 : : {"wallet", &lockunspent},
1154 : : {"wallet", &migratewallet},
1155 : : {"wallet", &newkeypool},
1156 : : {"wallet", &removeprunedfunds},
1157 : : {"wallet", &rescanblockchain},
1158 : : {"wallet", &send},
1159 : : {"wallet", &sendmany},
1160 : : {"wallet", &sendtoaddress},
1161 : : {"wallet", &sethdseed},
1162 : : {"wallet", &setlabel},
1163 : : {"wallet", &settxfee},
1164 : : {"wallet", &setwalletflag},
1165 : : {"wallet", &signmessage},
1166 : : {"wallet", &signrawtransactionwithwallet},
1167 : : {"wallet", &simulaterawtransaction},
1168 : : {"wallet", &sendall},
1169 : : {"wallet", &unloadwallet},
1170 : : {"wallet", &upgradewallet},
1171 : : {"wallet", &walletcreatefundedpsbt},
1172 : : #ifdef ENABLE_EXTERNAL_SIGNER
1173 : : {"wallet", &walletdisplayaddress},
1174 : : #endif // ENABLE_EXTERNAL_SIGNER
1175 : : {"wallet", &walletlock},
1176 : : {"wallet", &walletpassphrase},
1177 : : {"wallet", &walletpassphrasechange},
1178 : : {"wallet", &walletprocesspsbt},
1179 [ + + + - : 411 : };
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- - - ]
1180 : 411 : return commands;
1181 : : }
1182 : : } // namespace wallet
|
