Branch data Line data Source code
1 : : // Copyright (c) 2021-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 <consensus/amount.h>
6 : : #include <consensus/consensus.h>
7 : : #include <util/check.h>
8 : : #include <wallet/receive.h>
9 : : #include <wallet/transaction.h>
10 : : #include <wallet/wallet.h>
11 : :
12 : : namespace wallet {
13 : 0 : bool InputIsMine(const CWallet& wallet, const CTxIn& txin)
14 : : {
15 : 0 : AssertLockHeld(wallet.cs_wallet);
16 : 0 : const CWalletTx* prev = wallet.GetWalletTx(txin.prevout.hash);
17 [ # # # # : 0 : if (prev && txin.prevout.n < prev->tx->vout.size()) {
# # ]
18 : 0 : return wallet.IsMine(prev->tx->vout[txin.prevout.n]);
19 : : }
20 : : return false;
21 : : }
22 : :
23 : 0 : bool AllInputsMine(const CWallet& wallet, const CTransaction& tx)
24 : : {
25 : 0 : LOCK(wallet.cs_wallet);
26 [ # # ]: 0 : for (const CTxIn& txin : tx.vin) {
27 [ # # # # ]: 0 : if (!InputIsMine(wallet, txin)) return false;
28 : : }
29 : : return true;
30 : 0 : }
31 : :
32 : 0 : CAmount OutputGetCredit(const CWallet& wallet, const CTxOut& txout)
33 : : {
34 [ # # ]: 0 : if (!MoneyRange(txout.nValue))
35 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": value out of range");
36 : 0 : LOCK(wallet.cs_wallet);
37 [ # # # # ]: 0 : return (wallet.IsMine(txout) ? txout.nValue : 0);
38 : 0 : }
39 : :
40 : 0 : CAmount TxGetCredit(const CWallet& wallet, const CTransaction& tx)
41 : : {
42 : 0 : CAmount nCredit = 0;
43 [ # # ]: 0 : for (const CTxOut& txout : tx.vout)
44 : : {
45 : 0 : nCredit += OutputGetCredit(wallet, txout);
46 [ # # ]: 0 : if (!MoneyRange(nCredit))
47 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": value out of range");
48 : : }
49 : 0 : return nCredit;
50 : : }
51 : :
52 : 0 : bool ScriptIsChange(const CWallet& wallet, const CScript& script)
53 : : {
54 : : // TODO: fix handling of 'change' outputs. The assumption is that any
55 : : // payment to a script that is ours, but is not in the address book
56 : : // is change. That assumption is likely to break when we implement multisignature
57 : : // wallets that return change back into a multi-signature-protected address;
58 : : // a better way of identifying which outputs are 'the send' and which are
59 : : // 'the change' will need to be implemented (maybe extend CWalletTx to remember
60 : : // which output, if any, was change).
61 : 0 : AssertLockHeld(wallet.cs_wallet);
62 [ # # ]: 0 : if (wallet.IsMine(script))
63 : : {
64 : 0 : CTxDestination address;
65 [ # # # # ]: 0 : if (!ExtractDestination(script, address))
66 : : return true;
67 [ # # # # ]: 0 : if (!wallet.FindAddressBookEntry(address)) {
68 : : return true;
69 : : }
70 : 0 : }
71 : : return false;
72 : : }
73 : :
74 : 0 : bool OutputIsChange(const CWallet& wallet, const CTxOut& txout)
75 : : {
76 : 0 : return ScriptIsChange(wallet, txout.scriptPubKey);
77 : : }
78 : :
79 : 0 : CAmount OutputGetChange(const CWallet& wallet, const CTxOut& txout)
80 : : {
81 : 0 : AssertLockHeld(wallet.cs_wallet);
82 [ # # ]: 0 : if (!MoneyRange(txout.nValue))
83 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": value out of range");
84 [ # # ]: 0 : return (OutputIsChange(wallet, txout) ? txout.nValue : 0);
85 : : }
86 : :
87 : 0 : CAmount TxGetChange(const CWallet& wallet, const CTransaction& tx)
88 : : {
89 : 0 : LOCK(wallet.cs_wallet);
90 : 0 : CAmount nChange = 0;
91 [ # # ]: 0 : for (const CTxOut& txout : tx.vout)
92 : : {
93 [ # # ]: 0 : nChange += OutputGetChange(wallet, txout);
94 [ # # ]: 0 : if (!MoneyRange(nChange))
95 [ # # # # ]: 0 : throw std::runtime_error(std::string(__func__) + ": value out of range");
96 : : }
97 [ # # ]: 0 : return nChange;
98 : 0 : }
99 : :
100 : 0 : static CAmount GetCachableAmount(const CWallet& wallet, const CWalletTx& wtx, CWalletTx::AmountType type, bool avoid_reuse)
101 : : {
102 : 0 : auto& amount = wtx.m_amounts[type];
103 [ # # # # ]: 0 : if (!amount.IsCached(avoid_reuse)) {
104 [ # # # # ]: 0 : amount.Set(avoid_reuse, type == CWalletTx::DEBIT ? wallet.GetDebit(*wtx.tx) : TxGetCredit(wallet, *wtx.tx));
105 : 0 : wtx.m_is_cache_empty = false;
106 : : }
107 : 0 : return amount.Get(avoid_reuse);
108 : : }
109 : :
110 : 0 : CAmount CachedTxGetCredit(const CWallet& wallet, const CWalletTx& wtx, bool avoid_reuse)
111 : : {
112 : 0 : AssertLockHeld(wallet.cs_wallet);
113 : :
114 : : // Must wait until coinbase is safely deep enough in the chain before valuing it
115 [ # # ]: 0 : if (wallet.IsTxImmatureCoinBase(wtx))
116 : : return 0;
117 : :
118 : : // GetBalance can assume transactions in mapWallet won't change
119 : 0 : return GetCachableAmount(wallet, wtx, CWalletTx::CREDIT, avoid_reuse);
120 : : }
121 : :
122 : 0 : CAmount CachedTxGetDebit(const CWallet& wallet, const CWalletTx& wtx, bool avoid_reuse)
123 : : {
124 [ # # ]: 0 : if (wtx.tx->vin.empty())
125 : : return 0;
126 : :
127 : 0 : return GetCachableAmount(wallet, wtx, CWalletTx::DEBIT, avoid_reuse);
128 : : }
129 : :
130 : 0 : CAmount CachedTxGetChange(const CWallet& wallet, const CWalletTx& wtx)
131 : : {
132 [ # # ]: 0 : if (wtx.fChangeCached)
133 : 0 : return wtx.nChangeCached;
134 : 0 : wtx.nChangeCached = TxGetChange(wallet, *wtx.tx);
135 : 0 : wtx.fChangeCached = true;
136 : 0 : return wtx.nChangeCached;
137 : : }
138 : :
139 : 0 : void CachedTxGetAmounts(const CWallet& wallet, const CWalletTx& wtx,
140 : : std::list<COutputEntry>& listReceived,
141 : : std::list<COutputEntry>& listSent, CAmount& nFee,
142 : : bool include_change)
143 : : {
144 : 0 : nFee = 0;
145 : 0 : listReceived.clear();
146 : 0 : listSent.clear();
147 : :
148 : : // Compute fee:
149 : 0 : CAmount nDebit = CachedTxGetDebit(wallet, wtx, /*avoid_reuse=*/false);
150 [ # # ]: 0 : if (nDebit > 0) // debit>0 means we signed/sent this transaction
151 : : {
152 : 0 : CAmount nValueOut = wtx.tx->GetValueOut();
153 : 0 : nFee = nDebit - nValueOut;
154 : : }
155 : :
156 : 0 : LOCK(wallet.cs_wallet);
157 : : // Sent/received.
158 [ # # # # ]: 0 : for (unsigned int i = 0; i < wtx.tx->vout.size(); ++i)
159 : : {
160 [ # # ]: 0 : const CTxOut& txout = wtx.tx->vout[i];
161 [ # # ]: 0 : bool ismine = wallet.IsMine(txout);
162 : : // Only need to handle txouts if AT LEAST one of these is true:
163 : : // 1) they debit from us (sent)
164 : : // 2) the output is to us (received)
165 [ # # ]: 0 : if (nDebit > 0)
166 : : {
167 [ # # # # : 0 : if (!include_change && OutputIsChange(wallet, txout))
# # ]
168 : 0 : continue;
169 : : }
170 [ # # ]: 0 : else if (!ismine)
171 : 0 : continue;
172 : :
173 : : // In either case, we need to get the destination address
174 : 0 : CTxDestination address;
175 : :
176 [ # # # # : 0 : if (!ExtractDestination(txout.scriptPubKey, address) && !txout.scriptPubKey.IsUnspendable())
# # ]
177 : : {
178 [ # # ]: 0 : wallet.WalletLogPrintf("CWalletTx::GetAmounts: Unknown transaction type found, txid %s\n",
179 [ # # # # ]: 0 : wtx.GetHash().ToString());
180 : 0 : address = CNoDestination();
181 : : }
182 : :
183 [ # # ]: 0 : COutputEntry output = {address, txout.nValue, (int)i};
184 : :
185 : : // If we are debited by the transaction, add the output as a "sent" entry
186 [ # # ]: 0 : if (nDebit > 0)
187 [ # # ]: 0 : listSent.push_back(output);
188 : :
189 : : // If we are receiving the output, add it as a "received" entry
190 [ # # ]: 0 : if (ismine)
191 [ # # ]: 0 : listReceived.push_back(output);
192 : 0 : }
193 : :
194 : 0 : }
195 : :
196 : 0 : bool CachedTxIsFromMe(const CWallet& wallet, const CWalletTx& wtx)
197 : : {
198 : 0 : return (CachedTxGetDebit(wallet, wtx, /*avoid_reuse=*/false) > 0);
199 : : }
200 : :
201 : : // NOLINTNEXTLINE(misc-no-recursion)
202 : 0 : bool CachedTxIsTrusted(const CWallet& wallet, const CWalletTx& wtx, std::set<Txid>& trusted_parents)
203 : : {
204 : 0 : AssertLockHeld(wallet.cs_wallet);
205 : :
206 : : // This wtx is already trusted
207 [ # # ]: 0 : if (trusted_parents.contains(wtx.GetHash())) return true;
208 : :
209 [ # # ]: 0 : if (wtx.isConfirmed()) return true;
210 [ # # ]: 0 : if (wtx.isBlockConflicted()) return false;
211 : : // using wtx's cached debit
212 [ # # # # ]: 0 : if (!wallet.m_spend_zero_conf_change || !CachedTxIsFromMe(wallet, wtx)) return false;
213 : :
214 : : // Don't trust unconfirmed transactions from us unless they are in the mempool.
215 [ # # ]: 0 : if (!wtx.InMempool()) return false;
216 : :
217 : : // Trusted if all inputs are from us and are in the mempool:
218 [ # # ]: 0 : for (const CTxIn& txin : wtx.tx->vin)
219 : : {
220 : : // Transactions not sent by us: not trusted
221 : 0 : const CWalletTx* parent = wallet.GetWalletTx(txin.prevout.hash);
222 [ # # ]: 0 : if (parent == nullptr) return false;
223 : 0 : const CTxOut& parentOut = parent->tx->vout[txin.prevout.n];
224 : : // Check that this specific input being spent is trusted
225 [ # # ]: 0 : if (!wallet.IsMine(parentOut)) return false;
226 : : // If we've already trusted this parent, continue
227 [ # # ]: 0 : if (trusted_parents.count(parent->GetHash())) continue;
228 : : // Recurse to check that the parent is also trusted
229 [ # # ]: 0 : if (!CachedTxIsTrusted(wallet, *parent, trusted_parents)) return false;
230 : 0 : trusted_parents.insert(parent->GetHash());
231 : : }
232 : : return true;
233 : : }
234 : :
235 : 0 : bool CachedTxIsTrusted(const CWallet& wallet, const CWalletTx& wtx)
236 : : {
237 [ # # ]: 0 : std::set<Txid> trusted_parents;
238 [ # # ]: 0 : LOCK(wallet.cs_wallet);
239 [ # # # # ]: 0 : return CachedTxIsTrusted(wallet, wtx, trusted_parents);
240 : 0 : }
241 : :
242 : 0 : Balance GetBalance(const CWallet& wallet, const int min_depth, bool avoid_reuse)
243 : : {
244 : 0 : Balance ret;
245 [ # # # # ]: 0 : bool allow_used_addresses = !avoid_reuse || !wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
246 : 0 : {
247 : 0 : LOCK(wallet.cs_wallet);
248 : 0 : std::set<Txid> trusted_parents;
249 [ # # # # ]: 0 : for (const auto& [outpoint, txo] : wallet.GetTXOs()) {
250 [ # # ]: 0 : const CWalletTx& wtx = txo.GetWalletTx();
251 : :
252 [ # # ]: 0 : const bool is_trusted{CachedTxIsTrusted(wallet, wtx, trusted_parents)};
253 [ # # ]: 0 : const int tx_depth{wallet.GetTxDepthInMainChain(wtx)};
254 : :
255 [ # # # # : 0 : if (!wallet.IsSpent(outpoint) && (allow_used_addresses || !wallet.IsSpentKey(txo.GetTxOut().scriptPubKey))) {
# # # # #
# ]
256 : : // Get the amounts for mine
257 [ # # ]: 0 : CAmount credit_mine = txo.GetTxOut().nValue;
258 : :
259 : : // Set the amounts in the return object
260 [ # # # # ]: 0 : if (wallet.IsTxImmatureCoinBase(wtx) && wtx.isConfirmed()) {
261 : 0 : ret.m_mine_immature += credit_mine;
262 [ # # ]: 0 : } else if (is_trusted && tx_depth >= min_depth) {
263 : 0 : ret.m_mine_trusted += credit_mine;
264 [ # # # # : 0 : } else if (!is_trusted && wtx.InMempool()) {
# # ]
265 : 0 : ret.m_mine_untrusted_pending += credit_mine;
266 : : }
267 : : }
268 : : }
269 [ # # ]: 0 : }
270 : 0 : return ret;
271 : : }
272 : :
273 : 0 : std::map<CTxDestination, CAmount> GetAddressBalances(const CWallet& wallet)
274 : : {
275 [ # # ]: 0 : std::map<CTxDestination, CAmount> balances;
276 : :
277 : 0 : {
278 [ # # ]: 0 : LOCK(wallet.cs_wallet);
279 : 0 : std::set<Txid> trusted_parents;
280 [ # # # # ]: 0 : for (const auto& [outpoint, txo] : wallet.GetTXOs()) {
281 [ # # ]: 0 : const CWalletTx& wtx = txo.GetWalletTx();
282 : :
283 [ # # # # ]: 0 : if (!CachedTxIsTrusted(wallet, wtx, trusted_parents)) continue;
284 [ # # # # ]: 0 : if (wallet.IsTxImmatureCoinBase(wtx)) continue;
285 : :
286 [ # # ]: 0 : int nDepth = wallet.GetTxDepthInMainChain(wtx);
287 [ # # # # : 0 : if (nDepth < (CachedTxIsFromMe(wallet, wtx) ? 0 : 1)) continue;
# # ]
288 : :
289 : 0 : CTxDestination addr;
290 [ # # # # ]: 0 : Assume(wallet.IsMine(txo.GetTxOut()));
291 [ # # # # ]: 0 : if(!ExtractDestination(txo.GetTxOut().scriptPubKey, addr)) continue;
292 : :
293 [ # # # # ]: 0 : CAmount n = wallet.IsSpent(outpoint) ? 0 : txo.GetTxOut().nValue;
294 [ # # ]: 0 : balances[addr] += n;
295 : 0 : }
296 [ # # ]: 0 : }
297 : :
298 : 0 : return balances;
299 : 0 : }
300 : :
301 : 0 : std::set< std::set<CTxDestination> > GetAddressGroupings(const CWallet& wallet)
302 : : {
303 : 0 : AssertLockHeld(wallet.cs_wallet);
304 : 0 : std::set< std::set<CTxDestination> > groupings;
305 : 0 : std::set<CTxDestination> grouping;
306 : :
307 [ # # # # ]: 0 : for (const auto& walletEntry : wallet.mapWallet)
308 : : {
309 : 0 : const CWalletTx& wtx = walletEntry.second;
310 : :
311 [ # # # # ]: 0 : if (wtx.tx->vin.size() > 0)
312 : : {
313 : 0 : bool any_mine = false;
314 : : // group all input addresses with each other
315 [ # # ]: 0 : for (const CTxIn& txin : wtx.tx->vin)
316 : : {
317 : 0 : CTxDestination address;
318 [ # # # # ]: 0 : if(!InputIsMine(wallet, txin)) /* If this input isn't mine, ignore it */
319 : 0 : continue;
320 [ # # # # : 0 : if(!ExtractDestination(wallet.mapWallet.at(txin.prevout.hash).tx->vout[txin.prevout.n].scriptPubKey, address))
# # ]
321 : 0 : continue;
322 [ # # ]: 0 : grouping.insert(address);
323 : 0 : any_mine = true;
324 : 0 : }
325 : :
326 : : // group change with input addresses
327 [ # # ]: 0 : if (any_mine)
328 : : {
329 [ # # ]: 0 : for (const CTxOut& txout : wtx.tx->vout)
330 [ # # # # ]: 0 : if (OutputIsChange(wallet, txout))
331 : : {
332 : 0 : CTxDestination txoutAddr;
333 [ # # # # ]: 0 : if(!ExtractDestination(txout.scriptPubKey, txoutAddr))
334 : 0 : continue;
335 [ # # ]: 0 : grouping.insert(txoutAddr);
336 : 0 : }
337 : : }
338 [ # # ]: 0 : if (grouping.size() > 0)
339 : : {
340 [ # # ]: 0 : groupings.insert(grouping);
341 : 0 : grouping.clear();
342 : : }
343 : : }
344 : :
345 : : // group lone addrs by themselves
346 [ # # ]: 0 : for (const auto& txout : wtx.tx->vout)
347 [ # # # # ]: 0 : if (wallet.IsMine(txout))
348 : : {
349 : 0 : CTxDestination address;
350 [ # # # # ]: 0 : if(!ExtractDestination(txout.scriptPubKey, address))
351 : 0 : continue;
352 [ # # ]: 0 : grouping.insert(address);
353 [ # # ]: 0 : groupings.insert(grouping);
354 : 0 : grouping.clear();
355 : 0 : }
356 : : }
357 : :
358 : 0 : std::set< std::set<CTxDestination>* > uniqueGroupings; // a set of pointers to groups of addresses
359 : 0 : std::map< CTxDestination, std::set<CTxDestination>* > setmap; // map addresses to the unique group containing it
360 [ # # ]: 0 : for (const std::set<CTxDestination>& _grouping : groupings)
361 : : {
362 : : // make a set of all the groups hit by this new group
363 : 0 : std::set< std::set<CTxDestination>* > hits;
364 : 0 : std::map< CTxDestination, std::set<CTxDestination>* >::iterator it;
365 [ # # ]: 0 : for (const CTxDestination& address : _grouping)
366 [ # # ]: 0 : if ((it = setmap.find(address)) != setmap.end())
367 [ # # ]: 0 : hits.insert((*it).second);
368 : :
369 : : // merge all hit groups into a new single group and delete old groups
370 [ # # # # ]: 0 : std::set<CTxDestination>* merged = new std::set<CTxDestination>(_grouping);
371 [ # # ]: 0 : for (std::set<CTxDestination>* hit : hits)
372 : : {
373 [ # # ]: 0 : merged->insert(hit->begin(), hit->end());
374 : 0 : uniqueGroupings.erase(hit);
375 [ # # ]: 0 : delete hit;
376 : : }
377 [ # # ]: 0 : uniqueGroupings.insert(merged);
378 : :
379 : : // update setmap
380 [ # # ]: 0 : for (const CTxDestination& element : *merged)
381 [ # # ]: 0 : setmap[element] = merged;
382 : 0 : }
383 : :
384 : 0 : std::set< std::set<CTxDestination> > ret;
385 [ # # ]: 0 : for (const std::set<CTxDestination>* uniqueGrouping : uniqueGroupings)
386 : : {
387 [ # # ]: 0 : ret.insert(*uniqueGrouping);
388 [ # # ]: 0 : delete uniqueGrouping;
389 : : }
390 : :
391 : 0 : return ret;
392 : 0 : }
393 : : } // namespace wallet
|
