LCOV - code coverage report
Current view: top level - src/test - pow_tests.cpp (source / functions) Coverage Total Hit
Test: test_bitcoin_coverage.info Lines: 100.0 % 139 139
Test Date: 2026-03-07 04:57:14 Functions: 100.0 % 31 31
Branches: 50.6 % 1254 635

             Branch data     Line data    Source code
       1                 :             : // Copyright (c) 2015-present The Bitcoin Core developers
       2                 :             : // Distributed under the MIT software license, see the accompanying
       3                 :             : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :             : 
       5                 :             : #include <chain.h>
       6                 :             : #include <chainparams.h>
       7                 :             : #include <pow.h>
       8                 :             : #include <test/util/random.h>
       9                 :             : #include <test/util/common.h>
      10                 :             : #include <test/util/setup_common.h>
      11                 :             : #include <util/chaintype.h>
      12                 :             : 
      13                 :             : #include <boost/test/unit_test.hpp>
      14                 :             : 
      15                 :             : BOOST_FIXTURE_TEST_SUITE(pow_tests, BasicTestingSetup)
      16                 :             : 
      17                 :             : /* Test calculation of next difficulty target with no constraints applying */
      18   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(get_next_work)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      19                 :             : {
      20                 :           1 :     const auto chainParams = CreateChainParams(*m_node.args, ChainType::MAIN);
      21                 :           1 :     int64_t nLastRetargetTime = 1261130161; // Block #30240
      22                 :           1 :     CBlockIndex pindexLast;
      23                 :           1 :     pindexLast.nHeight = 32255;
      24                 :           1 :     pindexLast.nTime = 1262152739;  // Block #32255
      25                 :           1 :     pindexLast.nBits = 0x1d00ffff;
      26                 :             : 
      27                 :             :     // Here (and below): expected_nbits is calculated in
      28                 :             :     // CalculateNextWorkRequired(); redoing the calculation here would be just
      29                 :             :     // reimplementing the same code that is written in pow.cpp. Rather than
      30                 :             :     // copy that code, we just hardcode the expected result.
      31                 :           1 :     unsigned int expected_nbits = 0x1d00d86aU;
      32   [ +  -  +  -  :           1 :     BOOST_CHECK_EQUAL(CalculateNextWorkRequired(&pindexLast, nLastRetargetTime, chainParams->GetConsensus()), expected_nbits);
                   +  - ]
      33   [ +  -  +  -  :           2 :     BOOST_CHECK(PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, expected_nbits));
                   +  - ]
      34                 :           1 : }
      35                 :             : 
      36                 :             : /* Test the constraint on the upper bound for next work */
      37   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(get_next_work_pow_limit)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      38                 :             : {
      39                 :           1 :     const auto chainParams = CreateChainParams(*m_node.args, ChainType::MAIN);
      40                 :           1 :     int64_t nLastRetargetTime = 1231006505; // Block #0
      41                 :           1 :     CBlockIndex pindexLast;
      42                 :           1 :     pindexLast.nHeight = 2015;
      43                 :           1 :     pindexLast.nTime = 1233061996;  // Block #2015
      44                 :           1 :     pindexLast.nBits = 0x1d00ffff;
      45                 :           1 :     unsigned int expected_nbits = 0x1d00ffffU;
      46   [ +  -  +  -  :           1 :     BOOST_CHECK_EQUAL(CalculateNextWorkRequired(&pindexLast, nLastRetargetTime, chainParams->GetConsensus()), expected_nbits);
                   +  - ]
      47   [ +  -  +  -  :           2 :     BOOST_CHECK(PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, expected_nbits));
                   +  - ]
      48                 :           1 : }
      49                 :             : 
      50                 :             : /* Test the constraint on the lower bound for actual time taken */
      51   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(get_next_work_lower_limit_actual)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      52                 :             : {
      53                 :           1 :     const auto chainParams = CreateChainParams(*m_node.args, ChainType::MAIN);
      54                 :           1 :     int64_t nLastRetargetTime = 1279008237; // Block #66528
      55                 :           1 :     CBlockIndex pindexLast;
      56                 :           1 :     pindexLast.nHeight = 68543;
      57                 :           1 :     pindexLast.nTime = 1279297671;  // Block #68543
      58                 :           1 :     pindexLast.nBits = 0x1c05a3f4;
      59                 :           1 :     unsigned int expected_nbits = 0x1c0168fdU;
      60   [ +  -  +  -  :           1 :     BOOST_CHECK_EQUAL(CalculateNextWorkRequired(&pindexLast, nLastRetargetTime, chainParams->GetConsensus()), expected_nbits);
                   +  - ]
      61   [ +  -  +  -  :           2 :     BOOST_CHECK(PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, expected_nbits));
             +  -  +  - ]
      62                 :             :     // Test that reducing nbits further would not be a PermittedDifficultyTransition.
      63                 :           1 :     unsigned int invalid_nbits = expected_nbits-1;
      64   [ +  -  +  -  :           2 :     BOOST_CHECK(!PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, invalid_nbits));
                   +  - ]
      65                 :           1 : }
      66                 :             : 
      67                 :             : /* Test the constraint on the upper bound for actual time taken */
      68   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(get_next_work_upper_limit_actual)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      69                 :             : {
      70                 :           1 :     const auto chainParams = CreateChainParams(*m_node.args, ChainType::MAIN);
      71                 :           1 :     int64_t nLastRetargetTime = 1263163443; // NOTE: Not an actual block time
      72                 :           1 :     CBlockIndex pindexLast;
      73                 :           1 :     pindexLast.nHeight = 46367;
      74                 :           1 :     pindexLast.nTime = 1269211443;  // Block #46367
      75                 :           1 :     pindexLast.nBits = 0x1c387f6f;
      76                 :           1 :     unsigned int expected_nbits = 0x1d00e1fdU;
      77   [ +  -  +  -  :           1 :     BOOST_CHECK_EQUAL(CalculateNextWorkRequired(&pindexLast, nLastRetargetTime, chainParams->GetConsensus()), expected_nbits);
                   +  - ]
      78   [ +  -  +  -  :           2 :     BOOST_CHECK(PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, expected_nbits));
             +  -  +  - ]
      79                 :             :     // Test that increasing nbits further would not be a PermittedDifficultyTransition.
      80                 :           1 :     unsigned int invalid_nbits = expected_nbits+1;
      81   [ +  -  +  -  :           2 :     BOOST_CHECK(!PermittedDifficultyTransition(chainParams->GetConsensus(), pindexLast.nHeight+1, pindexLast.nBits, invalid_nbits));
                   +  - ]
      82                 :           1 : }
      83                 :             : 
      84   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(CheckProofOfWork_test_negative_target)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      85                 :             : {
      86         [ +  - ]:           1 :     const auto consensus = CreateChainParams(*m_node.args, ChainType::MAIN)->GetConsensus();
      87                 :           1 :     uint256 hash;
      88                 :           1 :     unsigned int nBits;
      89   [ +  -  +  - ]:           1 :     nBits = UintToArith256(consensus.powLimit).GetCompact(true);
      90                 :           1 :     hash = uint256{1};
      91   [ +  -  +  -  :           2 :     BOOST_CHECK(!CheckProofOfWork(hash, nBits, consensus));
                   +  - ]
      92                 :           1 : }
      93                 :             : 
      94   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(CheckProofOfWork_test_overflow_target)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
      95                 :             : {
      96         [ +  - ]:           1 :     const auto consensus = CreateChainParams(*m_node.args, ChainType::MAIN)->GetConsensus();
      97                 :           1 :     uint256 hash;
      98                 :           1 :     unsigned int nBits{~0x00800000U};
      99                 :           1 :     hash = uint256{1};
     100   [ +  -  +  -  :           2 :     BOOST_CHECK(!CheckProofOfWork(hash, nBits, consensus));
                   +  - ]
     101                 :           1 : }
     102                 :             : 
     103   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(CheckProofOfWork_test_too_easy_target)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     104                 :             : {
     105         [ +  - ]:           1 :     const auto consensus = CreateChainParams(*m_node.args, ChainType::MAIN)->GetConsensus();
     106                 :           1 :     uint256 hash;
     107                 :           1 :     unsigned int nBits;
     108         [ +  - ]:           1 :     arith_uint256 nBits_arith = UintToArith256(consensus.powLimit);
     109         [ +  - ]:           1 :     nBits_arith *= 2;
     110         [ +  - ]:           1 :     nBits = nBits_arith.GetCompact();
     111                 :           1 :     hash = uint256{1};
     112   [ +  -  +  -  :           2 :     BOOST_CHECK(!CheckProofOfWork(hash, nBits, consensus));
                   +  - ]
     113                 :           1 : }
     114                 :             : 
     115   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(CheckProofOfWork_test_biger_hash_than_target)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     116                 :             : {
     117         [ +  - ]:           1 :     const auto consensus = CreateChainParams(*m_node.args, ChainType::MAIN)->GetConsensus();
     118                 :           1 :     uint256 hash;
     119                 :           1 :     unsigned int nBits;
     120         [ +  - ]:           1 :     arith_uint256 hash_arith = UintToArith256(consensus.powLimit);
     121         [ +  - ]:           1 :     nBits = hash_arith.GetCompact();
     122         [ +  - ]:           1 :     hash_arith *= 2; // hash > nBits
     123         [ +  - ]:           1 :     hash = ArithToUint256(hash_arith);
     124   [ +  -  +  -  :           2 :     BOOST_CHECK(!CheckProofOfWork(hash, nBits, consensus));
                   +  - ]
     125                 :           1 : }
     126                 :             : 
     127   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(CheckProofOfWork_test_zero_target)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     128                 :             : {
     129         [ +  - ]:           1 :     const auto consensus = CreateChainParams(*m_node.args, ChainType::MAIN)->GetConsensus();
     130                 :           1 :     uint256 hash;
     131                 :           1 :     unsigned int nBits;
     132                 :           1 :     arith_uint256 hash_arith{0};
     133         [ +  - ]:           1 :     nBits = hash_arith.GetCompact();
     134         [ +  - ]:           1 :     hash = ArithToUint256(hash_arith);
     135   [ +  -  +  -  :           2 :     BOOST_CHECK(!CheckProofOfWork(hash, nBits, consensus));
                   +  - ]
     136                 :           1 : }
     137                 :             : 
     138   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(GetBlockProofEquivalentTime_test)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     139                 :             : {
     140                 :           1 :     const auto chainParams = CreateChainParams(*m_node.args, ChainType::MAIN);
     141         [ +  - ]:           1 :     std::vector<CBlockIndex> blocks(10000);
     142         [ +  + ]:       10001 :     for (int i = 0; i < 10000; i++) {
     143   [ +  +  +  + ]:       10000 :         blocks[i].pprev = i ? &blocks[i - 1] : nullptr;
     144                 :       10000 :         blocks[i].nHeight = i;
     145         [ +  + ]:       10000 :         blocks[i].nTime = 1269211443 + i * chainParams->GetConsensus().nPowTargetSpacing;
     146                 :       10000 :         blocks[i].nBits = 0x207fffff; /* target 0x7fffff000... */
     147   [ +  +  +  - ]:       10000 :         blocks[i].nChainWork = i ? blocks[i - 1].nChainWork + GetBlockProof(blocks[i - 1]) : arith_uint256(0);
     148                 :             :     }
     149                 :             : 
     150         [ +  + ]:        1001 :     for (int j = 0; j < 1000; j++) {
     151                 :        1000 :         CBlockIndex *p1 = &blocks[m_rng.randrange(10000)];
     152                 :        1000 :         CBlockIndex *p2 = &blocks[m_rng.randrange(10000)];
     153         [ +  - ]:        1000 :         CBlockIndex *p3 = &blocks[m_rng.randrange(10000)];
     154                 :             : 
     155         [ +  - ]:        1000 :         int64_t tdiff = GetBlockProofEquivalentTime(*p1, *p2, *p3, chainParams->GetConsensus());
     156   [ +  -  +  - ]:        1000 :         BOOST_CHECK_EQUAL(tdiff, p1->GetBlockTime() - p2->GetBlockTime());
     157                 :             :     }
     158                 :           1 : }
     159                 :             : 
     160                 :           5 : void sanity_check_chainparams(const ArgsManager& args, ChainType chain_type)
     161                 :             : {
     162                 :           5 :     const auto chainParams = CreateChainParams(args, chain_type);
     163         [ +  - ]:           5 :     const auto consensus = chainParams->GetConsensus();
     164                 :             : 
     165                 :             :     // hash genesis is correct
     166   [ +  -  +  -  :           5 :     BOOST_CHECK_EQUAL(consensus.hashGenesisBlock, chainParams->GenesisBlock().GetHash());
                   +  - ]
     167                 :             : 
     168                 :             :     // target timespan is an even multiple of spacing
     169   [ +  -  +  - ]:           5 :     BOOST_CHECK_EQUAL(consensus.nPowTargetTimespan % consensus.nPowTargetSpacing, 0);
     170                 :             : 
     171                 :             :     // genesis nBits is positive, doesn't overflow and is lower than powLimit
     172                 :           5 :     arith_uint256 pow_compact;
     173                 :           5 :     bool neg, over;
     174         [ +  - ]:           5 :     pow_compact.SetCompact(chainParams->GenesisBlock().nBits, &neg, &over);
     175   [ +  -  +  -  :          15 :     BOOST_CHECK(!neg && pow_compact != 0);
          -  +  +  -  +  
                      - ]
     176   [ +  -  +  -  :          10 :     BOOST_CHECK(!over);
                   +  - ]
     177   [ +  -  +  -  :          10 :     BOOST_CHECK(UintToArith256(consensus.powLimit) >= pow_compact);
          +  -  +  -  +  
                      + ]
     178                 :             : 
     179                 :             :     // check max target * 4*nPowTargetTimespan doesn't overflow -- see pow.cpp:CalculateNextWorkRequired()
     180         [ +  + ]:           5 :     if (!consensus.fPowNoRetargeting) {
     181         [ +  - ]:           4 :         arith_uint256 targ_max{UintToArith256(uint256{"ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff"})};
     182         [ +  - ]:           8 :         targ_max /= consensus.nPowTargetTimespan*4;
     183   [ +  -  +  -  :           8 :         BOOST_CHECK(UintToArith256(consensus.powLimit) < targ_max);
             +  -  +  - ]
     184                 :             :     }
     185                 :           5 : }
     186                 :             : 
     187   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(ChainParams_MAIN_sanity)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     188                 :             : {
     189                 :           1 :     sanity_check_chainparams(*m_node.args, ChainType::MAIN);
     190                 :           1 : }
     191                 :             : 
     192   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(ChainParams_REGTEST_sanity)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     193                 :             : {
     194                 :           1 :     sanity_check_chainparams(*m_node.args, ChainType::REGTEST);
     195                 :           1 : }
     196                 :             : 
     197   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(ChainParams_TESTNET_sanity)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     198                 :             : {
     199                 :           1 :     sanity_check_chainparams(*m_node.args, ChainType::TESTNET);
     200                 :           1 : }
     201                 :             : 
     202   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(ChainParams_TESTNET4_sanity)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     203                 :             : {
     204                 :           1 :     sanity_check_chainparams(*m_node.args, ChainType::TESTNET4);
     205                 :           1 : }
     206                 :             : 
     207   [ +  -  +  -  :           7 : BOOST_AUTO_TEST_CASE(ChainParams_SIGNET_sanity)
          +  -  +  -  -  
          +  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
          -  +  -  +  -  
          +  -  +  -  +  
          -  +  -  -  +  
          +  -  +  -  +  
          -  +  -  +  -  
          +  -  -  +  +  
                      - ]
     208                 :             : {
     209                 :           1 :     sanity_check_chainparams(*m_node.args, ChainType::SIGNET);
     210                 :           1 : }
     211                 :             : 
     212                 :             : BOOST_AUTO_TEST_SUITE_END()
        

Generated by: LCOV version 2.0-1