[wallet] GetBalance can take an isminefilter filter.

jnewbery · jnewbery · commit 4279da47855e · 2018-06-28T17:50:36.000-04:00
GetBalance() can now take an ismine filter, which is passed down to
GetAvailableCredit. This allows GetBalance to be used to get watch-only
balances.
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -1968,7 +1968,7 @@ CAmount CWalletTx::GetImmatureCredit(bool fUseCache) const
     return 0;
 }
 
-CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const
+CAmount CWalletTx::GetAvailableCredit(bool fUseCache, const isminefilter& filter) const
 {
     if (pwallet == nullptr)
         return 0;
@@ -1977,8 +1977,17 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const
     if (IsCoinBase() && GetBlocksToMaturity() > 0)
         return 0;
 
-    if (fUseCache && fAvailableCreditCached)
-        return nAvailableCreditCached;
+    CAmount* cache = nullptr;
+    bool* cache_used = nullptr;
+
+    if (filter == ISMINE_SPENDABLE) {
+        cache = &nAvailableCreditCached;
+        cache_used = &fAvailableCreditCached;
+    }
+
+    if (fUseCache && cache_used && *cache_used) {
+        return *cache;
+    }
 
     CAmount nCredit = 0;
     uint256 hashTx = GetHash();
@@ -1987,14 +1996,16 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const
         if (!pwallet->IsSpent(hashTx, i))
         {
             const CTxOut &txout = tx->vout[i];
-            nCredit += pwallet->GetCredit(txout, ISMINE_SPENDABLE);
+            nCredit += pwallet->GetCredit(txout, filter);
             if (!MoneyRange(nCredit))
                 throw std::runtime_error(std::string(__func__) + " : value out of range");
         }
     }
 
-    nAvailableCreditCached = nCredit;
-    fAvailableCreditCached = true;
+    if (cache) {
+        *cache = nCredit;
+        *cache_used = true;
+    }
     return nCredit;
 }
 
@@ -2154,16 +2165,17 @@ void CWallet::ResendWalletTransactions(int64_t nBestBlockTime, CConnman* connman
  */
 
 
-CAmount CWallet::GetBalance() const
+CAmount CWallet::GetBalance(const isminefilter& filter) const
 {
     CAmount nTotal = 0;
     {
         LOCK2(cs_main, cs_wallet);
         for (const auto& entry : mapWallet)
         {
             const CWalletTx* pcoin = &entry.second;
-            if (pcoin->IsTrusted())
-                nTotal += pcoin->GetAvailableCredit();
+            if (pcoin->IsTrusted()) {
+                nTotal += pcoin->GetAvailableCredit(true, filter);
+            }
         }
     }
 
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -460,7 +460,7 @@ class CWalletTx : public CMerkleTx
     CAmount GetDebit(const isminefilter& filter) const;
     CAmount GetCredit(const isminefilter& filter) const;
     CAmount GetImmatureCredit(bool fUseCache=true) const;
-    CAmount GetAvailableCredit(bool fUseCache=true) const;
+    CAmount GetAvailableCredit(bool fUseCache=true, const isminefilter& filter=ISMINE_SPENDABLE) const;
     CAmount GetImmatureWatchOnlyCredit(const bool fUseCache=true) const;
     CAmount GetAvailableWatchOnlyCredit(const bool fUseCache=true) const;
     CAmount GetChange() const;
@@ -944,7 +944,7 @@ class CWallet final : public CCryptoKeyStore, public CValidationInterface
     void ResendWalletTransactions(int64_t nBestBlockTime, CConnman* connman) override;
     // ResendWalletTransactionsBefore may only be called if fBroadcastTransactions!
     std::vector<uint256> ResendWalletTransactionsBefore(int64_t nTime, CConnman* connman);
-    CAmount GetBalance() const;
+    CAmount GetBalance(const isminefilter& filter=ISMINE_SPENDABLE) const;
     CAmount GetUnconfirmedBalance() const;
     CAmount GetImmatureBalance() const;
     CAmount GetWatchOnlyBalance() const;

Original file line number	Diff line number	Diff line change
`@@ -1968,7 +1968,7 @@ CAmount CWalletTx::GetImmatureCredit(bool fUseCache) const`
`1968`	`1968`	`return 0;`
`1969`	`1969`	`}`
`1970`	`1970`
`1971`		`-CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const`
	`1971`	`+CAmount CWalletTx::GetAvailableCredit(bool fUseCache, const isminefilter& filter) const`
`1972`	`1972`	`{`
`1973`	`1973`	`if (pwallet == nullptr)`
`1974`	`1974`	`return 0;`
`@@ -1977,8 +1977,17 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const`
`1977`	`1977`	`if (IsCoinBase() && GetBlocksToMaturity() > 0)`
`1978`	`1978`	`return 0;`
`1979`	`1979`
`1980`		`- if (fUseCache && fAvailableCreditCached)`
`1981`		`- return nAvailableCreditCached;`
	`1980`	`+ CAmount* cache = nullptr;`
	`1981`	`+ bool* cache_used = nullptr;`
	`1982`	`+`
	`1983`	`+ if (filter == ISMINE_SPENDABLE) {`
	`1984`	`+ cache = &nAvailableCreditCached;`
	`1985`	`+ cache_used = &fAvailableCreditCached;`
	`1986`	`+ }`
	`1987`	`+`
	`1988`	`+ if (fUseCache && cache_used && *cache_used) {`
	`1989`	`+ return *cache;`
	`1990`	`+ }`
`1982`	`1991`
`1983`	`1992`	`CAmount nCredit = 0;`
`1984`	`1993`	`uint256 hashTx = GetHash();`
`@@ -1987,14 +1996,16 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache) const`
`1987`	`1996`	`if (!pwallet->IsSpent(hashTx, i))`
`1988`	`1997`	`{`
`1989`	`1998`	`const CTxOut &txout = tx->vout[i];`
`1990`		`- nCredit += pwallet->GetCredit(txout, ISMINE_SPENDABLE);`
	`1999`	`+ nCredit += pwallet->GetCredit(txout, filter);`
`1991`	`2000`	`if (!MoneyRange(nCredit))`
`1992`	`2001`	`throw std::runtime_error(std::string(__func__) + " : value out of range");`
`1993`	`2002`	`}`
`1994`	`2003`	`}`
`1995`	`2004`
`1996`		`- nAvailableCreditCached = nCredit;`
`1997`		`- fAvailableCreditCached = true;`
	`2005`	`+ if (cache) {`
	`2006`	`+ *cache = nCredit;`
	`2007`	`+ *cache_used = true;`
	`2008`	`+ }`
`1998`	`2009`	`return nCredit;`
`1999`	`2010`	`}`
`2000`	`2011`
`@@ -2154,16 +2165,17 @@ void CWallet::ResendWalletTransactions(int64_t nBestBlockTime, CConnman* connman`
`2154`	`2165`	`*/`
`2155`	`2166`
`2156`	`2167`
`2157`		`-CAmount CWallet::GetBalance() const`
	`2168`	`+CAmount CWallet::GetBalance(const isminefilter& filter) const`
`2158`	`2169`	`{`
`2159`	`2170`	`CAmount nTotal = 0;`
`2160`	`2171`	`{`
`2161`	`2172`	`LOCK2(cs_main, cs_wallet);`
`2162`	`2173`	`for (const auto& entry : mapWallet)`
`2163`	`2174`	`{`
`2164`	`2175`	`const CWalletTx* pcoin = &entry.second;`
`2165`		`- if (pcoin->IsTrusted())`
`2166`		`- nTotal += pcoin->GetAvailableCredit();`
	`2176`	`+ if (pcoin->IsTrusted()) {`
	`2177`	`+ nTotal += pcoin->GetAvailableCredit(true, filter);`
	`2178`	`+ }`
`2167`	`2179`	`}`
`2168`	`2180`	`}`
`2169`	`2181`