feerate.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-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_POLICY_FEERATE_H
#define BITCOIN_POLICY_FEERATE_H
 
#include <consensus/amount.h>
#include <serialize.h>
#include <util/feefrac.h>
 
 
#include <cstdint>
#include <string>
#include <type_traits>
 
const std::string CURRENCY_UNIT = "BTC"; // One formatted unit
const std::string CURRENCY_ATOM = "sat"; // One indivisible minimum value unit
 
/* Used to determine type of fee estimation requested */
enum class FeeEstimateMode {
    UNSET,        
    ECONOMICAL,   
    CONSERVATIVE, 
    BTC_KVB,      
    SAT_VB,       
};
 
class CFeeRate
{
private:
    FeePerVSize m_feerate;
 
public:
    CFeeRate() = default;
    template<std::integral I> // Disallow silent float -> int conversion
    explicit CFeeRate(const I m_feerate_kvb) : m_feerate(FeePerVSize(m_feerate_kvb, 1000)) {}
 
    CFeeRate(const CAmount& nFeePaid, int32_t virtual_bytes);
 
    CAmount GetFee(int32_t virtual_bytes) const;
 
    FeePerVSize GetFeePerVSize() const { return m_feerate; }
 
    CAmount GetFeePerK() const { return CAmount(m_feerate.EvaluateFeeDown(1000)); }
    friend std::weak_ordering operator<=>(const CFeeRate& a, const CFeeRate& b) noexcept
    {
        return FeeRateCompare(a.m_feerate, b.m_feerate);
    }
    friend bool operator==(const CFeeRate& a, const CFeeRate& b) noexcept
    {
        return FeeRateCompare(a.m_feerate, b.m_feerate) == std::weak_ordering::equivalent;
    }
    CFeeRate& operator+=(const CFeeRate& a) {
        m_feerate = FeePerVSize(GetFeePerK() + a.GetFeePerK(), 1000);
        return *this;
    }
    std::string ToString(const FeeEstimateMode& fee_estimate_mode = FeeEstimateMode::BTC_KVB) const;
    friend CFeeRate operator*(const CFeeRate& f, int a) { return CFeeRate(a * f.m_feerate.fee, f.m_feerate.size); }
    friend CFeeRate operator*(int a, const CFeeRate& f) { return CFeeRate(a * f.m_feerate.fee, f.m_feerate.size); }
 
    SERIALIZE_METHODS(CFeeRate, obj) { READWRITE(obj.m_feerate.fee, obj.m_feerate.size); }
};
 
#endif // BITCOIN_POLICY_FEERATE_H