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.

8,584 bytes · SHA-256 fafb9c80607369bd… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2015-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 BIP65 (CHECKLOCKTIMEVERIFY).
6
7Test that the CHECKLOCKTIMEVERIFY soft-fork activates.
8"""
9
10from test_framework.blocktools import (
11    TIME_GENESIS_BLOCK,
12    create_block,
13)
14from test_framework.messages import (
15    CTransaction,
16    SEQUENCE_FINAL,
17    msg_block,
18)
19from test_framework.p2p import P2PInterface
20from test_framework.script import (
21    CScript,
22    CScriptNum,
23    OP_1NEGATE,
24    OP_CHECKLOCKTIMEVERIFY,
25    OP_DROP,
26)
27from test_framework.test_framework import BitcoinTestFramework
28from test_framework.util import assert_equal
29from test_framework.wallet import (
30    MiniWallet,
31    MiniWalletMode,
32)
33
34
35# Helper function to modify a transaction by
36# 1) prepending a given script to the scriptSig of vin 0 and
37# 2) (optionally) modify the nSequence of vin 0 and the tx's nLockTime
38def cltv_modify_tx(tx, prepend_scriptsig, nsequence=None, nlocktime=None):
39    assert_equal(len(tx.vin), 1)
40    if nsequence is not None:
41        tx.vin[0].nSequence = nsequence
42        tx.nLockTime = nlocktime
43
44    tx.vin[0].scriptSig = CScript(prepend_scriptsig + list(CScript(tx.vin[0].scriptSig)))
45
46
47def cltv_invalidate(tx, failure_reason):
48    # Modify the signature in vin 0 and nSequence/nLockTime of the tx to fail CLTV
49    #
50    # According to BIP65, OP_CHECKLOCKTIMEVERIFY can fail due the following reasons:
51    # 1) the stack is empty
52    # 2) the top item on the stack is less than 0
53    # 3) the lock-time type (height vs. timestamp) of the top stack item and the
54    #    nLockTime field are not the same
55    # 4) the top stack item is greater than the transaction's nLockTime field
56    # 5) the nSequence field of the txin is 0xffffffff (SEQUENCE_FINAL)
57    assert failure_reason in range(5)
58    scheme = [
59        # | Script to prepend to scriptSig                  | nSequence  | nLockTime    |
60        # +-------------------------------------------------+------------+--------------+
61        [[OP_CHECKLOCKTIMEVERIFY],                            None,       None],
62        [[OP_1NEGATE, OP_CHECKLOCKTIMEVERIFY, OP_DROP],       None,       None],
63        [[CScriptNum(100), OP_CHECKLOCKTIMEVERIFY, OP_DROP],  0,          TIME_GENESIS_BLOCK],
64        [[CScriptNum(100), OP_CHECKLOCKTIMEVERIFY, OP_DROP],  0,          50],
65        [[CScriptNum(50),  OP_CHECKLOCKTIMEVERIFY, OP_DROP],  SEQUENCE_FINAL, 50],
66    ][failure_reason]
67
68    cltv_modify_tx(tx, prepend_scriptsig=scheme[0], nsequence=scheme[1], nlocktime=scheme[2])
69
70
71def cltv_validate(tx, height):
72    # Modify the signature in vin 0 and nSequence/nLockTime of the tx to pass CLTV
73    scheme = [[CScriptNum(height), OP_CHECKLOCKTIMEVERIFY, OP_DROP], 0, height]
74
75    cltv_modify_tx(tx, prepend_scriptsig=scheme[0], nsequence=scheme[1], nlocktime=scheme[2])
76
77
78CLTV_HEIGHT = 111
79
80
81class BIP65Test(BitcoinTestFramework):
82    def set_test_params(self):
83        self.num_nodes = 1
84        # whitelist peers to speed up tx relay / mempool sync
85        self.noban_tx_relay = True
86        self.extra_args = [[
87            f'-testactivationheight=cltv@{CLTV_HEIGHT}',
88            '-acceptnonstdtxn=1',  # cltv_invalidate is nonstandard
89        ]]
90        self.setup_clean_chain = True
91        self.rpc_timeout = 480
92
93    def test_cltv_info(self, *, is_active):
94        assert_equal(self.nodes[0].getdeploymentinfo()['deployments']['bip65'], {
95                "active": is_active,
96                "height": CLTV_HEIGHT,
97                "type": "buried",
98            },
99        )
100
101    def run_test(self):
102        peer = self.nodes[0].add_p2p_connection(P2PInterface())
103        wallet = MiniWallet(self.nodes[0], mode=MiniWalletMode.RAW_OP_TRUE)
104
105        self.test_cltv_info(is_active=False)
106
107        self.log.info("Mining %d blocks", CLTV_HEIGHT - 2)
108        self.generate(wallet, 10)
109        self.generate(self.nodes[0], CLTV_HEIGHT - 2 - 10)
110        assert_equal(self.nodes[0].getblockcount(), CLTV_HEIGHT - 2)
111
112        self.log.info("Test that invalid-according-to-CLTV transactions can still appear in a block")
113
114        # create one invalid tx per CLTV failure reason (5 in total) and collect them
115        invalid_cltv_txs = []
116        for i in range(5):
117            spendtx = wallet.create_self_transfer()['tx']
118            cltv_invalidate(spendtx, i)
119            invalid_cltv_txs.append(spendtx)
120
121        tip = self.nodes[0].getbestblockhash()
122        block_time = self.nodes[0].getblockheader(tip)['mediantime'] + 1
123        block = create_block(int(tip, 16), height=CLTV_HEIGHT - 1, ntime=block_time, version=3, txlist=invalid_cltv_txs)
124        block.solve()
125
126        self.test_cltv_info(is_active=False)  # Not active as of current tip and next block does not need to obey rules
127        peer.send_and_ping(msg_block(block))
128        self.test_cltv_info(is_active=True)  # Not active as of current tip, but next block must obey rules
129        assert_equal(self.nodes[0].getbestblockhash(), block.hash_hex)
130
131        self.log.info("Test that blocks must now be at least version 4")
132        tip = block.hash_int
133        block_time += 1
134        block = create_block(tip, height=CLTV_HEIGHT, ntime=block_time, version=3)
135        block.solve()
136
137        with self.nodes[0].assert_debug_log(expected_msgs=[f'{block.hash_hex}, bad-version(0x00000003)']):
138            peer.send_and_ping(msg_block(block))
139            assert_equal(int(self.nodes[0].getbestblockhash(), 16), tip)
140            peer.sync_with_ping()
141
142        self.log.info("Test that invalid-according-to-CLTV transactions cannot appear in a block")
143        block.nVersion = 4
144        block.vtx.append(CTransaction()) # dummy tx after coinbase that will be replaced later
145
146        # create and test one invalid tx per CLTV failure reason (5 in total)
147        for i in range(5):
148            spendtx = wallet.create_self_transfer()['tx']
149            assert_equal(len(spendtx.vin), 1)
150            coin = spendtx.vin[0]
151            coin_txid = format(coin.prevout.hash, '064x')
152            coin_vout = coin.prevout.n
153            cltv_invalidate(spendtx, i)
154
155            blk_rej = "block-script-verify-flag-failed"
156            tx_rej = "mempool-script-verify-flag-failed"
157            expected_cltv_reject_reason = [
158                " (Operation not valid with the current stack size)",
159                " (Negative locktime)",
160                " (Locktime requirement not satisfied)",
161                " (Locktime requirement not satisfied)",
162                " (Locktime requirement not satisfied)",
163            ][i]
164            # First we show that this tx is valid except for CLTV by getting it
165            # rejected from the mempool for exactly that reason.
166            spendtx_txid = spendtx.txid_hex
167            spendtx_wtxid = spendtx.wtxid_hex
168            assert_equal(
169                [{
170                    'txid': spendtx_txid,
171                    'wtxid': spendtx_wtxid,
172                    'allowed': False,
173                    'reject-reason': tx_rej + expected_cltv_reject_reason,
174                    'reject-details': tx_rej + expected_cltv_reject_reason + f", input 0 of {spendtx_txid} (wtxid {spendtx_wtxid}), spending {coin_txid}:{coin_vout}"
175                }],
176                self.nodes[0].testmempoolaccept(rawtxs=[spendtx.serialize().hex()], maxfeerate=0),
177            )
178
179            # Now we verify that a block with this transaction is also invalid.
180            block.vtx[1] = spendtx
181            block.hashMerkleRoot = block.calc_merkle_root()
182            block.solve()
183
184            with self.nodes[0].assert_debug_log(expected_msgs=[f'Block validation error: {blk_rej + expected_cltv_reject_reason}']):
185                peer.send_and_ping(msg_block(block))
186                assert_equal(int(self.nodes[0].getbestblockhash(), 16), tip)
187                peer.sync_with_ping()
188
189        self.log.info("Test that a version 4 block with a valid-according-to-CLTV transaction is accepted")
190        cltv_validate(spendtx, CLTV_HEIGHT - 1)
191
192        block.vtx.pop(1)
193        block.vtx.append(spendtx)
194        block.hashMerkleRoot = block.calc_merkle_root()
195        block.solve()
196
197        self.test_cltv_info(is_active=True)  # Not active as of current tip, but next block must obey rules
198        peer.send_and_ping(msg_block(block))
199        self.test_cltv_info(is_active=True)  # Active as of current tip
200        assert_equal(self.nodes[0].getbestblockhash(), block.hash_hex)
201
202
203if __name__ == '__main__':
204    BIP65Test(__file__).main()
205

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.