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 
83 };
84 
90 template <typename Result> class ValidationState {
91 private:
92  enum class ModeState {
93  M_VALID,
94  M_INVALID,
95  M_ERROR,
96  } m_mode{ModeState::M_VALID};
97  Result m_result{};
98  std::string m_reject_reason;
99  std::string m_debug_message;
100 
101 public:
102  bool Invalid(Result result, const std::string &reject_reason = "",
103  const std::string &debug_message = "") {
104  m_result = result;
105  m_reject_reason = reject_reason;
106  m_debug_message = debug_message;
107  if (m_mode != ModeState::M_ERROR) {
108  m_mode = ModeState::M_INVALID;
109  }
110  return false;
111  }
112 
113  bool Error(const std::string &reject_reason) {
114  if (m_mode == ModeState::M_VALID) {
115  m_reject_reason = reject_reason;
116  }
117  m_mode = ModeState::M_ERROR;
118  return false;
119  }
120  bool IsValid() const { return m_mode == ModeState::M_VALID; }
121  bool IsInvalid() const { return m_mode == ModeState::M_INVALID; }
122  bool IsError() const { return m_mode == ModeState::M_ERROR; }
123  Result GetResult() const { return m_result; }
124  std::string GetRejectReason() const { return m_reject_reason; }
125  std::string GetDebugMessage() const { return m_debug_message; }
126  std::string ToString() const {
127  if (IsValid()) {
128  return "Valid";
129  }
130 
131  if (!m_debug_message.empty()) {
132  return m_reject_reason + ", " + m_debug_message;
133  }
134 
135  return m_reject_reason;
136  }
137 };
138 
139 class TxValidationState : public ValidationState<TxValidationResult> {};
140 class BlockValidationState : public ValidationState<BlockValidationResult> {};
141 
142 #endif // BITCOIN_CONSENSUS_VALIDATION_H
Template for capturing information about block/transaction validation.
Definition: validation.h:90
@ M_INVALID
network rule violation (DoS value may be set)
bool IsValid() const
Definition: validation.h:120
std::string GetRejectReason() const
Definition: validation.h:124
Result m_result
Definition: validation.h:97
std::string m_reject_reason
Definition: validation.h:98
std::string GetDebugMessage() const
Definition: validation.h:125
bool Error(const std::string &reject_reason)
Definition: validation.h:113
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:102
bool IsError() const
Definition: validation.h:122
Result GetResult() const
Definition: validation.h:123
std::string m_debug_message
Definition: validation.h:99
std::string ToString() const
Definition: validation.h:126
bool IsInvalid() const
Definition: validation.h:121
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_FINALIZATION
block finalization problems
@ BLOCK_RECENT_CONSENSUS_CHANGE
Invalid by a change to consensus rules more recent than SegWit.
@ 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_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_INPUTS_NOT_STANDARD
inputs failed policy rules
@ TX_CONFLICT
Tx already in mempool or conflicts with a tx in the chain Currently this is only used if the transact...
@ TX_RECENT_CONSENSUS_CHANGE
Invalid by a recent change to consensus rules.
@ 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