refactor: move masternode mode logic to governance/signing.cpp

Review with `git log -p -n1 --color-moved=dimmed_zebra`.

Author: kwvg

src/Makefile.am

@@ -510,6 +510,7 @@ libbitcoin_node_a_SOURCES = \
   governance/exceptions.cpp \
   governance/governance.cpp \
   governance/object.cpp \
+  governance/signing.cpp \
   governance/validators.cpp \
   governance/vote.cpp \
   governance/votedb.cpp \

src/governance/governance.cpp

@@ -592,276 +592,6 @@ struct sortProposalsByVotes {
     }
 };
 
-std::optional<const CSuperblock> CGovernanceManager::CreateSuperblockCandidate(int nHeight) const
-{
-    if (!IsValid()) return std::nullopt;
-    if (!m_mn_sync.IsSynced()) return std::nullopt;
-    if (nHeight % Params().GetConsensus().nSuperblockCycle < Params().GetConsensus().nSuperblockCycle - Params().GetConsensus().nSuperblockMaturityWindow) return std::nullopt;
-    if (HasAlreadyVotedFundingTrigger()) return std::nullopt;
-
-    // A proposal is considered passing if (YES votes) >= (Total Weight of Masternodes / 10),
-    // count total valid (ENABLED) masternodes to determine passing threshold.
-    const auto tip_mn_list = Assert(m_dmnman)->GetListAtChainTip();
-    const int nWeightedMnCount = tip_mn_list.GetValidWeightedMNsCount();
-    const int nAbsVoteReq = std::max(Params().GetConsensus().nGovernanceMinQuorum, nWeightedMnCount / 10);
-
-    // Use std::vector of std::shared_ptr<const CGovernanceObject> because CGovernanceObject doesn't support move operations (needed for sorting the vector later)
-    std::vector<std::shared_ptr<const CGovernanceObject>> approvedProposals;
-
-    {
-        LOCK(cs);
-        for (const auto& [unused, object] : mapObjects) {
-            // Skip all non-proposals objects
-            if (object.GetObjectType() != GovernanceObject::PROPOSAL) continue;
-
-            const int absYesCount = object.GetAbsoluteYesCount(tip_mn_list, VOTE_SIGNAL_FUNDING);
-            // Skip non-passing proposals
-            if (absYesCount < nAbsVoteReq) continue;
-
-            approvedProposals.emplace_back(std::make_shared<const CGovernanceObject>(object));
-        }
-    } // cs
-
-    // Sort approved proposals by absolute Yes votes descending
-    std::sort(approvedProposals.begin(), approvedProposals.end(), [tip_mn_list](std::shared_ptr<const CGovernanceObject> a, std::shared_ptr<const CGovernanceObject> b) {
-        const auto a_yes = a->GetAbsoluteYesCount(tip_mn_list, VOTE_SIGNAL_FUNDING);
-        const auto b_yes = b->GetAbsoluteYesCount(tip_mn_list, VOTE_SIGNAL_FUNDING);
-        return a_yes == b_yes ? UintToArith256(a->GetHash()) > UintToArith256(b->GetHash()) : a_yes > b_yes;
-    });
-
-    if (approvedProposals.empty()) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s nHeight:%d empty approvedProposals\n", __func__, nHeight);
-        return std::nullopt;
-    }
-
-    std::vector<CGovernancePayment> payments;
-    int nLastSuperblock;
-    int nNextSuperblock;
-
-    CSuperblock::GetNearestSuperblocksHeights(nHeight, nLastSuperblock, nNextSuperblock);
-    auto SBEpochTime = static_cast<int64_t>(GetTime<std::chrono::seconds>().count() + (nNextSuperblock - nHeight) * 2.62 * 60);
-    auto governanceBudget = CSuperblock::GetPaymentsLimit(m_chainman.ActiveChain(), nNextSuperblock);
-
-    CAmount budgetAllocated{};
-    for (const auto& proposal : approvedProposals) {
-        // Extract payment address and amount from proposal
-        UniValue jproposal = proposal->GetJSONObject();
-
-        CTxDestination dest = DecodeDestination(jproposal["payment_address"].getValStr());
-        if (!IsValidDestination(dest)) continue;
-
-        CAmount nAmount{};
-        try {
-            nAmount = ParsePaymentAmount(jproposal["payment_amount"].getValStr());
-        }
-        catch (const std::runtime_error& e) {
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s nHeight:%d Skipping payment exception:%s\n", __func__,nHeight, e.what());
-            continue;
-        }
-
-        // Construct CGovernancePayment object and make sure it is valid
-        CGovernancePayment payment(dest, nAmount, proposal->GetHash());
-        if (!payment.IsValid()) continue;
-
-        // Skip proposals that are too expensive
-        if (budgetAllocated + payment.nAmount > governanceBudget) continue;
-
-        int64_t windowStart = jproposal["start_epoch"].getInt<int64_t>() - GOVERNANCE_FUDGE_WINDOW;
-        int64_t windowEnd = jproposal["end_epoch"].getInt<int64_t>() + GOVERNANCE_FUDGE_WINDOW;
-
-        // Skip proposals if the SB isn't within the proposal time window
-        if (SBEpochTime < windowStart) {
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s nHeight:%d SB:%d windowStart:%d\n", __func__,nHeight, SBEpochTime, windowStart);
-            continue;
-        }
-        if (SBEpochTime > windowEnd) {
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s nHeight:%d SB:%d windowEnd:%d\n", __func__,nHeight, SBEpochTime, windowEnd);
-            continue;
-        }
-
-        // Keep track of total budget allocation
-        budgetAllocated += payment.nAmount;
-
-        // Add the payment
-        payments.push_back(payment);
-    }
-
-    // No proposals made the cut
-    if (payments.empty()) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s CreateSuperblockCandidate nHeight:%d empty payments\n", __func__, nHeight);
-        return std::nullopt;
-    }
-
-    // Sort by proposal hash descending
-    std::sort(payments.begin(), payments.end(), [](const CGovernancePayment& a, const CGovernancePayment& b) {
-        return UintToArith256(a.proposalHash) > UintToArith256(b.proposalHash);
-    });
-
-    // Create Superblock
-    return CSuperblock(nNextSuperblock, std::move(payments));
-}
-
-std::optional<const CGovernanceObject> CGovernanceManager::CreateGovernanceTrigger(const std::optional<const CSuperblock>& sb_opt, PeerManager& peerman,
-                                                                                   const CActiveMasternodeManager& mn_activeman)
-{
-    // no sb_opt, no trigger
-    if (!sb_opt.has_value()) return std::nullopt;
-
-    //TODO: Check if nHashParentIn, nRevision and nCollateralHashIn are correct
-    LOCK2(::cs_main, cs);
-
-    // Check if identical trigger (equal DataHash()) is already created (signed by other masternode)
-    CGovernanceObject gov_sb(uint256(), 1, GetAdjustedTime(), uint256(), sb_opt.value().GetHexStrData());
-    if (auto identical_sb = FindGovernanceObjectByDataHash(gov_sb.GetDataHash())) {
-        // Somebody submitted a trigger with the same data, support it instead of submitting a duplicate
-        return std::make_optional<CGovernanceObject>(*identical_sb);
-    }
-
-    // Nobody submitted a trigger we'd like to see, so let's do it but only if we are the payee
-    const CBlockIndex* tip = m_chainman.ActiveChain().Tip();
-    const auto mnList = Assert(m_dmnman)->GetListForBlock(tip);
-    const auto mn_payees = mnList.GetProjectedMNPayees(tip);
-
-    if (mn_payees.empty()) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s payee list is empty\n", __func__);
-        return std::nullopt;
-    }
-
-    if (mn_payees.front()->proTxHash != mn_activeman.GetProTxHash()) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s we are not the payee, skipping\n", __func__);
-        return std::nullopt;
-    }
-    gov_sb.SetMasternodeOutpoint(mn_activeman.GetOutPoint());
-    gov_sb.SetSignature(mn_activeman.SignBasic(gov_sb.GetSignatureHash()));
-
-    if (std::string strError; !gov_sb.IsValidLocally(m_dmnman->GetListAtChainTip(), m_chainman, strError, true)) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Created trigger is invalid:%s\n", __func__, strError);
-        return std::nullopt;
-    }
-
-    if (!MasternodeRateCheck(gov_sb)) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Trigger rejected because of rate check failure hash(%s)\n", __func__, gov_sb.GetHash().ToString());
-        return std::nullopt;
-    }
-
-    // The trigger we just created looks good, submit it
-    AddGovernanceObject(gov_sb, peerman);
-    return std::make_optional<CGovernanceObject>(gov_sb);
-}
-
-void CGovernanceManager::VoteGovernanceTriggers(const std::optional<const CGovernanceObject>& trigger_opt, CConnman& connman, PeerManager& peerman,
-                                                const CActiveMasternodeManager& mn_activeman)
-{
-    // only active masternodes can vote on triggers
-    if (mn_activeman.GetProTxHash().IsNull()) return;
-
-    LOCK2(::cs_main, cs);
-
-    if (trigger_opt.has_value()) {
-        // We should never vote "yes" on another trigger or the same trigger twice
-        assert(!votedFundingYesTriggerHash.has_value());
-        // Vote YES-FUNDING for the trigger we like, unless we already did
-        const uint256 gov_sb_hash = trigger_opt.value().GetHash();
-        bool voted_already{false};
-        if (vote_rec_t voteRecord; trigger_opt.value().GetCurrentMNVotes(mn_activeman.GetOutPoint(), voteRecord)) {
-            const auto& strFunc = __func__;
-            // Let's see if there is a VOTE_SIGNAL_FUNDING vote from us already
-            voted_already = ranges::any_of(voteRecord.mapInstances, [&](const auto& voteInstancePair) {
-                if (voteInstancePair.first == VOTE_SIGNAL_FUNDING) {
-                    if (voteInstancePair.second.eOutcome == VOTE_OUTCOME_YES) {
-                        votedFundingYesTriggerHash = gov_sb_hash;
-                    }
-                    LogPrint(BCLog::GOBJECT, /* Continued */
-                             "CGovernanceManager::%s "
-                             "Not voting YES-FUNDING for trigger:%s, we voted %s for it already\n",
-                             strFunc, gov_sb_hash.ToString(),
-                             CGovernanceVoting::ConvertOutcomeToString(voteInstancePair.second.eOutcome));
-                    return true;
-                }
-                return false;
-            });
-        }
-        if (!voted_already) {
-            // No previous VOTE_SIGNAL_FUNDING was found, vote now
-            if (VoteFundingTrigger(gov_sb_hash, VOTE_OUTCOME_YES, connman, peerman, mn_activeman)) {
-                LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Voting YES-FUNDING for new trigger:%s success\n",
-                         __func__, gov_sb_hash.ToString());
-                votedFundingYesTriggerHash = gov_sb_hash;
-            } else {
-                LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Voting YES-FUNDING for new trigger:%s failed\n",
-                         __func__, gov_sb_hash.ToString());
-                // this should never happen, bail out
-                return;
-            }
-        }
-    }
-
-    // Vote NO-FUNDING for the rest of the active triggers
-    const auto activeTriggers = GetActiveTriggers();
-    for (const auto& trigger : activeTriggers) {
-        const auto govobj = FindGovernanceObject(trigger->GetGovernanceObjHash());
-        const uint256 trigger_hash = govobj->GetHash();
-        if (trigger->GetBlockHeight() <= nCachedBlockHeight) {
-            // ignore triggers from the past
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Not voting NO-FUNDING for outdated trigger:%s\n", __func__, trigger_hash.ToString());
-            continue;
-        }
-        if (trigger_hash == votedFundingYesTriggerHash) {
-            // Skip actual trigger
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Not voting NO-FUNDING for trigger:%s, we voted yes for it already\n", __func__, trigger_hash.ToString());
-            continue;
-        }
-        if (vote_rec_t voteRecord; govobj->GetCurrentMNVotes(mn_activeman.GetOutPoint(), voteRecord)) {
-            const auto& strFunc = __func__;
-            if (ranges::any_of(voteRecord.mapInstances, [&](const auto& voteInstancePair) {
-                    if (voteInstancePair.first == VOTE_SIGNAL_FUNDING) {
-                        LogPrint(BCLog::GOBJECT, /* Continued */
-                                 "CGovernanceManager::%s "
-                                 "Not voting NO-FUNDING for trigger:%s, we voted %s for it already\n",
-                                 strFunc, trigger_hash.ToString(),
-                                 CGovernanceVoting::ConvertOutcomeToString(voteInstancePair.second.eOutcome));
-                        return true;
-                    }
-                    return false;
-                })) {
-                continue;
-            }
-        }
-        if (!VoteFundingTrigger(trigger_hash, VOTE_OUTCOME_NO, connman, peerman, mn_activeman)) {
-            LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Voting NO-FUNDING for trigger:%s failed\n", __func__, trigger_hash.ToString());
-            // failing here is ok-ish
-            continue;
-        }
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Voting NO-FUNDING for trigger:%s success\n", __func__, trigger_hash.ToString());
-    }
-}
-
-bool CGovernanceManager::VoteFundingTrigger(const uint256& nHash, const vote_outcome_enum_t outcome, CConnman& connman, PeerManager& peerman,
-                                            const CActiveMasternodeManager& mn_activeman)
-{
-    CGovernanceVote vote(mn_activeman.GetOutPoint(), nHash, VOTE_SIGNAL_FUNDING, outcome);
-    vote.SetTime(GetAdjustedTime());
-    vote.SetSignature(mn_activeman.SignBasic(vote.GetSignatureHash()));
-
-    CGovernanceException exception;
-    if (!ProcessVoteAndRelay(vote, exception, connman, peerman)) {
-        LogPrint(BCLog::GOBJECT, "CGovernanceManager::%s Vote FUNDING %d for trigger:%s failed:%s\n", __func__, outcome, nHash.ToString(), exception.what());
-        return false;
-    }
-
-    return true;
-}
-
-bool CGovernanceManager::HasAlreadyVotedFundingTrigger() const
-{
-    return votedFundingYesTriggerHash.has_value();
-}
-
-void CGovernanceManager::ResetVotedFundingTrigger()
-{
-    votedFundingYesTriggerHash = std::nullopt;
-}
-
 void CGovernanceManager::DoMaintenance(CConnman& connman)
 {
     if (!IsValid()) return;