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.

18,422 bytes · SHA-256 e84296532012715a… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2014-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 BIP68 implementation."""
6
7import random
8import time
9
10from test_framework.blocktools import (
11    NORMAL_GBT_REQUEST_PARAMS,
12    add_witness_commitment,
13    create_block,
14    script_to_p2wsh_script,
15)
16from test_framework.messages import (
17    COIN,
18    COutPoint,
19    CTransaction,
20    CTxIn,
21    CTxInWitness,
22    CTxOut,
23    tx_from_hex,
24)
25from test_framework.script import (
26    CScript,
27    OP_TRUE,
28    SEQUENCE_LOCKTIME_DISABLE_FLAG,
29    SEQUENCE_LOCKTIME_TYPE_FLAG,
30    SEQUENCE_LOCKTIME_GRANULARITY,
31    SEQUENCE_LOCKTIME_MASK,
32)
33from test_framework.test_framework import BitcoinTestFramework
34from test_framework.util import (
35    assert_equal,
36    assert_greater_than,
37    assert_raises_rpc_error,
38    softfork_active,
39)
40from test_framework.wallet import MiniWallet
41
42SCRIPT_W0_SH_OP_TRUE = script_to_p2wsh_script(CScript([OP_TRUE]))
43
44# RPC error for non-BIP68 final transactions
45NOT_FINAL_ERROR = "non-BIP68-final"
46
47class BIP68Test(BitcoinTestFramework):
48    def set_test_params(self):
49        self.num_nodes = 2
50        self.extra_args = [
51            [
52                '-testactivationheight=csv@432',
53            ],
54            [
55                '-testactivationheight=csv@432',
56            ],
57        ]
58
59    def run_test(self):
60        self.relayfee = self.nodes[0].getnetworkinfo()["relayfee"]
61        self.wallet = MiniWallet(self.nodes[0])
62
63        self.log.info("Running test disable flag")
64        self.test_disable_flag()
65
66        self.log.info("Running test sequence-lock-confirmed-inputs")
67        self.test_sequence_lock_confirmed_inputs()
68
69        self.log.info("Running test sequence-lock-unconfirmed-inputs")
70        self.test_sequence_lock_unconfirmed_inputs()
71
72        self.log.info("Running test BIP68 not consensus before activation")
73        self.test_bip68_not_consensus()
74
75        self.log.info("Activating BIP68 (and 112/113)")
76        self.activateCSV()
77
78        self.log.info("Verifying version=2 transactions are standard.")
79        self.log.info("Note that version=2 transactions are always standard (independent of BIP68 activation status).")
80        self.test_version2_relay()
81
82        self.log.info("Passed")
83
84    # Test that BIP68 is not in effect if tx version is 1, or if
85    # the first sequence bit is set.
86    def test_disable_flag(self):
87        # Create some unconfirmed inputs
88        utxo = self.wallet.send_self_transfer(from_node=self.nodes[0])["new_utxo"]
89
90        tx1 = CTransaction()
91        value = int((utxo["value"] - self.relayfee) * COIN)
92
93        # Check that the disable flag disables relative locktime.
94        # If sequence locks were used, this would require 1 block for the
95        # input to mature.
96        sequence_value = SEQUENCE_LOCKTIME_DISABLE_FLAG | 1
97        tx1.vin = [CTxIn(COutPoint(int(utxo["txid"], 16), utxo["vout"]), nSequence=sequence_value)]
98        tx1.vout = [CTxOut(value, SCRIPT_W0_SH_OP_TRUE)]
99
100        self.wallet.sign_tx(tx=tx1)
101        tx1_id = self.wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=tx1.serialize().hex())
102        tx1_id = int(tx1_id, 16)
103
104        # This transaction will enable sequence-locks, so this transaction should
105        # fail
106        tx2 = CTransaction()
107        tx2.version = 2
108        sequence_value = sequence_value & 0x7fffffff
109        tx2.vin = [CTxIn(COutPoint(tx1_id, 0), nSequence=sequence_value)]
110        tx2.wit.vtxinwit = [CTxInWitness()]
111        tx2.wit.vtxinwit[0].scriptWitness.stack = [CScript([OP_TRUE])]
112        tx2.vout = [CTxOut(int(value - self.relayfee * COIN), SCRIPT_W0_SH_OP_TRUE)]
113
114        assert_raises_rpc_error(-26, NOT_FINAL_ERROR, self.wallet.sendrawtransaction, from_node=self.nodes[0], tx_hex=tx2.serialize().hex())
115
116        # Setting the version back down to 1 should disable the sequence lock,
117        # so this should be accepted.
118        tx2.version = 1
119
120        self.wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=tx2.serialize().hex())
121
122    # Calculate the median time past of a prior block ("confirmations" before
123    # the current tip).
124    def get_median_time_past(self, confirmations):
125        block_hash = self.nodes[0].getblockhash(self.nodes[0].getblockcount()-confirmations)
126        return self.nodes[0].getblockheader(block_hash)["mediantime"]
127
128    # Test that sequence locks are respected for transactions spending confirmed inputs.
129    def test_sequence_lock_confirmed_inputs(self):
130        # Create lots of confirmed utxos, and use them to generate lots of random
131        # transactions.
132        max_outputs = 50
133        while len(self.wallet.get_utxos(include_immature_coinbase=False, mark_as_spent=False)) < 200:
134            num_outputs = random.randint(1, max_outputs)
135            self.wallet.send_self_transfer_multi(from_node=self.nodes[0], num_outputs=num_outputs)
136            self.generate(self.wallet, 1)
137
138        utxos = self.wallet.get_utxos(include_immature_coinbase=False)
139
140        # Try creating a lot of random transactions.
141        # Each time, choose a random number of inputs, and randomly set
142        # some of those inputs to be sequence locked (and randomly choose
143        # between height/time locking). Small random chance of making the locks
144        # all pass.
145        for _ in range(400):
146            available_utxos = len(utxos)
147
148            # Randomly choose up to 10 inputs
149            num_inputs = random.randint(1, min(10, available_utxos))
150            random.shuffle(utxos)
151
152            # Track whether any sequence locks used should fail
153            should_pass = True
154
155            # Track whether this transaction was built with sequence locks
156            using_sequence_locks = False
157
158            tx = CTransaction()
159            tx.version = 2
160            value = 0
161            for j in range(num_inputs):
162                sequence_value = 0xfffffffe # this disables sequence locks
163
164                # 50% chance we enable sequence locks
165                if random.randint(0,1):
166                    using_sequence_locks = True
167
168                    # 10% of the time, make the input sequence value pass
169                    input_will_pass = (random.randint(1,10) == 1)
170                    sequence_value = utxos[j]["confirmations"]
171                    if not input_will_pass:
172                        sequence_value += 1
173                        should_pass = False
174
175                    # Figure out what the median-time-past was for the confirmed input
176                    # Note that if an input has N confirmations, we're going back N blocks
177                    # from the tip so that we're looking up MTP of the block
178                    # PRIOR to the one the input appears in, as per the BIP68 spec.
179                    orig_time = self.get_median_time_past(utxos[j]["confirmations"])
180                    cur_time = self.get_median_time_past(0) # MTP of the tip
181
182                    # can only timelock this input if it's not too old -- otherwise use height
183                    can_time_lock = True
184                    if ((cur_time - orig_time) >> SEQUENCE_LOCKTIME_GRANULARITY) >= SEQUENCE_LOCKTIME_MASK:
185                        can_time_lock = False
186
187                    # if time-lockable, then 50% chance we make this a time lock
188                    if random.randint(0,1) and can_time_lock:
189                        # Find first time-lock value that fails, or latest one that succeeds
190                        time_delta = sequence_value << SEQUENCE_LOCKTIME_GRANULARITY
191                        if input_will_pass and time_delta > cur_time - orig_time:
192                            sequence_value = ((cur_time - orig_time) >> SEQUENCE_LOCKTIME_GRANULARITY)
193                        elif (not input_will_pass and time_delta <= cur_time - orig_time):
194                            sequence_value = ((cur_time - orig_time) >> SEQUENCE_LOCKTIME_GRANULARITY)+1
195                        sequence_value |= SEQUENCE_LOCKTIME_TYPE_FLAG
196                tx.vin.append(CTxIn(COutPoint(int(utxos[j]["txid"], 16), utxos[j]["vout"]), nSequence=sequence_value))
197                value += utxos[j]["value"]*COIN
198            # Overestimate the size of the tx - signatures should be less than 120 bytes, and leave 50 for the output
199            tx_size = len(tx.serialize().hex())//2 + 120*num_inputs + 50
200            tx.vout.append(CTxOut(int(value - self.relayfee * tx_size * COIN / 1000), self.wallet.get_output_script()))
201            self.wallet.sign_tx(tx=tx)
202
203            if (using_sequence_locks and not should_pass):
204                # This transaction should be rejected
205                assert_raises_rpc_error(-26, NOT_FINAL_ERROR, self.wallet.sendrawtransaction, from_node=self.nodes[0], tx_hex=tx.serialize().hex())
206            else:
207                # This raw transaction should be accepted
208                self.wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=tx.serialize().hex())
209                self.wallet.rescan_utxos()
210                utxos = self.wallet.get_utxos(include_immature_coinbase=False)
211
212    # Test that sequence locks on unconfirmed inputs must have nSequence
213    # height or time of 0 to be accepted.
214    # Then test that BIP68-invalid transactions are removed from the mempool
215    # after a reorg.
216    def test_sequence_lock_unconfirmed_inputs(self):
217        # Store height so we can easily reset the chain at the end of the test
218        cur_height = self.nodes[0].getblockcount()
219
220        # Create a mempool tx.
221        self.wallet.rescan_utxos()
222        tx1 = self.wallet.send_self_transfer(from_node=self.nodes[0])["tx"]
223
224        # Anyone-can-spend mempool tx.
225        # Sequence lock of 0 should pass.
226        tx2 = CTransaction()
227        tx2.version = 2
228        tx2.vin = [CTxIn(COutPoint(tx1.txid_int, 0), nSequence=0)]
229        tx2.vout = [CTxOut(int(tx1.vout[0].nValue - self.relayfee * COIN), SCRIPT_W0_SH_OP_TRUE)]
230        self.wallet.sign_tx(tx=tx2)
231        tx2_raw = tx2.serialize().hex()
232
233        self.wallet.sendrawtransaction(from_node=self.nodes[0], tx_hex=tx2_raw)
234
235        # Create a spend of the 0th output of orig_tx with a sequence lock
236        # of 1, and test what happens when submitting.
237        # orig_tx.vout[0] must be an anyone-can-spend output
238        def test_nonzero_locks(orig_tx, node, relayfee, use_height_lock):
239            sequence_value = 1
240            if not use_height_lock:
241                sequence_value |= SEQUENCE_LOCKTIME_TYPE_FLAG
242
243            tx = CTransaction()
244            tx.version = 2
245            tx.vin = [CTxIn(COutPoint(orig_tx.txid_int, 0), nSequence=sequence_value)]
246            tx.wit.vtxinwit = [CTxInWitness()]
247            tx.wit.vtxinwit[0].scriptWitness.stack = [CScript([OP_TRUE])]
248            tx.vout = [CTxOut(int(orig_tx.vout[0].nValue - relayfee * COIN), SCRIPT_W0_SH_OP_TRUE)]
249
250            if (orig_tx.txid_hex in node.getrawmempool()):

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.