// Copyright (c) 2009-2010 Satoshi Nakamoto

// Copyright (c) 2009-2022 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<std::integral I> // Disallow silent float -> int conversion

    explicit CFeeRate(const I _nSatoshisPerK): nSatoshisPerK(_nSatoshisPerK) {

    }

Unexecuted instantiation: _ZN8CFeeRateC2ITkSt8integrallEET_

Unexecuted instantiation: _ZN8CFeeRateC2ITkSt8integraljEET_

Unexecuted instantiation: _ZN8CFeeRateC2ITkSt8integraliEET_

Unexecuted instantiation: _ZN8CFeeRateC2ITkSt8integralxEET_

    /**

     * 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 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; }

    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;

    friend CFeeRate operator*(const CFeeRate& f, int a) { return CFeeRate(a * f.nSatoshisPerK); }

    friend CFeeRate operator*(int a, const CFeeRate& f) { return CFeeRate(a * f.nSatoshisPerK); }

    SERIALIZE_METHODS(CFeeRate, obj) { READWRITE(obj.nSatoshisPerK); }

Unexecuted instantiation: _ZN8CFeeRate16SerializationOpsI10DataStreamS_17ActionUnserializeEEvRT0_RT_T1_

Unexecuted instantiation: _ZN8CFeeRate16SerializationOpsI10DataStreamKS_15ActionSerializeEEvRT0_RT_T1_

};

#endif // BITCOIN_POLICY_FEERATE_H