Branch data Line data Source code
1 : : // Copyright (c) 2011-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <wallet/rpc/util.h>
6 : :
7 : : #include <common/url.h>
8 : : #include <rpc/util.h>
9 : : #include <util/any.h>
10 : : #include <util/translation.h>
11 : : #include <wallet/context.h>
12 : : #include <wallet/wallet.h>
13 : :
14 : : #include <string_view>
15 : : #include <univalue.h>
16 : :
17 : : namespace wallet {
18 : : static const std::string WALLET_ENDPOINT_BASE = "/wallet/";
19 : : const std::string HELP_REQUIRING_PASSPHRASE{"\nRequires wallet passphrase to be set with walletpassphrase call if wallet is encrypted.\n"};
20 : :
21 : 1669 : bool GetAvoidReuseFlag(const CWallet& wallet, const UniValue& param) {
22 : 1669 : bool can_avoid_reuse = wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
23 [ + + ]: 1669 : bool avoid_reuse = param.isNull() ? can_avoid_reuse : param.get_bool();
24 : :
25 [ - + ]: 1669 : if (avoid_reuse && !can_avoid_reuse) {
26 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "wallet does not have the \"avoid reuse\" feature enabled");
27 : : }
28 : :
29 : 1669 : return avoid_reuse;
30 : : }
31 : :
32 : : /** Used by RPC commands that have an include_watchonly parameter.
33 : : * We default to true for watchonly wallets if include_watchonly isn't
34 : : * explicitly set.
35 : : */
36 : 1748 : bool ParseIncludeWatchonly(const UniValue& include_watchonly, const CWallet& wallet)
37 : : {
38 [ + + ]: 1748 : if (include_watchonly.isNull()) {
39 : : // if include_watchonly isn't explicitly set, then check if we have a watchonly wallet
40 : 1723 : return wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS);
41 : : }
42 : :
43 : : // otherwise return whatever include_watchonly was set to
44 : 25 : return include_watchonly.get_bool();
45 : : }
46 : :
47 : 17828 : bool GetWalletNameFromJSONRPCRequest(const JSONRPCRequest& request, std::string& wallet_name)
48 : : {
49 [ + + ]: 17828 : if (request.URI.starts_with(WALLET_ENDPOINT_BASE)) {
50 : : // wallet endpoint was used
51 : 12678 : wallet_name = UrlDecode(std::string_view{request.URI}.substr(WALLET_ENDPOINT_BASE.size()));
52 : 12678 : return true;
53 : : }
54 : : return false;
55 : : }
56 : :
57 : 17507 : std::shared_ptr<CWallet> GetWalletForJSONRPCRequest(const JSONRPCRequest& request)
58 : : {
59 : 17507 : CHECK_NONFATAL(request.mode == JSONRPCRequest::EXECUTE);
60 : 17507 : WalletContext& context = EnsureWalletContext(request.context);
61 : :
62 [ + - ]: 17507 : std::string wallet_name;
63 [ + - + + ]: 17507 : if (GetWalletNameFromJSONRPCRequest(request, wallet_name)) {
64 [ + - ]: 12494 : std::shared_ptr<CWallet> pwallet = GetWallet(context, wallet_name);
65 [ + + + - : 12505 : if (!pwallet) throw JSONRPCError(RPC_WALLET_NOT_FOUND, "Requested wallet does not exist or is not loaded");
+ - ]
66 : : return pwallet;
67 : 11 : }
68 : :
69 : 5013 : size_t count{0};
70 [ + - ]: 5013 : auto wallet = GetDefaultWallet(context, count);
71 [ + + - + ]: 5013 : if (wallet) return wallet;
72 : :
73 [ + + ]: 23 : if (count == 0) {
74 [ + - ]: 11 : throw JSONRPCError(
75 [ + - + - ]: 22 : RPC_WALLET_NOT_FOUND, "No wallet is loaded. Load a wallet using loadwallet or create a new one with createwallet. (Note: A default wallet is no longer automatically created)");
76 : : }
77 [ + - ]: 12 : throw JSONRPCError(RPC_WALLET_NOT_SPECIFIED,
78 [ + - + - ]: 24 : "Multiple wallets are loaded. Please select which wallet to use by requesting the RPC through the /wallet/<walletname> URI path.");
79 : 22486 : }
80 : :
81 : 3765 : void EnsureWalletIsUnlocked(const CWallet& wallet)
82 : : {
83 [ + + ]: 3765 : if (wallet.IsLocked()) {
84 [ + - + - ]: 30 : throw JSONRPCError(RPC_WALLET_UNLOCK_NEEDED, "Error: Please enter the wallet passphrase with walletpassphrase first.");
85 : : }
86 : 3750 : }
87 : :
88 : 18573 : WalletContext& EnsureWalletContext(const std::any& context)
89 : : {
90 : 18573 : auto wallet_context = util::AnyPtr<WalletContext>(context);
91 [ - + ]: 18573 : if (!wallet_context) {
92 [ # # # # ]: 0 : throw JSONRPCError(RPC_INTERNAL_ERROR, "Wallet context not found");
93 : : }
94 : 18573 : return *wallet_context;
95 : : }
96 : :
97 : 10804 : std::string LabelFromValue(const UniValue& value)
98 : : {
99 [ + + + - ]: 10804 : static const std::string empty_string;
100 [ + + ]: 10804 : if (value.isNull()) return empty_string;
101 : :
102 : 357 : const std::string& label{value.get_str()};
103 [ + + ]: 357 : if (label == "*")
104 [ + - + - ]: 16 : throw JSONRPCError(RPC_WALLET_INVALID_LABEL_NAME, "Invalid label name");
105 : 349 : return label;
106 : : }
107 : :
108 : 35568 : void PushParentDescriptors(const CWallet& wallet, const CScript& script_pubkey, UniValue& entry)
109 : : {
110 : 35568 : UniValue parent_descs(UniValue::VARR);
111 [ + - + + ]: 71136 : for (const auto& desc: wallet.GetWalletDescriptors(script_pubkey)) {
112 [ + - + - : 35568 : parent_descs.push_back(desc.descriptor->ToString());
+ - ]
113 : 35568 : }
114 [ + - + - ]: 71136 : entry.pushKV("parent_descs", std::move(parent_descs));
115 : 35568 : }
116 : :
117 : 175 : void HandleWalletError(const std::shared_ptr<CWallet> wallet, DatabaseStatus& status, bilingual_str& error)
118 : : {
119 [ + + ]: 175 : if (!wallet) {
120 : : // Map bad format to not found, since bad format is returned when the
121 : : // wallet directory exists, but doesn't contain a data file.
122 : 27 : RPCErrorCode code = RPC_WALLET_ERROR;
123 [ + - + + : 27 : switch (status) {
+ ]
124 : 15 : case DatabaseStatus::FAILED_NOT_FOUND:
125 : 15 : case DatabaseStatus::FAILED_BAD_FORMAT:
126 : 15 : code = RPC_WALLET_NOT_FOUND;
127 : 15 : break;
128 : 0 : case DatabaseStatus::FAILED_ALREADY_LOADED:
129 : 0 : code = RPC_WALLET_ALREADY_LOADED;
130 : 0 : break;
131 : 1 : case DatabaseStatus::FAILED_ALREADY_EXISTS:
132 : 1 : code = RPC_WALLET_ALREADY_EXISTS;
133 : 1 : break;
134 : 1 : case DatabaseStatus::FAILED_INVALID_BACKUP_FILE:
135 : 1 : code = RPC_INVALID_PARAMETER;
136 : 1 : break;
137 : : default: // RPC_WALLET_ERROR is returned for all other cases.
138 : : break;
139 : : }
140 [ + - ]: 27 : throw JSONRPCError(code, error.original);
141 : : }
142 : 148 : }
143 : :
144 : 1503 : void AppendLastProcessedBlock(UniValue& entry, const CWallet& wallet)
145 : : {
146 : 1503 : AssertLockHeld(wallet.cs_wallet);
147 : 1503 : UniValue lastprocessedblock{UniValue::VOBJ};
148 [ + - + - : 3006 : lastprocessedblock.pushKV("hash", wallet.GetLastBlockHash().GetHex());
+ - + - ]
149 [ + - + - : 3006 : lastprocessedblock.pushKV("height", wallet.GetLastBlockHeight());
+ - ]
150 [ + - + - ]: 3006 : entry.pushKV("lastprocessedblock", std::move(lastprocessedblock));
151 : 1503 : }
152 : :
153 : : } // namespace wallet
|
