src/policy/feerate.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2015 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #ifndef BITCOIN_POLICY_FEERATE_H
   7 #define BITCOIN_POLICY_FEERATE_H
   8
   9 #include "amount.h"
  10 #include "serialize.h"
  11
  12 #include <string>
  13
  14 extern const std::string CURRENCY_UNIT;
  15
  16 /**
  17  * Fee rate in satoshis per kilobyte: CAmount / kB
  18  */
  19 class CFeeRate
  20 {
  21 private:
  22     CAmount nSatoshisPerK; // unit is satoshis-per-1,000-bytes
  23
  24 public:
  25     /** Fee rate of 0 satoshis per kB */
  26     CFeeRate() : nSatoshisPerK(0) { }
  27     template<typename I>
  28     CFeeRate(const I _nSatoshisPerK): nSatoshisPerK(_nSatoshisPerK) {
  29         // We've previously had bugs creep in from silent double->int conversion...
  30         static_assert(std::is_integral<I>::value, "CFeeRate should be used without floats");
  31     }
  32     /** Constructor for a fee rate in satoshis per kB. The size in bytes must not exceed (2^63 - 1)*/
  33     CFeeRate(const CAmount& nFeePaid, size_t nBytes);
  34     /**
  35      * Return the fee in satoshis for the given size in bytes.
  36      */
  37     CAmount GetFee(size_t nBytes) const;
  38     /**
  39      * Return the fee in satoshis for a size of 1000 bytes
  40      */
  41     CAmount GetFeePerK() const { return GetFee(1000); }
  42     friend bool operator<(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK < b.nSatoshisPerK; }
  43     friend bool operator>(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK > b.nSatoshisPerK; }
  44     friend bool operator==(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK == b.nSatoshisPerK; }
  45     friend bool operator<=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK <= b.nSatoshisPerK; }
  46     friend bool operator>=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK >= b.nSatoshisPerK; }
  47     friend bool operator!=(const CFeeRate& a, const CFeeRate& b) { return a.nSatoshisPerK != b.nSatoshisPerK; }
  48     CFeeRate& operator+=(const CFeeRate& a) { nSatoshisPerK += a.nSatoshisPerK; return *this; }
  49     std::string ToString() const;
  50
  51     ADD_SERIALIZE_METHODS;
  52
  53     template <typename Stream, typename Operation>
  54     inline void SerializationOp(Stream& s, Operation ser_action) {
  55         READWRITE(nSatoshisPerK);
  56     }
  57 };
  58
  59 #endif //  BITCOIN_POLICY_FEERATE_H