foster/bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-06 14:19:59 -05:00
Code Issues Activity

Templatize ValidationState instead of subclassing

Browse source 
This removes boilerplate code in the subclasses which otherwise only
differ by the result type.
This commit is contained in:
Jeffrey Czyz 2019-11-08 12:14:27 -08:00
parent 10e85d4adc
commit 10efc0487c
1 changed files with 13 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
src/consensus/validation.h
View file

@ -16,7 +16,7 @@
* provider of the transaction should be banned/ignored/disconnected/etc. * provider of the transaction should be banned/ignored/disconnected/etc.
*/ */
enum class TxValidationResult { enum class TxValidationResult {
TX_RESULT_UNSET, //!< initial value. Tx has not yet been rejected TX_RESULT_UNSET = 0, //!< initial value. Tx has not yet been rejected
TX_CONSENSUS, //!< invalid by consensus rules TX_CONSENSUS, //!< invalid by consensus rules
/** /**
* Invalid by a change to consensus rules more recent than SegWit. * Invalid by a change to consensus rules more recent than SegWit.
@ -50,7 +50,7 @@ enum class TxValidationResult {
* useful for some other use-cases. * useful for some other use-cases.
*/ */
enum class BlockValidationResult { enum class BlockValidationResult {
BLOCK_RESULT_UNSET, //!< initial value. Block has not yet been rejected BLOCK_RESULT_UNSET = 0, //!< initial value. Block has not yet been rejected
BLOCK_CONSENSUS, //!< invalid by consensus rules (excluding any below reasons) BLOCK_CONSENSUS, //!< invalid by consensus rules (excluding any below reasons)
/** /**
* Invalid by a change to consensus rules more recent than SegWit. * Invalid by a change to consensus rules more recent than SegWit.
@ -71,9 +71,10 @@ enum class BlockValidationResult {
/** Base class for capturing information about block/transaction validation. This is subclassed /** Template for capturing information about block/transaction validation. This is instantiated
* by TxValidationState and BlockValidationState for validation information on transactions * by TxValidationState and BlockValidationState for validation information on transactions
* and blocks respectively. */ * and blocks respectively. */
template <typename Result>
class ValidationState { class ValidationState {
private: private:
enum mode_state { enum mode_state {
@ -81,20 +82,20 @@ private:
MODE_INVALID, //!< network rule violation (DoS value may be set) MODE_INVALID, //!< network rule violation (DoS value may be set)
MODE_ERROR, //!< run-time error MODE_ERROR, //!< run-time error
} m_mode{MODE_VALID}; } m_mode{MODE_VALID};
Result m_result{};
std::string m_reject_reason; std::string m_reject_reason;
std::string m_debug_message; std::string m_debug_message;
protected: public:
void Invalid(const std::string &reject_reason="", bool Invalid(Result result,
const std::string &reject_reason="",
const std::string &debug_message="") const std::string &debug_message="")
{ {
m_result = result;
m_reject_reason = reject_reason; m_reject_reason = reject_reason;
m_debug_message = debug_message; m_debug_message = debug_message;
if (m_mode != MODE_ERROR) m_mode = MODE_INVALID; if (m_mode != MODE_ERROR) m_mode = MODE_INVALID;
return false;
} }
public:
// ValidationState is abstract. Have a pure virtual destructor.
virtual ~ValidationState() = 0;
bool Error(const std::string& reject_reason) bool Error(const std::string& reject_reason)
{ {
if (m_mode == MODE_VALID) if (m_mode == MODE_VALID)
@ -105,6 +106,7 @@ public:
bool IsValid() const { return m_mode == MODE_VALID; } bool IsValid() const { return m_mode == MODE_VALID; }
bool IsInvalid() const { return m_mode == MODE_INVALID; } bool IsInvalid() const { return m_mode == MODE_INVALID; }
bool IsError() const { return m_mode == MODE_ERROR; } bool IsError() const { return m_mode == MODE_ERROR; }
Result GetResult() const { return m_result; }
std::string GetRejectReason() const { return m_reject_reason; } std::string GetRejectReason() const { return m_reject_reason; }
std::string GetDebugMessage() const { return m_debug_message; } std::string GetDebugMessage() const { return m_debug_message; }
std::string ToString() const std::string ToString() const
@ -121,36 +123,8 @@ public:
} }
}; };
inline ValidationState::~ValidationState() {}; class TxValidationState : public ValidationState<TxValidationResult> {};
class BlockValidationState : public ValidationState<BlockValidationResult> {};
class TxValidationState : public ValidationState {
private:
TxValidationResult m_result = TxValidationResult::TX_RESULT_UNSET;
public:
bool Invalid(TxValidationResult result,
const std::string &reject_reason="",
const std::string &debug_message="")
{
m_result = result;
ValidationState::Invalid(reject_reason, debug_message);
return false;
}
TxValidationResult GetResult() const { return m_result; }
};
class BlockValidationState : public ValidationState {
private:
BlockValidationResult m_result = BlockValidationResult::BLOCK_RESULT_UNSET;
public:
bool Invalid(BlockValidationResult result,
const std::string &reject_reason="",
const std::string &debug_message="") {
m_result = result;
ValidationState::Invalid(reject_reason, debug_message);
return false;
}
BlockValidationResult GetResult() const { return m_result; }
};
// These implement the weight = (stripped_size * 4) + witness_size formula, // These implement the weight = (stripped_size * 4) + witness_size formula,
// using only serialization with and without witness data. As witness_size // using only serialization with and without witness data. As witness_size