Bitcoin Core  24.99.0
P2P Digital Currency
util.cpp
Go to the documentation of this file.
1 // Copyright (c) 2011-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 <wallet/rpc/util.h>
6 
7 #include <common/url.h>
8 #include <rpc/util.h>
9 #include <util/translation.h>
10 #include <wallet/context.h>
11 #include <wallet/wallet.h>
12 
13 #include <univalue.h>
14 
15 #include <boost/date_time/posix_time/posix_time.hpp>
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 int64_t ParseISO8601DateTime(const std::string& str)
22 {
23  static const boost::posix_time::ptime epoch = boost::posix_time::from_time_t(0);
24  static const std::locale loc(std::locale::classic(),
25  new boost::posix_time::time_input_facet("%Y-%m-%dT%H:%M:%SZ"));
26  std::istringstream iss(str);
27  iss.imbue(loc);
28  boost::posix_time::ptime ptime(boost::date_time::not_a_date_time);
29  iss >> ptime;
30  if (ptime.is_not_a_date_time() || epoch > ptime)
31  return 0;
32  return (ptime - epoch).total_seconds();
33 }
34 
35 bool GetAvoidReuseFlag(const CWallet& wallet, const UniValue& param) {
36  bool can_avoid_reuse = wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
37  bool avoid_reuse = param.isNull() ? can_avoid_reuse : param.get_bool();
38 
39  if (avoid_reuse && !can_avoid_reuse) {
40  throw JSONRPCError(RPC_WALLET_ERROR, "wallet does not have the \"avoid reuse\" feature enabled");
41  }
42 
43  return avoid_reuse;
44 }
45 
50 bool ParseIncludeWatchonly(const UniValue& include_watchonly, const CWallet& wallet)
51 {
52  if (include_watchonly.isNull()) {
53  // if include_watchonly isn't explicitly set, then check if we have a watchonly wallet
54  return wallet.IsWalletFlagSet(WALLET_FLAG_DISABLE_PRIVATE_KEYS);
55  }
56 
57  // otherwise return whatever include_watchonly was set to
58  return include_watchonly.get_bool();
59 }
60 
61 bool GetWalletNameFromJSONRPCRequest(const JSONRPCRequest& request, std::string& wallet_name)
62 {
63  if (URL_DECODE && request.URI.substr(0, WALLET_ENDPOINT_BASE.size()) == WALLET_ENDPOINT_BASE) {
64  // wallet endpoint was used
65  wallet_name = URL_DECODE(request.URI.substr(WALLET_ENDPOINT_BASE.size()));
66  return true;
67  }
68  return false;
69 }
70 
71 std::shared_ptr<CWallet> GetWalletForJSONRPCRequest(const JSONRPCRequest& request)
72 {
75 
76  std::string wallet_name;
77  if (GetWalletNameFromJSONRPCRequest(request, wallet_name)) {
78  std::shared_ptr<CWallet> pwallet = GetWallet(context, wallet_name);
79  if (!pwallet) throw JSONRPCError(RPC_WALLET_NOT_FOUND, "Requested wallet does not exist or is not loaded");
80  return pwallet;
81  }
82 
83  size_t count{0};
85  if (wallet) return wallet;
86 
87  if (count == 0) {
88  throw JSONRPCError(
89  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)");
90  }
92  "Wallet file not specified (must request wallet RPC through /wallet/<filename> uri-path).");
93 }
94 
96 {
97  if (wallet.IsLocked()) {
98  throw JSONRPCError(RPC_WALLET_UNLOCK_NEEDED, "Error: Please enter the wallet passphrase with walletpassphrase first.");
99  }
100 }
101 
103 {
104  auto wallet_context = util::AnyPtr<WalletContext>(context);
105  if (!wallet_context) {
106  throw JSONRPCError(RPC_INTERNAL_ERROR, "Wallet context not found");
107  }
108  return *wallet_context;
109 }
110 
111 // also_create should only be set to true only when the RPC is expected to add things to a blank wallet and make it no longer blank
113 {
114  LegacyScriptPubKeyMan* spk_man = wallet.GetLegacyScriptPubKeyMan();
115  if (!spk_man && also_create) {
116  spk_man = wallet.GetOrCreateLegacyScriptPubKeyMan();
117  }
118  if (!spk_man) {
119  throw JSONRPCError(RPC_WALLET_ERROR, "Only legacy wallets are supported by this command");
120  }
121  return *spk_man;
122 }
123 
125 {
126  const LegacyScriptPubKeyMan* spk_man = wallet.GetLegacyScriptPubKeyMan();
127  if (!spk_man) {
128  throw JSONRPCError(RPC_WALLET_ERROR, "Only legacy wallets are supported by this command");
129  }
130  return *spk_man;
131 }
132 
133 std::string LabelFromValue(const UniValue& value)
134 {
135  static const std::string empty_string;
136  if (value.isNull()) return empty_string;
137 
138  const std::string& label{value.get_str()};
139  if (label == "*")
140  throw JSONRPCError(RPC_WALLET_INVALID_LABEL_NAME, "Invalid label name");
141  return label;
142 }
143 
144 void PushParentDescriptors(const CWallet& wallet, const CScript& script_pubkey, UniValue& entry)
145 {
146  UniValue parent_descs(UniValue::VARR);
147  for (const auto& desc: wallet.GetWalletDescriptors(script_pubkey)) {
148  parent_descs.push_back(desc.descriptor->ToString());
149  }
150  entry.pushKV("parent_descs", parent_descs);
151 }
152 
153 void HandleWalletError(const std::shared_ptr<CWallet> wallet, DatabaseStatus& status, bilingual_str& error)
154 {
155  if (!wallet) {
156  // Map bad format to not found, since bad format is returned when the
157  // wallet directory exists, but doesn't contain a data file.
159  switch (status) {
162  code = RPC_WALLET_NOT_FOUND;
163  break;
166  break;
169  break;
171  code = RPC_INVALID_PARAMETER;
172  break;
173  default: // RPC_WALLET_ERROR is returned for all other cases.
174  break;
175  }
176  throw JSONRPCError(code, error.original);
177  }
178 }
179 } // namespace wallet
UrlDecodeFn *const URL_DECODE
Definition: bitcoin-cli.cpp:50
#define CHECK_NONFATAL(condition)
Identity function.
Definition: check.h:46
Serialized script, used inside transaction inputs and outputs.
Definition: script.h:411
enum JSONRPCRequest::Mode mode
std::string URI
Definition: request.h:35
std::any context
Definition: request.h:38
void push_back(UniValue val)
Definition: univalue.cpp:104
const std::string & get_str() const
@ VARR
Definition: univalue.h:20
bool isNull() const
Definition: univalue.h:75
void pushKV(std::string key, UniValue val)
Definition: univalue.cpp:126
bool get_bool() const
A CWallet maintains a set of transactions and balances, and provides the ability to create new transa...
Definition: wallet.h:237
Definition: node.h:39
std::shared_ptr< CWallet > GetWalletForJSONRPCRequest(const JSONRPCRequest &request)
Figures out what wallet, if any, to use for a JSONRPCRequest.
Definition: util.cpp:71
bool GetWalletNameFromJSONRPCRequest(const JSONRPCRequest &request, std::string &wallet_name)
Definition: util.cpp:61
void HandleWalletError(const std::shared_ptr< CWallet > wallet, DatabaseStatus &status, bilingual_str &error)
Definition: util.cpp:153
void EnsureWalletIsUnlocked(const CWallet &wallet)
Definition: util.cpp:95
const LegacyScriptPubKeyMan & EnsureConstLegacyScriptPubKeyMan(const CWallet &wallet)
Definition: util.cpp:124
const std::string HELP_REQUIRING_PASSPHRASE
Definition: util.cpp:19
void PushParentDescriptors(const CWallet &wallet, const CScript &script_pubkey, UniValue &entry)
Fetch parent descriptors of this scriptPubKey.
Definition: util.cpp:144
LegacyScriptPubKeyMan & EnsureLegacyScriptPubKeyMan(CWallet &wallet, bool also_create)
Definition: util.cpp:112
WalletContext & EnsureWalletContext(const std::any &context)
Definition: util.cpp:102
std::string LabelFromValue(const UniValue &value)
Definition: util.cpp:133
bool ParseIncludeWatchonly(const UniValue &include_watchonly, const CWallet &wallet)
Used by RPC commands that have an include_watchonly parameter.
Definition: util.cpp:50
int64_t ParseISO8601DateTime(const std::string &str)
Definition: util.cpp:21
bool GetAvoidReuseFlag(const CWallet &wallet, const UniValue &param)
Definition: util.cpp:35
@ WALLET_FLAG_AVOID_REUSE
Definition: walletutil.h:42
@ WALLET_FLAG_DISABLE_PRIVATE_KEYS
Definition: walletutil.h:51
std::shared_ptr< CWallet > GetWallet(WalletContext &context, const std::string &name)
Definition: wallet.cpp:161
static const std::string WALLET_ENDPOINT_BASE
Definition: util.cpp:18
DatabaseStatus
Definition: db.h:239
std::shared_ptr< CWallet > GetDefaultWallet(WalletContext &context, size_t &count)
Definition: wallet.cpp:154
std::shared_ptr< CWallet > wallet
WalletContext context
UniValue JSONRPCError(int code, const std::string &message)
Definition: request.cpp:56
RPCErrorCode
Bitcoin RPC error codes.
Definition: protocol.h:24
@ RPC_WALLET_NOT_SPECIFIED
No wallet specified (error when there are multiple wallets loaded)
Definition: protocol.h:81
@ RPC_WALLET_INVALID_LABEL_NAME
Invalid label name.
Definition: protocol.h:73
@ RPC_WALLET_UNLOCK_NEEDED
Enter the wallet passphrase with walletpassphrase first.
Definition: protocol.h:75
@ RPC_WALLET_ALREADY_EXISTS
There is already a wallet with the same name.
Definition: protocol.h:83
@ RPC_INVALID_PARAMETER
Invalid, missing or duplicate parameter.
Definition: protocol.h:43
@ RPC_WALLET_ERROR
Wallet errors.
Definition: protocol.h:71
@ RPC_WALLET_ALREADY_LOADED
This same wallet is already loaded.
Definition: protocol.h:82
@ RPC_WALLET_NOT_FOUND
Invalid wallet specified.
Definition: protocol.h:80
@ RPC_INTERNAL_ERROR
Definition: protocol.h:35
Bilingual messages:
Definition: translation.h:18
WalletContext struct containing references to state shared between CWallet instances,...
Definition: context.h:35
bool error(const char *fmt, const Args &... args)
Definition: system.h:48
static int count
Definition: tests.c:34
static const std::string empty_string
Definition: threadnames.cpp:54