block_template_manager.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_NODE_BLOCK_TEMPLATE_MANAGER_H
#define BITCOIN_NODE_BLOCK_TEMPLATE_MANAGER_H
 
#include <node/mining_types.h>
#include <util/time.h>
 
#include <memory>
#include <optional>
#include <string>
 
class CBlock;
class ChainstateManager;
class CTxMemPool;
class uint256;
 
namespace interfaces {
struct BlockRef;
} // namespace interfaces
 
namespace node {
class KernelNotifications;
struct CBlockTemplate;
 
class BlockTemplateManager
{
private:
    CTxMemPool& m_mempool;
    ChainstateManager& m_chainman;
    KernelNotifications& m_notifications;
    const BlockCreateOptions m_block_create_args;
 
public:
    explicit BlockTemplateManager(CTxMemPool& mempool,
                                  ChainstateManager& chainman,
                                  KernelNotifications& notifications,
                                  BlockCreateOptions block_create_args = {});
 
    const BlockCreateOptions& BlockCreateArgs() const { return m_block_create_args; }
 
    std::unique_ptr<CBlockTemplate> CreateNewTemplate(const BlockCreateOptions& options);
 
    bool SubmitBlock(const std::shared_ptr<const CBlock>& block, std::string& reason, std::string& debug);
 
    std::optional<interfaces::BlockRef> GetTip();
 
    std::optional<interfaces::BlockRef> WaitTipChanged(const uint256& current_tip, MillisecondsDouble& timeout, bool& interrupt);
 
    std::optional<interfaces::BlockRef> WaitTipChanged(const uint256& current_tip, MillisecondsDouble timeout = MillisecondsDouble::max());
 
    bool CooldownIfHeadersAhead(const interfaces::BlockRef& last_tip, bool& interrupt_mining);
 
    void InterruptWait(bool& interrupt_wait);
 
    std::unique_ptr<CBlockTemplate> WaitAndCreateNewBlock(
        const std::unique_ptr<CBlockTemplate>& block_template,
        const BlockWaitOptions& wait_options,
        const BlockCreateOptions& create_options,
        bool& interrupt_wait);
};
} // namespace node
 
#endif // BITCOIN_NODE_BLOCK_TEMPLATE_MANAGER_H