fees.h

Go to the documentation of this file.

// Copyright (c) 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_UTIL_FEES_H
#define BITCOIN_UTIL_FEES_H
 
#include <attributes.h>
#include <util/expected.h>
#include <util/feefrac.h>
 
#include <optional>
#include <string>
#include <string_view>
#include <utility>
 
/* Used to determine type of fee estimation requested */
enum class FeeEstimateMode {
    UNSET,        
    ECONOMICAL,   
    CONSERVATIVE, 
};
 
/* Used to determine the reason a wallet selected a transaction fee rate */
enum class FeeReason {
    FEE_RATE_ESTIMATOR,
    MEMPOOL_MIN,
    USER_SPECIFIED,
    FALLBACK,
    REQUIRED,
};

enum class FeeRateEstimatorType {
    AUTO,
    BLOCK_POLICY,
    MEMPOOL_POLICY,
};

struct FeeRateEstimation {
    FeeRateEstimatorType feerate_estimator;
    FeePerVSize feerate;
    int returned_target;
    auto operator<=>(const FeeRateEstimation& other) const
    {
        return ByRatio{feerate} <=> ByRatio{other.feerate};
    }
};

struct FeeRateEstimationError {
    FeeRateEstimation estimation;
    std::string reason;
};

inline util::Unexpected<FeeRateEstimationError> EstimationError(FeeRateEstimatorType estimator, int returned_target, std::string error)
{
    return util::Unexpected{FeeRateEstimationError{{estimator, FeePerVSize{0, 0}, returned_target}, std::move(error)}};
}

inline const FeeRateEstimation& FeeRateEstimationRef(const util::Expected<FeeRateEstimation, FeeRateEstimationError>& result LIFETIMEBOUND)
{
    return result ? *result : result.error().estimation;
}
 
std::string_view FeeRateEstimatorTypeToString(FeeRateEstimatorType feerate_estimator_type);
std::optional<FeeRateEstimatorType> FeeRateEstimatorTypeFromString(std::string_view feerate_estimator_type);
 
#endif // BITCOIN_UTIL_FEES_H