estimator_man.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_POLICY_FEES_ESTIMATOR_MAN_H
#define BITCOIN_POLICY_FEES_ESTIMATOR_MAN_H
 
#include <policy/fees/block_policy_estimator.h>
#include <policy/fees/mempool_estimator.h>
#include <primitives/transaction.h>
#include <util/expected.h>
#include <util/fees.h>
#include <util/fs.h>
#include <validationinterface.h>
 
#include <chrono>
#include <memory>
 
class CFeeRate;
class ChainstateManager;
class CTxMemPool;
class MemPoolFeeRateEstimator;
 
// How often to flush data to disk
inline constexpr std::chrono::hours FEE_FLUSH_INTERVAL{1};
 
class FeeRateEstimatorManager : public CValidationInterface
{
public:
    FeeRateEstimatorManager(const fs::path& block_policy_path,
                            bool read_stale_estimates,
                            const fs::path& mempool_estimator_path,
                            const CTxMemPool& mempool,
                            ChainstateManager& chainman);
 
    virtual ~FeeRateEstimatorManager();
 
    virtual util::Expected<FeeRateEstimation, FeeRateEstimationError> GetFeeRateEstimate(int target, bool conservative) const;
 
    virtual util::Expected<FeeRateEstimation, FeeRateEstimationError> GetFeeRateEstimate(FeeRateEstimatorType type, int target, bool conservative) const;
 
    void IntervalFlush();
 
    void ShutdownFlush();
 
    virtual unsigned int MaximumTarget() const;
 
    CFeeRate BlockPolicyEstimateRawFee(unsigned int target, double threshold, FeeEstimateHorizon horizon, EstimationResult* buckets) const;
 
    unsigned int BlockPolicyHighestTargetTracked(FeeEstimateHorizon horizon) const;
 
    std::vector<MinedBlockStats> MempoolPolicyEstimatorBlocksStats() const;
 
protected:
    void TransactionAddedToMempool(const NewMempoolTransactionInfo& tx, uint64_t /*unused*/) override;
    void TransactionRemovedFromMempool(const CTransactionRef& tx, MemPoolRemovalReason /*unused*/, uint64_t /*unused*/) override;
    void MempoolTransactionsRemovedForBlock(const std::shared_ptr<const CBlock>& block, const std::vector<RemovedMempoolTransactionInfo>& txs_removed_for_block, unsigned int block_height) override;
 
private:
    std::unique_ptr<CBlockPolicyEstimator> m_block_policy_estimator;
    std::unique_ptr<MemPoolFeeRateEstimator> m_mempool_estimator;
};
 
#endif // BITCOIN_POLICY_FEES_ESTIMATOR_MAN_H