Branch data Line data Source code
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 <core_io.h>
6 : : #include <hash.h>
7 : : #include <key_io.h>
8 : : #include <rpc/util.h>
9 : : #include <script/script.h>
10 : : #include <util/moneystr.h>
11 : : #include <wallet/coincontrol.h>
12 : : #include <wallet/receive.h>
13 : : #include <wallet/rpc/util.h>
14 : : #include <wallet/spend.h>
15 : : #include <wallet/wallet.h>
16 : :
17 : : #include <univalue.h>
18 : :
19 : :
20 : : namespace wallet {
21 : 0 : static CAmount GetReceived(const CWallet& wallet, const UniValue& params, bool by_label) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
22 : : {
23 : 0 : std::vector<CTxDestination> addresses;
24 [ # # ]: 0 : if (by_label) {
25 : : // Get the set of addresses assigned to label
26 [ # # # # : 0 : addresses = wallet.ListAddrBookAddresses(CWallet::AddrBookFilter{LabelFromValue(params[0])});
# # ]
27 [ # # # # : 0 : if (addresses.empty()) throw JSONRPCError(RPC_WALLET_ERROR, "Label not found in wallet");
# # ]
28 : : } else {
29 : : // Get the address
30 [ # # # # : 0 : CTxDestination dest = DecodeDestination(params[0].get_str());
# # ]
31 [ # # # # ]: 0 : if (!IsValidDestination(dest)) {
32 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, "Invalid Bitcoin address");
33 : : }
34 [ # # ]: 0 : addresses.emplace_back(dest);
35 : 0 : }
36 : :
37 : : // Filter by own scripts only
38 : 0 : std::set<CScript> output_scripts;
39 [ # # ]: 0 : for (const auto& address : addresses) {
40 [ # # ]: 0 : auto output_script{GetScriptForDestination(address)};
41 [ # # # # ]: 0 : if (wallet.IsMine(output_script)) {
42 [ # # ]: 0 : output_scripts.insert(output_script);
43 : : }
44 : 0 : }
45 : :
46 [ # # ]: 0 : if (output_scripts.empty()) {
47 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Address not found in wallet");
48 : : }
49 : :
50 : : // Minimum confirmations
51 : 0 : int min_depth = 1;
52 [ # # # # ]: 0 : if (!params[1].isNull())
53 [ # # # # ]: 0 : min_depth = params[1].getInt<int>();
54 : :
55 [ # # # # : 0 : const bool include_immature_coinbase{params[2].isNull() ? false : params[2].get_bool()};
# # # # ]
56 : :
57 : : // Tally
58 : 0 : CAmount amount = 0;
59 [ # # # # ]: 0 : for (const auto& [_, wtx] : wallet.mapWallet) {
60 [ # # ]: 0 : int depth{wallet.GetTxDepthInMainChain(wtx)};
61 : 0 : if (depth < min_depth
62 : : // Coinbase with less than 1 confirmation is no longer in the main chain
63 [ # # # # ]: 0 : || (wtx.IsCoinBase() && (depth < 1))
64 [ # # # # : 0 : || (wallet.IsTxImmatureCoinBase(wtx) && !include_immature_coinbase))
# # # # ]
65 : : {
66 : 0 : continue;
67 : : }
68 : :
69 [ # # ]: 0 : for (const CTxOut& txout : wtx.tx->vout) {
70 [ # # ]: 0 : if (output_scripts.count(txout.scriptPubKey) > 0) {
71 : 0 : amount += txout.nValue;
72 : : }
73 : : }
74 : : }
75 : :
76 : 0 : return amount;
77 : 0 : }
78 : :
79 : :
80 : 12 : RPCHelpMan getreceivedbyaddress()
81 : : {
82 : 12 : return RPCHelpMan{
83 : 12 : "getreceivedbyaddress",
84 [ + - ]: 24 : "Returns the total amount received by the given address in transactions with at least minconf confirmations.\n",
85 : : {
86 [ + - + - ]: 24 : {"address", RPCArg::Type::STR, RPCArg::Optional::NO, "The bitcoin address for transactions."},
87 [ + - + - : 36 : {"minconf", RPCArg::Type::NUM, RPCArg::Default{1}, "Only include transactions confirmed at least this many times."},
+ - ]
88 [ + - + - : 36 : {"include_immature_coinbase", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include immature coinbase transactions."},
+ - ]
89 : : },
90 [ + - ]: 24 : RPCResult{
91 [ + - + - ]: 24 : RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " received at this address."
92 [ + - ]: 24 : },
93 : 12 : RPCExamples{
94 : : "\nThe amount from transactions with at least 1 confirmation\n"
95 [ + - + - : 36 : + HelpExampleCli("getreceivedbyaddress", "\"" + EXAMPLE_ADDRESS[0] + "\"") +
+ - + - ]
96 : 12 : "\nThe amount including unconfirmed transactions, zero confirmations\n"
97 [ + - + - : 60 : + HelpExampleCli("getreceivedbyaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 0") +
+ - + - ]
98 : 12 : "\nThe amount with at least 6 confirmations\n"
99 [ + - + - : 60 : + HelpExampleCli("getreceivedbyaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 6") +
+ - + - ]
100 : 12 : "\nThe amount with at least 6 confirmations including immature coinbase outputs\n"
101 [ + - + - : 60 : + HelpExampleCli("getreceivedbyaddress", "\"" + EXAMPLE_ADDRESS[0] + "\" 6 true") +
+ - + - ]
102 : 12 : "\nAs a JSON-RPC call\n"
103 [ + - + - : 60 : + HelpExampleRpc("getreceivedbyaddress", "\"" + EXAMPLE_ADDRESS[0] + "\", 6")
+ - + - ]
104 [ + - ]: 12 : },
105 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
106 : : {
107 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
108 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
109 : :
110 : : // Make sure the results are valid at least up to the most recent block
111 : : // the user could have gotten from another RPC command prior to now
112 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
113 : :
114 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
115 : :
116 [ # # # # ]: 0 : return ValueFromAmount(GetReceived(*pwallet, request.params, /*by_label=*/false));
117 : 0 : },
118 [ + - + - : 84 : };
+ + - - ]
119 [ + - + - : 72 : }
+ - - - ]
120 : :
121 : :
122 : 12 : RPCHelpMan getreceivedbylabel()
123 : : {
124 : 12 : return RPCHelpMan{
125 : 12 : "getreceivedbylabel",
126 [ + - ]: 24 : "Returns the total amount received by addresses with <label> in transactions with at least [minconf] confirmations.\n",
127 : : {
128 [ + - + - ]: 24 : {"label", RPCArg::Type::STR, RPCArg::Optional::NO, "The selected label, may be the default label using \"\"."},
129 [ + - + - : 36 : {"minconf", RPCArg::Type::NUM, RPCArg::Default{1}, "Only include transactions confirmed at least this many times."},
+ - ]
130 [ + - + - : 36 : {"include_immature_coinbase", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include immature coinbase transactions."},
+ - ]
131 : : },
132 [ + - ]: 24 : RPCResult{
133 [ + - + - ]: 24 : RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " received for this label."
134 [ + - ]: 24 : },
135 : 12 : RPCExamples{
136 : : "\nAmount received by the default label with at least 1 confirmation\n"
137 [ + - + - : 24 : + HelpExampleCli("getreceivedbylabel", "\"\"") +
+ - + - ]
138 : 12 : "\nAmount received at the tabby label including unconfirmed amounts with zero confirmations\n"
139 [ + - + - : 48 : + HelpExampleCli("getreceivedbylabel", "\"tabby\" 0") +
+ - + - ]
140 : 12 : "\nThe amount with at least 6 confirmations\n"
141 [ + - + - : 48 : + HelpExampleCli("getreceivedbylabel", "\"tabby\" 6") +
+ - + - ]
142 : 12 : "\nThe amount with at least 6 confirmations including immature coinbase outputs\n"
143 [ + - + - : 48 : + HelpExampleCli("getreceivedbylabel", "\"tabby\" 6 true") +
+ - + - ]
144 : 12 : "\nAs a JSON-RPC call\n"
145 [ + - + - : 48 : + HelpExampleRpc("getreceivedbylabel", "\"tabby\", 6, true")
+ - + - ]
146 [ + - ]: 12 : },
147 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
148 : : {
149 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
150 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
151 : :
152 : : // Make sure the results are valid at least up to the most recent block
153 : : // the user could have gotten from another RPC command prior to now
154 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
155 : :
156 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
157 : :
158 [ # # # # ]: 0 : return ValueFromAmount(GetReceived(*pwallet, request.params, /*by_label=*/true));
159 : 0 : },
160 [ + - + - : 84 : };
+ + - - ]
161 [ + - + - : 72 : }
+ - - - ]
162 : :
163 : :
164 : 12 : RPCHelpMan getbalance()
165 : : {
166 : 12 : return RPCHelpMan{
167 : 12 : "getbalance",
168 [ + - ]: 24 : "Returns the total available balance.\n"
169 : : "The available balance is what the wallet considers currently spendable, and is\n"
170 : : "thus affected by options which limit spendability such as -spendzeroconfchange.\n",
171 : : {
172 [ + - + - ]: 24 : {"dummy", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "Remains for backward compatibility. Must be excluded or set to \"*\"."},
173 [ + - + - : 36 : {"minconf", RPCArg::Type::NUM, RPCArg::Default{0}, "Only include transactions confirmed at least this many times."},
+ - ]
174 [ + - + - : 36 : {"include_watchonly", RPCArg::Type::BOOL, RPCArg::Default{false}, "No longer used"},
+ - ]
175 [ + - + - : 36 : {"avoid_reuse", RPCArg::Type::BOOL, RPCArg::Default{true}, "(only available if avoid_reuse wallet flag is set) Do not include balance in dirty outputs; addresses are considered dirty if they have previously been used in a transaction."},
+ - ]
176 : : },
177 [ + - ]: 24 : RPCResult{
178 [ + - + - ]: 24 : RPCResult::Type::STR_AMOUNT, "amount", "The total amount in " + CURRENCY_UNIT + " received for this wallet."
179 [ + - ]: 24 : },
180 : 12 : RPCExamples{
181 : : "\nThe total amount in the wallet with 0 or more confirmations\n"
182 [ + - + - : 24 : + HelpExampleCli("getbalance", "") +
+ - + - ]
183 : 12 : "\nThe total amount in the wallet with at least 6 confirmations\n"
184 [ + - + - : 48 : + HelpExampleCli("getbalance", "\"*\" 6") +
+ - + - ]
185 : 12 : "\nAs a JSON-RPC call\n"
186 [ + - + - : 48 : + HelpExampleRpc("getbalance", "\"*\", 6")
+ - + - ]
187 [ + - ]: 12 : },
188 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
189 : : {
190 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
191 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
192 : :
193 : : // Make sure the results are valid at least up to the most recent block
194 : : // the user could have gotten from another RPC command prior to now
195 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
196 : :
197 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
198 : :
199 [ # # # # ]: 0 : if (self.MaybeArg<std::string_view>("dummy").value_or("*") != "*") {
200 [ # # # # ]: 0 : throw JSONRPCError(RPC_METHOD_DEPRECATED, "dummy first argument must be excluded or set to \"*\".");
201 : : }
202 : :
203 [ # # ]: 0 : const auto min_depth{self.Arg<int>("minconf")};
204 : :
205 [ # # # # ]: 0 : bool avoid_reuse = GetAvoidReuseFlag(*pwallet, request.params[3]);
206 : :
207 [ # # ]: 0 : const auto bal = GetBalance(*pwallet, min_depth, avoid_reuse);
208 : :
209 [ # # ]: 0 : return ValueFromAmount(bal.m_mine_trusted);
210 : 0 : },
211 [ + - + - : 96 : };
+ + - - ]
212 [ + - + - : 96 : }
+ - + - -
- ]
213 : :
214 : 12 : RPCHelpMan lockunspent()
215 : : {
216 : 12 : return RPCHelpMan{
217 : 12 : "lockunspent",
218 [ + - ]: 24 : "Updates list of temporarily unspendable outputs.\n"
219 : : "Temporarily lock (unlock=false) or unlock (unlock=true) specified transaction outputs.\n"
220 : : "If no transaction outputs are specified when unlocking then all current locked transaction outputs are unlocked.\n"
221 : : "A locked transaction output will not be chosen by automatic coin selection, when spending bitcoins.\n"
222 : : "Manually selected coins are automatically unlocked.\n"
223 : : "Locks are stored in memory only, unless persistent=true, in which case they will be written to the\n"
224 : : "wallet database and loaded on node start. Unwritten (persistent=false) locks are always cleared\n"
225 : : "(by virtue of process exit) when a node stops or fails. Unlocking will clear both persistent and not.\n"
226 : : "Also see the listunspent call\n",
227 : : {
228 [ + - + - ]: 24 : {"unlock", RPCArg::Type::BOOL, RPCArg::Optional::NO, "Whether to unlock (true) or lock (false) the specified transactions"},
229 [ + - + - ]: 24 : {"transactions", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The transaction outputs and within each, the txid (string) vout (numeric).",
230 : : {
231 [ + - + - ]: 24 : {"", RPCArg::Type::OBJ, RPCArg::Optional::OMITTED, "",
232 : : {
233 [ + - + - ]: 24 : {"txid", RPCArg::Type::STR_HEX, RPCArg::Optional::NO, "The transaction id"},
234 [ + - + - ]: 24 : {"vout", RPCArg::Type::NUM, RPCArg::Optional::NO, "The output number"},
235 : : },
236 : : },
237 : : },
238 : : },
239 [ + - + - : 36 : {"persistent", RPCArg::Type::BOOL, RPCArg::Default{false}, "Whether to write/erase this lock in the wallet database, or keep the change in memory only. Ignored for unlocking."},
+ - ]
240 : : },
241 [ + - ]: 24 : RPCResult{
242 [ + - + - ]: 24 : RPCResult::Type::BOOL, "", "Whether the command was successful or not"
243 [ + - ]: 24 : },
244 : 12 : RPCExamples{
245 : : "\nList the unspent transactions\n"
246 [ + - + - : 24 : + HelpExampleCli("listunspent", "") +
+ - + - ]
247 : 12 : "\nLock an unspent transaction\n"
248 [ + - + - : 48 : + HelpExampleCli("lockunspent", "false \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\"") +
+ - + - ]
249 : 12 : "\nList the locked transactions\n"
250 [ + - + - : 48 : + HelpExampleCli("listlockunspent", "") +
+ - + - ]
251 : 12 : "\nUnlock the transaction again\n"
252 [ + - + - : 48 : + HelpExampleCli("lockunspent", "true \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\"") +
+ - + - ]
253 : 12 : "\nLock the transaction persistently in the wallet database\n"
254 [ + - + - : 48 : + HelpExampleCli("lockunspent", "false \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\" true") +
+ - + - ]
255 : 12 : "\nAs a JSON-RPC call\n"
256 [ + - + - : 48 : + HelpExampleRpc("lockunspent", "false, \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\"")
+ - + - ]
257 [ + - ]: 12 : },
258 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
259 : : {
260 : 0 : std::shared_ptr<CWallet> const pwallet = GetWalletForJSONRPCRequest(request);
261 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
262 : :
263 : : // Make sure the results are valid at least up to the most recent block
264 : : // the user could have gotten from another RPC command prior to now
265 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
266 : :
267 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
268 : :
269 [ # # # # ]: 0 : bool fUnlock = request.params[0].get_bool();
270 : :
271 [ # # # # : 0 : const bool persistent{request.params[2].isNull() ? false : request.params[2].get_bool()};
# # # # ]
272 : :
273 [ # # # # ]: 0 : if (request.params[1].isNull()) {
274 [ # # ]: 0 : if (fUnlock) {
275 [ # # # # ]: 0 : if (!pwallet->UnlockAllCoins())
276 [ # # # # ]: 0 : throw JSONRPCError(RPC_WALLET_ERROR, "Unlocking coins failed");
277 : : }
278 [ # # ]: 0 : return true;
279 : : }
280 : :
281 [ # # # # ]: 0 : const UniValue& output_params = request.params[1].get_array();
282 : :
283 : : // Create and validate the COutPoints first.
284 : :
285 : 0 : std::vector<COutPoint> outputs;
286 [ # # # # ]: 0 : outputs.reserve(output_params.size());
287 : :
288 [ # # # # ]: 0 : for (unsigned int idx = 0; idx < output_params.size(); idx++) {
289 [ # # # # ]: 0 : const UniValue& o = output_params[idx].get_obj();
290 : :
291 [ # # # # : 0 : RPCTypeCheckObj(o,
# # ]
292 : : {
293 [ # # ]: 0 : {"txid", UniValueType(UniValue::VSTR)},
294 [ # # ]: 0 : {"vout", UniValueType(UniValue::VNUM)},
295 : : });
296 : :
297 [ # # ]: 0 : const Txid txid = Txid::FromUint256(ParseHashO(o, "txid"));
298 [ # # # # ]: 0 : const int nOutput = o.find_value("vout").getInt<int>();
299 [ # # ]: 0 : if (nOutput < 0) {
300 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout cannot be negative");
301 : : }
302 : :
303 [ # # ]: 0 : const COutPoint outpt(txid, nOutput);
304 : :
305 [ # # ]: 0 : const auto it = pwallet->mapWallet.find(outpt.hash);
306 [ # # ]: 0 : if (it == pwallet->mapWallet.end()) {
307 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, unknown transaction");
308 : : }
309 : :
310 [ # # ]: 0 : const CWalletTx& trans = it->second;
311 : :
312 [ # # # # ]: 0 : if (outpt.n >= trans.tx->vout.size()) {
313 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, vout index out of bounds");
314 : : }
315 : :
316 [ # # # # ]: 0 : if (pwallet->IsSpent(outpt)) {
317 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, expected unspent output");
318 : : }
319 : :
320 [ # # ]: 0 : const bool is_locked = pwallet->IsLockedCoin(outpt);
321 : :
322 [ # # ]: 0 : if (fUnlock && !is_locked) {
323 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, expected locked output");
324 : : }
325 : :
326 [ # # # # ]: 0 : if (!fUnlock && is_locked && !persistent) {
327 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Invalid parameter, output already locked");
328 : : }
329 : :
330 [ # # ]: 0 : outputs.push_back(outpt);
331 : : }
332 : :
333 : : // Atomically set (un)locked status for the outputs.
334 [ # # ]: 0 : for (const COutPoint& outpt : outputs) {
335 [ # # ]: 0 : if (fUnlock) {
336 [ # # # # : 0 : if (!pwallet->UnlockCoin(outpt)) throw JSONRPCError(RPC_WALLET_ERROR, "Unlocking coin failed");
# # # # ]
337 : : } else {
338 [ # # # # : 0 : if (!pwallet->LockCoin(outpt, persistent)) throw JSONRPCError(RPC_WALLET_ERROR, "Locking coin failed");
# # # # ]
339 : : }
340 : : }
341 : :
342 [ # # ]: 0 : return true;
343 [ # # # # : 0 : },
# # # # ]
344 [ + - + - : 168 : };
+ - + - +
+ + + + +
- - - - -
- ]
345 [ + - + - : 144 : }
+ - + - +
- + - - -
- - ]
346 : :
347 : 12 : RPCHelpMan listlockunspent()
348 : : {
349 : 12 : return RPCHelpMan{
350 : 12 : "listlockunspent",
351 [ + - ]: 24 : "Returns list of temporarily unspendable outputs.\n"
352 : : "See the lockunspent call to lock and unlock transactions for spending.\n",
353 : : {},
354 [ + - ]: 24 : RPCResult{
355 [ + - ]: 24 : RPCResult::Type::ARR, "", "",
356 : : {
357 [ + - + - ]: 24 : {RPCResult::Type::OBJ, "", "",
358 : : {
359 [ + - + - ]: 24 : {RPCResult::Type::STR_HEX, "txid", "The transaction id locked"},
360 [ + - + - ]: 24 : {RPCResult::Type::NUM, "vout", "The vout value"},
361 : : }},
362 : : }
363 [ + - + - : 84 : },
+ - + + +
+ - - -
- ]
364 : 12 : RPCExamples{
365 : : "\nList the unspent transactions\n"
366 [ + - + - : 24 : + HelpExampleCli("listunspent", "") +
+ - + - ]
367 : 12 : "\nLock an unspent transaction\n"
368 [ + - + - : 48 : + HelpExampleCli("lockunspent", "false \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\"") +
+ - + - ]
369 : 12 : "\nList the locked transactions\n"
370 [ + - + - : 48 : + HelpExampleCli("listlockunspent", "") +
+ - + - ]
371 : 12 : "\nUnlock the transaction again\n"
372 [ + - + - : 48 : + HelpExampleCli("lockunspent", "true \"[{\\\"txid\\\":\\\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\\\",\\\"vout\\\":1}]\"") +
+ - + - ]
373 : 12 : "\nAs a JSON-RPC call\n"
374 [ + - + - : 48 : + HelpExampleRpc("listlockunspent", "")
+ - + - ]
375 [ + - ]: 12 : },
376 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
377 : : {
378 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
379 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
380 : :
381 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
382 : :
383 : 0 : std::vector<COutPoint> vOutpts;
384 [ # # ]: 0 : pwallet->ListLockedCoins(vOutpts);
385 : :
386 : 0 : UniValue ret(UniValue::VARR);
387 : :
388 [ # # ]: 0 : for (const COutPoint& outpt : vOutpts) {
389 : 0 : UniValue o(UniValue::VOBJ);
390 : :
391 [ # # # # : 0 : o.pushKV("txid", outpt.hash.GetHex());
# # # # ]
392 [ # # # # : 0 : o.pushKV("vout", (int)outpt.n);
# # ]
393 [ # # ]: 0 : ret.push_back(std::move(o));
394 : 0 : }
395 : :
396 : 0 : return ret;
397 [ # # ]: 0 : },
398 [ + - + - ]: 48 : };
399 [ + - + - : 36 : }
+ - - - ]
400 : :
401 : 12 : RPCHelpMan getbalances()
402 : : {
403 : 12 : return RPCHelpMan{
404 : 12 : "getbalances",
405 [ + - ]: 24 : "Returns an object with all balances in " + CURRENCY_UNIT + ".\n",
406 : : {},
407 [ + - ]: 24 : RPCResult{
408 [ + - ]: 24 : RPCResult::Type::OBJ, "", "",
409 : : {
410 [ + - + - ]: 24 : {RPCResult::Type::OBJ, "mine", "balances from outputs that the wallet can sign",
411 : : {
412 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "trusted", "trusted balance (outputs created by the wallet or confirmed outputs)"},
413 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "untrusted_pending", "untrusted pending balance (outputs created by others that are in the mempool)"},
414 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "immature", "balance from immature coinbase outputs"},
415 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "used", /*optional=*/true, "(only present if avoid_reuse is set) balance from coins sent to addresses that were previously spent from (potentially privacy violating)"},
416 : : }},
417 : : RESULT_LAST_PROCESSED_BLOCK,
418 : : }
419 [ + - + - : 144 : },
+ - + + +
+ - - -
- ]
420 : 12 : RPCExamples{
421 [ + - + - : 24 : HelpExampleCli("getbalances", "") +
+ - ]
422 [ + - + - : 48 : HelpExampleRpc("getbalances", "")},
+ - + - +
- ]
423 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
424 : : {
425 [ # # ]: 0 : const std::shared_ptr<const CWallet> rpc_wallet = GetWalletForJSONRPCRequest(request);
426 [ # # ]: 0 : if (!rpc_wallet) return UniValue::VNULL;
427 [ # # ]: 0 : const CWallet& wallet = *rpc_wallet;
428 : :
429 : : // Make sure the results are valid at least up to the most recent block
430 : : // the user could have gotten from another RPC command prior to now
431 [ # # ]: 0 : wallet.BlockUntilSyncedToCurrentChain();
432 : :
433 [ # # ]: 0 : LOCK(wallet.cs_wallet);
434 : :
435 [ # # ]: 0 : const auto bal = GetBalance(wallet);
436 : 0 : UniValue balances{UniValue::VOBJ};
437 : 0 : {
438 : 0 : UniValue balances_mine{UniValue::VOBJ};
439 [ # # # # : 0 : balances_mine.pushKV("trusted", ValueFromAmount(bal.m_mine_trusted));
# # ]
440 [ # # # # : 0 : balances_mine.pushKV("untrusted_pending", ValueFromAmount(bal.m_mine_untrusted_pending));
# # ]
441 [ # # # # : 0 : balances_mine.pushKV("immature", ValueFromAmount(bal.m_mine_immature));
# # ]
442 [ # # # # ]: 0 : if (wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE)) {
443 : : // If the AVOID_REUSE flag is set, bal has been set to just the un-reused address balance. Get
444 : : // the total balance, and then subtract bal to get the reused address balance.
445 [ # # ]: 0 : const auto full_bal = GetBalance(wallet, 0, false);
446 [ # # # # : 0 : balances_mine.pushKV("used", ValueFromAmount(full_bal.m_mine_trusted + full_bal.m_mine_untrusted_pending - bal.m_mine_trusted - bal.m_mine_untrusted_pending));
# # ]
447 : : }
448 [ # # # # ]: 0 : balances.pushKV("mine", std::move(balances_mine));
449 : 0 : }
450 [ # # ]: 0 : AppendLastProcessedBlock(balances, wallet);
451 : 0 : return balances;
452 [ # # ]: 0 : },
453 [ + - + - ]: 48 : };
454 [ + - + - : 60 : }
+ - + - +
- + - - -
- - ]
455 : :
456 : 12 : RPCHelpMan listunspent()
457 : : {
458 : 12 : return RPCHelpMan{
459 : 12 : "listunspent",
460 [ + - ]: 24 : "Returns array of unspent transaction outputs\n"
461 : : "with between minconf and maxconf (inclusive) confirmations.\n"
462 : : "Optionally filter to only include txouts paid to specified addresses.\n",
463 : : {
464 [ + - + - : 36 : {"minconf", RPCArg::Type::NUM, RPCArg::Default{1}, "The minimum confirmations to filter"},
+ - ]
465 [ + - + - : 36 : {"maxconf", RPCArg::Type::NUM, RPCArg::Default{9999999}, "The maximum confirmations to filter"},
+ - ]
466 [ + - + - ]: 24 : {"addresses", RPCArg::Type::ARR, RPCArg::Default{UniValue::VARR}, "The bitcoin addresses to filter",
467 : : {
468 [ + - + - ]: 24 : {"address", RPCArg::Type::STR, RPCArg::Optional::OMITTED, "bitcoin address"},
469 : : },
470 : : },
471 [ + - + - : 36 : {"include_unsafe", RPCArg::Type::BOOL, RPCArg::Default{true}, "Include outputs that are not safe to spend\n"
+ - ]
472 : : "See description of \"safe\" attribute below."},
473 [ + - + - ]: 24 : {"query_options", RPCArg::Type::OBJ_NAMED_PARAMS, RPCArg::Optional::OMITTED, "",
474 : : {
475 [ + - + - : 36 : {"minimumAmount", RPCArg::Type::AMOUNT, RPCArg::Default{FormatMoney(0)}, "Minimum value of each UTXO in " + CURRENCY_UNIT + ""},
+ - + - ]
476 [ + - + - : 36 : {"maximumAmount", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"unlimited"}, "Maximum value of each UTXO in " + CURRENCY_UNIT + ""},
+ - ]
477 [ + - + - : 36 : {"maximumCount", RPCArg::Type::NUM, RPCArg::DefaultHint{"unlimited"}, "Maximum number of UTXOs"},
+ - ]
478 [ + - + - : 36 : {"minimumSumAmount", RPCArg::Type::AMOUNT, RPCArg::DefaultHint{"unlimited"}, "Minimum sum value of all UTXOs in " + CURRENCY_UNIT + ""},
+ - ]
479 [ + - + - : 36 : {"include_immature_coinbase", RPCArg::Type::BOOL, RPCArg::Default{false}, "Include immature coinbase UTXOs"}
+ - ]
480 : : },
481 [ + - ]: 12 : RPCArgOptions{.oneline_description="query_options"}},
482 : : },
483 [ + - ]: 24 : RPCResult{
484 [ + - + - ]: 24 : RPCResult::Type::ARR, "", "",
485 : : {
486 [ + - + - ]: 24 : {RPCResult::Type::OBJ, "", "",
487 : : {
488 [ + - + - ]: 24 : {RPCResult::Type::STR_HEX, "txid", "the transaction id"},
489 [ + - + - ]: 24 : {RPCResult::Type::NUM, "vout", "the vout value"},
490 [ + - + - ]: 24 : {RPCResult::Type::STR, "address", /*optional=*/true, "the bitcoin address"},
491 [ + - + - ]: 24 : {RPCResult::Type::STR, "label", /*optional=*/true, "The associated label, or \"\" for the default label"},
492 [ + - + - ]: 24 : {RPCResult::Type::STR, "scriptPubKey", "the output script"},
493 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "amount", "the transaction output amount in " + CURRENCY_UNIT},
494 [ + - + - ]: 24 : {RPCResult::Type::NUM, "confirmations", "The number of confirmations"},
495 [ + - + - ]: 24 : {RPCResult::Type::NUM, "ancestorcount", /*optional=*/true, "The number of in-mempool ancestor transactions, including this one (if transaction is in the mempool)"},
496 [ + - + - ]: 24 : {RPCResult::Type::NUM, "ancestorsize", /*optional=*/true, "The virtual transaction size of in-mempool ancestors, including this one (if transaction is in the mempool)"},
497 [ + - + - ]: 24 : {RPCResult::Type::STR_AMOUNT, "ancestorfees", /*optional=*/true, "The total fees of in-mempool ancestors (including this one) with fee deltas used for mining priority in " + CURRENCY_ATOM + " (if transaction is in the mempool)"},
498 [ + - + - ]: 24 : {RPCResult::Type::STR_HEX, "redeemScript", /*optional=*/true, "The redeem script if the output script is P2SH"},
499 [ + - + - ]: 24 : {RPCResult::Type::STR, "witnessScript", /*optional=*/true, "witness script if the output script is P2WSH or P2SH-P2WSH"},
500 [ + - + - ]: 24 : {RPCResult::Type::BOOL, "spendable", "(DEPRECATED) Always true"},
501 [ + - + - ]: 24 : {RPCResult::Type::BOOL, "solvable", "Whether we know how to spend this output, ignoring the lack of keys"},
502 [ + - + - ]: 24 : {RPCResult::Type::BOOL, "reused", /*optional=*/true, "(only present if avoid_reuse is set) Whether this output is reused/dirty (sent to an address that was previously spent from)"},
503 [ + - + - ]: 24 : {RPCResult::Type::STR, "desc", /*optional=*/true, "(only when solvable) A descriptor for spending this output"},
504 [ + - + - ]: 24 : {RPCResult::Type::ARR, "parent_descs", /*optional=*/false, "List of parent descriptors for the output script of this coin.", {
505 [ + - + - ]: 24 : {RPCResult::Type::STR, "desc", "The descriptor string."},
506 : : }},
507 [ + - + - ]: 24 : {RPCResult::Type::BOOL, "safe", "Whether this output is considered safe to spend. Unconfirmed transactions\n"
508 : : "from outside keys and unconfirmed replacement transactions are considered unsafe\n"
509 : : "and are not eligible for spending by fundrawtransaction and sendtoaddress."},
510 : : }},
511 : : }
512 [ + - + - : 492 : },
+ - + - +
+ + + + +
- - - - -
- ]
513 : 12 : RPCExamples{
514 [ + - + - : 24 : HelpExampleCli("listunspent", "")
+ - ]
515 [ + - + - : 72 : + HelpExampleCli("listunspent", "6 9999999 \"[\\\"" + EXAMPLE_ADDRESS[0] + "\\\",\\\"" + EXAMPLE_ADDRESS[1] + "\\\"]\"")
+ - + - +
- ]
516 [ + - + - : 72 : + HelpExampleRpc("listunspent", "6, 9999999 \"[\\\"" + EXAMPLE_ADDRESS[0] + "\\\",\\\"" + EXAMPLE_ADDRESS[1] + "\\\"]\"")
+ - + - +
- ]
517 [ + - + - : 48 : + HelpExampleCli("listunspent", "6 9999999 '[]' true '{ \"minimumAmount\": 0.005 }'")
+ - + - ]
518 [ + - + - : 48 : + HelpExampleRpc("listunspent", "6, 9999999, [] , true, { \"minimumAmount\": 0.005 } ")
+ - + - ]
519 [ + - ]: 12 : },
520 : 12 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
521 : : {
522 [ # # ]: 0 : const std::shared_ptr<const CWallet> pwallet = GetWalletForJSONRPCRequest(request);
523 [ # # ]: 0 : if (!pwallet) return UniValue::VNULL;
524 : :
525 : 0 : int nMinDepth = 1;
526 [ # # # # ]: 0 : if (!request.params[0].isNull()) {
527 [ # # # # ]: 0 : nMinDepth = request.params[0].getInt<int>();
528 : : }
529 : :
530 : 0 : int nMaxDepth = 9999999;
531 [ # # # # ]: 0 : if (!request.params[1].isNull()) {
532 [ # # # # ]: 0 : nMaxDepth = request.params[1].getInt<int>();
533 : : }
534 : :
535 [ # # ]: 0 : std::set<CTxDestination> destinations;
536 [ # # # # ]: 0 : if (!request.params[2].isNull()) {
537 [ # # # # : 0 : UniValue inputs = request.params[2].get_array();
# # ]
538 [ # # # # ]: 0 : for (unsigned int idx = 0; idx < inputs.size(); idx++) {
539 [ # # ]: 0 : const UniValue& input = inputs[idx];
540 [ # # # # ]: 0 : CTxDestination dest = DecodeDestination(input.get_str());
541 [ # # # # ]: 0 : if (!IsValidDestination(dest)) {
542 [ # # # # : 0 : throw JSONRPCError(RPC_INVALID_ADDRESS_OR_KEY, std::string("Invalid Bitcoin address: ") + input.get_str());
# # # # ]
543 : : }
544 [ # # # # ]: 0 : if (!destinations.insert(dest).second) {
545 [ # # # # : 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, std::string("Invalid parameter, duplicated address: ") + input.get_str());
# # # # ]
546 : : }
547 : 0 : }
548 : 0 : }
549 : :
550 : 0 : bool include_unsafe = true;
551 [ # # # # ]: 0 : if (!request.params[3].isNull()) {
552 [ # # # # ]: 0 : include_unsafe = request.params[3].get_bool();
553 : : }
554 : :
555 : 0 : CoinFilterParams filter_coins;
556 : 0 : filter_coins.min_amount = 0;
557 : :
558 [ # # # # ]: 0 : if (!request.params[4].isNull()) {
559 [ # # # # ]: 0 : const UniValue& options = request.params[4].get_obj();
560 : :
561 [ # # # # : 0 : RPCTypeCheckObj(options,
# # ]
562 : : {
563 [ # # ]: 0 : {"minimumAmount", UniValueType()},
564 [ # # ]: 0 : {"maximumAmount", UniValueType()},
565 [ # # ]: 0 : {"minimumSumAmount", UniValueType()},
566 [ # # ]: 0 : {"maximumCount", UniValueType(UniValue::VNUM)},
567 [ # # ]: 0 : {"include_immature_coinbase", UniValueType(UniValue::VBOOL)}
568 : : },
569 : : true, true);
570 : :
571 [ # # # # ]: 0 : if (options.exists("minimumAmount"))
572 [ # # # # : 0 : filter_coins.min_amount = AmountFromValue(options["minimumAmount"]);
# # ]
573 : :
574 [ # # # # ]: 0 : if (options.exists("maximumAmount"))
575 [ # # # # : 0 : filter_coins.max_amount = AmountFromValue(options["maximumAmount"]);
# # ]
576 : :
577 [ # # # # ]: 0 : if (options.exists("minimumSumAmount"))
578 [ # # # # : 0 : filter_coins.min_sum_amount = AmountFromValue(options["minimumSumAmount"]);
# # ]
579 : :
580 [ # # # # ]: 0 : if (options.exists("maximumCount"))
581 [ # # # # : 0 : filter_coins.max_count = options["maximumCount"].getInt<int64_t>();
# # ]
582 : :
583 [ # # # # ]: 0 : if (options.exists("include_immature_coinbase")) {
584 [ # # # # : 0 : filter_coins.include_immature_coinbase = options["include_immature_coinbase"].get_bool();
# # ]
585 : : }
586 : : }
587 : :
588 : : // Make sure the results are valid at least up to the most recent block
589 : : // the user could have gotten from another RPC command prior to now
590 [ # # ]: 0 : pwallet->BlockUntilSyncedToCurrentChain();
591 : :
592 : 0 : UniValue results(UniValue::VARR);
593 : 0 : std::vector<COutput> vecOutputs;
594 : 0 : {
595 [ # # ]: 0 : CCoinControl cctl;
596 : 0 : cctl.m_avoid_address_reuse = false;
597 : 0 : cctl.m_min_depth = nMinDepth;
598 : 0 : cctl.m_max_depth = nMaxDepth;
599 : 0 : cctl.m_include_unsafe_inputs = include_unsafe;
600 : 0 : filter_coins.check_version_trucness = false;
601 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
602 [ # # # # : 0 : vecOutputs = AvailableCoins(*pwallet, &cctl, /*feerate=*/std::nullopt, filter_coins).All();
# # ]
603 : 0 : }
604 : :
605 [ # # ]: 0 : LOCK(pwallet->cs_wallet);
606 : :
607 [ # # ]: 0 : const bool avoid_reuse = pwallet->IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
608 : :
609 [ # # ]: 0 : for (const COutput& out : vecOutputs) {
610 : 0 : CTxDestination address;
611 : 0 : const CScript& scriptPubKey = out.txout.scriptPubKey;
612 [ # # ]: 0 : bool fValidAddress = ExtractDestination(scriptPubKey, address);
613 [ # # # # : 0 : bool reused = avoid_reuse && pwallet->IsSpentKey(scriptPubKey);
# # ]
614 : :
615 [ # # # # : 0 : if (destinations.size() && (!fValidAddress || !destinations.count(address)))
# # ]
616 : 0 : continue;
617 : :
618 : 0 : UniValue entry(UniValue::VOBJ);
619 [ # # # # : 0 : entry.pushKV("txid", out.outpoint.hash.GetHex());
# # # # ]
620 [ # # # # : 0 : entry.pushKV("vout", (int)out.outpoint.n);
# # ]
621 : :
622 [ # # ]: 0 : if (fValidAddress) {
623 [ # # # # : 0 : entry.pushKV("address", EncodeDestination(address));
# # # # ]
624 : :
625 [ # # ]: 0 : const auto* address_book_entry = pwallet->FindAddressBookEntry(address);
626 [ # # ]: 0 : if (address_book_entry) {
627 [ # # # # : 0 : entry.pushKV("label", address_book_entry->GetLabel());
# # # # ]
628 : : }
629 : :
630 [ # # ]: 0 : std::unique_ptr<SigningProvider> provider = pwallet->GetSolvingProvider(scriptPubKey);
631 [ # # ]: 0 : if (provider) {
632 [ # # # # ]: 0 : if (scriptPubKey.IsPayToScriptHash()) {
633 [ # # # # ]: 0 : const CScriptID hash = ToScriptID(std::get<ScriptHash>(address));
634 : 0 : CScript redeemScript;
635 [ # # # # ]: 0 : if (provider->GetCScript(hash, redeemScript)) {
636 [ # # # # : 0 : entry.pushKV("redeemScript", HexStr(redeemScript));
# # # # #
# ]
637 : : // Now check if the redeemScript is actually a P2WSH script
638 : 0 : CTxDestination witness_destination;
639 [ # # # # ]: 0 : if (redeemScript.IsPayToWitnessScriptHash()) {
640 [ # # ]: 0 : bool extracted = ExtractDestination(redeemScript, witness_destination);
641 [ # # ]: 0 : CHECK_NONFATAL(extracted);
642 : : // Also return the witness script
643 [ # # ]: 0 : const WitnessV0ScriptHash& whash = std::get<WitnessV0ScriptHash>(witness_destination);
644 [ # # ]: 0 : CScriptID id{RIPEMD160(whash)};
645 : 0 : CScript witnessScript;
646 [ # # # # ]: 0 : if (provider->GetCScript(id, witnessScript)) {
647 [ # # # # : 0 : entry.pushKV("witnessScript", HexStr(witnessScript));
# # # # #
# ]
648 : : }
649 : 0 : }
650 : 0 : }
651 [ # # # # ]: 0 : } else if (scriptPubKey.IsPayToWitnessScriptHash()) {
652 [ # # ]: 0 : const WitnessV0ScriptHash& whash = std::get<WitnessV0ScriptHash>(address);
653 [ # # ]: 0 : CScriptID id{RIPEMD160(whash)};
654 : 0 : CScript witnessScript;
655 [ # # # # ]: 0 : if (provider->GetCScript(id, witnessScript)) {
656 [ # # # # : 0 : entry.pushKV("witnessScript", HexStr(witnessScript));
# # # # #
# ]
657 : : }
658 : 0 : }
659 : : }
660 : 0 : }
661 : :
662 [ # # # # : 0 : entry.pushKV("scriptPubKey", HexStr(scriptPubKey));
# # # # #
# ]
663 [ # # # # : 0 : entry.pushKV("amount", ValueFromAmount(out.txout.nValue));
# # ]
664 [ # # # # : 0 : entry.pushKV("confirmations", out.depth);
# # ]
665 [ # # ]: 0 : if (!out.depth) {
666 : 0 : size_t ancestor_count, descendant_count, ancestor_size;
667 : 0 : CAmount ancestor_fees;
668 [ # # ]: 0 : pwallet->chain().getTransactionAncestry(out.outpoint.hash, ancestor_count, descendant_count, &ancestor_size, &ancestor_fees);
669 [ # # ]: 0 : if (ancestor_count) {
670 [ # # # # : 0 : entry.pushKV("ancestorcount", uint64_t(ancestor_count));
# # ]
671 [ # # # # : 0 : entry.pushKV("ancestorsize", uint64_t(ancestor_size));
# # ]
672 [ # # # # : 0 : entry.pushKV("ancestorfees", uint64_t(ancestor_fees));
# # ]
673 : : }
674 : : }
675 [ # # # # : 0 : entry.pushKV("spendable", true); // Any coins we list are always spendable
# # ]
676 [ # # # # : 0 : entry.pushKV("solvable", out.solvable);
# # ]
677 [ # # ]: 0 : if (out.solvable) {
678 [ # # ]: 0 : std::unique_ptr<SigningProvider> provider = pwallet->GetSolvingProvider(scriptPubKey);
679 [ # # ]: 0 : if (provider) {
680 [ # # ]: 0 : auto descriptor = InferDescriptor(scriptPubKey, *provider);
681 [ # # # # : 0 : entry.pushKV("desc", descriptor->ToString());
# # # # ]
682 : 0 : }
683 : 0 : }
684 [ # # ]: 0 : PushParentDescriptors(*pwallet, scriptPubKey, entry);
685 [ # # # # : 0 : if (avoid_reuse) entry.pushKV("reused", reused);
# # # # ]
686 [ # # # # : 0 : entry.pushKV("safe", out.safe);
# # ]
687 [ # # ]: 0 : results.push_back(std::move(entry));
688 : 0 : }
689 : :
690 [ # # ]: 0 : return results;
691 [ # # # # : 0 : },
# # # # #
# # # #
# ]
692 [ + - + - : 228 : };
+ - + - +
+ + + + +
- - - - -
- ]
693 [ + - + - : 492 : }
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - + -
+ - + - +
- + - - -
- - - - ]
694 : : } // namespace wallet
|
