LCOV - code coverage report
Current view: top level - src/wallet - receive.cpp (source / functions) Coverage Total Hit
Test: total_coverage.info Lines: 84.7 % 216 183
Test Date: 2025-08-25 05:11:47 Functions: 84.2 % 19 16
Branches: 61.9 % 310 192

             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                 :         475 : bool InputIsMine(const CWallet& wallet, const CTxIn& txin)
      14                 :             : {
      15                 :         475 :     AssertLockHeld(wallet.cs_wallet);
      16                 :         475 :     const CWalletTx* prev = wallet.GetWalletTx(txin.prevout.hash);
      17   [ +  +  -  +  :         475 :     if (prev && txin.prevout.n < prev->tx->vout.size()) {
                   +  - ]
      18                 :         271 :         return wallet.IsMine(prev->tx->vout[txin.prevout.n]);
      19                 :             :     }
      20                 :             :     return false;
      21                 :             : }
      22                 :             : 
      23                 :         115 : bool AllInputsMine(const CWallet& wallet, const CTransaction& tx)
      24                 :             : {
      25                 :         115 :     LOCK(wallet.cs_wallet);
      26         [ +  + ]:         383 :     for (const CTxIn& txin : tx.vin) {
      27   [ +  -  +  + ]:         269 :         if (!InputIsMine(wallet, txin)) return false;
      28                 :             :     }
      29                 :             :     return true;
      30                 :         115 : }
      31                 :             : 
      32                 :         811 : CAmount OutputGetCredit(const CWallet& wallet, const CTxOut& txout)
      33                 :             : {
      34         [ -  + ]:         811 :     if (!MoneyRange(txout.nValue))
      35   [ #  #  #  # ]:           0 :         throw std::runtime_error(std::string(__func__) + ": value out of range");
      36                 :         811 :     LOCK(wallet.cs_wallet);
      37   [ +  -  +  + ]:         811 :     return (wallet.IsMine(txout) ? txout.nValue : 0);
      38                 :         811 : }
      39                 :             : 
      40                 :         425 : CAmount TxGetCredit(const CWallet& wallet, const CTransaction& tx)
      41                 :             : {
      42                 :         425 :     CAmount nCredit = 0;
      43         [ +  + ]:        1236 :     for (const CTxOut& txout : tx.vout)
      44                 :             :     {
      45                 :         811 :         nCredit += OutputGetCredit(wallet, txout);
      46         [ -  + ]:         811 :         if (!MoneyRange(nCredit))
      47   [ #  #  #  # ]:           0 :             throw std::runtime_error(std::string(__func__) + ": value out of range");
      48                 :             :     }
      49                 :         425 :     return nCredit;
      50                 :             : }
      51                 :             : 
      52                 :        2128 : 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                 :        2128 :     AssertLockHeld(wallet.cs_wallet);
      62         [ +  + ]:        2128 :     if (wallet.IsMine(script))
      63                 :             :     {
      64                 :        1447 :         CTxDestination address;
      65   [ +  -  +  + ]:        1447 :         if (!ExtractDestination(script, address))
      66                 :             :             return true;
      67   [ +  -  +  + ]:        1442 :         if (!wallet.FindAddressBookEntry(address)) {
      68                 :             :             return true;
      69                 :             :         }
      70                 :        1447 :     }
      71                 :             :     return false;
      72                 :             : }
      73                 :             : 
      74                 :        1381 : bool OutputIsChange(const CWallet& wallet, const CTxOut& txout)
      75                 :             : {
      76                 :        1381 :     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                 :      256030 : static CAmount GetCachableAmount(const CWallet& wallet, const CWalletTx& wtx, CWalletTx::AmountType type, bool avoid_reuse)
     101                 :             : {
     102                 :      256030 :     auto& amount = wtx.m_amounts[type];
     103   [ -  +  +  + ]:      512060 :     if (!amount.IsCached(avoid_reuse)) {
     104   [ +  +  -  + ]:       11170 :         amount.Set(avoid_reuse, type == CWalletTx::DEBIT ? wallet.GetDebit(*wtx.tx) : TxGetCredit(wallet, *wtx.tx));
     105                 :       11170 :         wtx.m_is_cache_empty = false;
     106                 :             :     }
     107                 :      256030 :     return amount.Get(avoid_reuse);
     108                 :             : }
     109                 :             : 
     110                 :         455 : CAmount CachedTxGetCredit(const CWallet& wallet, const CWalletTx& wtx, bool avoid_reuse)
     111                 :             : {
     112                 :         455 :     AssertLockHeld(wallet.cs_wallet);
     113                 :             : 
     114                 :             :     // Must wait until coinbase is safely deep enough in the chain before valuing it
     115         [ +  + ]:         455 :     if (wallet.IsTxImmatureCoinBase(wtx))
     116                 :             :         return 0;
     117                 :             : 
     118                 :             :     // GetBalance can assume transactions in mapWallet won't change
     119                 :         445 :     return GetCachableAmount(wallet, wtx, CWalletTx::CREDIT, avoid_reuse);
     120                 :             : }
     121                 :             : 
     122                 :      255585 : CAmount CachedTxGetDebit(const CWallet& wallet, const CWalletTx& wtx, bool avoid_reuse)
     123                 :             : {
     124         [ +  - ]:      255585 :     if (wtx.tx->vin.empty())
     125                 :             :         return 0;
     126                 :             : 
     127                 :      255585 :     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                 :        1923 : 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                 :        1923 :     nFee = 0;
     145                 :        1923 :     listReceived.clear();
     146                 :        1923 :     listSent.clear();
     147                 :             : 
     148                 :             :     // Compute fee:
     149                 :        1923 :     CAmount nDebit = CachedTxGetDebit(wallet, wtx, /*avoid_reuse=*/false);
     150         [ +  + ]:        1923 :     if (nDebit > 0) // debit>0 means we signed/sent this transaction
     151                 :             :     {
     152                 :         588 :         CAmount nValueOut = wtx.tx->GetValueOut();
     153                 :         588 :         nFee = nDebit - nValueOut;
     154                 :             :     }
     155                 :             : 
     156                 :        1923 :     LOCK(wallet.cs_wallet);
     157                 :             :     // Sent/received.
     158   [ -  +  +  + ]:        5743 :     for (unsigned int i = 0; i < wtx.tx->vout.size(); ++i)
     159                 :             :     {
     160         [ +  - ]:        3820 :         const CTxOut& txout = wtx.tx->vout[i];
     161         [ +  - ]:        3820 :         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         [ +  + ]:        3820 :         if (nDebit > 0)
     166                 :             :         {
     167   [ +  +  +  -  :        1151 :             if (!include_change && OutputIsChange(wallet, txout))
                   +  + ]
     168                 :         453 :                 continue;
     169                 :             :         }
     170         [ +  + ]:        2669 :         else if (!ismine)
     171                 :        1324 :             continue;
     172                 :             : 
     173                 :             :         // In either case, we need to get the destination address
     174                 :        2043 :         CTxDestination address;
     175                 :             : 
     176   [ +  -  +  +  :        2043 :         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         [ +  - ]:        2043 :         COutputEntry output = {address, txout.nValue, (int)i};
     184                 :             : 
     185                 :             :         // If we are debited by the transaction, add the output as a "sent" entry
     186         [ +  + ]:        2043 :         if (nDebit > 0)
     187         [ +  - ]:         698 :             listSent.push_back(output);
     188                 :             : 
     189                 :             :         // If we are receiving the output, add it as a "received" entry
     190         [ +  + ]:        2043 :         if (ismine)
     191         [ +  - ]:        1560 :             listReceived.push_back(output);
     192                 :        2043 :     }
     193                 :             : 
     194                 :        1923 : }
     195                 :             : 
     196                 :      253207 : bool CachedTxIsFromMe(const CWallet& wallet, const CWalletTx& wtx)
     197                 :             : {
     198                 :      253207 :     return (CachedTxGetDebit(wallet, wtx, /*avoid_reuse=*/false) > 0);
     199                 :             : }
     200                 :             : 
     201                 :             : // NOLINTNEXTLINE(misc-no-recursion)
     202                 :      585801 : bool CachedTxIsTrusted(const CWallet& wallet, const CWalletTx& wtx, std::set<Txid>& trusted_parents)
     203                 :             : {
     204                 :      585801 :     AssertLockHeld(wallet.cs_wallet);
     205                 :             : 
     206                 :             :     // This wtx is already trusted
     207         [ +  + ]:      585801 :     if (trusted_parents.contains(wtx.GetHash())) return true;
     208                 :             : 
     209         [ +  + ]:      534777 :     if (wtx.isConfirmed()) return true;
     210         [ +  + ]:       76453 :     if (wtx.isBlockConflicted()) return false;
     211                 :             :     // using wtx's cached debit
     212   [ +  +  +  + ]:       76362 :     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         [ +  + ]:       73561 :     if (!wtx.InMempool()) return false;
     216                 :             : 
     217                 :             :     // Trusted if all inputs are from us and are in the mempool:
     218         [ +  + ]:      152964 :     for (const CTxIn& txin : wtx.tx->vin)
     219                 :             :     {
     220                 :             :         // Transactions not sent by us: not trusted
     221                 :       79852 :         const CWalletTx* parent = wallet.GetWalletTx(txin.prevout.hash);
     222         [ +  + ]:       79852 :         if (parent == nullptr) return false;
     223                 :       79843 :         const CTxOut& parentOut = parent->tx->vout[txin.prevout.n];
     224                 :             :         // Check that this specific input being spent is trusted
     225         [ +  + ]:       79843 :         if (!wallet.IsMine(parentOut)) return false;
     226                 :             :         // If we've already trusted this parent, continue
     227         [ +  + ]:       79841 :         if (trusted_parents.count(parent->GetHash())) continue;
     228                 :             :         // Recurse to check that the parent is also trusted
     229         [ +  + ]:       72588 :         if (!CachedTxIsTrusted(wallet, *parent, trusted_parents)) return false;
     230                 :       72258 :         trusted_parents.insert(parent->GetHash());
     231                 :             :     }
     232                 :             :     return true;
     233                 :             : }
     234                 :             : 
     235                 :         663 : bool CachedTxIsTrusted(const CWallet& wallet, const CWalletTx& wtx)
     236                 :             : {
     237         [ +  - ]:         663 :     std::set<Txid> trusted_parents;
     238         [ +  - ]:         663 :     LOCK(wallet.cs_wallet);
     239   [ +  -  +  - ]:         663 :     return CachedTxIsTrusted(wallet, wtx, trusted_parents);
     240                 :         663 : }
     241                 :             : 
     242                 :        1156 : Balance GetBalance(const CWallet& wallet, const int min_depth, bool avoid_reuse)
     243                 :             : {
     244                 :        1156 :     Balance ret;
     245   [ +  +  +  + ]:        1156 :     bool allow_used_addresses = !avoid_reuse || !wallet.IsWalletFlagSet(WALLET_FLAG_AVOID_REUSE);
     246                 :        1156 :     {
     247                 :        1156 :         LOCK(wallet.cs_wallet);
     248                 :        1156 :         std::set<Txid> trusted_parents;
     249   [ +  +  +  - ]:       84174 :         for (const auto& [outpoint, txo] : wallet.GetTXOs()) {
     250         [ +  - ]:       83018 :             const CWalletTx& wtx = txo.GetWalletTx();
     251                 :             : 
     252         [ +  - ]:       83018 :             const bool is_trusted{CachedTxIsTrusted(wallet, wtx, trusted_parents)};
     253         [ +  - ]:       83018 :             const int tx_depth{wallet.GetTxDepthInMainChain(wtx)};
     254                 :             : 
     255   [ +  -  +  +  :       83018 :             if (!wallet.IsSpent(outpoint) && (allow_used_addresses || !wallet.IsSpentKey(txo.GetTxOut().scriptPubKey))) {
          +  +  +  -  +  
                      + ]
     256                 :             :                 // Get the amounts for mine
     257         [ +  - ]:       32388 :                 CAmount credit_mine = txo.GetTxOut().nValue;
     258                 :             : 
     259                 :             :                 // Set the amounts in the return object
     260   [ +  -  +  + ]:       32388 :                 if (wallet.IsTxImmatureCoinBase(wtx) && wtx.isConfirmed()) {
     261                 :       20811 :                     ret.m_mine_immature += credit_mine;
     262         [ +  + ]:       11577 :                 } else if (is_trusted && tx_depth >= min_depth) {
     263                 :       10978 :                     ret.m_mine_trusted += credit_mine;
     264   [ +  +  +  -  :         599 :                 } else if (!is_trusted && wtx.InMempool()) {
                   +  + ]
     265                 :         394 :                     ret.m_mine_untrusted_pending += credit_mine;
     266                 :             :                 }
     267                 :             :             }
     268                 :             :         }
     269         [ +  - ]:        1156 :     }
     270                 :        1156 :     return ret;
     271                 :             : }
     272                 :             : 
     273                 :           2 : std::map<CTxDestination, CAmount> GetAddressBalances(const CWallet& wallet)
     274                 :             : {
     275         [ +  - ]:           2 :     std::map<CTxDestination, CAmount> balances;
     276                 :             : 
     277                 :           2 :     {
     278         [ +  - ]:           2 :         LOCK(wallet.cs_wallet);
     279                 :           2 :         std::set<Txid> trusted_parents;
     280   [ +  +  +  - ]:         206 :         for (const auto& [outpoint, txo] : wallet.GetTXOs()) {
     281         [ +  - ]:         204 :             const CWalletTx& wtx = txo.GetWalletTx();
     282                 :             : 
     283   [ -  +  +  - ]:         204 :             if (!CachedTxIsTrusted(wallet, wtx, trusted_parents)) continue;
     284   [ +  -  +  + ]:         204 :             if (wallet.IsTxImmatureCoinBase(wtx)) continue;
     285                 :             : 
     286         [ +  - ]:           4 :             int nDepth = wallet.GetTxDepthInMainChain(wtx);
     287   [ +  -  +  -  :           8 :             if (nDepth < (CachedTxIsFromMe(wallet, wtx) ? 0 : 1)) continue;
                   -  + ]
     288                 :             : 
     289                 :           4 :             CTxDestination addr;
     290         [ +  - ]:           4 :             Assume(wallet.IsMine(txo.GetTxOut()));
     291   [ +  -  -  + ]:           4 :             if(!ExtractDestination(txo.GetTxOut().scriptPubKey, addr)) continue;
     292                 :             : 
     293   [ +  -  +  + ]:           4 :             CAmount n = wallet.IsSpent(outpoint) ? 0 : txo.GetTxOut().nValue;
     294         [ +  - ]:           4 :             balances[addr] += n;
     295                 :           4 :         }
     296         [ +  - ]:           2 :     }
     297                 :             : 
     298                 :           2 :     return balances;
     299                 :           0 : }
     300                 :             : 
     301                 :           2 : std::set< std::set<CTxDestination> > GetAddressGroupings(const CWallet& wallet)
     302                 :             : {
     303                 :           2 :     AssertLockHeld(wallet.cs_wallet);
     304                 :           2 :     std::set< std::set<CTxDestination> > groupings;
     305                 :           2 :     std::set<CTxDestination> grouping;
     306                 :             : 
     307   [ +  +  -  + ]:         207 :     for (const auto& walletEntry : wallet.mapWallet)
     308                 :             :     {
     309                 :         205 :         const CWalletTx& wtx = walletEntry.second;
     310                 :             : 
     311   [ +  -  -  + ]:         205 :         if (wtx.tx->vin.size() > 0)
     312                 :             :         {
     313                 :         205 :             bool any_mine = false;
     314                 :             :             // group all input addresses with each other
     315         [ +  + ]:         411 :             for (const CTxIn& txin : wtx.tx->vin)
     316                 :             :             {
     317                 :         206 :                 CTxDestination address;
     318   [ +  -  +  + ]:         206 :                 if(!InputIsMine(wallet, txin)) /* If this input isn't mine, ignore it */
     319                 :         204 :                     continue;
     320   [ +  -  +  -  :           2 :                 if(!ExtractDestination(wallet.mapWallet.at(txin.prevout.hash).tx->vout[txin.prevout.n].scriptPubKey, address))
                   -  + ]
     321                 :           0 :                     continue;
     322         [ +  - ]:           2 :                 grouping.insert(address);
     323                 :           2 :                 any_mine = true;
     324                 :         206 :             }
     325                 :             : 
     326                 :             :             // group change with input addresses
     327         [ +  + ]:         205 :             if (any_mine)
     328                 :             :             {
     329         [ +  + ]:           2 :                for (const CTxOut& txout : wtx.tx->vout)
     330   [ +  -  -  + ]:           1 :                    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         [ +  + ]:         205 :             if (grouping.size() > 0)
     339                 :             :             {
     340         [ +  - ]:           1 :                 groupings.insert(grouping);
     341                 :           1 :                 grouping.clear();
     342                 :             :             }
     343                 :             :         }
     344                 :             : 
     345                 :             :         // group lone addrs by themselves
     346         [ +  + ]:         614 :         for (const auto& txout : wtx.tx->vout)
     347   [ +  -  +  + ]:         409 :             if (wallet.IsMine(txout))
     348                 :             :             {
     349                 :         204 :                 CTxDestination address;
     350   [ +  -  -  + ]:         204 :                 if(!ExtractDestination(txout.scriptPubKey, address))
     351                 :           0 :                     continue;
     352         [ +  - ]:         204 :                 grouping.insert(address);
     353         [ +  - ]:         204 :                 groupings.insert(grouping);
     354                 :         204 :                 grouping.clear();
     355                 :         204 :             }
     356                 :             :     }
     357                 :             : 
     358                 :           2 :     std::set< std::set<CTxDestination>* > uniqueGroupings; // a set of pointers to groups of addresses
     359                 :           2 :     std::map< CTxDestination, std::set<CTxDestination>* > setmap;  // map addresses to the unique group containing it
     360         [ +  + ]:           7 :     for (const std::set<CTxDestination>& _grouping : groupings)
     361                 :             :     {
     362                 :             :         // make a set of all the groups hit by this new group
     363                 :           5 :         std::set< std::set<CTxDestination>* > hits;
     364                 :           5 :         std::map< CTxDestination, std::set<CTxDestination>* >::iterator it;
     365         [ +  + ]:          11 :         for (const CTxDestination& address : _grouping)
     366         [ +  + ]:           6 :             if ((it = setmap.find(address)) != setmap.end())
     367         [ +  - ]:           2 :                 hits.insert((*it).second);
     368                 :             : 
     369                 :             :         // merge all hit groups into a new single group and delete old groups
     370   [ +  -  +  - ]:           5 :         std::set<CTxDestination>* merged = new std::set<CTxDestination>(_grouping);
     371         [ +  + ]:           7 :         for (std::set<CTxDestination>* hit : hits)
     372                 :             :         {
     373         [ +  - ]:           2 :             merged->insert(hit->begin(), hit->end());
     374                 :           2 :             uniqueGroupings.erase(hit);
     375         [ +  - ]:           4 :             delete hit;
     376                 :             :         }
     377         [ +  - ]:           5 :         uniqueGroupings.insert(merged);
     378                 :             : 
     379                 :             :         // update setmap
     380         [ +  + ]:          12 :         for (const CTxDestination& element : *merged)
     381         [ +  - ]:           7 :             setmap[element] = merged;
     382                 :           5 :     }
     383                 :             : 
     384                 :           2 :     std::set< std::set<CTxDestination> > ret;
     385         [ +  + ]:           5 :     for (const std::set<CTxDestination>* uniqueGrouping : uniqueGroupings)
     386                 :             :     {
     387         [ +  - ]:           3 :         ret.insert(*uniqueGrouping);
     388         [ +  - ]:           6 :         delete uniqueGrouping;
     389                 :             :     }
     390                 :             : 
     391                 :           2 :     return ret;
     392                 :           2 : }
     393                 :             : } // namespace wallet
        

Generated by: LCOV version 2.0-1