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.

5,986 bytes · SHA-256 dba41e6bea1fc0c1… · View upstream ↗

1// Copyright (c) 2012-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 <compressor.h>
6#include <script/script.h>
7#include <test/util/random.h>
8#include <test/util/setup_common.h>
9
10#include <cstdint>
11
12#include <boost/test/unit_test.hpp>
13
14// amounts 0.00000001 .. 0.00100000
15#define NUM_MULTIPLES_UNIT 100000
16
17// amounts 0.01 .. 100.00
18#define NUM_MULTIPLES_CENT 10000
19
20// amounts 1 .. 10000
21#define NUM_MULTIPLES_1BTC 10000
22
23// amounts 50 .. 21000000
24#define NUM_MULTIPLES_50BTC 420000
25
26BOOST_FIXTURE_TEST_SUITE(compress_tests, BasicTestingSetup)
27
28bool static TestEncode(uint64_t in) {
29    return in == DecompressAmount(CompressAmount(in));
30}
31
32bool static TestDecode(uint64_t in) {
33    return in == CompressAmount(DecompressAmount(in));
34}
35
36bool static TestPair(uint64_t dec, uint64_t enc) {
37    return CompressAmount(dec) == enc &&
38           DecompressAmount(enc) == dec;
39}
40
41BOOST_AUTO_TEST_CASE(compress_amounts)
42{
43    BOOST_CHECK(TestPair(            0,       0x0));
44    BOOST_CHECK(TestPair(            1,       0x1));
45    BOOST_CHECK(TestPair(         CENT,       0x7));
46    BOOST_CHECK(TestPair(         COIN,       0x9));
47    BOOST_CHECK(TestPair(      50*COIN,      0x32));
48    BOOST_CHECK(TestPair(21000000*COIN, 0x1406f40));
49
50    for (uint64_t i = 1; i <= NUM_MULTIPLES_UNIT; i++)
51        BOOST_CHECK(TestEncode(i));
52
53    for (uint64_t i = 1; i <= NUM_MULTIPLES_CENT; i++)
54        BOOST_CHECK(TestEncode(i * CENT));
55
56    for (uint64_t i = 1; i <= NUM_MULTIPLES_1BTC; i++)
57        BOOST_CHECK(TestEncode(i * COIN));
58
59    for (uint64_t i = 1; i <= NUM_MULTIPLES_50BTC; i++)
60        BOOST_CHECK(TestEncode(i * 50 * COIN));
61
62    for (uint64_t i = 0; i < 100000; i++)
63        BOOST_CHECK(TestDecode(i));
64}
65
66BOOST_AUTO_TEST_CASE(compress_script_to_ckey_id)
67{
68    // case CKeyID
69    CKey key = GenerateRandomKey();
70    CPubKey pubkey = key.GetPubKey();
71
72    CScript script = CScript() << OP_DUP << OP_HASH160 << ToByteVector(pubkey.GetID()) << OP_EQUALVERIFY << OP_CHECKSIG;
73    BOOST_CHECK_EQUAL(script.size(), 25U);
74
75    CompressedScript out;
76    bool done = CompressScript(script, out);
77    BOOST_CHECK_EQUAL(done, true);
78
79    // Check compressed script
80    BOOST_CHECK_EQUAL(out.size(), 21U);
81    BOOST_CHECK_EQUAL(out[0], 0x00);
82    BOOST_CHECK_EQUAL(memcmp(out.data() + 1, script.data() + 3, 20), 0); // compare the 20 relevant chars of the CKeyId in the script
83}
84
85BOOST_AUTO_TEST_CASE(compress_script_to_cscript_id)
86{
87    // case CScriptID
88    CScript script, redeemScript;
89    script << OP_HASH160 << ToByteVector(CScriptID(redeemScript)) << OP_EQUAL;
90    BOOST_CHECK_EQUAL(script.size(), 23U);
91
92    CompressedScript out;
93    bool done = CompressScript(script, out);
94    BOOST_CHECK_EQUAL(done, true);
95
96    // Check compressed script
97    BOOST_CHECK_EQUAL(out.size(), 21U);
98    BOOST_CHECK_EQUAL(out[0], 0x01);
99    BOOST_CHECK_EQUAL(memcmp(out.data() + 1, script.data() + 2, 20), 0); // compare the 20 relevant chars of the CScriptId in the script
100}
101
102BOOST_AUTO_TEST_CASE(compress_script_to_compressed_pubkey_id)
103{
104    CKey key = GenerateRandomKey(); // case compressed PubKeyID
105
106    CScript script = CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // COMPRESSED_PUBLIC_KEY_SIZE (33)
107    BOOST_CHECK_EQUAL(script.size(), 35U);
108
109    CompressedScript out;
110    bool done = CompressScript(script, out);
111    BOOST_CHECK_EQUAL(done, true);
112
113    // Check compressed script
114    BOOST_CHECK_EQUAL(out.size(), 33U);
115    BOOST_CHECK_EQUAL(memcmp(out.data(), script.data() + 1, 1), 0);
116    BOOST_CHECK_EQUAL(memcmp(out.data() + 1, script.data() + 2, 32), 0); // compare the 32 chars of the compressed CPubKey
117}
118
119BOOST_AUTO_TEST_CASE(compress_script_to_uncompressed_pubkey_id)
120{
121    CKey key = GenerateRandomKey(/*compressed=*/false); // case uncompressed PubKeyID
122    CScript script =  CScript() << ToByteVector(key.GetPubKey()) << OP_CHECKSIG; // PUBLIC_KEY_SIZE (65)
123    BOOST_CHECK_EQUAL(script.size(), 67U);                   // 1 char code + 65 char pubkey + OP_CHECKSIG
124
125    CompressedScript out;
126    bool done = CompressScript(script, out);
127    BOOST_CHECK_EQUAL(done, true);
128
129    // Check compressed script
130    BOOST_CHECK_EQUAL(out.size(), 33U);
131    BOOST_CHECK_EQUAL(memcmp(out.data() + 1, script.data() + 2, 32), 0); // first 32 chars of CPubKey are copied into out[1:]
132    BOOST_CHECK_EQUAL(out[0], 0x04 | (script[65] & 0x01)); // least significant bit (lsb) of last char of pubkey is mapped into out[0]
133}
134
135BOOST_AUTO_TEST_CASE(compress_p2pk_scripts_not_on_curve)
136{
137    XOnlyPubKey x_not_on_curve;
138    do {
139        x_not_on_curve = XOnlyPubKey(m_rng.randbytes(32));
140    } while (x_not_on_curve.IsFullyValid());
141
142    // Check that P2PK script with uncompressed pubkey [=> OP_PUSH65 <0x04 .....> OP_CHECKSIG]
143    // which is not fully valid (i.e. point is not on curve) can't be compressed
144    std::vector<unsigned char> pubkey_raw(65, 0);
145    pubkey_raw[0] = 4;
146    std::copy(x_not_on_curve.begin(), x_not_on_curve.end(), &pubkey_raw[1]);
147    CPubKey pubkey_not_on_curve(pubkey_raw);
148    assert(pubkey_not_on_curve.IsValid());
149    assert(!pubkey_not_on_curve.IsFullyValid());
150    CScript script = CScript() << ToByteVector(pubkey_not_on_curve) << OP_CHECKSIG;
151    BOOST_CHECK_EQUAL(script.size(), 67U);
152
153    CompressedScript out;
154    bool done = CompressScript(script, out);
155    BOOST_CHECK_EQUAL(done, false);
156
157    // Check that compressed P2PK script with uncompressed pubkey that is not fully
158    // valid (i.e. x coordinate of the pubkey is not on curve) can't be decompressed
159    CompressedScript compressed_script(x_not_on_curve.begin(), x_not_on_curve.end());
160    for (unsigned int compression_id : {4, 5}) {
161        CScript uncompressed_script;
162        bool success = DecompressScript(uncompressed_script, compression_id, compressed_script);
163        BOOST_CHECK_EQUAL(success, false);
164    }
165}
166
167BOOST_AUTO_TEST_SUITE_END()
168

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.