mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-12 12:52:35 -03:00
78 lines
3.1 KiB
C++
78 lines
3.1 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2021 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 <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, //!< Use default settings based on other criteria
|
|
ECONOMICAL, //!< Force estimateSmartFee to use non-conservative estimates
|
|
CONSERVATIVE, //!< Force estimateSmartFee to use conservative estimates
|
|
BTC_KVB, //!< Use BTC/kvB fee rate unit
|
|
SAT_VB, //!< Use sat/vB fee rate unit
|
|
};
|
|
|
|
/**
|
|
* Fee rate in satoshis per kilovirtualbyte: CAmount / kvB
|
|
*/
|
|
class CFeeRate
|
|
{
|
|
private:
|
|
/** Fee rate in sat/kvB (satoshis per 1000 virtualbytes) */
|
|
CAmount nSatoshisPerK;
|
|
|
|
public:
|
|
/** Fee rate of 0 satoshis per kvB */
|
|
CFeeRate() : nSatoshisPerK(0) { }
|
|
template<typename I>
|
|
explicit CFeeRate(const I _nSatoshisPerK): nSatoshisPerK(_nSatoshisPerK) {
|
|
// We've previously had bugs creep in from silent double->int conversion...
|
|
static_assert(std::is_integral<I>::value, "CFeeRate should be used without floats");
|
|
}
|
|
|
|
/**
|
|
* Construct a fee rate from a fee in satoshis and a vsize in vB.
|
|
*
|
|
* param@[in] nFeePaid The fee paid by a transaction, in satoshis
|
|
* param@[in] num_bytes The vsize of a transaction, in vbytes
|
|
*/
|
|
CFeeRate(const CAmount& nFeePaid, uint32_t num_bytes);
|
|
|
|
/**
|
|
* Return the fee in satoshis for the given vsize in vbytes.
|
|
* If the calculated fee would have fractional satoshis, then the
|
|
* returned fee will always be rounded up to the nearest satoshi.
|
|
*/
|
|
CAmount GetFee(uint32_t num_bytes) const;
|
|
|
|
/**
|
|
* Return the fee in satoshis for a vsize of 1000 vbytes
|
|
*/
|
|
CAmount GetFeePerK() const { return GetFee(1000); }
|
|
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; }
|
|
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 FeeEstimateMode& fee_estimate_mode = FeeEstimateMode::BTC_KVB) const;
|
|
|
|
SERIALIZE_METHODS(CFeeRate, obj) { READWRITE(obj.nSatoshisPerK); }
|
|
};
|
|
|
|
#endif // BITCOIN_POLICY_FEERATE_H
|