scripted-diff: Wallet: Rename incorrectly named *UsedDestination

luke-jr · luke-jr · commit bca8665d0895 · 2020-02-21T21:16:40.000Z
These functions are used to mark/check if a key of our own has been used to spend (and only for avoid-reuse wallets), which has nothing to do with the destination/address itself.
Give them more accurate names to avoid confusion.

-BEGIN VERIFY SCRIPT-
sed -i -e 's/UsedDestination/SpentKey/g' $(git grep -l 'UsedDestination' ./src)
-END VERIFY SCRIPT-
diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp
@@ -2925,7 +2925,7 @@ static UniValue listunspent(const JSONRPCRequest& request)
         CTxDestination address;
         const CScript& scriptPubKey = out.tx->tx->vout[out.i].scriptPubKey;
         bool fValidAddress = ExtractDestination(scriptPubKey, address);
-        bool reused = avoid_reuse && pwallet->IsUsedDestination(out.tx->GetHash(), out.i);
+        bool reused = avoid_reuse && pwallet->IsSpentKey(out.tx->GetHash(), out.i);
 
         if (destinations.size() && (!fValidAddress || !destinations.count(address)))
             continue;
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -714,7 +714,7 @@ bool CWallet::MarkReplaced(const uint256& originalHash, const uint256& newHash)
     return success;
 }
 
-void CWallet::SetUsedDestinationState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations)
+void CWallet::SetSpentKeyState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations)
 {
     AssertLockHeld(cs_wallet);
     const CWalletTx* srctx = GetWalletTx(hash);
@@ -734,7 +734,7 @@ void CWallet::SetUsedDestinationState(WalletBatch& batch, const uint256& hash, u
     }
 }
 
-bool CWallet::IsUsedDestination(const uint256& hash, unsigned int n) const
+bool CWallet::IsSpentKey(const uint256& hash, unsigned int n) const
 {
     AssertLockHeld(cs_wallet);
     CTxDestination dst;
@@ -777,7 +777,7 @@ bool CWallet::AddToWallet(const CWalletTx& wtxIn, bool fFlushOnClose)
 
         for (const CTxIn& txin : wtxIn.tx->vin) {
             const COutPoint& op = txin.prevout;
-            SetUsedDestinationState(batch, op.hash, op.n, true, tx_destinations);
+            SetSpentKeyState(batch, op.hash, op.n, true, tx_destinations);
         }
 
         MarkDestinationsDirty(tx_destinations);
@@ -1878,7 +1878,7 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache, const isminefilter& filter
     uint256 hashTx = GetHash();
     for (unsigned int i = 0; i < tx->vout.size(); i++)
     {
-        if (!pwallet->IsSpent(hashTx, i) && (allow_used_addresses || !pwallet->IsUsedDestination(hashTx, i))) {
+        if (!pwallet->IsSpent(hashTx, i) && (allow_used_addresses || !pwallet->IsSpentKey(hashTx, i))) {
             const CTxOut &txout = tx->vout[i];
             nCredit += pwallet->GetCredit(txout, filter);
             if (!MoneyRange(nCredit))
@@ -2168,7 +2168,7 @@ void CWallet::AvailableCoins(interfaces::Chain::Lock& locked_chain, std::vector<
                 continue;
             }
 
-            if (!allow_used_addresses && IsUsedDestination(wtxid, i)) {
+            if (!allow_used_addresses && IsSpentKey(wtxid, i)) {
                 continue;
             }
 
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -817,8 +817,8 @@ class CWallet final : public WalletStorage, private interfaces::Chain::Notificat
     bool IsSpent(const uint256& hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
 
     // Whether this or any known UTXO with the same single key has been spent.
-    bool IsUsedDestination(const uint256& hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
-    void SetUsedDestinationState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
+    bool IsSpentKey(const uint256& hash, unsigned int n) const EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
+    void SetSpentKeyState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations) EXCLUSIVE_LOCKS_REQUIRED(cs_wallet);
 
     std::vector<OutputGroup> GroupOutputs(const std::vector<COutput>& outputs, bool single_coin) const;
 

Original file line number	Diff line number	Diff line change
`@@ -714,7 +714,7 @@ bool CWallet::MarkReplaced(const uint256& originalHash, const uint256& newHash)`
`714`	`714`	`return success;`
`715`	`715`	`}`
`716`	`716`
`717`		`-void CWallet::SetUsedDestinationState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations)`
	`717`	`+void CWallet::SetSpentKeyState(WalletBatch& batch, const uint256& hash, unsigned int n, bool used, std::set<CTxDestination>& tx_destinations)`
`718`	`718`	`{`
`719`	`719`	`AssertLockHeld(cs_wallet);`
`720`	`720`	`const CWalletTx* srctx = GetWalletTx(hash);`
`@@ -734,7 +734,7 @@ void CWallet::SetUsedDestinationState(WalletBatch& batch, const uint256& hash, u`
`734`	`734`	`}`
`735`	`735`	`}`
`736`	`736`
`737`		`-bool CWallet::IsUsedDestination(const uint256& hash, unsigned int n) const`
	`737`	`+bool CWallet::IsSpentKey(const uint256& hash, unsigned int n) const`
`738`	`738`	`{`
`739`	`739`	`AssertLockHeld(cs_wallet);`
`740`	`740`	`CTxDestination dst;`
`@@ -777,7 +777,7 @@ bool CWallet::AddToWallet(const CWalletTx& wtxIn, bool fFlushOnClose)`
`777`	`777`
`778`	`778`	`for (const CTxIn& txin : wtxIn.tx->vin) {`
`779`	`779`	`const COutPoint& op = txin.prevout;`
`780`		`- SetUsedDestinationState(batch, op.hash, op.n, true, tx_destinations);`
	`780`	`+ SetSpentKeyState(batch, op.hash, op.n, true, tx_destinations);`
`781`	`781`	`}`
`782`	`782`
`783`	`783`	`MarkDestinationsDirty(tx_destinations);`
`@@ -1878,7 +1878,7 @@ CAmount CWalletTx::GetAvailableCredit(bool fUseCache, const isminefilter& filter`
`1878`	`1878`	`uint256 hashTx = GetHash();`
`1879`	`1879`	`for (unsigned int i = 0; i < tx->vout.size(); i++)`
`1880`	`1880`	`{`
`1881`		`- if (!pwallet->IsSpent(hashTx, i) && (allow_used_addresses \|\| !pwallet->IsUsedDestination(hashTx, i))) {`
	`1881`	`+ if (!pwallet->IsSpent(hashTx, i) && (allow_used_addresses \|\| !pwallet->IsSpentKey(hashTx, i))) {`
`1882`	`1882`	`const CTxOut &txout = tx->vout[i];`
`1883`	`1883`	`nCredit += pwallet->GetCredit(txout, filter);`
`1884`	`1884`	`if (!MoneyRange(nCredit))`
`@@ -2168,7 +2168,7 @@ void CWallet::AvailableCoins(interfaces::Chain::Lock& locked_chain, std::vector<`
`2168`	`2168`	`continue;`
`2169`	`2169`	`}`
`2170`	`2170`
`2171`		`- if (!allow_used_addresses && IsUsedDestination(wtxid, i)) {`
	`2171`	`+ if (!allow_used_addresses && IsSpentKey(wtxid, i)) {`
`2172`	`2172`	`continue;`
`2173`	`2173`	`}`
`2174`	`2174`