feerate.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 The Bitcoin Core developers
// Copyright (c) 2017-present The Bitcoin developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef BITCOIN_FEERATE_H
#define BITCOIN_FEERATE_H
 
#include <consensus/amount.h>
#include <serialize.h>
#include <util/feefrac.h>
 
#include <cstdint>
#include <cstdlib>
#include <ostream>
#include <string>
#include <type_traits>
 
class CFeeRate {
private:
    // unit is satoshis-per-N-vbytes
    FeePerVSize m_feerate;
 
public:
    CFeeRate() = delete;
    explicit CFeeRate(const Amount m_feerate_kvb)
        : m_feerate(FeePerVSize(m_feerate_kvb / SATOSHI, 1000)) {}
 
    CFeeRate(const Amount nFeePaid, int32_t virtual_bytes);
 
    Amount GetFee(int32_t virtual_bytes) const;
 
    Amount GetFeePerK() const {
        return m_feerate.EvaluateFeeDown(1000) * SATOSHI;
    }
 
    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()) / SATOSHI, 1000);
        return *this;
    }
 
    std::string ToString() const;
 
    SERIALIZE_METHODS(CFeeRate, obj) {
        READWRITE(obj.m_feerate.fee, obj.m_feerate.size);
    }
};
 
#endif // BITCOIN_FEERATE_H