Bitcoin Core  22.99.0
P2P Digital Currency
coincontrol.h
Go to the documentation of this file.
1 // Copyright (c) 2011-2021 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 #ifndef BITCOIN_WALLET_COINCONTROL_H
6 #define BITCOIN_WALLET_COINCONTROL_H
7 
8 #include <outputtype.h>
9 #include <policy/feerate.h>
10 #include <policy/fees.h>
11 #include <primitives/transaction.h>
12 #include <script/keyorigin.h>
13 #include <script/signingprovider.h>
14 #include <script/standard.h>
15 
16 #include <optional>
17 #include <algorithm>
18 #include <map>
19 #include <set>
20 
21 namespace wallet {
22 const int DEFAULT_MIN_DEPTH = 0;
23 const int DEFAULT_MAX_DEPTH = 9999999;
24 
26 static constexpr bool DEFAULT_AVOIDPARTIALSPENDS = false;
27 
30 {
31 public:
35  std::optional<OutputType> m_change_type;
37  bool m_add_inputs = true;
41  bool fAllowOtherInputs = false;
43  bool fAllowWatchOnly = false;
45  bool fOverrideFeeRate = false;
47  std::optional<CFeeRate> m_feerate;
49  std::optional<unsigned int> m_confirm_target;
51  std::optional<bool> m_signal_bip125_rbf;
55  bool m_avoid_address_reuse = false;
64 
65  CCoinControl();
66 
67  bool HasSelected() const
68  {
69  return (setSelected.size() > 0);
70  }
71 
72  bool IsSelected(const COutPoint& output) const
73  {
74  return (setSelected.count(output) > 0);
75  }
76 
77  bool IsExternalSelected(const COutPoint& output) const
78  {
79  return (m_external_txouts.count(output) > 0);
80  }
81 
82  bool GetExternalOutput(const COutPoint& outpoint, CTxOut& txout) const
83  {
84  const auto ext_it = m_external_txouts.find(outpoint);
85  if (ext_it == m_external_txouts.end()) {
86  return false;
87  }
88  txout = ext_it->second;
89  return true;
90  }
91 
92  void Select(const COutPoint& output)
93  {
94  setSelected.insert(output);
95  }
96 
97  void SelectExternal(const COutPoint& outpoint, const CTxOut& txout)
98  {
99  setSelected.insert(outpoint);
100  m_external_txouts.emplace(outpoint, txout);
101  }
102 
103  void UnSelect(const COutPoint& output)
104  {
105  setSelected.erase(output);
106  }
107 
108  void UnSelectAll()
109  {
110  setSelected.clear();
111  }
112 
113  void ListSelected(std::vector<COutPoint>& vOutpoints) const
114  {
115  vOutpoints.assign(setSelected.begin(), setSelected.end());
116  }
117 
118 private:
119  std::set<COutPoint> setSelected;
120  std::map<COutPoint, CTxOut> m_external_txouts;
121 };
122 } // namespace wallet
123 
124 #endif // BITCOIN_WALLET_COINCONTROL_H
wallet::CCoinControl::IsExternalSelected
bool IsExternalSelected(const COutPoint &output) const
Definition: coincontrol.h:77
feerate.h
wallet::CCoinControl::m_max_depth
int m_max_depth
Maximum chain depth value for coin availability.
Definition: coincontrol.h:61
wallet::CCoinControl::fAllowOtherInputs
bool fAllowOtherInputs
If false, allows unselected inputs, but requires all selected inputs be used.
Definition: coincontrol.h:41
transaction.h
outputtype.h
wallet::CCoinControl::m_external_txouts
std::map< COutPoint, CTxOut > m_external_txouts
Definition: coincontrol.h:120
wallet::CCoinControl::GetExternalOutput
bool GetExternalOutput(const COutPoint &outpoint, CTxOut &txout) const
Definition: coincontrol.h:82
wallet::CCoinControl::m_confirm_target
std::optional< unsigned int > m_confirm_target
Override the default confirmation target if set.
Definition: coincontrol.h:49
wallet
Definition: node.h:38
wallet::CCoinControl::fAllowWatchOnly
bool fAllowWatchOnly
Includes watch only addresses which are solvable.
Definition: coincontrol.h:43
wallet::CCoinControl::m_add_inputs
bool m_add_inputs
If false, only selected inputs are used.
Definition: coincontrol.h:37
wallet::CCoinControl::HasSelected
bool HasSelected() const
Definition: coincontrol.h:67
signingprovider.h
CTxDestination
std::variant< CNoDestination, PKHash, ScriptHash, WitnessV0ScriptHash, WitnessV0KeyHash, WitnessV1Taproot, WitnessUnknown > CTxDestination
A txout script template with a specific destination.
Definition: standard.h:157
wallet::CCoinControl::destChange
CTxDestination destChange
Custom change destination, if not set an address is generated.
Definition: coincontrol.h:33
CTxOut
An output of a transaction.
Definition: transaction.h:128
wallet::CCoinControl::m_external_provider
FlatSigningProvider m_external_provider
SigningProvider that has pubkeys and scripts to do spend size estimation for external inputs.
Definition: coincontrol.h:63
wallet::CCoinControl::ListSelected
void ListSelected(std::vector< COutPoint > &vOutpoints) const
Definition: coincontrol.h:113
wallet::CCoinControl::m_avoid_address_reuse
bool m_avoid_address_reuse
Forbids inclusion of dirty (previously used) addresses.
Definition: coincontrol.h:55
FeeEstimateMode
FeeEstimateMode
Definition: feerate.h:18
wallet::CCoinControl::m_change_type
std::optional< OutputType > m_change_type
Override the default change type if set, ignored if destChange is set.
Definition: coincontrol.h:35
wallet::CCoinControl::m_feerate
std::optional< CFeeRate > m_feerate
Override the wallet's m_pay_tx_fee if set.
Definition: coincontrol.h:47
wallet::CCoinControl::m_min_depth
int m_min_depth
Minimum chain depth value for coin availability.
Definition: coincontrol.h:59
standard.h
wallet::CCoinControl::m_avoid_partial_spends
bool m_avoid_partial_spends
Avoid partial use of funds sent to a given address.
Definition: coincontrol.h:53
wallet::CCoinControl::UnSelect
void UnSelect(const COutPoint &output)
Definition: coincontrol.h:103
wallet::CCoinControl::m_signal_bip125_rbf
std::optional< bool > m_signal_bip125_rbf
Override the wallet's m_signal_rbf if set.
Definition: coincontrol.h:51
wallet::CCoinControl::Select
void Select(const COutPoint &output)
Definition: coincontrol.h:92
FeeEstimateMode::UNSET
@ UNSET
Use default settings based on other criteria.
wallet::CCoinControl::m_include_unsafe_inputs
bool m_include_unsafe_inputs
If false, only safe inputs will be used.
Definition: coincontrol.h:39
CNoDestination
Definition: standard.h:73
fees.h
wallet::CCoinControl::CCoinControl
CCoinControl()
Definition: coincontrol.cpp:10
wallet::CCoinControl::SelectExternal
void SelectExternal(const COutPoint &outpoint, const CTxOut &txout)
Definition: coincontrol.h:97
wallet::CCoinControl::fOverrideFeeRate
bool fOverrideFeeRate
Override automatic min/max checks on fee, m_feerate must be set if true.
Definition: coincontrol.h:45
wallet::DEFAULT_MAX_DEPTH
const int DEFAULT_MAX_DEPTH
Definition: coincontrol.h:23
wallet::DEFAULT_MIN_DEPTH
const int DEFAULT_MIN_DEPTH
Definition: coincontrol.h:22
COutPoint
An outpoint - a combination of a transaction hash and an index n into its vout.
Definition: transaction.h:26
wallet::CCoinControl::m_fee_mode
FeeEstimateMode m_fee_mode
Fee estimation mode to control arguments to estimateSmartFee.
Definition: coincontrol.h:57
wallet::CCoinControl::UnSelectAll
void UnSelectAll()
Definition: coincontrol.h:108
keyorigin.h
wallet::CCoinControl::IsSelected
bool IsSelected(const COutPoint &output) const
Definition: coincontrol.h:72
wallet::CCoinControl
Coin Control Features.
Definition: coincontrol.h:29
FlatSigningProvider
Definition: signingprovider.h:72
wallet::CCoinControl::setSelected
std::set< COutPoint > setSelected
Definition: coincontrol.h:119
wallet::DEFAULT_AVOIDPARTIALSPENDS
static constexpr bool DEFAULT_AVOIDPARTIALSPENDS
Default for -avoidpartialspends.
Definition: coincontrol.h:26