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,215 bytes · SHA-256 3d4edebca7b581be… · View upstream ↗

1Test Shell for Interactive Environments
2=========================================
3
4This document describes how to use the `TestShell` submodule in the functional
5test suite.
6
7The `TestShell` submodule extends the `BitcoinTestFramework` functionality to
8external interactive environments for prototyping and educational purposes. Just
9like `BitcoinTestFramework`, the `TestShell` allows the user to:
10
11* Manage regtest bitcoind subprocesses.
12* Access RPC interfaces of the underlying bitcoind instances.
13* Log events to the functional test logging utility.
14
15The `TestShell` can be useful in interactive environments where it is necessary
16to extend the object lifetime of the underlying `BitcoinTestFramework` between
17user inputs. Such environments include the Python3 command line interpreter or
18[Jupyter](https://jupyter.org/) notebooks running a Python3 kernel.
19
20## 1. Requirements
21
22* Python3
23* `bitcoind` built in the same repository as the `TestShell`.
24
25## 2. Importing `TestShell` from the Bitcoin Core repository
26
27We can import the `TestShell` by adding the path of the configured Bitcoin Core
28`test_framework` module to the beginning of the PATH variable, and then
29importing the `TestShell` class from the `test_shell` sub-package. Since
30the build system creates a copy of the `test_framework` module into a new `build/`
31directory along with the required configuration file, the path to the build copy
32must be used.
33
34```
35>>> import sys
36>>> sys.path.insert(0, "/path/to/bitcoin/build/test/functional")
37>>> from test_framework.test_shell import TestShell
38```
39
40The following `TestShell` methods manage the lifetime of the underlying bitcoind
41processes and logging utilities.
42
43* `TestShell().setup()`
44* `TestShell().shutdown()`
45
46The `TestShell` inherits all `BitcoinTestFramework` members and methods, such
47as:
48* `TestShell().nodes[index].rpc_method()`
49* `TestShell().log.info("Custom log message")`
50
51The following sections demonstrate how to initialize, run, and shut down a
52`TestShell` object.
53
54## 3. Initializing a `TestShell` object
55
56```
57>>> test = TestShell().setup(num_nodes=2, setup_clean_chain=True)
5820XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Initializing test directory /path/to/bitcoin_func_test_XXXXXXX
59```
60The `TestShell` forwards all functional test parameters of the parent
61`BitcoinTestFramework` object. The full set of argument keywords which can be
62used to initialize the `TestShell` can be found in [section
63#6](#custom-testshell-parameters) of this document.
64
65**Note: Running multiple instances of `TestShell` is not allowed.** Running a
66single process also ensures that logging remains consolidated in the same
67temporary folder. If you need more bitcoind nodes than set by default (1),
68simply increase the `num_nodes` parameter during setup.
69
70```
71>>> test2 = TestShell().setup()
72TestShell is already running!
73```
74
75## 4. Interacting with the `TestShell`
76
77Unlike the `BitcoinTestFramework` class, the `TestShell` keeps the underlying
78Bitcoind subprocesses (nodes) and logging utilities running until the user
79explicitly shuts down the `TestShell` object.
80
81During the time between the `setup` and `shutdown` calls, all `bitcoind` node
82processes and `BitcoinTestFramework` convenience methods can be accessed
83interactively.
84
85**Example: Mining a regtest chain**
86
87By default, the `TestShell` nodes are initialized with a clean chain. This means
88that each node of the `TestShell` is initialized with a block height of 0.
89
90```
91>>> test.nodes[0].getblockchaininfo()["blocks"]
920
93```
94
95We now let the first node generate 101 regtest blocks, and direct the coinbase
96rewards to a wallet address owned by the mining node.
97
98```
99>>> test.nodes[0].createwallet('default')
100{'name': 'default'}
101>>> address = test.nodes[0].getnewaddress()
102>>> test.generatetoaddress(test.nodes[0], 101, address)
103['2b98dd0044aae6f1cca7f88a0acf366a4bfe053c7f7b00da3c0d115f03d67efb', ...
104```
105Since the two nodes are both initialized by default to establish an outbound
106connection to each other during `setup`, the second node's chain will include
107the mined blocks as soon as they propagate.
108
109```
110>>> test.nodes[1].getblockchaininfo()["blocks"]
111101
112```
113The block rewards from the first block are now spendable by the wallet of the
114first node.
115
116```
117>>> test.nodes[0].getbalance()
118Decimal('50.00000000')
119```
120
121We can also log custom events to the logger.
122
123```
124>>> test.nodes[0].log.info("Successfully mined regtest chain!")
12520XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework.node0 (INFO): Successfully mined regtest chain!
126```
127
128**Note: Please also consider the functional test
129[readme](/test/functional/README.md), which provides an overview of the
130test-framework**. Modules such as
131[key.py](/test/functional/test_framework/key.py),
132[script.py](/test/functional/test_framework/script.py) and
133[messages.py](/test/functional/test_framework/messages.py) are particularly
134useful in constructing objects which can be passed to the bitcoind nodes managed
135by a running `TestShell` object.
136
137## 5. Shutting the `TestShell` down
138
139Shutting down the `TestShell` will safely tear down all running bitcoind
140instances and remove all temporary data and logging directories.
141
142```
143>>> test.shutdown()
14420XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Stopping nodes
14520XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Cleaning up /path/to/bitcoin_func_test_XXXXXXX on exit
14620XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Tests successful
147```
148To prevent the logs from being removed after a shutdown, simply set the
149`TestShell().options.nocleanup` member to `True`.
150```
151>>> test.options.nocleanup = True
152>>> test.shutdown()
15320XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Stopping nodes
15420XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Not cleaning up dir /path/to/bitcoin_func_test_XXXXXXX on exit
15520XX-XX-XXTXX:XX:XX.XXXXXXX TestFramework (INFO): Tests successful
156```
157
158The following utility consolidates logs from the bitcoind nodes and the
159underlying `BitcoinTestFramework`:
160
161* `/path/to/bitcoin/build/test/functional/combine_logs.py
162  '/path/to/bitcoin_func_test_XXXXXXX'`
163
164## 6. Custom `TestShell` parameters
165
166The `TestShell` object initializes with the default settings inherited from the
167`BitcoinTestFramework` class. The user can override these in
168`TestShell().setup(key=value)`.
169
170**Note:** `TestShell().reset()` will reset test parameters to default values and
171can be called after the TestShell is shut down.
172
173| Test parameter key | Default Value | Description |
174|---|---|---|
175| `bind_to_localhost_only` | `True` | Binds bitcoind P2P services to `127.0.0.1` if set to `True`.|
176| `cachedir` | `"/path/to/bitcoin/build/test/cache"` | Sets the bitcoind datadir directory. |
177| `chain`  | `"regtest"` | Sets the chain-type for the underlying test bitcoind processes. |
178| `configfile` | `"/path/to/bitcoin/build/test/config.ini"` | Sets the location of the test framework config file. |
179| `coveragedir` | `None` | Records bitcoind RPC test coverage into this directory if set. |
180| `loglevel` | `INFO` | Logs events at this level and higher. Can be set to `DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL`. |
181| `nocleanup` | `False` | Cleans up temporary test directory if set to `True` during `shutdown`. |
182| `num_nodes` | `1` | Sets the number of initialized bitcoind processes. |
183| `rpc_timeout` | `60` | Sets the RPC server timeout for the underlying bitcoind processes. |
184| `setup_clean_chain` | `False` | A 200-block-long chain is initialized from cache by default. Instead, `setup_clean_chain` initializes an empty blockchain if set to `True`. |
185| `randomseed` | Random Integer | `TestShell().options.randomseed` is a member of `TestShell` which can be accessed during a test to seed a random generator. User can override default with a constant value for reproducible test runs. |
186| `supports_cli` | `False` | Whether the bitcoin-cli utility is compiled and available for the test. |
187| `tmpdir` | `"/var/folders/.../"` | Sets directory for test logs. Will be deleted upon a successful test run unless `nocleanup` is set to `True` |
188| `trace_rpc` | `False` | Logs all RPC calls if set to `True`. |
189| `usecli` | `False` | Uses the bitcoin-cli interface for all bitcoind commands instead of directly calling the RPC server. Requires `supports_cli`. |
190

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.