validation.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2016 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_CONSENSUS_VALIDATION_H
#define BITCOIN_CONSENSUS_VALIDATION_H
 
#include <cassert>
#include <string>
 
enum class TxValidationResult {
    TX_RESULT_UNSET = 0,
    TX_CONSENSUS,
    TX_INPUTS_NOT_STANDARD,
    TX_NOT_STANDARD,
    TX_MISSING_INPUTS,
    TX_PREMATURE_SPEND,
    TX_DUPLICATE,
    TX_CONFLICT,
    TX_CHILD_BEFORE_PARENT,
    TX_MEMPOOL_POLICY,
    TX_NO_MEMPOOL,
    TX_PACKAGE_RECONSIDERABLE,
    TX_AVALANCHE_RECONSIDERABLE,
    TX_UNKNOWN,
};
 
enum class BlockValidationResult {
    BLOCK_RESULT_UNSET = 0,
    BLOCK_CONSENSUS,
    BLOCK_CACHED_INVALID,
    BLOCK_INVALID_HEADER,
    BLOCK_MUTATED,
    BLOCK_MISSING_PREV,
    BLOCK_INVALID_PREV,
    BLOCK_TIME_FUTURE,
    BLOCK_CHECKPOINT,
    BLOCK_HEADER_LOW_WORK
};
 
template <typename Result> class ValidationState {
private:
    enum class ModeState {
        M_VALID,   
        M_INVALID, 
        M_ERROR,   
    } m_mode{ModeState::M_VALID};
    Result m_result{};
    std::string m_reject_reason;
    std::string m_debug_message;
 
public:
    bool Invalid(Result result, const std::string &reject_reason = "",
                 const std::string &debug_message = "") {
        m_result = result;
        m_reject_reason = reject_reason;
        m_debug_message = debug_message;
        if (m_mode != ModeState::M_ERROR) {
            m_mode = ModeState::M_INVALID;
        }
        return false;
    }
 
    bool Error(const std::string &reject_reason) {
        if (m_mode == ModeState::M_VALID) {
            m_reject_reason = reject_reason;
        }
        m_mode = ModeState::M_ERROR;
        return false;
    }
    bool IsValid() const { return m_mode == ModeState::M_VALID; }
    bool IsInvalid() const { return m_mode == ModeState::M_INVALID; }
    bool IsError() const { return m_mode == ModeState::M_ERROR; }
    Result GetResult() const { return m_result; }
    std::string GetRejectReason() const { return m_reject_reason; }
    std::string GetDebugMessage() const { return m_debug_message; }
    std::string ToString() const {
        if (IsValid()) {
            return "Valid";
        }
 
        if (!m_debug_message.empty()) {
            return m_reject_reason + ", " + m_debug_message;
        }
 
        return m_reject_reason;
    }
};
 
class TxValidationState : public ValidationState<TxValidationResult> {};
class BlockValidationState : public ValidationState<BlockValidationResult> {};
 
#endif // BITCOIN_CONSENSUS_VALIDATION_H