mining.h

Go to the documentation of this file.

// Copyright (c) 2024 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_INTERFACES_MINING_H
#define BITCOIN_INTERFACES_MINING_H
 
#include <node/types.h>
#include <uint256.h>
 
#include <memory>
#include <optional>
 
namespace node {
struct CBlockTemplate;
struct NodeContext;
} // namespace node
 
class BlockValidationState;
class CBlock;
class CScript;
 
namespace interfaces {
 
 
class Mining
{
public:
    virtual ~Mining() = default;
 
    virtual bool isTestChain() = 0;
 
    virtual bool isInitialBlockDownload() = 0;
 
    virtual std::optional<uint256> getTipHash() = 0;
 
    virtual std::unique_ptr<node::CBlockTemplate> createNewBlock(const CScript& script_pub_key, const node::BlockCreateOptions& options={}) = 0;
 
    virtual bool processNewBlock(const std::shared_ptr<const CBlock>& block, bool* new_block) = 0;
 
    virtual unsigned int getTransactionsUpdated() = 0;
 
    virtual bool testBlockValidity(const CBlock& block, bool check_merkle_root, BlockValidationState& state) = 0;
 
    virtual node::NodeContext* context() { return nullptr; }
};
 
std::unique_ptr<Mining> MakeMining(node::NodeContext& node);
 
} // namespace interfaces
 
#endif // BITCOIN_INTERFACES_MINING_H