PIVX Core  5.6.99
P2P Digital Currency
upgrades_tests.cpp
Go to the documentation of this file.
1 // Copyright (c) 2017 The Zcash Core developers
2 // Copyright (c) 2020 The PIVX 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 #include "chainparams.h"
7 #include "consensus/upgrades.h"
8 #include "optional.h"
9 #include "test/test_pivx.h"
10 
11 #include <boost/test/unit_test.hpp>
12 
13 struct UpgradesTest : public TestingSetup
14 {
15  int DefaultActivation[Consensus::MAX_NETWORK_UPGRADES];
16  UpgradesTest()
17  {
18  SelectParams(CBaseChainParams::REGTEST);
19  // Save activation heights in DefaultActivation and set all upgrades to inactive.
20  for (uint32_t idx = Consensus::BASE_NETWORK + 1; idx < Consensus::MAX_NETWORK_UPGRADES; idx++) {
21  DefaultActivation[idx] = Params().GetConsensus().vUpgrades[idx].nActivationHeight;
22  UpdateNetworkUpgradeParameters(Consensus::UpgradeIndex(idx), Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT);
23  }
24  }
25  ~UpgradesTest()
26  {
27  // Revert to default
28  for (uint32_t idx = Consensus::BASE_NETWORK + 1; idx < Consensus::MAX_NETWORK_UPGRADES; idx++) {
29  UpdateNetworkUpgradeParameters(Consensus::UpgradeIndex(idx), DefaultActivation[idx]);
30  }
31  SelectParams(CBaseChainParams::MAIN);
32  }
33 };
34 
35 BOOST_FIXTURE_TEST_SUITE(network_upgrades_tests, UpgradesTest)
36 
37 BOOST_AUTO_TEST_CASE(networkUpgradeStateTest)
38 {
39  const Consensus::Params& params = Params().GetConsensus();
40 
41  // Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT
42  BOOST_CHECK_EQUAL(
43  NetworkUpgradeState(0, params, Consensus::UPGRADE_TESTDUMMY),
44  UPGRADE_DISABLED);
45  BOOST_CHECK_EQUAL(
46  NetworkUpgradeState(1000000, params, Consensus::UPGRADE_TESTDUMMY),
47  UPGRADE_DISABLED);
48 
49  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, Consensus::NetworkUpgrade::ALWAYS_ACTIVE);
50 
51  BOOST_CHECK_EQUAL(
52  NetworkUpgradeState(0, params, Consensus::UPGRADE_TESTDUMMY),
53  UPGRADE_ACTIVE);
54  BOOST_CHECK_EQUAL(
55  NetworkUpgradeState(1000000, params, Consensus::UPGRADE_TESTDUMMY),
56  UPGRADE_ACTIVE);
57 
58  int nActivationHeight = 100;
59  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, nActivationHeight);
60 
61  BOOST_CHECK_EQUAL(
62  NetworkUpgradeState(0, params, Consensus::UPGRADE_TESTDUMMY),
63  UPGRADE_PENDING);
64  BOOST_CHECK_EQUAL(
65  NetworkUpgradeState(nActivationHeight - 1, params, Consensus::UPGRADE_TESTDUMMY),
66  UPGRADE_PENDING);
67  BOOST_CHECK_EQUAL(
68  NetworkUpgradeState(nActivationHeight, params, Consensus::UPGRADE_TESTDUMMY),
69  UPGRADE_ACTIVE);
70  BOOST_CHECK_EQUAL(
71  NetworkUpgradeState(1000000, params, Consensus::UPGRADE_TESTDUMMY),
72  UPGRADE_ACTIVE);
73 }
74 
75 BOOST_AUTO_TEST_CASE(IsActivationHeightTest)
76 {
77  const Consensus::Params& params = Params().GetConsensus();
78 
79  // Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT
80  BOOST_CHECK(!IsActivationHeight(-1, params, Consensus::UPGRADE_TESTDUMMY));
81  BOOST_CHECK(!IsActivationHeight(0, params, Consensus::UPGRADE_TESTDUMMY));
82  BOOST_CHECK(!IsActivationHeight(1, params, Consensus::UPGRADE_TESTDUMMY));
83  BOOST_CHECK(!IsActivationHeight(1000000, params, Consensus::UPGRADE_TESTDUMMY));
84 
85  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, Consensus::NetworkUpgrade::ALWAYS_ACTIVE);
86 
87  BOOST_CHECK(!IsActivationHeight(-1, params, Consensus::UPGRADE_TESTDUMMY));
88  BOOST_CHECK(IsActivationHeight(0, params, Consensus::UPGRADE_TESTDUMMY));
89  BOOST_CHECK(!IsActivationHeight(1, params, Consensus::UPGRADE_TESTDUMMY));
90  BOOST_CHECK(!IsActivationHeight(1000000, params, Consensus::UPGRADE_TESTDUMMY));
91 
92  int nActivationHeight = 100;
93  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, nActivationHeight);
94 
95  BOOST_CHECK(!IsActivationHeight(-1, params, Consensus::UPGRADE_TESTDUMMY));
96  BOOST_CHECK(!IsActivationHeight(0, params, Consensus::UPGRADE_TESTDUMMY));
97  BOOST_CHECK(!IsActivationHeight(1, params, Consensus::UPGRADE_TESTDUMMY));
98  BOOST_CHECK(!IsActivationHeight(nActivationHeight - 1, params, Consensus::UPGRADE_TESTDUMMY));
99  BOOST_CHECK(IsActivationHeight(nActivationHeight, params, Consensus::UPGRADE_TESTDUMMY));
100  BOOST_CHECK(!IsActivationHeight(nActivationHeight + 1, params, Consensus::UPGRADE_TESTDUMMY));
101  BOOST_CHECK(!IsActivationHeight(1000000, params, Consensus::UPGRADE_TESTDUMMY));
102 }
103 
104 BOOST_AUTO_TEST_CASE(IsActivationHeightForAnyUpgradeTest)
105 {
106  const Consensus::Params& params = Params().GetConsensus();
107 
108  // Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT
109  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(-1, params));
110  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(0, params));
111  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1, params));
112  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1000000, params));
113 
114  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, Consensus::NetworkUpgrade::ALWAYS_ACTIVE);
115 
116  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(-1, params));
117  BOOST_CHECK(IsActivationHeightForAnyUpgrade(0, params));
118  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1, params));
119  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1000000, params));
120 
121  int nActivationHeight = 100;
122  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, nActivationHeight);
123 
124  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(-1, params));
125  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(0, params));
126  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1, params));
127  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(nActivationHeight - 1, params));
128  BOOST_CHECK(IsActivationHeightForAnyUpgrade(nActivationHeight, params));
129  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(nActivationHeight + 1, params));
130  BOOST_CHECK(!IsActivationHeightForAnyUpgrade(1000000, params));
131 }
132 
133 BOOST_AUTO_TEST_CASE(NextActivationHeightTest)
134 {
135  const Consensus::Params& params = Params().GetConsensus();
136 
137  // Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT
138  BOOST_CHECK(NextActivationHeight(-1, params) == nullopt);
139  BOOST_CHECK(NextActivationHeight(0, params) == nullopt);
140  BOOST_CHECK(NextActivationHeight(1, params) == nullopt);
141  BOOST_CHECK(NextActivationHeight(1000000, params) == nullopt);
142 
143  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, Consensus::NetworkUpgrade::ALWAYS_ACTIVE);
144 
145  BOOST_CHECK(NextActivationHeight(-1, params) == nullopt);
146  BOOST_CHECK(NextActivationHeight(0, params) == nullopt);
147  BOOST_CHECK(NextActivationHeight(1, params) == nullopt);
148  BOOST_CHECK(NextActivationHeight(1000000, params) == nullopt);
149 
150  int nActivationHeight = 100;
151  UpdateNetworkUpgradeParameters(Consensus::UPGRADE_TESTDUMMY, nActivationHeight);
152 
153  BOOST_CHECK(NextActivationHeight(-1, params) == nullopt);
154  BOOST_CHECK(NextActivationHeight(0, params) == nActivationHeight);
155  BOOST_CHECK(NextActivationHeight(1, params) == nActivationHeight);
156  BOOST_CHECK(NextActivationHeight(nActivationHeight - 1, params) == nActivationHeight);
157  BOOST_CHECK(NextActivationHeight(nActivationHeight, params) == nullopt);
158  BOOST_CHECK(NextActivationHeight(nActivationHeight + 1, params) == nullopt);
159  BOOST_CHECK(NextActivationHeight(1000000, params) == nullopt);
160 }
161 
162 BOOST_AUTO_TEST_SUITE_END()
UpdateNetworkUpgradeParameters
void UpdateNetworkUpgradeParameters(Consensus::UpgradeIndex idx, int nActivationHeight)
Allows modifying the network upgrade regtest parameters.
Definition: chainparams.cpp:689
SelectParams
void SelectParams(const std::string &network)
Sets the params returned by Params() to those for the given chain name.
Definition: chainparams.cpp:683
Params
const CChainParams & Params()
Return the currently selected parameters.
Definition: chainparams.cpp:666
CBaseChainParams::REGTEST
static const std::string REGTEST
Definition: chainparamsbase.h:24
CBaseChainParams::MAIN
static const std::string MAIN
Chain name strings.
Definition: chainparamsbase.h:22
CChainParams::GetConsensus
const Consensus::Params & GetConsensus() const
Definition: chainparams.h:72
BOOST_AUTO_TEST_SUITE_END
BOOST_AUTO_TEST_SUITE_END()
Consensus::UpgradeIndex
UpgradeIndex
Index into Params.vUpgrades and NetworkUpgradeInfo.
Definition: params.h:26
Consensus::UPGRADE_TESTDUMMY
@ UPGRADE_TESTDUMMY
Definition: params.h:42
Consensus::BASE_NETWORK
@ BASE_NETWORK
Definition: params.h:27
Consensus::MAX_NETWORK_UPGRADES
@ MAX_NETWORK_UPGRADES
Definition: params.h:44
BOOST_FIXTURE_TEST_SUITE
#define BOOST_FIXTURE_TEST_SUITE(a, b)
Definition: object.cpp:14
BOOST_CHECK_EQUAL
#define BOOST_CHECK_EQUAL(v1, v2)
Definition: object.cpp:18
BOOST_CHECK
#define BOOST_CHECK(expr)
Definition: object.cpp:17
Consensus::NetworkUpgrade::ALWAYS_ACTIVE
static constexpr int ALWAYS_ACTIVE
Special value for nActivationHeight indicating that the upgrade is always active.
Definition: params.h:67
Consensus::NetworkUpgrade::nActivationHeight
int nActivationHeight
Height of the first block for which the new consensus rules will be active.
Definition: params.h:56
Consensus::NetworkUpgrade::NO_ACTIVATION_HEIGHT
static constexpr int NO_ACTIVATION_HEIGHT
Special value for nActivationHeight indicating that the upgrade will never activate.
Definition: params.h:74
Consensus::Params
Parameters that influence chain consensus.
Definition: params.h:171
Consensus::Params::vUpgrades
NetworkUpgrade vUpgrades[MAX_NETWORK_UPGRADES]
Definition: params.h:213
UpgradesTest::DefaultActivation
int DefaultActivation[Consensus::MAX_NETWORK_UPGRADES]
Definition: upgrades_tests.cpp:15
test_pivx.h
NetworkUpgradeState
UpgradeState NetworkUpgradeState(int nHeight, const Consensus::Params &params, Consensus::UpgradeIndex idx)
Checks the state of a given network upgrade based on block height.
Definition: upgrades.cpp:82
IsActivationHeightForAnyUpgrade
bool IsActivationHeightForAnyUpgrade(int nHeight, const Consensus::Params &params)
Returns true if the given block height is the activation height for any upgrade.
Definition: upgrades.cpp:139
IsActivationHeight
bool IsActivationHeight(int nHeight, const Consensus::Params &params, Consensus::UpgradeIndex idx)
Returns true if the given block height is the activation height for the given upgrade.
Definition: upgrades.cpp:124
NextActivationHeight
Optional< int > NextActivationHeight(int nHeight, const Consensus::Params &params)
Returns the activation height for the next upgrade after the given block height, or nullopt if there ...
Definition: upgrades.cpp:170
UPGRADE_PENDING
@ UPGRADE_PENDING
Definition: upgrades.h:14
UPGRADE_DISABLED
@ UPGRADE_DISABLED
Definition: upgrades.h:13
UPGRADE_ACTIVE
@ UPGRADE_ACTIVE
Definition: upgrades.h:15
BOOST_AUTO_TEST_CASE
BOOST_AUTO_TEST_CASE(networkUpgradeStateTest)
Definition: upgrades_tests.cpp:37
Generated on Wed Apr 2 2025 00:40:37 for PIVX Core by doxygen 1.9.1