From becc45b589d07c4523276e4ba2dad8852d0d2632 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A8le=20Oul=C3=A8s?= <aurele@oules.com>
Date: Tue, 13 Sep 2022 18:59:54 +0200
Subject: [PATCH 1/4] scripted-diff: Rename setSelected->m_selected_inputs

-BEGIN VERIFY SCRIPT-
sed -i 's/setSelected/m_selected_inputs/g' src/wallet/coincontrol.h src/wallet/coincontrol.cpp
-END VERIFY SCRIPT-
---
 src/wallet/coincontrol.h | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/wallet/coincontrol.h b/src/wallet/coincontrol.h
index cb6f0a1635..86069d005e 100644
--- a/src/wallet/coincontrol.h
+++ b/src/wallet/coincontrol.h
@@ -65,12 +65,12 @@ public:
 
     bool HasSelected() const
     {
-        return (setSelected.size() > 0);
+        return (m_selected_inputs.size() > 0);
     }
 
     bool IsSelected(const COutPoint& output) const
     {
-        return (setSelected.count(output) > 0);
+        return (m_selected_inputs.count(output) > 0);
     }
 
     bool IsExternalSelected(const COutPoint& output) const
@@ -90,28 +90,28 @@ public:
 
     void Select(const COutPoint& output)
     {
-        setSelected.insert(output);
+        m_selected_inputs.insert(output);
     }
 
     void SelectExternal(const COutPoint& outpoint, const CTxOut& txout)
     {
-        setSelected.insert(outpoint);
+        m_selected_inputs.insert(outpoint);
         m_external_txouts.emplace(outpoint, txout);
     }
 
     void UnSelect(const COutPoint& output)
     {
-        setSelected.erase(output);
+        m_selected_inputs.erase(output);
     }
 
     void UnSelectAll()
     {
-        setSelected.clear();
+        m_selected_inputs.clear();
     }
 
     void ListSelected(std::vector<COutPoint>& vOutpoints) const
     {
-        vOutpoints.assign(setSelected.begin(), setSelected.end());
+        vOutpoints.assign(m_selected_inputs.begin(), m_selected_inputs.end());
     }
 
     void SetInputWeight(const COutPoint& outpoint, int64_t weight)
@@ -132,7 +132,7 @@ public:
     }
 
 private:
-    std::set<COutPoint> setSelected;
+    std::set<COutPoint> m_selected_inputs;
     std::map<COutPoint, CTxOut> m_external_txouts;
     //! Map of COutPoints to the maximum weight for that input
     std::map<COutPoint, int64_t> m_input_weights;

From 1db23da6e163e793458ec702a9601d2837aea9cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A8le=20Oul=C3=A8s?= <aurele@oules.com>
Date: Mon, 12 Sep 2022 12:03:07 +0200
Subject: [PATCH 2/4] wallet: Use std::optional for GetExternalOutput and
 fixups

---
 src/wallet/coincontrol.h | 16 ++++++++--------
 src/wallet/spend.cpp     | 17 ++++++++---------
 2 files changed, 16 insertions(+), 17 deletions(-)

diff --git a/src/wallet/coincontrol.h b/src/wallet/coincontrol.h
index 86069d005e..04f524028f 100644
--- a/src/wallet/coincontrol.h
+++ b/src/wallet/coincontrol.h
@@ -13,9 +13,9 @@
 #include <script/signingprovider.h>
 #include <script/standard.h>
 
-#include <optional>
 #include <algorithm>
 #include <map>
+#include <optional>
 #include <set>
 
 namespace wallet {
@@ -65,27 +65,27 @@ public:
 
     bool HasSelected() const
     {
-        return (m_selected_inputs.size() > 0);
+        return !m_selected_inputs.empty();
     }
 
     bool IsSelected(const COutPoint& output) const
     {
-        return (m_selected_inputs.count(output) > 0);
+        return m_selected_inputs.count(output) > 0;
     }
 
     bool IsExternalSelected(const COutPoint& output) const
     {
-        return (m_external_txouts.count(output) > 0);
+        return m_external_txouts.count(output) > 0;
     }
 
-    bool GetExternalOutput(const COutPoint& outpoint, CTxOut& txout) const
+    std::optional<CTxOut> GetExternalOutput(const COutPoint& outpoint) const
     {
         const auto ext_it = m_external_txouts.find(outpoint);
         if (ext_it == m_external_txouts.end()) {
-            return false;
+            return std::nullopt;
         }
-        txout = ext_it->second;
-        return true;
+
+        return std::make_optional(ext_it->second);
     }
 
     void Select(const COutPoint& output)
diff --git a/src/wallet/spend.cpp b/src/wallet/spend.cpp
index 748f40dce8..7379490f9b 100644
--- a/src/wallet/spend.cpp
+++ b/src/wallet/spend.cpp
@@ -52,9 +52,7 @@ int CalculateMaximumSignedInputSize(const CTxOut& txout, const CWallet* wallet,
 TxSize CalculateMaximumSignedTxSize(const CTransaction &tx, const CWallet *wallet, const std::vector<CTxOut>& txouts, const CCoinControl* coin_control)
 {
     CMutableTransaction txNew(tx);
-    if (!wallet->DummySignTx(txNew, txouts, coin_control)) {
-        return TxSize{-1, -1};
-    }
+    if (!wallet->DummySignTx(txNew, txouts, coin_control)) return TxSize{-1, -1};
     CTransaction ctx(txNew);
     int64_t vsize = GetVirtualTransactionSize(ctx);
     int64_t weight = GetTransactionWeight(ctx);
@@ -72,11 +70,9 @@ TxSize CalculateMaximumSignedTxSize(const CTransaction &tx, const CWallet *walle
             assert(input.prevout.n < mi->second.tx->vout.size());
             txouts.emplace_back(mi->second.tx->vout.at(input.prevout.n));
         } else if (coin_control) {
-            CTxOut txout;
-            if (!coin_control->GetExternalOutput(input.prevout, txout)) {
-                return TxSize{-1, -1};
-            }
-            txouts.emplace_back(txout);
+            const auto& txout{coin_control->GetExternalOutput(input.prevout)};
+            if (!txout) return TxSize{-1, -1};
+            txouts.emplace_back(*txout);
         } else {
             return TxSize{-1, -1};
         }
@@ -178,9 +174,12 @@ util::Result<PreSelectedInputs> FetchSelectedInputs(const CWallet& wallet, const
             input_bytes = CalculateMaximumSignedInputSize(txout, &wallet, &coin_control);
         } else {
             // The input is external. We did not find the tx in mapWallet.
-            if (!coin_control.GetExternalOutput(outpoint, txout)) {
+            const auto out{coin_control.GetExternalOutput(outpoint)};
+            if (!out) {
                 return util::Error{strprintf(_("Not found pre-selected input %s"), outpoint.ToString())};
             }
+
+            txout = *out;
         }
 
         if (input_bytes == -1) {

From 94776621ba6a79f3197ec71250bc48e974ad5e4a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A8le=20Oul=C3=A8s?= <aurele@oules.com>
Date: Mon, 12 Sep 2022 12:13:17 +0200
Subject: [PATCH 3/4] wallet: Move CoinCointrol definitions to .cpp

Move definitions to coincontrol.cpp and add documentation.
---
 src/wallet/coincontrol.cpp |  68 +++++++++++++++++++++
 src/wallet/coincontrol.h   | 120 ++++++++++++++++---------------------
 2 files changed, 121 insertions(+), 67 deletions(-)

diff --git a/src/wallet/coincontrol.cpp b/src/wallet/coincontrol.cpp
index ad2fab4b7d..d87b54e35c 100644
--- a/src/wallet/coincontrol.cpp
+++ b/src/wallet/coincontrol.cpp
@@ -11,4 +11,72 @@ CCoinControl::CCoinControl()
 {
     m_avoid_partial_spends = gArgs.GetBoolArg("-avoidpartialspends", DEFAULT_AVOIDPARTIALSPENDS);
 }
+
+bool CCoinControl::HasSelected() const
+{
+    return !m_selected_inputs.empty();
+}
+
+bool CCoinControl::IsSelected(const COutPoint& output) const
+{
+    return m_selected_inputs.count(output) > 0;
+}
+
+bool CCoinControl::IsExternalSelected(const COutPoint& output) const
+{
+    return m_external_txouts.count(output) > 0;
+}
+
+std::optional<CTxOut> CCoinControl::GetExternalOutput(const COutPoint& outpoint) const
+{
+    const auto ext_it = m_external_txouts.find(outpoint);
+    if (ext_it == m_external_txouts.end()) {
+        return std::nullopt;
+    }
+
+    return std::make_optional(ext_it->second);
+}
+
+void CCoinControl::Select(const COutPoint& output)
+{
+    m_selected_inputs.insert(output);
+}
+
+void CCoinControl::SelectExternal(const COutPoint& outpoint, const CTxOut& txout)
+{
+    m_selected_inputs.insert(outpoint);
+    m_external_txouts.emplace(outpoint, txout);
+}
+
+void CCoinControl::UnSelect(const COutPoint& output)
+{
+    m_selected_inputs.erase(output);
+}
+
+void CCoinControl::UnSelectAll()
+{
+    m_selected_inputs.clear();
+}
+
+void CCoinControl::ListSelected(std::vector<COutPoint>& vOutpoints) const
+{
+    vOutpoints.assign(m_selected_inputs.begin(), m_selected_inputs.end());
+}
+
+void CCoinControl::SetInputWeight(const COutPoint& outpoint, int64_t weight)
+{
+    m_input_weights[outpoint] = weight;
+}
+
+bool CCoinControl::HasInputWeight(const COutPoint& outpoint) const
+{
+    return m_input_weights.count(outpoint) > 0;
+}
+
+int64_t CCoinControl::GetInputWeight(const COutPoint& outpoint) const
+{
+    auto it = m_input_weights.find(outpoint);
+    assert(it != m_input_weights.end());
+    return it->second;
+}
 } // namespace wallet
diff --git a/src/wallet/coincontrol.h b/src/wallet/coincontrol.h
index 04f524028f..0a860dd782 100644
--- a/src/wallet/coincontrol.h
+++ b/src/wallet/coincontrol.h
@@ -63,76 +63,62 @@ public:
 
     CCoinControl();
 
-    bool HasSelected() const
-    {
-        return !m_selected_inputs.empty();
-    }
-
-    bool IsSelected(const COutPoint& output) const
-    {
-        return m_selected_inputs.count(output) > 0;
-    }
-
-    bool IsExternalSelected(const COutPoint& output) const
-    {
-        return m_external_txouts.count(output) > 0;
-    }
-
-    std::optional<CTxOut> GetExternalOutput(const COutPoint& outpoint) const
-    {
-        const auto ext_it = m_external_txouts.find(outpoint);
-        if (ext_it == m_external_txouts.end()) {
-            return std::nullopt;
-        }
-
-        return std::make_optional(ext_it->second);
-    }
-
-    void Select(const COutPoint& output)
-    {
-        m_selected_inputs.insert(output);
-    }
-
-    void SelectExternal(const COutPoint& outpoint, const CTxOut& txout)
-    {
-        m_selected_inputs.insert(outpoint);
-        m_external_txouts.emplace(outpoint, txout);
-    }
-
-    void UnSelect(const COutPoint& output)
-    {
-        m_selected_inputs.erase(output);
-    }
-
-    void UnSelectAll()
-    {
-        m_selected_inputs.clear();
-    }
-
-    void ListSelected(std::vector<COutPoint>& vOutpoints) const
-    {
-        vOutpoints.assign(m_selected_inputs.begin(), m_selected_inputs.end());
-    }
-
-    void SetInputWeight(const COutPoint& outpoint, int64_t weight)
-    {
-        m_input_weights[outpoint] = weight;
-    }
-
-    bool HasInputWeight(const COutPoint& outpoint) const
-    {
-        return m_input_weights.count(outpoint) > 0;
-    }
-
-    int64_t GetInputWeight(const COutPoint& outpoint) const
-    {
-        auto it = m_input_weights.find(outpoint);
-        assert(it != m_input_weights.end());
-        return it->second;
-    }
+    /**
+     * Returns true if there are pre-selected inputs.
+     */
+    bool HasSelected() const;
+    /**
+     * Returns true if the given output is pre-selected.
+     */
+    bool IsSelected(const COutPoint& output) const;
+    /**
+     * Returns true if the given output is selected as an external input.
+     */
+    bool IsExternalSelected(const COutPoint& output) const;
+    /**
+     * Returns the external output for the given outpoint if it exists.
+     */
+    std::optional<CTxOut> GetExternalOutput(const COutPoint& outpoint) const;
+    /**
+     * Lock-in the given output for spending.
+     * The output will be included in the transaction even if it's not the most optimal choice.
+     */
+    void Select(const COutPoint& output);
+    /**
+     * Lock-in the given output as an external input for spending because it is not in the wallet.
+     * The output will be included in the transaction even if it's not the most optimal choice.
+     */
+    void SelectExternal(const COutPoint& outpoint, const CTxOut& txout);
+    /**
+     * Unselects the given output.
+     */
+    void UnSelect(const COutPoint& output);
+    /**
+     * Unselects all outputs.
+     */
+    void UnSelectAll();
+    /**
+     * List the selected inputs.
+     */
+    void ListSelected(std::vector<COutPoint>& vOutpoints) const;
+    /**
+     * Set an input's weight.
+     */
+    void SetInputWeight(const COutPoint& outpoint, int64_t weight);
+    /**
+     * Returns true if the input weight is set.
+     */
+    bool HasInputWeight(const COutPoint& outpoint) const;
+    /**
+     * Returns the input weight.
+     */
+    int64_t GetInputWeight(const COutPoint& outpoint) const;
 
 private:
+    //! Selected inputs (inputs that will be used, regardless of whether they're optimal or not)
     std::set<COutPoint> m_selected_inputs;
+    //! Map of external inputs to include in the transaction
+    //! These are not in the wallet, so we need to track them separately
     std::map<COutPoint, CTxOut> m_external_txouts;
     //! Map of COutPoints to the maximum weight for that input
     std::map<COutPoint, int64_t> m_input_weights;

From daba95700b0b77a2e898299f218c47a69ed2c7d0 Mon Sep 17 00:00:00 2001
From: Sebastian Falbesoner <sebastian.falbesoner@gmail.com>
Date: Mon, 23 Jan 2023 17:00:14 +0100
Subject: [PATCH 4/4] refactor: Make ListSelected return vector

---
 src/qt/coincontroldialog.cpp | 3 +--
 src/wallet/coincontrol.cpp   | 4 ++--
 src/wallet/coincontrol.h     | 2 +-
 src/wallet/spend.cpp         | 4 +---
 4 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/src/qt/coincontroldialog.cpp b/src/qt/coincontroldialog.cpp
index e1b1ae12e9..50d3c2e559 100644
--- a/src/qt/coincontroldialog.cpp
+++ b/src/qt/coincontroldialog.cpp
@@ -412,8 +412,7 @@ void CoinControlDialog::updateLabels(CCoinControl& m_coin_control, WalletModel *
     unsigned int nQuantity      = 0;
     bool fWitness               = false;
 
-    std::vector<COutPoint> vCoinControl;
-    m_coin_control.ListSelected(vCoinControl);
+    auto vCoinControl{m_coin_control.ListSelected()};
 
     size_t i = 0;
     for (const auto& out : model->wallet().getCoins(vCoinControl)) {
diff --git a/src/wallet/coincontrol.cpp b/src/wallet/coincontrol.cpp
index d87b54e35c..2087119db9 100644
--- a/src/wallet/coincontrol.cpp
+++ b/src/wallet/coincontrol.cpp
@@ -58,9 +58,9 @@ void CCoinControl::UnSelectAll()
     m_selected_inputs.clear();
 }
 
-void CCoinControl::ListSelected(std::vector<COutPoint>& vOutpoints) const
+std::vector<COutPoint> CCoinControl::ListSelected() const
 {
-    vOutpoints.assign(m_selected_inputs.begin(), m_selected_inputs.end());
+    return {m_selected_inputs.begin(), m_selected_inputs.end()};
 }
 
 void CCoinControl::SetInputWeight(const COutPoint& outpoint, int64_t weight)
diff --git a/src/wallet/coincontrol.h b/src/wallet/coincontrol.h
index 0a860dd782..7ff8fee5bc 100644
--- a/src/wallet/coincontrol.h
+++ b/src/wallet/coincontrol.h
@@ -100,7 +100,7 @@ public:
     /**
      * List the selected inputs.
      */
-    void ListSelected(std::vector<COutPoint>& vOutpoints) const;
+    std::vector<COutPoint> ListSelected() const;
     /**
      * Set an input's weight.
      */
diff --git a/src/wallet/spend.cpp b/src/wallet/spend.cpp
index 7379490f9b..b14a30921b 100644
--- a/src/wallet/spend.cpp
+++ b/src/wallet/spend.cpp
@@ -159,10 +159,8 @@ util::Result<PreSelectedInputs> FetchSelectedInputs(const CWallet& wallet, const
                                             const CoinSelectionParams& coin_selection_params) EXCLUSIVE_LOCKS_REQUIRED(wallet.cs_wallet)
 {
     PreSelectedInputs result;
-    std::vector<COutPoint> vPresetInputs;
-    coin_control.ListSelected(vPresetInputs);
     const bool can_grind_r = wallet.CanGrindR();
-    for (const COutPoint& outpoint : vPresetInputs) {
+    for (const COutPoint& outpoint : coin_control.ListSelected()) {
         int input_bytes = -1;
         CTxOut txout;
         if (auto ptr_wtx = wallet.GetWalletTx(outpoint.hash)) {