coincontrol.h

Go to the documentation of this file.

// Copyright (c) 2011-present The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#ifndef BITCOIN_WALLET_COINCONTROL_H
#define BITCOIN_WALLET_COINCONTROL_H

#include <outputtype.h>
#include <policy/feerate.h>
#include <policy/fees/block_policy_estimator.h>
#include <primitives/transaction.h>
#include <script/keyorigin.h>
#include <script/signingprovider.h>
#include <util/fees.h>

#include <algorithm>
#include <map>
#include <optional>
#include <set>

namespace wallet {
const int DEFAULT_MIN_DEPTH = 0;
const int DEFAULT_MAX_DEPTH = 9999999;

const int DEFAULT_WALLET_TX_VERSION = CTransaction::CURRENT_VERSION;

static constexpr bool DEFAULT_AVOIDPARTIALSPENDS = false;

class PreselectedInput
{
private:
    std::optional<CTxOut> m_txout;
    std::optional<int64_t> m_weight;
    std::optional<uint32_t> m_sequence;
    std::optional<CScript> m_script_sig;
    std::optional<CScriptWitness> m_script_witness;
    std::optional<unsigned int> m_pos;

public:
    void SetTxOut(const CTxOut& txout);
    CTxOut GetTxOut() const;
    bool HasTxOut() const;

    void SetInputWeight(int64_t weight);
    std::optional<int64_t> GetInputWeight() const;

    void SetSequence(uint32_t sequence);
    std::optional<uint32_t> GetSequence() const;

    void SetScriptSig(const CScript& script);
    void SetScriptWitness(const CScriptWitness& script_wit);
    bool HasScripts() const;
    std::pair<std::optional<CScript>, std::optional<CScriptWitness>> GetScripts() const;

    void SetPosition(unsigned int pos);
    std::optional<unsigned int> GetPosition() const;
};

class CCoinControl
{
public:
    CTxDestination destChange = CNoDestination();
    std::optional<OutputType> m_change_type;
    bool m_include_unsafe_inputs = false;
    bool m_allow_other_inputs = true;
    bool fOverrideFeeRate = false;
    std::optional<CFeeRate> m_feerate;
    std::optional<unsigned int> m_confirm_target;
    std::optional<bool> m_signal_bip125_rbf;
    bool m_avoid_partial_spends = DEFAULT_AVOIDPARTIALSPENDS;
    bool m_avoid_address_reuse = false;
    FeeEstimateMode m_fee_mode = FeeEstimateMode::UNSET;
    int m_min_depth = DEFAULT_MIN_DEPTH;
    int m_max_depth = DEFAULT_MAX_DEPTH;
    FlatSigningProvider m_external_provider;
    uint32_t m_version = DEFAULT_WALLET_TX_VERSION;
    std::optional<uint32_t> m_locktime;
    std::optional<int> m_max_tx_weight{std::nullopt};

    CCoinControl();

    bool HasSelected() const;
    bool IsSelected(const COutPoint& outpoint) const;
    bool IsExternalSelected(const COutPoint& outpoint) const;
    std::optional<CTxOut> GetExternalOutput(const COutPoint& outpoint) const;
    PreselectedInput& Select(const COutPoint& outpoint);
    void UnSelect(const COutPoint& outpoint);
    void UnSelectAll();
    std::vector<COutPoint> ListSelected() const;
    void SetInputWeight(const COutPoint& outpoint, int64_t weight);
    std::optional<int64_t> GetInputWeight(const COutPoint& outpoint) const;
    std::optional<uint32_t> GetSequence(const COutPoint& outpoint) const;
    std::pair<std::optional<CScript>, std::optional<CScriptWitness>> GetScripts(const COutPoint& outpoint) const;

    bool HasSelectedOrder() const
    {
        return m_selection_pos > 0;
    }

    std::optional<unsigned int> GetSelectionPos(const COutPoint& outpoint) const
    {
        const auto it = m_selected.find(outpoint);
        if (it == m_selected.end()) {
            return std::nullopt;
        }
        return it->second.GetPosition();
    }

private:
    std::map<COutPoint, PreselectedInput> m_selected;
    unsigned int m_selection_pos{0};
};
} // namespace wallet

#endif // BITCOIN_WALLET_COINCONTROL_H