Bitcoin Core  22.99.0
P2P Digital Currency
validation.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 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 <string>
10 #include <version.h>
11 #include <consensus/consensus.h>
12 #include <primitives/transaction.h>
13 #include <primitives/block.h>
14 
16 static constexpr int NO_WITNESS_COMMITMENT{-1};
17 
19 static constexpr size_t MINIMUM_WITNESS_COMMITMENT{38};
20 
24 enum class TxValidationResult {
25  TX_RESULT_UNSET = 0,
26  TX_CONSENSUS,
27 
39 
56 };
57 
64  BLOCK_RESULT_UNSET = 0,
66 
81 };
82 
83 
84 
88 template <typename Result>
90 {
91 private:
92  enum class ModeState {
93  M_VALID,
94  M_INVALID,
95  M_ERROR,
96  } m_mode{ModeState::M_VALID};
98  std::string m_reject_reason;
99  std::string m_debug_message;
100 
101 public:
102  bool Invalid(Result result,
103  const std::string& reject_reason = "",
104  const std::string& debug_message = "")
105  {
106  m_result = result;
107  m_reject_reason = reject_reason;
108  m_debug_message = debug_message;
109  if (m_mode != ModeState::M_ERROR) m_mode = ModeState::M_INVALID;
110  return false;
111  }
112  bool Error(const std::string& reject_reason)
113  {
114  if (m_mode == ModeState::M_VALID)
115  m_reject_reason = reject_reason;
116  m_mode = ModeState::M_ERROR;
117  return false;
118  }
119  bool IsValid() const { return m_mode == ModeState::M_VALID; }
120  bool IsInvalid() const { return m_mode == ModeState::M_INVALID; }
121  bool IsError() const { return m_mode == ModeState::M_ERROR; }
122  Result GetResult() const { return m_result; }
123  std::string GetRejectReason() const { return m_reject_reason; }
124  std::string GetDebugMessage() const { return m_debug_message; }
125  std::string ToString() const
126  {
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 // These implement the weight = (stripped_size * 4) + witness_size formula,
143 // using only serialization with and without witness data. As witness_size
144 // is equal to total_size - stripped_size, this formula is identical to:
145 // weight = (stripped_size * 3) + total_size.
146 static inline int64_t GetTransactionWeight(const CTransaction& tx)
147 {
149 }
150 static inline int64_t GetBlockWeight(const CBlock& block)
151 {
153 }
154 static inline int64_t GetTransactionInputWeight(const CTxIn& txin)
155 {
156  // scriptWitness size is added here because witnesses and txins are split up in segwit serialization.
158 }
159 
161 inline int GetWitnessCommitmentIndex(const CBlock& block)
162 {
163  int commitpos = NO_WITNESS_COMMITMENT;
164  if (!block.vtx.empty()) {
165  for (size_t o = 0; o < block.vtx[0]->vout.size(); o++) {
166  const CTxOut& vout = block.vtx[0]->vout[o];
168  vout.scriptPubKey[0] == OP_RETURN &&
169  vout.scriptPubKey[1] == 0x24 &&
170  vout.scriptPubKey[2] == 0xaa &&
171  vout.scriptPubKey[3] == 0x21 &&
172  vout.scriptPubKey[4] == 0xa9 &&
173  vout.scriptPubKey[5] == 0xed) {
174  commitpos = o;
175  }
176  }
177  }
178  return commitpos;
179 }
180 
181 #endif // BITCOIN_CONSENSUS_VALIDATION_H
GetSerializeSize
size_t GetSerializeSize(const T &t, int nVersion=0)
Definition: serialize.h:1080
CTxIn
An input of a transaction.
Definition: transaction.h:65
ValidationState< PackageValidationResult >::ModeState
ModeState
Definition: validation.h:92
BlockValidationResult::BLOCK_CACHED_INVALID
@ BLOCK_CACHED_INVALID
this block was cached as being invalid and we didn't store the reason why
block.h
BlockValidationResult::BLOCK_CONSENSUS
@ BLOCK_CONSENSUS
invalid by consensus rules (excluding any below reasons)
BlockValidationResult::BLOCK_MUTATED
@ BLOCK_MUTATED
the block's data didn't match the data committed to by the PoW
ValidationState::m_result
Result m_result
Definition: validation.h:97
TxValidationResult::TX_WITNESS_STRIPPED
@ TX_WITNESS_STRIPPED
Transaction is missing a witness.
BlockValidationState
Definition: validation.h:140
transaction.h
feebumper::Result
Result
Definition: feebumper.h:19
ValidationState::ModeState::M_ERROR
@ M_ERROR
run-time error
ValidationState::GetDebugMessage
std::string GetDebugMessage() const
Definition: validation.h:124
BlockValidationResult::BLOCK_RECENT_CONSENSUS_CHANGE
@ BLOCK_RECENT_CONSENSUS_CHANGE
Invalid by a change to consensus rules more recent than SegWit.
BlockValidationResult::BLOCK_TIME_FUTURE
@ BLOCK_TIME_FUTURE
block timestamp was > 2 hours in the future (or our clock is bad)
TxValidationResult::TX_CONFLICT
@ TX_CONFLICT
Tx already in mempool or conflicts with a tx in the chain (if it conflicts with another tx in mempool...
TxValidationResult::TX_NOT_STANDARD
@ TX_NOT_STANDARD
otherwise didn't meet our local policy rules
version.h
BlockValidationResult
BlockValidationResult
A "reason" why a block was invalid, suitable for determining whether the provider of the block should...
Definition: validation.h:63
CTransaction
The basic transaction that is broadcasted on the network and contained in blocks.
Definition: transaction.h:259
ValidationState::ToString
std::string ToString() const
Definition: validation.h:125
CTxIn::scriptWitness
CScriptWitness scriptWitness
Only serialized through CTransaction.
Definition: transaction.h:71
ValidationState::IsValid
bool IsValid() const
Definition: validation.h:119
TxValidationState
Definition: validation.h:139
OP_RETURN
@ OP_RETURN
Definition: script.h:104
BlockValidationResult::BLOCK_INVALID_PREV
@ BLOCK_INVALID_PREV
A block this one builds on is invalid.
CTxOut
An output of a transaction.
Definition: transaction.h:128
CTxOut::scriptPubKey
CScript scriptPubKey
Definition: transaction.h:132
consensus.h
ValidationState::m_debug_message
std::string m_debug_message
Definition: validation.h:99
SERIALIZE_TRANSACTION_NO_WITNESS
static const int SERIALIZE_TRANSACTION_NO_WITNESS
A flag that is ORed into the protocol version to designate that a transaction should be (un)serialize...
Definition: transaction.h:23
MINIMUM_WITNESS_COMMITMENT
static constexpr size_t MINIMUM_WITNESS_COMMITMENT
Minimum size of a witness commitment structure.
Definition: validation.h:19
GetWitnessCommitmentIndex
int GetWitnessCommitmentIndex(const CBlock &block)
Compute at which vout of the block's coinbase transaction the witness commitment occurs,...
Definition: validation.h:161
GetBlockWeight
static int64_t GetBlockWeight(const CBlock &block)
Definition: validation.h:150
ValidationState::Invalid
bool Invalid(Result result, const std::string &reject_reason="", const std::string &debug_message="")
Definition: validation.h:102
ValidationState::GetResult
Result GetResult() const
Definition: validation.h:122
TxValidationResult::TX_MEMPOOL_POLICY
@ TX_MEMPOOL_POLICY
violated mempool's fee/size/descendant/RBF/etc limits
TxValidationResult::TX_PREMATURE_SPEND
@ TX_PREMATURE_SPEND
transaction spends a coinbase too early, or violates locktime/sequence locks
CBlock
Definition: block.h:62
TxValidationResult::TX_RESULT_UNSET
@ TX_RESULT_UNSET
initial value. Tx has not yet been rejected
ValidationState::m_reject_reason
std::string m_reject_reason
Definition: validation.h:98
TxValidationResult::TX_CONSENSUS
@ TX_CONSENSUS
invalid by consensus rules
GetTransactionWeight
static int64_t GetTransactionWeight(const CTransaction &tx)
Definition: validation.h:146
CBlock::vtx
std::vector< CTransactionRef > vtx
Definition: block.h:66
TxValidationResult::TX_MISSING_INPUTS
@ TX_MISSING_INPUTS
transaction was missing some of its inputs
BlockValidationResult::BLOCK_MISSING_PREV
@ BLOCK_MISSING_PREV
We don't have the previous block the checked one is built on.
BlockValidationResult::BLOCK_RESULT_UNSET
@ BLOCK_RESULT_UNSET
initial value. Block has not yet been rejected
prevector::size
size_type size() const
Definition: prevector.h:282
GetTransactionInputWeight
static int64_t GetTransactionInputWeight(const CTxIn &txin)
Definition: validation.h:154
BlockValidationResult::BLOCK_INVALID_HEADER
@ BLOCK_INVALID_HEADER
invalid proof of work or time too old
TxValidationResult::TX_INPUTS_NOT_STANDARD
@ TX_INPUTS_NOT_STANDARD
inputs (covered by txid) failed policy rules
TxValidationResult::TX_WITNESS_MUTATED
@ TX_WITNESS_MUTATED
Transaction might have a witness prior to SegWit activation, or witness may have been malleated (whic...
ValidationState::ModeState::M_VALID
@ M_VALID
everything ok
ValidationState::GetRejectReason
std::string GetRejectReason() const
Definition: validation.h:123
TxValidationResult
TxValidationResult
A "reason" why a transaction was invalid, suitable for determining whether the provider of the transa...
Definition: validation.h:24
ValidationState::ModeState::M_INVALID
@ M_INVALID
network rule violation (DoS value may be set)
ValidationState::Error
bool Error(const std::string &reject_reason)
Definition: validation.h:112
ValidationState::IsError
bool IsError() const
Definition: validation.h:121
BlockValidationResult::BLOCK_CHECKPOINT
@ BLOCK_CHECKPOINT
the block failed to meet one of our checkpoints
WITNESS_SCALE_FACTOR
static const int WITNESS_SCALE_FACTOR
Definition: consensus.h:21
ValidationState::IsInvalid
bool IsInvalid() const
Definition: validation.h:120
CScriptWitness::stack
std::vector< std::vector< unsigned char > > stack
Definition: script.h:561
NO_WITNESS_COMMITMENT
static constexpr int NO_WITNESS_COMMITMENT
Index marker for when no witness commitment is present in a coinbase transaction.
Definition: validation.h:16
PROTOCOL_VERSION
static const int PROTOCOL_VERSION
network protocol versioning
Definition: version.h:12
TxValidationResult::TX_RECENT_CONSENSUS_CHANGE
@ TX_RECENT_CONSENSUS_CHANGE
Invalid by a change to consensus rules more recent than SegWit.
ValidationState
Template for capturing information about block/transaction validation.
Definition: validation.h:89