Skip to content

refactor: prefer using TxValidationState directly for unification with bitcoin implementation #5335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2023
Merged

refactor: prefer using TxValidationState directly for unification with bitcoin implementation #5335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 24 additions & 16 deletions src/evo/deterministicmns.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1451,8 +1451,9 @@ bool CheckProRegTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVali
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-payload");
}

if (auto maybe_err = ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev)); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev), state)) {
// pass the state returned by the function above
return false;
}

// It's allowed to set addr to 0, which will put the MN into PoSe-banned state and require a ProUpServTx to be issues later
Expand Down Expand Up @@ -1540,8 +1541,9 @@ bool CheckProRegTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVali
}
}

if (auto maybe_err = CheckInputsHash(tx, ptx); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!CheckInputsHash(tx, ptx, state)) {
// pass the state returned by the function above
return false;
}

if (keyForPayloadSig) {
Expand Down Expand Up @@ -1571,8 +1573,9 @@ bool CheckProUpServTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxV
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-payload");
}

if (auto maybe_err = ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev)); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev), state)) {
// pass the state returned by the function above
return false;
}

if (!CheckService(ptx, state)) {
Expand Down Expand Up @@ -1616,8 +1619,9 @@ bool CheckProUpServTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxV
}

// we can only check the signature if pindexPrev != nullptr and the MN is known
if (auto maybe_err = CheckInputsHash(tx, ptx); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!CheckInputsHash(tx, ptx, state)) {
// pass the state returned by the function above
return false;
}
if (check_sigs && !CheckHashSig(ptx, mn->pdmnState->pubKeyOperator.Get(), state)) {
// pass the state returned by the function above
Expand All @@ -1639,8 +1643,9 @@ bool CheckProUpRegTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVa
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-payload");
}

if (auto maybe_err = ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev)); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev), state)) {
// pass the state returned by the function above
return false;
}

CTxDestination payoutDest;
Expand Down Expand Up @@ -1689,8 +1694,9 @@ bool CheckProUpRegTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVa
}
}

if (auto maybe_err = CheckInputsHash(tx, ptx); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!CheckInputsHash(tx, ptx, state)) {
// pass the state returned by the function above
return false;
}
if (check_sigs && !CheckHashSig(ptx, PKHash(dmn->pdmnState->keyIDOwner), state)) {
// pass the state returned by the function above
Expand All @@ -1712,8 +1718,9 @@ bool CheckProUpRevTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVa
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-payload");
}

if (auto maybe_err = ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev)); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!ptx.IsTriviallyValid(llmq::utils::IsV19Active(pindexPrev), state)) {
// pass the state returned by the function above
return false;
}

if (pindexPrev) {
Expand All @@ -1722,8 +1729,9 @@ bool CheckProUpRevTx(const CTransaction& tx, const CBlockIndex* pindexPrev, TxVa
if (!dmn)
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-hash");

if (auto maybe_err = CheckInputsHash(tx, ptx); maybe_err.did_err) {
return state.Invalid(maybe_err.reason, std::string(maybe_err.error_str));
if (!CheckInputsHash(tx, ptx, state)) {
// pass the state returned by the function above
return false;
}
if (check_sigs && !CheckHashSig(ptx, dmn->pdmnState->pubKeyOperator.Get(), state)) {
// pass the state returned by the function above
Expand Down
46 changes: 23 additions & 23 deletions src/evo/providertx.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,40 +11,40 @@
#include <script/standard.h>
#include <util/underlying.h>

maybe_error CProRegTx::IsTriviallyValid(bool is_bls_legacy_scheme) const
bool CProRegTx::IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const
{
if (nVersion == 0 || nVersion > GetVersion(is_bls_legacy_scheme)) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-version"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-version");
}
if (!IsValidMnType(nType)) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-type"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-type");
}
if (nMode != 0) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-mode"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-mode");
}

if (keyIDOwner.IsNull() || !pubKeyOperator.IsValid() || keyIDVoting.IsNull()) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-key-null"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-key-null");
}
if (!scriptPayout.IsPayToPublicKeyHash() && !scriptPayout.IsPayToScriptHash()) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee");
}

CTxDestination payoutDest;
if (!ExtractDestination(scriptPayout, payoutDest)) {
// should not happen as we checked script types before
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee-dest"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee-dest");
}
// don't allow reuse of payout key for other keys (don't allow people to put the payee key onto an online server)
if (payoutDest == CTxDestination(PKHash(keyIDOwner)) || payoutDest == CTxDestination(PKHash(keyIDVoting))) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee-reuse"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee-reuse");
}

if (nOperatorReward > 10000) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-operator-reward"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-operator-reward");
}

return {};
return true;
}

std::string CProRegTx::MakeSignString() const
Expand Down Expand Up @@ -84,13 +84,13 @@ std::string CProRegTx::ToString() const
nVersion, ToUnderlying(nType), collateralOutpoint.ToStringShort(), addr.ToString(), (double)nOperatorReward / 100, EncodeDestination(PKHash(keyIDOwner)), pubKeyOperator.ToString(nVersion == LEGACY_BLS_VERSION), EncodeDestination(PKHash(keyIDVoting)), payee, platformNodeID.ToString(), platformP2PPort, platformHTTPPort);
}

maybe_error CProUpServTx::IsTriviallyValid(bool is_bls_legacy_scheme) const
bool CProUpServTx::IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const
{
if (nVersion == 0 || nVersion > GetVersion(is_bls_legacy_scheme)) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-version"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-version");
}

return {};
return true;
}

std::string CProUpServTx::ToString() const
Expand All @@ -105,22 +105,22 @@ std::string CProUpServTx::ToString() const
nVersion, ToUnderlying(nType), proTxHash.ToString(), addr.ToString(), payee, platformNodeID.ToString(), platformP2PPort, platformHTTPPort);
}

maybe_error CProUpRegTx::IsTriviallyValid(bool is_bls_legacy_scheme) const
bool CProUpRegTx::IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const
{
if (nVersion == 0 || nVersion > GetVersion(is_bls_legacy_scheme)) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-version"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-version");
}
if (nMode != 0) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-mode"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-mode");
}

if (!pubKeyOperator.IsValid() || keyIDVoting.IsNull()) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-key-null"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-key-null");
}
if (!scriptPayout.IsPayToPublicKeyHash() && !scriptPayout.IsPayToScriptHash()) {
return {TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee"};
return state.Invalid(TxValidationResult::TX_BAD_SPECIAL, "bad-protx-payee");
}
return {};
return true;
}

std::string CProUpRegTx::ToString() const
Expand All @@ -135,18 +135,18 @@ std::string CProUpRegTx::ToString() const
nVersion, proTxHash.ToString(), pubKeyOperator.ToString(nVersion == LEGACY_BLS_VERSION), EncodeDestination(PKHash(keyIDVoting)), payee);
}

maybe_error CProUpRevTx::IsTriviallyValid(bool is_bls_legacy_scheme) const
bool CProUpRevTx::IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const
{
if (nVersion == 0 || nVersion > GetVersion(is_bls_legacy_scheme)) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-version"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-version");
}

// nReason < CProUpRevTx::REASON_NOT_SPECIFIED is always `false` since
// nReason is unsigned and CProUpRevTx::REASON_NOT_SPECIFIED == 0
if (nReason > CProUpRevTx::REASON_LAST) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-reason"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-reason");
}
return {};
return true;
}

std::string CProUpRevTx::ToString() const
Expand Down
14 changes: 7 additions & 7 deletions src/evo/providertx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class CProRegTx
obj.pushKV("inputsHash", inputsHash.ToString());
}

maybe_error IsTriviallyValid(bool is_bls_legacy_scheme) const;
bool IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const;
};

class CProUpServTx
Expand Down Expand Up @@ -194,7 +194,7 @@ class CProUpServTx
obj.pushKV("inputsHash", inputsHash.ToString());
}

maybe_error IsTriviallyValid(bool is_bls_legacy_scheme) const;
bool IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const;
};

class CProUpRegTx
Expand Down Expand Up @@ -259,7 +259,7 @@ class CProUpRegTx
obj.pushKV("inputsHash", inputsHash.ToString());
}

maybe_error IsTriviallyValid(bool is_bls_legacy_scheme) const;
bool IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const;
};

class CProUpRevTx
Expand Down Expand Up @@ -322,17 +322,17 @@ class CProUpRevTx
obj.pushKV("inputsHash", inputsHash.ToString());
}

maybe_error IsTriviallyValid(bool is_bls_legacy_scheme) const;
bool IsTriviallyValid(bool is_bls_legacy_scheme, TxValidationState& state) const;
};

template <typename ProTx>
static maybe_error CheckInputsHash(const CTransaction& tx, const ProTx& proTx)
static bool CheckInputsHash(const CTransaction& tx, const ProTx& proTx, TxValidationState& state)
{
if (uint256 inputsHash = CalcTxInputsHash(tx); inputsHash != proTx.inputsHash) {
return {TxValidationResult::TX_CONSENSUS, "bad-protx-inputs-hash"};
return state.Invalid(TxValidationResult::TX_CONSENSUS, "bad-protx-inputs-hash");
}

return {};
return true;
}


Expand Down
9 changes: 0 additions & 9 deletions src/evo/specialtx.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,6 @@
#include <string_view>
#include <vector>

struct maybe_error {
bool did_err{false};
TxValidationResult reason{TxValidationResult::TX_CONSENSUS};
std::string_view error_str;

constexpr maybe_error() = default;
constexpr maybe_error(TxValidationResult reasonIn, std::string_view err): did_err(true), reason(reasonIn), error_str(err) {};
};

template <typename T>
inline bool GetTxPayload(const std::vector<unsigned char>& payload, T& obj)
{
Expand Down
18 changes: 10 additions & 8 deletions src/test/evo_trivialvalidation.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,33 +43,34 @@ BOOST_AUTO_TEST_CASE(trivialvalidation_valid)
BOOST_CHECK_EQUAL(tx.nVersion, 3);
BOOST_CHECK_EQUAL(tx.GetHash(), txHash);
// Deserialization based on transaction nType
TxValidationState dummy_state;
switch (tx.nType) {
case TRANSACTION_PROVIDER_REGISTER: {
BOOST_CHECK_EQUAL(txType, "proregtx");
CProRegTx ptx;
BOOST_CHECK(GetTxPayload(tx, ptx, false));
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
break;
}
case TRANSACTION_PROVIDER_UPDATE_SERVICE: {
BOOST_CHECK_EQUAL(txType, "proupservtx");
CProUpServTx ptx;
BOOST_CHECK(GetTxPayload(tx, ptx, false));
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
break;
}
case TRANSACTION_PROVIDER_UPDATE_REGISTRAR: {
BOOST_CHECK_EQUAL(txType, "proupregtx");
CProUpRegTx ptx;
BOOST_CHECK(GetTxPayload(tx, ptx, false));
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
break;
}
case TRANSACTION_PROVIDER_UPDATE_REVOKE: {
BOOST_CHECK_EQUAL(txType, "prouprevtx");
CProUpRevTx ptx;
BOOST_CHECK(GetTxPayload(tx, ptx, false));
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
break;
}
default:
Expand Down Expand Up @@ -108,26 +109,27 @@ BOOST_AUTO_TEST_CASE(trivialvalidation_invalid)
BOOST_CHECK_EQUAL(tx.nVersion, 3);
BOOST_CHECK_EQUAL(tx.GetHash(), txHash);
// Deserialization based on transaction nType
TxValidationState dummy_state;
if (txType == "proregtx") {
CProRegTx ptx;
if (GetTxPayload(tx, ptx, false)) {
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
} else {
BOOST_CHECK(tx.nType != TRANSACTION_PROVIDER_REGISTER || ptx.nVersion == 0);
}
}
else if (txType == "proupservtx") {
CProUpServTx ptx;
if (GetTxPayload(tx, ptx, false)) {
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
} else {
BOOST_CHECK(tx.nType != TRANSACTION_PROVIDER_UPDATE_SERVICE || ptx.nVersion == 0);
}
}
else if (txType == "proupregtx") {
CProUpRegTx ptx;
if (GetTxPayload(tx, ptx, false)) {
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
}
else {
BOOST_CHECK(tx.nType != TRANSACTION_PROVIDER_UPDATE_REGISTRAR || ptx.nVersion == 0);
Expand All @@ -136,7 +138,7 @@ BOOST_AUTO_TEST_CASE(trivialvalidation_invalid)
else if (txType == "prouprevtx") {
CProUpRevTx ptx;
if (GetTxPayload(tx, ptx, false)) {
BOOST_CHECK(ptx.IsTriviallyValid(bls::bls_legacy_scheme.load()).did_err);
BOOST_CHECK(!ptx.IsTriviallyValid(bls::bls_legacy_scheme.load(), dummy_state));
} else {
BOOST_CHECK(tx.nType != TRANSACTION_PROVIDER_UPDATE_REVOKE || ptx.nVersion == 0);
}
Expand Down