Bitcoin ABC  0.26.3
P2P Digital Currency
validation.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #ifndef BITCOIN_CONSENSUS_VALIDATION_H
7 #define BITCOIN_CONSENSUS_VALIDATION_H
8 
9 #include <cassert>
10 #include <string>
11 
16 enum class TxValidationResult {
18  TX_RESULT_UNSET = 0,
45 };
46 
75 };
76 
82 template <typename Result> class ValidationState {
83 private:
84  enum class ModeState {
85  M_VALID,
86  M_INVALID,
87  M_ERROR,
88  } m_mode{ModeState::M_VALID};
89  Result m_result{};
90  std::string m_reject_reason;
91  std::string m_debug_message;
92 
93 public:
94  bool Invalid(Result result, const std::string &reject_reason = "",
95  const std::string &debug_message = "") {
96  m_result = result;
97  m_reject_reason = reject_reason;
98  m_debug_message = debug_message;
99  if (m_mode != ModeState::M_ERROR) {
100  m_mode = ModeState::M_INVALID;
101  }
102  return false;
103  }
104 
105  bool Error(const std::string &reject_reason) {
106  if (m_mode == ModeState::M_VALID) {
107  m_reject_reason = reject_reason;
108  }
109  m_mode = ModeState::M_ERROR;
110  return false;
111  }
112  bool IsValid() const { return m_mode == ModeState::M_VALID; }
113  bool IsInvalid() const { return m_mode == ModeState::M_INVALID; }
114  bool IsError() const { return m_mode == ModeState::M_ERROR; }
115  Result GetResult() const { return m_result; }
116  std::string GetRejectReason() const { return m_reject_reason; }
117  std::string GetDebugMessage() const { return m_debug_message; }
118  std::string ToString() const {
119  if (IsValid()) {
120  return "Valid";
121  }
122 
123  if (!m_debug_message.empty()) {
124  return m_reject_reason + ", " + m_debug_message;
125  }
126 
127  return m_reject_reason;
128  }
129 };
130 
131 class TxValidationState : public ValidationState<TxValidationResult> {};
132 class BlockValidationState : public ValidationState<BlockValidationResult> {};
133 
134 #endif // BITCOIN_CONSENSUS_VALIDATION_H
Template for capturing information about block/transaction validation.
Definition: validation.h:82
@ M_INVALID
network rule violation (DoS value may be set)
bool IsValid() const
Definition: validation.h:112
std::string GetRejectReason() const
Definition: validation.h:116
Result m_result
Definition: validation.h:89
std::string m_reject_reason
Definition: validation.h:90
std::string GetDebugMessage() const
Definition: validation.h:117
bool Error(const std::string &reject_reason)
Definition: validation.h:105
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:94
bool IsError() const
Definition: validation.h:114
Result GetResult() const
Definition: validation.h:115
std::string m_debug_message
Definition: validation.h:91
std::string ToString() const
Definition: validation.h:118
bool IsInvalid() const
Definition: validation.h:113
BlockValidationResult
A "reason" why a block was invalid, suitable for determining whether the provider of the block should...
Definition: validation.h:53
@ BLOCK_CHECKPOINT
the block failed to meet one of our checkpoints
@ BLOCK_HEADER_LOW_WORK
the block header may be on a too-little-work chain
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
@ BLOCK_RESULT_UNSET
initial value. Block has not yet been rejected
TxValidationResult
A "reason" why a transaction was invalid, suitable for determining whether the provider of the transa...
Definition: validation.h:16
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
@ TX_CHILD_BEFORE_PARENT
This tx outputs are already spent in the mempool.
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/etc limits
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
@ TX_DUPLICATE
Tx already in mempool or in the chain.
@ TX_INPUTS_NOT_STANDARD
inputs failed policy rules
@ TX_CONFLICT
Tx conflicts with another mempool tx, i.e.
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
@ TX_NO_MEMPOOL
this node does not have a mempool so can't validate the transaction
@ TX_RESULT_UNSET
initial value. Tx has not yet been rejected
@ TX_CONSENSUS
invalid by consensus rules