READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

11,452 bytes · SHA-256 d53c738b3aeb41af… · View upstream ↗

1// Copyright (c) 2017-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 <random.h>
6
7#include <test/util/random.h>
8#include <test/util/setup_common.h>
9#include <util/time.h>
10
11#include <boost/test/unit_test.hpp>
12
13#include <algorithm>
14#include <random>
15
16BOOST_FIXTURE_TEST_SUITE(random_tests, BasicTestingSetup)
17
18BOOST_AUTO_TEST_CASE(osrandom_tests)
19{
20    BOOST_CHECK(Random_SanityCheck());
21}
22
23BOOST_AUTO_TEST_CASE(fastrandom_tests_deterministic)
24{
25    // Check that deterministic FastRandomContexts are deterministic
26    SeedRandomForTest(SeedRand::ZEROS);
27    FastRandomContext ctx1{true};
28    FastRandomContext ctx2{true};
29
30    {
31        BOOST_CHECK_EQUAL(FastRandomContext().rand<uint64_t>(), uint64_t{9330418229102544152u});
32        BOOST_CHECK_EQUAL(FastRandomContext().rand<int>(), int{618925161});
33        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::microseconds>(1h).count(), 1271170921);
34        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count(), 2803534);
35
36        BOOST_CHECK_EQUAL(FastRandomContext().rand<uint64_t>(), uint64_t{10170981140880778086u});
37        BOOST_CHECK_EQUAL(FastRandomContext().rand<int>(), int{1689082725});
38        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::microseconds>(1h).count(), 2464643716);
39        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count(), 2312205);
40
41        BOOST_CHECK_EQUAL(FastRandomContext().rand<uint64_t>(), uint64_t{5689404004456455543u});
42        BOOST_CHECK_EQUAL(FastRandomContext().rand<int>(), int{785839937});
43        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::microseconds>(1h).count(), 93558804);
44        BOOST_CHECK_EQUAL(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count(), 507022);
45    }
46
47    {
48        constexpr SteadySeconds time_point{1s};
49        FastRandomContext ctx{true};
50        BOOST_CHECK_EQUAL(7, ctx.rand_uniform_delay(time_point, 9s).time_since_epoch().count());
51        BOOST_CHECK_EQUAL(-6, ctx.rand_uniform_delay(time_point, -9s).time_since_epoch().count());
52        BOOST_CHECK_EQUAL(1, ctx.rand_uniform_delay(time_point, 0s).time_since_epoch().count());
53        BOOST_CHECK_EQUAL(4652286523065884857, ctx.rand_uniform_delay(time_point, 9223372036854775807s).time_since_epoch().count());
54        BOOST_CHECK_EQUAL(-8813961240025683129, ctx.rand_uniform_delay(time_point, -9223372036854775807s).time_since_epoch().count());
55        BOOST_CHECK_EQUAL(26443, ctx.rand_uniform_delay(time_point, 9h).time_since_epoch().count());
56    }
57    BOOST_CHECK_EQUAL(ctx1.rand32(), ctx2.rand32());
58    BOOST_CHECK_EQUAL(ctx1.rand32(), ctx2.rand32());
59    BOOST_CHECK_EQUAL(ctx1.rand64(), ctx2.rand64());
60    BOOST_CHECK_EQUAL(ctx1.randbits(3), ctx2.randbits(3));
61    BOOST_CHECK(std::ranges::equal(ctx1.randbytes<std::byte>(17), ctx2.randbytes<17>())); // check vector/array behavior symmetry
62    BOOST_CHECK(ctx1.rand256() == ctx2.rand256());
63    BOOST_CHECK_EQUAL(ctx1.randbits(7), ctx2.randbits(7));
64    BOOST_CHECK(ctx1.randbytes(128) == ctx2.randbytes(128));
65    BOOST_CHECK_EQUAL(ctx1.rand32(), ctx2.rand32());
66    BOOST_CHECK_EQUAL(ctx1.randbits(3), ctx2.randbits(3));
67    BOOST_CHECK(ctx1.rand256() == ctx2.rand256());
68    BOOST_CHECK(ctx1.randbytes(50) == ctx2.randbytes(50));
69    {
70        struct MicroClock {
71            using duration = std::chrono::microseconds;
72        };
73        FastRandomContext ctx{true};
74        // Check with clock type
75        BOOST_CHECK_EQUAL(47222, ctx.rand_uniform_duration<MicroClock>(1s).count());
76        // Check with time-point type
77        BOOST_CHECK_EQUAL(2782, ctx.rand_uniform_duration<SteadySeconds>(9h).count());
78    }
79}
80
81BOOST_AUTO_TEST_CASE(fastrandom_tests_nondeterministic)
82{
83    // Check that a nondeterministic ones are not
84    {
85        BOOST_CHECK(FastRandomContext().rand<uint64_t>() != uint64_t{9330418229102544152u});
86        BOOST_CHECK(FastRandomContext().rand<int>() != int{618925161});
87        BOOST_CHECK(FastRandomContext().randrange<std::chrono::microseconds>(1h).count() != 1271170921);
88        BOOST_CHECK(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count() != 2803534);
89
90        BOOST_CHECK(FastRandomContext().rand<uint64_t>() != uint64_t{10170981140880778086u});
91        BOOST_CHECK(FastRandomContext().rand<int>() != int{1689082725});
92        BOOST_CHECK(FastRandomContext().randrange<std::chrono::microseconds>(1h).count() != 2464643716);
93        BOOST_CHECK(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count() != 2312205);
94
95        BOOST_CHECK(FastRandomContext().rand<uint64_t>() != uint64_t{5689404004456455543u});
96        BOOST_CHECK(FastRandomContext().rand<int>() != int{785839937});
97        BOOST_CHECK(FastRandomContext().randrange<std::chrono::microseconds>(1h).count() != 93558804);
98        BOOST_CHECK(FastRandomContext().randrange<std::chrono::milliseconds>(1h).count() != 507022);
99    }
100
101    {
102        FastRandomContext ctx3, ctx4;
103        BOOST_CHECK(ctx3.rand64() != ctx4.rand64()); // extremely unlikely to be equal
104    }
105    {
106        FastRandomContext ctx3, ctx4;
107        BOOST_CHECK(ctx3.rand256() != ctx4.rand256());
108    }
109    {
110        FastRandomContext ctx3, ctx4;
111        BOOST_CHECK(ctx3.randbytes(7) != ctx4.randbytes(7));
112    }
113}
114
115BOOST_AUTO_TEST_CASE(fastrandom_randbits)
116{
117    FastRandomContext ctx1;
118    FastRandomContext ctx2;
119    for (int bits = 0; bits < 63; ++bits) {
120        for (int j = 0; j < 1000; ++j) {
121            uint64_t rangebits = ctx1.randbits(bits);
122            BOOST_CHECK_EQUAL(rangebits >> bits, 0U);
123            uint64_t range = (uint64_t{1}) << bits | rangebits;
124            uint64_t rand = ctx2.randrange(range);
125            BOOST_CHECK(rand < range);
126        }
127    }
128}
129
130/** Verify that RandomMixin::randbits returns 0 and 1 for every requested bit. */
131BOOST_AUTO_TEST_CASE(randbits_test)
132{
133    FastRandomContext ctx_lens; //!< RNG for producing the lengths requested from ctx_test.
134    FastRandomContext ctx_test1(true), ctx_test2(true); //!< The RNGs being tested.
135    int ctx_test_bitsleft{0}; //!< (Assumed value of) ctx_test::bitbuf_len
136
137    // Run the entire test 5 times.
138    for (int i = 0; i < 5; ++i) {
139        // count (first) how often it has occurred, and (second) how often it was true:
140        // - for every bit position, in every requested bits count (0 + 1 + 2 + ... + 64 = 2080)
141        // - for every value of ctx_test_bitsleft (0..63 = 64)
142        std::vector<std::pair<uint64_t, uint64_t>> seen(2080 * 64);
143        while (true) {
144            // Loop 1000 times, just to not continuously check std::all_of.
145            for (int j = 0; j < 1000; ++j) {
146                // Decide on a number of bits to request (0 through 64, inclusive; don't use randbits/randrange).
147                int bits = ctx_lens.rand64() % 65;
148                // Generate that many bits.
149                uint64_t gen = ctx_test1.randbits(bits);
150                // For certain bits counts, also test randbits<Bits> and compare.
151                uint64_t gen2;
152                if (bits == 0) {
153                    gen2 = ctx_test2.randbits<0>();
154                } else if (bits == 1) {
155                    gen2 = ctx_test2.randbits<1>();
156                } else if (bits == 7) {
157                    gen2 = ctx_test2.randbits<7>();
158                } else if (bits == 32) {
159                    gen2 = ctx_test2.randbits<32>();
160                } else if (bits == 51) {
161                    gen2 = ctx_test2.randbits<51>();
162                } else if (bits == 64) {
163                    gen2 = ctx_test2.randbits<64>();
164                } else {
165                    gen2 = ctx_test2.randbits(bits);
166                }
167                BOOST_CHECK_EQUAL(gen, gen2);
168                // Make sure the result is in range.
169                if (bits < 64) BOOST_CHECK_EQUAL(gen >> bits, 0);
170                // Mark all the seen bits in the output.
171                for (int bit = 0; bit < bits; ++bit) {
172                    int idx = bit + (bits * (bits - 1)) / 2 + 2080 * ctx_test_bitsleft;
173                    seen[idx].first += 1;
174                    seen[idx].second += (gen >> bit) & 1;
175                }
176                // Update ctx_test_bitself.
177                if (bits > ctx_test_bitsleft) {
178                    ctx_test_bitsleft = ctx_test_bitsleft + 64 - bits;
179                } else {
180                    ctx_test_bitsleft -= bits;
181                }
182            }
183            // Loop until every bit position/combination is seen 242 times.
184            if (std::all_of(seen.begin(), seen.end(), [](const auto& x) { return x.first >= 242; })) break;
185        }
186        // Check that each bit appears within 7.78 standard deviations of 50%
187        // (each will fail with P < 1/(2080 * 64 * 10^9)).
188        for (const auto& val : seen) {
189             assert(fabs(val.first * 0.5 - val.second) < sqrt(val.first * 0.25) * 7.78);
190        }
191    }
192}
193
194/** Does-it-compile test for compatibility with standard library RNG interface. */
195BOOST_AUTO_TEST_CASE(stdrandom_test)
196{
197    FastRandomContext ctx;
198    std::uniform_int_distribution<int> distribution(3, 9);
199    for (int i = 0; i < 100; ++i) {
200        int x = distribution(ctx);
201        BOOST_CHECK(x >= 3);
202        BOOST_CHECK(x <= 9);
203
204        std::vector<int> test{1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
205        std::shuffle(test.begin(), test.end(), ctx);
206        for (int j = 1; j <= 10; ++j) {
207            BOOST_CHECK(std::find(test.begin(), test.end(), j) != test.end());
208        }
209    }
210}
211
212/** Test that Shuffle reaches every permutation with equal probability. */
213BOOST_AUTO_TEST_CASE(shuffle_stat_test)
214{
215    FastRandomContext ctx(true);
216    uint32_t counts[5 * 5 * 5 * 5 * 5] = {0};
217    for (int i = 0; i < 12000; ++i) {
218        int data[5] = {0, 1, 2, 3, 4};
219        std::shuffle(std::begin(data), std::end(data), ctx);
220        int pos = data[0] + data[1] * 5 + data[2] * 25 + data[3] * 125 + data[4] * 625;
221        ++counts[pos];
222    }
223    unsigned int sum = 0;
224    double chi_score = 0.0;
225    for (int i = 0; i < 5 * 5 * 5 * 5 * 5; ++i) {
226        int i1 = i % 5, i2 = (i / 5) % 5, i3 = (i / 25) % 5, i4 = (i / 125) % 5, i5 = i / 625;
227        uint32_t count = counts[i];
228        if (i1 == i2 || i1 == i3 || i1 == i4 || i1 == i5 || i2 == i3 || i2 == i4 || i2 == i5 || i3 == i4 || i3 == i5 || i4 == i5) {
229            BOOST_CHECK(count == 0);
230        } else {
231            chi_score += ((count - 100.0) * (count - 100.0)) / 100.0;
232            BOOST_CHECK(count > 50);
233            BOOST_CHECK(count < 150);
234            sum += count;
235        }
236    }
237    BOOST_CHECK(chi_score > 58.1411); // 99.9999% confidence interval
238    BOOST_CHECK(chi_score < 210.275);
239    BOOST_CHECK_EQUAL(sum, 12000U);
240}
241
242BOOST_AUTO_TEST_CASE(xoroshiro128plusplus_reference_values)
243{
244    // numbers generated from reference implementation
245    InsecureRandomContext rng(0);
246    BOOST_TEST(0x6f68e1e7e2646ee1 == rng());
247    BOOST_TEST(0xbf971b7f454094ad == rng());
248    BOOST_TEST(0x48f2de556f30de38 == rng());
249    BOOST_TEST(0x6ea7c59f89bbfc75 == rng());
250

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/key_io.h

src/logging/categories.h

src/logging/timer.h

src/mapport.h

src/musig.h

src/net_permissions.h

src/netgroup.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/pow.h

src/primitives/block.cpp

src/randomenv.h

src/rest.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/signet.h

src/span.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.