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-2019 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 <cstdlib>
#include <ostream>
#include <string>
#include <type_traits>
 
class CFeeRate {
private:
    // unit is satoshis-per-1,000-bytes
    Amount nSatoshisPerK;
 
public:
    constexpr CFeeRate() : nSatoshisPerK() {}
    explicit constexpr CFeeRate(const Amount _nSatoshisPerK)
        : nSatoshisPerK(_nSatoshisPerK) {}
 
    CFeeRate(const Amount nFeePaid, size_t nBytes);
 
    Amount GetFee(size_t nBytes) const;
 
    Amount GetFeeCeiling(size_t nBytes) const;
 
    Amount GetFeePerK() const { return GetFee(1000); }
 
    friend constexpr bool operator==(const CFeeRate a, const CFeeRate b) {
        return a.nSatoshisPerK == b.nSatoshisPerK;
    }
    friend constexpr bool operator!=(const CFeeRate a, const CFeeRate b) {
        return !(a == b);
    }
 
    friend bool operator<(const CFeeRate &a, const CFeeRate &b) {
        return a.nSatoshisPerK < b.nSatoshisPerK;
    }
    friend bool operator>(const CFeeRate &a, const CFeeRate &b) {
        return a.nSatoshisPerK > b.nSatoshisPerK;
    }
    friend bool operator<=(const CFeeRate &a, const CFeeRate &b) {
        return a.nSatoshisPerK <= b.nSatoshisPerK;
    }
    friend bool operator>=(const CFeeRate &a, const CFeeRate &b) {
        return a.nSatoshisPerK >= b.nSatoshisPerK;
    }
    CFeeRate &operator+=(const CFeeRate &a) {
        nSatoshisPerK += a.nSatoshisPerK;
        return *this;
    }
    std::string ToString() const;
 
    SERIALIZE_METHODS(CFeeRate, obj) { READWRITE(obj.nSatoshisPerK); }
};
 
#endif // BITCOIN_FEERATE_H