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.

42,383 bytes · SHA-256 d1b57481d692bc0f… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2021-present The Bitcoin 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"""Test for assumeutxo, a means of quickly bootstrapping a node using
6a serialized version of the UTXO set at a certain height, which corresponds
7to a hash that has been compiled into bitcoind.
8
9The assumeutxo value generated and used here is committed to in
10`CRegTestParams::m_assumeutxo_data` in `src/kernel/chainparams.cpp`.
11"""
12import contextlib
13
14from dataclasses import dataclass
15from test_framework.blocktools import (
16        create_block,
17)
18from test_framework.compressor import (
19    compress_amount,
20)
21from test_framework.messages import (
22    CBlockHeader,
23    from_hex,
24    MAGIC_BYTES,
25    MAX_MONEY,
26    msg_headers,
27    ser_varint,
28    tx_from_hex,
29)
30from test_framework.p2p import (
31    P2PInterface,
32)
33from test_framework.test_framework import BitcoinTestFramework
34from test_framework.util import (
35    assert_approx,
36    assert_equal,
37    assert_not_equal,
38    assert_raises_rpc_error,
39    dumb_sync_blocks,
40    ensure_for,
41    sha256sum_file,
42    try_rpc,
43)
44from test_framework.wallet import (
45    getnewdestination,
46    MiniWallet,
47)
48from test_framework.blocktools import (
49    REGTEST_N_BITS,
50    REGTEST_TARGET,
51    nbits_str,
52    target_str,
53)
54
55START_HEIGHT = 199
56SNAPSHOT_BASE_HEIGHT = 299
57FINAL_HEIGHT = 399
58COMPLETE_IDX = {'synced': True, 'best_block_height': FINAL_HEIGHT}
59
60
61class AssumeutxoTest(BitcoinTestFramework):
62
63    def set_test_params(self):
64        """Use the pregenerated, deterministic chain up to height 199."""
65        self.num_nodes = 4
66        self.rpc_timeout = 120
67        self.extra_args = [
68            [],
69            ["-fastprune", "-prune=1", "-blockfilterindex=1", "-coinstatsindex=1"],
70            ["-persistmempool=0","-txindex=1", "-blockfilterindex=1", "-coinstatsindex=1"],
71            []
72        ]
73
74    def setup_network(self):
75        """Start with the nodes disconnected so that one can generate a snapshot
76        including blocks the other hasn't yet seen."""
77        self.add_nodes(4)
78        self.start_nodes(extra_args=self.extra_args)
79
80    def test_invalid_snapshot_scenarios(self, valid_snapshot_path):
81        self.log.info("Test different scenarios of loading invalid snapshot files")
82        with open(valid_snapshot_path, 'rb') as f:
83            valid_snapshot_contents = f.read()
84        bad_snapshot_path = valid_snapshot_path + '.mod'
85        node = self.nodes[1]
86
87        def expected_error(msg):
88            assert_raises_rpc_error(-32603, f"Unable to load UTXO snapshot: Population failed: {msg}", node.loadtxoutset, bad_snapshot_path)
89
90        self.log.info("  - snapshot file with invalid file magic")
91        parsing_error_code = -22
92        bad_magic = 0xf00f00f000
93        with open(bad_snapshot_path, 'wb') as f:
94            f.write(bad_magic.to_bytes(5, "big") + valid_snapshot_contents[5:])
95        assert_raises_rpc_error(parsing_error_code, "Unable to parse metadata: Invalid UTXO set snapshot magic bytes. Please check if this is indeed a snapshot file or if you are using an outdated snapshot format.", node.loadtxoutset, bad_snapshot_path)
96
97        self.log.info("  - snapshot file with unsupported version")
98        for version in [0, 1, 3]:
99            with open(bad_snapshot_path, 'wb') as f:
100                f.write(valid_snapshot_contents[:5] + version.to_bytes(2, "little") + valid_snapshot_contents[7:])
101            assert_raises_rpc_error(parsing_error_code, f"Unable to parse metadata: Version of snapshot {version} does not match any of the supported versions.", node.loadtxoutset, bad_snapshot_path)
102
103        self.log.info("  - snapshot file with mismatching network magic")
104        invalid_magics = [
105            # magic, name, real
106            [MAGIC_BYTES["mainnet"], "main", True],
107            [MAGIC_BYTES["testnet4"], "testnet4", True],
108            [MAGIC_BYTES["signet"], "signet", True],
109            [0x00000000.to_bytes(4, 'big'), "", False],
110            [0xffffffff.to_bytes(4, 'big'), "", False],
111        ]
112        for [magic, name, real] in invalid_magics:
113            with open(bad_snapshot_path, 'wb') as f:
114                f.write(valid_snapshot_contents[:7] + magic + valid_snapshot_contents[11:])
115            if real:
116                assert_raises_rpc_error(parsing_error_code, f"Unable to parse metadata: The network of the snapshot ({name}) does not match the network of this node (regtest).", node.loadtxoutset, bad_snapshot_path)
117            else:
118                assert_raises_rpc_error(parsing_error_code, "Unable to parse metadata: This snapshot has been created for an unrecognized network. This could be a custom signet, a new testnet or possibly caused by data corruption.", node.loadtxoutset, bad_snapshot_path)
119
120        self.log.info("  - snapshot file referring to a block that is not in the assumeutxo parameters")
121        prev_block_hash = self.nodes[0].getblockhash(SNAPSHOT_BASE_HEIGHT - 1)
122        bogus_block_hash = "0" * 64  # Represents any unknown block hash
123        for bad_block_hash in [bogus_block_hash, prev_block_hash]:
124            with open(bad_snapshot_path, 'wb') as f:
125                f.write(valid_snapshot_contents[:11] + bytes.fromhex(bad_block_hash)[::-1] + valid_snapshot_contents[43:])
126
127            msg = f"Unable to load UTXO snapshot: assumeutxo block hash in snapshot metadata not recognized (hash: {bad_block_hash}). The following snapshot heights are available: 110, 200, 299."
128            assert_raises_rpc_error(-32603, msg, node.loadtxoutset, bad_snapshot_path)
129
130        self.log.info("  - snapshot file with wrong number of coins")
131        valid_num_coins = int.from_bytes(valid_snapshot_contents[43:43 + 8], "little")
132        for off in [-1, +1]:
133            with open(bad_snapshot_path, 'wb') as f:
134                f.write(valid_snapshot_contents[:43])
135                f.write((valid_num_coins + off).to_bytes(8, "little"))
136                f.write(valid_snapshot_contents[43 + 8:])
137            expected_error(msg="Bad snapshot - coins left over after deserializing 298 coins." if off == -1 else "Bad snapshot format or truncated snapshot after deserializing 299 coins.")
138
139        self.log.info("  - snapshot file with alternated but parsable UTXO data results in different hash")
140        cases = [
141            # (content, offset, wrong_hash, custom_message)
142            [b"\xff" * 32, 0, "43bb0fcc50f3789d50ce41891810bbc571d549a32e2bbaabfc036f73ae2a23f9", None],  # wrong outpoint hash
143            [(2).to_bytes(1, "little"), 32, None, "Bad snapshot data after deserializing 2 coins."],  # wrong txid coins count
144            [b"\xfd\xff\xff", 32, None, "Mismatch in coins count in snapshot metadata and actual snapshot data"],  # txid coins count exceeds coins left
145            [b"\x01", 33, "0b0e96fd9a556157a68d9e6fe6e2c7562169c730347565ce0725032f824bea34", None],  # wrong outpoint index
146            [b"\x83", 34, "52084c732f760fbcfb804d854815a9145111e93d7c7f3f7bfcb0ade1ea4f6b99", None],  # wrong coin code VARINT
147            [b"\x80", 34, "c1a1308fcf04cbb14fc777467eb5e98e77a921b66eac4ad47877d0b6ed7b15b1", None],  # another wrong coin code
148            [b"\x84\x58", 34, None, "Bad snapshot data after deserializing 0 coins"],  # wrong coin case with height 364 and coinbase 0
149            [
150                # compressed txout value + scriptpubkey
151                ser_varint(compress_amount(MAX_MONEY + 1)) + ser_varint(0),
152                # txid + coins per txid + vout + coin height
153                32 + 1 + 1 + 2,
154                None,
155                "Bad snapshot data after deserializing 0 coins - bad tx out value"
156            ],  # Amount exceeds MAX_MONEY
157        ]
158
159        for content, offset, wrong_hash, custom_message in cases:
160            with open(bad_snapshot_path, "wb") as f:
161                # Prior to offset: Snapshot magic, snapshot version, network magic, hash, coins count
162                f.write(valid_snapshot_contents[:(5 + 2 + 4 + 32 + 8 + offset)])
163                f.write(content)
164                f.write(valid_snapshot_contents[(5 + 2 + 4 + 32 + 8 + offset + len(content)):])
165
166            msg = custom_message if custom_message is not None else f"Bad snapshot content hash: expected 106b2c56233e378a824cf0d5ff2be42ed32c72f1605c9be288d00942908a40ac, got {wrong_hash}."
167            expected_error(msg)
168
169    def test_headers_not_synced(self, valid_snapshot_path):
170        for node in self.nodes[1:]:
171            msg = "Unable to load UTXO snapshot: The base block header (0c552ced4721c249a389eb9b08cb8da261cd46f0e7b5f9d064d48f3113406853) must appear in the headers chain. Make sure all headers are syncing, and call loadtxoutset again."
172            assert_raises_rpc_error(-32603, msg, node.loadtxoutset, valid_snapshot_path)
173
174    def test_invalid_chainstate_scenarios(self):
175        self.log.info("Test different scenarios of invalid snapshot chainstate in datadir")
176
177        self.log.info("  - snapshot chainstate referring to a block that is not in the assumeutxo parameters")
178        self.stop_node(0)
179        chainstate_snapshot_path = self.nodes[0].chain_path / "chainstate_snapshot"
180        chainstate_snapshot_path.mkdir()
181        with open(chainstate_snapshot_path / "base_blockhash", 'wb') as f:
182            f.write(b'z' * 32)
183
184        def expected_error(log_msg="", error_msg=""):
185            with self.nodes[0].assert_debug_log([log_msg]):
186                self.nodes[0].assert_start_raises_init_error(expected_msg=error_msg)
187
188        expected_error_msg = "Error: A fatal internal error occurred, see debug.log for details: Assumeutxo data not found for the given blockhash '7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a7a'."
189        error_details = "Assumeutxo data not found for the given blockhash"
190        expected_error(log_msg=error_details, error_msg=expected_error_msg)
191
192        # resurrect node again
193        (chainstate_snapshot_path / "base_blockhash").unlink()
194        chainstate_snapshot_path.rmdir()
195        self.start_node(0)
196
197    def test_invalid_mempool_state(self, dump_output_path):
198        self.log.info("Test bitcoind should fail when mempool not empty.")
199        node=self.nodes[2]
200        tx = MiniWallet(node).send_self_transfer(from_node=node)
201
202        assert tx['txid'] in node.getrawmempool()
203
204        # Attempt to load the snapshot on Node 2 and expect it to fail
205        msg = "Unable to load UTXO snapshot: Can't activate a snapshot when mempool not empty"
206        assert_raises_rpc_error(-32603, msg, node.loadtxoutset, dump_output_path)
207
208        self.restart_node(2, extra_args=self.extra_args[2])
209
210    def test_invalid_file_path(self):
211        self.log.info("Test bitcoind should fail when file path is invalid.")
212        node = self.nodes[0]
213        path = node.datadir_path / node.chain / "invalid" / "path"
214        assert_raises_rpc_error(-8, "Couldn't open file {} for reading.".format(path), node.loadtxoutset, path)
215
216    def test_snapshot_with_less_work(self, dump_output_path):
217        self.log.info("Test bitcoind should fail when snapshot has less accumulated work than this node.")
218        node = self.nodes[0]
219        msg = "Unable to load UTXO snapshot: Population failed: Work does not exceed active chainstate."
220        assert_raises_rpc_error(-32603, msg, node.loadtxoutset, dump_output_path)
221
222    def test_snapshot_block_invalidated(self, dump_output_path):
223        self.log.info("Test snapshot is not loaded when base block is invalid.")
224        node = self.nodes[0]
225        # We are testing the case where the base block is invalidated itself
226        # and also the case where one of its parents is invalidated.
227        for height in [SNAPSHOT_BASE_HEIGHT, SNAPSHOT_BASE_HEIGHT - 1]:
228            block_hash = node.getblockhash(height)
229            node.invalidateblock(block_hash)
230            assert_equal(node.getblockcount(), height - 1)
231            msg = "Unable to load UTXO snapshot: The base block header (0c552ced4721c249a389eb9b08cb8da261cd46f0e7b5f9d064d48f3113406853) is part of an invalid chain."
232            assert_raises_rpc_error(-32603, msg, node.loadtxoutset, dump_output_path)
233            node.reconsiderblock(block_hash)
234
235    def test_snapshot_in_a_divergent_chain(self, dump_output_path):
236        n0 = self.nodes[0]
237        n3 = self.nodes[3]
238        assert_equal(n0.getblockcount(), FINAL_HEIGHT)
239        assert_equal(n3.getblockcount(), START_HEIGHT)
240
241        self.log.info("Check importing a snapshot where current chain-tip is not an ancestor of the snapshot block but has less work")
242        # Generate a divergent chain in n3 up to 298
243        self.generate(n3, nblocks=99, sync_fun=self.no_op)
244        assert_equal(n3.getblockcount(), SNAPSHOT_BASE_HEIGHT - 1)
245
246        # Try importing the snapshot and assert its success
247        loaded = n3.loadtxoutset(dump_output_path)
248        assert_equal(loaded['base_height'], SNAPSHOT_BASE_HEIGHT)
249        normal, snapshot = n3.getchainstates()["chainstates"]
250        assert_equal(normal['blocks'], START_HEIGHT + 99)

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.