feat: changed activation way of MN reward location reallocation, added functional tests

knst · knst · commit 5ea6da9af37e · 2023-04-26T14:35:25.000+07:00
diff --git a/src/chainparams.cpp b/src/chainparams.cpp
@@ -235,6 +235,13 @@ class CMainParams : public CChainParams {
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nThresholdMin = 2420;         // 60% of 4032
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nFalloffCoeff = 5;            // this corresponds to 10 periods
 
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].bit = 10;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nStartTime = 19999999999;   // TODO: To be determined later
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nTimeout = 999999999999ULL;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nWindowSize = 4032;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdStart = 3226;     // 80% of 4032
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdMin = 2420;       // 60% of 4032
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nFalloffCoeff = 5;          // this corresponds to 10 periods
 
         // The best chain should have at least this much work.
         consensus.nMinimumChainWork = uint256S("0x0000000000000000000000000000000000000000000082094584a23266cbb5f8"); // 1850400
@@ -466,6 +473,14 @@ class CTestNetParams : public CChainParams {
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nThresholdMin = 60;           // 60% of 100
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nFalloffCoeff = 5;            // this corresponds to 10 periods
 
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].bit = 10;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nStartTime = 19999999999;   // TODO: To be determined later
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nTimeout = 999999999999ULL;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nWindowSize = 100;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdStart = 80;       // 80% of 100
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdMin = 60;         // 60% of 100
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nFalloffCoeff = 5;          // this corresponds to 10 periods
+
         // The best chain should have at least this much work.
         consensus.nMinimumChainWork = uint256S("0x00000000000000000000000000000000000000000000000002d68cb6c090031f"); // 864000
 
@@ -669,6 +684,14 @@ class CDevNetParams : public CChainParams {
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nThresholdMin = 60;   // 60% of 100
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nFalloffCoeff = 5;     // this corresponds to 10 periods
 
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].bit = 10;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nStartTime = 1661990400; // Sep 1st, 2022
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nTimeout = 999999999999ULL;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nWindowSize = 120;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdStart = 80; // 80% of 100
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdMin = 60;   // 60% of 100
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nFalloffCoeff = 5;     // this corresponds to 10 periods
+
         // The best chain should have at least this much work.
         consensus.nMinimumChainWork = uint256S("0x000000000000000000000000000000000000000000000000000000000000000");
 
@@ -933,6 +956,14 @@ class CRegTestParams : public CChainParams {
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nThresholdMin = 288;   // 60% of 480
         consensus.vDeployments[Consensus::DEPLOYMENT_V20].nFalloffCoeff = 5;     // this corresponds to 10 periods
 
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].bit = 10;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nStartTime = 0;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nTimeout = 999999999999ULL;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nWindowSize = 1030;
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdStart = 800; // 80% of 1000
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nThresholdMin = 600;   // 60% of 1000
+        consensus.vDeployments[Consensus::DEPLOYMENT_MN_RR].nFalloffCoeff = 5;     // this corresponds to 10 periods
+
         // The best chain should have at least this much work.
         consensus.nMinimumChainWork = uint256S("0x00");
 
diff --git a/src/consensus/params.h b/src/consensus/params.h
@@ -22,6 +22,7 @@ enum DeploymentPos {
     DEPLOYMENT_DIP0024, // Deployment of DIP0024 (Quorum Rotation) and decreased governance proposal fee
     DEPLOYMENT_V19,     // Deployment of Basic BLS, AssetLocks
     DEPLOYMENT_V20,     // Deployment of EHF, LLMQ Randomness Beacon
+    DEPLOYMENT_MN_RR,   // Deployment of Masternode Reward Location Reallocation
     // NOTE: Also add new deployments to VersionBitsDeploymentInfo in versionbits.cpp
     MAX_VERSION_BITS_DEPLOYMENTS
 };
diff --git a/src/evo/creditpool.cpp b/src/evo/creditpool.cpp
@@ -10,7 +10,6 @@
 #include <chain.h>
 #include <llmq/utils.h>
 #include <logging.h>
-#include <spork.h>
 #include <util/validation.h>
 #include <validation.h>
 
@@ -246,7 +245,8 @@ CCreditPoolManager::CCreditPoolManager(CEvoDB& _evoDb)
 
 CCreditPoolDiff::CCreditPoolDiff(CCreditPool starter, const CBlockIndex *pindex, const Consensus::Params& consensusParams) :
     pool(std::move(starter)),
-    pindex(pindex)
+    pindex(pindex),
+    params(consensusParams)
 {
     assert(pindex);
 }
@@ -267,13 +267,13 @@ bool CCreditPoolDiff::setTarget(const CTransaction& tx, TxValidationState& state
     targetLocked = cbTx.assetLockedAmount;
 
 
-    if (isIgnoringMNRewardReallocation(*sporkManager)) return true;
+    if (!llmq::utils::IsMNRewardReallocationActive(pindex)) return true;
 
     CAmount blockReward = 0;
     for (const CTxOut& txout : tx.vout) {
         blockReward += txout.nValue;
     }
-    masternodeReward = GetMasternodePayment(cbTx.nHeight, blockReward, Params().GetConsensus().BRRHeight);
+    masternodeReward = GetMasternodePayment(cbTx.nHeight, blockReward, params.BRRHeight);
     LogPrintf("CreditPool: set target to %lld with MN reward %lld\n", *targetLocked, masternodeReward);
 
     return true;
@@ -348,11 +348,3 @@ bool CCreditPoolDiff::processTransaction(const CTransaction& tx, TxValidationSta
         return state.Invalid(TxValidationResult::TX_CONSENSUS, "failed-procassetlocksinblock");
     }
 }
-
-bool isIgnoringMNRewardReallocation(const CSporkManager& spork_manager) {
-    if (Params().NetworkIDString() != CBaseChainParams::REGTEST) return false;
-
-    bool ret = spork_manager.IsSporkActive(SPORK_24_IGNORE_MN_REWARD_REALLOCED);
-    LogPrintf("%s: spork IGNORE_MN_REWARD_REALLOCED value: %d\n", __func__, ret);
-    return ret;
-}
diff --git a/src/evo/creditpool.h b/src/evo/creditpool.h
@@ -21,7 +21,6 @@
 
 class CBlockIndex;
 class TxValidationState;
-class CSporkManager;
 
 namespace Consensus
 {
@@ -110,6 +109,7 @@ class CCreditPoolDiff {
     std::optional<CAmount> targetLocked;
 
     const CBlockIndex *pindex{nullptr};
+    const Consensus::Params& params;
 public:
     explicit CCreditPoolDiff(CCreditPool starter, const CBlockIndex *pindex, const Consensus::Params& consensusParams);
 
@@ -122,7 +122,6 @@ class CCreditPoolDiff {
 
     /**
      * This function should be called by miner for initalization of MasterNode reward
-     *
      */
     void addRewardRealloced(const CAmount reward);
 
@@ -178,8 +177,6 @@ class CCreditPoolManager
     CCreditPool constructCreditPool(const CBlockIndex* block_index, CCreditPool prev, const Consensus::Params& consensusParams);
 };
 
-bool isIgnoringMNRewardReallocation(const CSporkManager& spork_manager);
-
 extern std::unique_ptr<CCreditPoolManager> creditPoolManager;
 
 #endif
diff --git a/src/evo/specialtxman.cpp b/src/evo/specialtxman.cpp
@@ -17,10 +17,8 @@
 #include <llmq/commitment.h>
 #include <llmq/utils.h>
 #include <primitives/block.h>
-#include <spork.h>
 #include <validation.h>
 
-#include <masternode/payments.h>
 bool CheckSpecialTx(const CTransaction& tx, const CBlockIndex* pindexPrev, const CCoinsViewCache& view, const CCreditPool& creditPool, bool check_sigs, TxValidationState& state)
 {
     AssertLockHeld(cs_main);
diff --git a/src/llmq/utils.cpp b/src/llmq/utils.cpp
@@ -678,6 +678,14 @@ bool IsV20Active(const CBlockIndex* pindex)
     return VersionBitsState(pindex, Params().GetConsensus(), Consensus::DEPLOYMENT_V20, llmq_versionbitscache) == ThresholdState::ACTIVE;
 }
 
+bool IsMNRewardReallocationActive(const CBlockIndex* pindex)
+{
+    if (!IsV20Active(pindex)) return false;
+
+    LOCK(cs_llmq_vbc);
+    return VersionBitsState(pindex, Params().GetConsensus(), Consensus::DEPLOYMENT_MN_RR, llmq_versionbitscache) == ThresholdState::ACTIVE;
+}
+
 bool IsInstantSendLLMQTypeShared()
 {
     if (Params().GetConsensus().llmqTypeInstantSend == Params().GetConsensus().llmqTypeChainLocks ||
diff --git a/src/llmq/utils.h b/src/llmq/utils.h
@@ -86,6 +86,7 @@ bool IsDIP0024Active(const CBlockIndex* pindex);
 bool IsV19Active(const CBlockIndex* pindex);
 const CBlockIndex* V19ActivationIndex(const CBlockIndex* pindex);
 bool IsV20Active(const CBlockIndex* pindex);
+bool IsMNRewardReallocationActive(const CBlockIndex* pindex);
 
 /// Returns the state of `-llmq-data-recovery`
 bool QuorumDataRecoveryEnabled();
diff --git a/src/masternode/payments.cpp b/src/masternode/payments.cpp
@@ -16,12 +16,12 @@
 #include <masternode/sync.h>
 #include <primitives/block.h>
 #include <script/standard.h>
-#include <spork.h>
 #include <tinyformat.h>
 #include <util/ranges.h>
 #include <util/system.h>
 #include <validation.h>
 #include <evo/creditpool.h>
+
 #include <string>
 
 CMasternodePayments mnpayments;
@@ -280,8 +280,9 @@ bool CMasternodePayments::GetBlockTxOuts(int nBlockHeight, CAmount blockReward,
 
     CAmount masternodeReward = GetMasternodePayment(nBlockHeight, blockReward, Params().GetConsensus().BRRHeight);
 
-    bool fV20Active_context = llmq::utils::IsV20Active(::ChainActive().Tip());
-    if (fV20Active_context && !isIgnoringMNRewardReallocation(*sporkManager)) {
+    bool fMNRewardReallocated =  llmq::utils::IsMNRewardReallocationActive(::ChainActive().Tip());
+
+    if (fMNRewardReallocated) {
         LogPrintf("CMasternodePayments::%s -- MN reward %lld reallocated to credit pool\n", __func__, masternodeReward);
         voutMasternodePaymentsRet.emplace_back(masternodeReward, CScript() << OP_RETURN);
         return true;
@@ -294,12 +295,14 @@ bool CMasternodePayments::GetBlockTxOuts(int nBlockHeight, CAmount blockReward,
     }
 
     CAmount operatorReward = 0;
+
     if (dmnPayee->nOperatorReward != 0 && dmnPayee->pdmnState->scriptOperatorPayout != CScript()) {
         // This calculation might eventually turn out to result in 0 even if an operator reward percentage is given.
         // This will however only happen in a few years when the block rewards drops very low.
         operatorReward = (masternodeReward * dmnPayee->nOperatorReward) / 10000;
         masternodeReward -= operatorReward;
     }
+
     if (masternodeReward > 0) {
         voutMasternodePaymentsRet.emplace_back(masternodeReward, dmnPayee->pdmnState->scriptPayout);
     }
diff --git a/src/miner.cpp b/src/miner.cpp
@@ -233,12 +233,12 @@ std::unique_ptr<CBlockTemplate> BlockAssembler::CreateNewBlock(CChainState& chai
                 }
                 assert(creditPoolDiff);
 
-                if (!isIgnoringMNRewardReallocation(spork_manager)) {
+                bool fMNRewardReallocated = llmq::utils::IsMNRewardReallocationActive(pindexPrev);
+                if (fMNRewardReallocated) {
                     if (!CMasternodePayments::GetMasternodeTxOuts(nHeight, blockReward, pblocktemplate->voutMasternodePayments)) {
                         LogPrint(BCLog::MNPAYMENTS, "%s -- no masternode to pay (MN list probably empty)\n", __func__);
                     }
                     for (const auto& txout : pblocktemplate->voutMasternodePayments) {
-                        // subtract MN payment from miner reward
                         LogPrintf("CreateNewBlock() add MN reward %lld to credit pool\n", txout.nValue);
                         creditPoolDiff->addRewardRealloced(txout.nValue);
                     }
diff --git a/src/spork.h b/src/spork.h
@@ -38,7 +38,6 @@ enum SporkId : int32_t {
     SPORK_19_CHAINLOCKS_ENABLED                            = 10018,
     SPORK_21_QUORUM_ALL_CONNECTED                          = 10020,
     SPORK_23_QUORUM_POSE                                   = 10022,
-    SPORK_24_IGNORE_MN_REWARD_REALLOCED                    = 10023,
 
     SPORK_INVALID                                          = -1,
 };
@@ -64,15 +63,14 @@ struct CSporkDef
 };
 
 #define MAKE_SPORK_DEF(name, defaultValue) CSporkDef{name, defaultValue, #name}
-[[maybe_unused]] static constexpr std::array<CSporkDef, 8> sporkDefs = {
+[[maybe_unused]] static constexpr std::array<CSporkDef, 7> sporkDefs = {
     MAKE_SPORK_DEF(SPORK_2_INSTANTSEND_ENABLED,            4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_3_INSTANTSEND_BLOCK_FILTERING,    4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_9_SUPERBLOCKS_ENABLED,            4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_17_QUORUM_DKG_ENABLED,            4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_19_CHAINLOCKS_ENABLED,            4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_21_QUORUM_ALL_CONNECTED,          4070908800ULL), // OFF
     MAKE_SPORK_DEF(SPORK_23_QUORUM_POSE,                   4070908800ULL), // OFF
-    MAKE_SPORK_DEF(SPORK_24_IGNORE_MN_REWARD_REALLOCED,    4070908800ULL), // OFF
 };
 #undef MAKE_SPORK_DEF
 extern std::unique_ptr<CSporkManager> sporkManager;
diff --git a/src/test/evo_deterministicmns_tests.cpp b/src/test/evo_deterministicmns_tests.cpp
@@ -271,11 +271,6 @@ void FuncDIP3Protx(TestChainSetup& setup)
     sporkManager->SetSporkAddress(EncodeDestination(PKHash(sporkKey.GetPubKey())));
     sporkManager->SetPrivKey(EncodeSecret(sporkKey));
 
-    // broadcast new spork
-    if (sporkManager->UpdateSpork(SporkId::SPORK_24_IGNORE_MN_REWARD_REALLOCED, 0, *setup.m_node.connman)) {
-        LogPrintf("spork SPORK_24_IGNORE_MN_REWARD_REALLOCED updated\n");
-    }
-
     auto utxos = BuildSimpleUtxoMap(setup.m_coinbase_txns);
 
     int nHeight = ::ChainActive().Height();
diff --git a/src/versionbitsinfo.cpp b/src/versionbitsinfo.cpp
@@ -46,5 +46,10 @@ const struct VBDeploymentInfo VersionBitsDeploymentInfo[Consensus::MAX_VERSION_B
         /*.name =*/"v20",
         /*.gbt_force =*/true,
         /*.check_mn_protocol =*/false,
-    }
+    },
+    {
+        /*.name =*/"mn_rr",
+        /*.gbt_force =*/true,
+        /*.check_mn_protocol =*/false,
+    },
 };
diff --git a/test/functional/feature_asset_locks.py b/test/functional/feature_asset_locks.py
@@ -169,8 +169,6 @@ def set_sporks(self):
         self.nodes[0].sporkupdate("SPORK_19_CHAINLOCKS_ENABLED", spork_disabled)
         self.nodes[0].sporkupdate("SPORK_3_INSTANTSEND_BLOCK_FILTERING", spork_disabled)
         self.nodes[0].sporkupdate("SPORK_2_INSTANTSEND_ENABLED", spork_disabled)
-        self.nodes[0].sporkupdate("SPORK_24_IGNORE_MN_REWARD_REALLOCED", spork_enabled)
-
         self.wait_for_sporks_same()
 
     def ensure_tx_is_not_mined(self, tx_id):
@@ -496,5 +494,25 @@ def run_test(self):
         assert_equal(new_total, get_credit_pool_amount(node))
         assert_equal(node.getmempoolinfo()['size'], 0)
 
+        self.activate_mn_rr(expected_activation_height=3089)
+        self.log.info(f'height: {node.getblock(node.getbestblockhash())["height"]} credit: {get_credit_pool_amount(node)}')
+        reward = 6132959502
+        assert_equal(new_total, get_credit_pool_amount(node))
+        node.generate(1)
+        self.sync_all()
+        new_total += reward
+        assert_equal(new_total, get_credit_pool_amount(node))
+
+        coin = coins.pop()
+        self.send_tx(create_assetlock(node, coin, COIN, pubkey))
+        new_total += reward + COIN
+        node.generate(1)
+        self.sync_all()
+        # part of fee is going to master node reward
+        # these 2 conditions need to check a range
+        assert_greater_than(get_credit_pool_amount(node), new_total)
+        assert_greater_than(new_total + tiny_amount, get_credit_pool_amount(node))
+
+
 if __name__ == '__main__':
     AssetLocksTest().main()
diff --git a/test/functional/feature_llmq_is_cl_conflicts.py b/test/functional/feature_llmq_is_cl_conflicts.py
@@ -20,7 +20,6 @@
 from test_framework.test_framework import DashTestFramework
 from test_framework.util import assert_equal, assert_raises_rpc_error, hex_str_to_bytes, wait_until
 
-from test_framework.address import ADDRESS_BCRT1_UNSPENDABLE
 
 class TestP2PConn(P2PInterface):
     def __init__(self):
@@ -318,8 +317,6 @@ def create_block(self, node, vtx=None):
 
         outputs = {miner_address: str(Decimal(miner_amount) / COIN)}
         if mn_amount > 0:
-            if mn_payee is None or mn_payee == '':
-                mn_payee = ADDRESS_BCRT1_UNSPENDABLE
             outputs[mn_payee] = str(Decimal(mn_amount) / COIN)
 
         coinbase = FromHex(CTransaction(), node.createrawtransaction([], outputs))
diff --git a/test/functional/test_framework/test_framework.py b/test/functional/test_framework/test_framework.py
@@ -1050,8 +1050,9 @@ def activate_by_name(self, name, expected_activation_height=None):
             assert not softfork_active(self.nodes[0], name)
 
         while not softfork_active(self.nodes[0], name):
-            self.bump_mocktime(batch_size)
-            self.nodes[0].generate(batch_size)
+            next_batch = batch_size if expected_activation_height is None else 1
+            self.bump_mocktime(next_batch)
+            self.nodes[0].generate(next_batch)
             self.sync_blocks()
         self.sync_blocks()
 
@@ -1075,6 +1076,9 @@ def activate_v19(self, expected_activation_height=None):
     def activate_v20(self, expected_activation_height=None):
         self.activate_by_name('v20', expected_activation_height)
 
+    def activate_mn_rr(self, expected_activation_height=None):
+        self.activate_by_name('mn_rr', expected_activation_height)
+
     def set_dash_llmq_test_params(self, llmq_size, llmq_threshold):
         self.llmq_size = llmq_size
         self.llmq_threshold = llmq_threshold

Original file line number	Diff line number	Diff line change
`@@ -678,6 +678,14 @@ bool IsV20Active(const CBlockIndex* pindex)`
`678`	`678`	`return VersionBitsState(pindex, Params().GetConsensus(), Consensus::DEPLOYMENT_V20, llmq_versionbitscache) == ThresholdState::ACTIVE;`
`679`	`679`	`}`
`680`	`680`
	`681`	`+bool IsMNRewardReallocationActive(const CBlockIndex* pindex)`
	`682`	`+{`
	`683`	`+ if (!IsV20Active(pindex)) return false;`
	`684`	`+`
	`685`	`+ LOCK(cs_llmq_vbc);`
	`686`	`+ return VersionBitsState(pindex, Params().GetConsensus(), Consensus::DEPLOYMENT_MN_RR, llmq_versionbitscache) == ThresholdState::ACTIVE;`
	`687`	`+}`
	`688`	`+`
`681`	`689`	`bool IsInstantSendLLMQTypeShared()`
`682`	`690`	`{`
`683`	`691`	`if (Params().GetConsensus().llmqTypeInstantSend == Params().GetConsensus().llmqTypeChainLocks \|\|`
Original file line number	Diff line number	Diff line change
`@@ -233,12 +233,12 @@ std::unique_ptr<CBlockTemplate> BlockAssembler::CreateNewBlock(CChainState& chai`
`233`	`233`	`}`
`234`	`234`	`assert(creditPoolDiff);`
`235`	`235`
`236`		`- if (!isIgnoringMNRewardReallocation(spork_manager)) {`
	`236`	`+ bool fMNRewardReallocated = llmq::utils::IsMNRewardReallocationActive(pindexPrev);`
	`237`	`+ if (fMNRewardReallocated) {`
`237`	`238`	`if (!CMasternodePayments::GetMasternodeTxOuts(nHeight, blockReward, pblocktemplate->voutMasternodePayments)) {`
`238`	`239`	`LogPrint(BCLog::MNPAYMENTS, "%s -- no masternode to pay (MN list probably empty)\n", __func__);`
`239`	`240`	`}`
`240`	`241`	`for (const auto& txout : pblocktemplate->voutMasternodePayments) {`
`241`		`- // subtract MN payment from miner reward`
`242`	`242`	`LogPrintf("CreateNewBlock() add MN reward %lld to credit pool\n", txout.nValue);`
`243`	`243`	`creditPoolDiff->addRewardRealloced(txout.nValue);`
`244`	`244`	`}`