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.

21,486 bytes · SHA-256 6787e3d41e806762… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2020-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"""A limited-functionality wallet, which may replace a real wallet in tests"""
6
7from copy import deepcopy
8from decimal import Decimal
9from enum import Enum
10from typing import (
11    Any,
12    Optional,
13)
14from test_framework.address import (
15    address_to_scriptpubkey,
16    create_deterministic_address_bcrt1_p2tr_op_true,
17    key_to_p2pkh,
18    key_to_p2sh_p2wpkh,
19    key_to_p2wpkh,
20    output_key_to_p2tr,
21)
22from test_framework.blocktools import COINBASE_MATURITY
23from test_framework.descriptors import descsum_create
24from test_framework.key import (
25    ECKey,
26    compute_xonly_pubkey,
27)
28from test_framework.messages import (
29    COIN,
30    COutPoint,
31    CTransaction,
32    CTxIn,
33    CTxInWitness,
34    CTxOut,
35    hash256,
36)
37from test_framework.script import (
38    CScript,
39    OP_NOP,
40    OP_RETURN,
41    OP_TRUE,
42    sign_input_legacy,
43    taproot_construct,
44)
45from test_framework.script_util import (
46    bulk_vout,
47    key_to_p2pk_script,
48    key_to_p2pkh_script,
49    key_to_p2sh_p2wpkh_script,
50    key_to_p2wpkh_script,
51)
52from test_framework.util import (
53    assert_equal,
54    assert_greater_than_or_equal,
55    get_fee,
56)
57from test_framework.wallet_util import (
58    bytes_to_wif,
59    generate_keypair,
60)
61
62DEFAULT_FEE = Decimal("0.0001")
63
64class MiniWalletMode(Enum):
65    """Determines the transaction type the MiniWallet is creating and spending.
66
67    For most purposes, the default mode ADDRESS_OP_TRUE should be sufficient;
68    it simply uses a fixed bech32m P2TR address whose coins are spent with a
69    witness stack of OP_TRUE, i.e. following an anyone-can-spend policy.
70    However, if the transactions need to be modified by the user (e.g. prepending
71    scriptSig for testing opcodes that are activated by a soft-fork), or the txs
72    should contain an actual signature, the raw modes RAW_OP_TRUE and RAW_P2PK
73    can be useful. In order to avoid mixing of UTXOs between different MiniWallet
74    instances, a tag name can be passed to the default mode, to create different
75    output scripts. Note that the UTXOs from the pre-generated test chain can
76    only be spent if no tag is passed. Summary of modes:
77
78                    |      output       |           |  tx is   | can modify |  needs
79         mode       |    description    |  address  | standard | scriptSig  | signing
80    ----------------+-------------------+-----------+----------+------------+----------
81    ADDRESS_OP_TRUE | anyone-can-spend  |  bech32m  |   yes    |    no      |   no
82    RAW_OP_TRUE     | anyone-can-spend  |  - (raw)  |   no     |    yes     |   no
83    RAW_P2PK        | pay-to-public-key |  - (raw)  |   yes    |    yes     |   yes
84    """
85    ADDRESS_OP_TRUE = 1
86    RAW_OP_TRUE = 2
87    RAW_P2PK = 3
88
89
90class MiniWallet:
91    def __init__(self, test_node, *, mode=MiniWalletMode.ADDRESS_OP_TRUE, tag_name=None):
92        self._test_node = test_node
93        self._utxos = []
94        self._mode = mode
95
96        assert isinstance(mode, MiniWalletMode)
97        if mode == MiniWalletMode.RAW_OP_TRUE:
98            assert tag_name is None
99            self._scriptPubKey = bytes(CScript([OP_TRUE]))
100        elif mode == MiniWalletMode.RAW_P2PK:
101            # use simple deterministic private key (k=1)
102            assert tag_name is None
103            self._priv_key = ECKey()
104            self._priv_key.set((1).to_bytes(32, 'big'), True)
105            pub_key = self._priv_key.get_pubkey()
106            self._scriptPubKey = key_to_p2pk_script(pub_key.get_bytes())
107        elif mode == MiniWalletMode.ADDRESS_OP_TRUE:
108            internal_key = None if tag_name is None else compute_xonly_pubkey(hash256(tag_name.encode()))[0]
109            self._address, self._taproot_info = create_deterministic_address_bcrt1_p2tr_op_true(internal_key)
110            self._scriptPubKey = address_to_scriptpubkey(self._address)
111
112        # When the pre-mined test framework chain is used, it contains coinbase
113        # outputs to the MiniWallet's default address in blocks 76-100
114        # (see method BitcoinTestFramework._initialize_chain())
115        # The MiniWallet needs to rescan_utxos() in order to account
116        # for those mature UTXOs, so that all txs spend confirmed coins
117        self.rescan_utxos()
118
119    def _create_utxo(self, *, txid, vout, value, height, coinbase, confirmations):
120        return {"txid": txid, "vout": vout, "value": value, "height": height, "coinbase": coinbase, "confirmations": confirmations}
121
122    def _bulk_tx(self, tx, target_vsize):
123        """Pad a transaction with extra outputs until it reaches a target vsize.
124        returns the tx
125        """
126        tx.vout.append(CTxOut(nValue=0, scriptPubKey=CScript([OP_RETURN])))
127        bulk_vout(tx, target_vsize)
128
129
130    def get_balance(self):
131        return sum(u['value'] for u in self._utxos)
132
133    def rescan_utxos(self, *, include_mempool=True):
134        """Drop all utxos and rescan the utxo set"""
135        self._utxos = []
136        res = self._test_node.scantxoutset(action="start", scanobjects=[self.get_descriptor()])
137        assert_equal(True, res['success'])
138        for utxo in res['unspents']:
139            self._utxos.append(
140                self._create_utxo(txid=utxo["txid"],
141                                  vout=utxo["vout"],
142                                  value=utxo["amount"],
143                                  height=utxo["height"],
144                                  coinbase=utxo["coinbase"],
145                                  confirmations=res["height"] - utxo["height"] + 1))
146        if include_mempool:
147            mempool = self._test_node.getrawmempool(verbose=True)
148            # Sort tx by ancestor count. See BlockAssembler::SortForBlock in src/node/miner.cpp
149            sorted_mempool = sorted(mempool.items(), key=lambda item: (item[1]["ancestorcount"], int(item[0], 16)))
150            for txid, _ in sorted_mempool:
151                self.scan_tx(self._test_node.getrawtransaction(txid=txid, verbose=True))
152
153    def scan_tx(self, tx):
154        """Scan the tx and adjust the internal list of owned utxos"""
155        for spent in tx["vin"]:
156            # Mark spent. This may happen when the caller has ownership of a
157            # utxo that remained in this wallet. For example, by passing
158            # mark_as_spent=False to get_utxo or by using an utxo returned by a
159            # create_self_transfer* call.
160            try:
161                self.get_utxo(txid=spent["txid"], vout=spent["vout"])
162            except StopIteration:
163                pass
164        for out in tx['vout']:
165            if out['scriptPubKey']['hex'] == self._scriptPubKey.hex():
166                self._utxos.append(self._create_utxo(txid=tx["txid"], vout=out["n"], value=out["value"], height=0, coinbase=False, confirmations=0))
167
168    def scan_txs(self, txs):
169        for tx in txs:
170            self.scan_tx(tx)
171
172    def sign_tx(self, tx, fixed_length=True):
173        if self._mode == MiniWalletMode.RAW_P2PK:
174            # for exact fee calculation, create only signatures with fixed size by default (>49.89% probability):
175            # 65 bytes: high-R val (33 bytes) + low-S val (32 bytes)
176            # with the DER header/skeleton data of 6 bytes added, plus 2 bytes scriptSig overhead
177            # (OP_PUSHn and SIGHASH_ALL), this leads to a scriptSig target size of 73 bytes
178            tx.vin[0].scriptSig = b''
179            while not len(tx.vin[0].scriptSig) == 73:
180                tx.vin[0].scriptSig = b''
181                sign_input_legacy(tx, 0, self._scriptPubKey, self._priv_key)
182                if not fixed_length:
183                    break
184        elif self._mode == MiniWalletMode.RAW_OP_TRUE:
185            for i in tx.vin:
186                i.scriptSig = CScript([OP_NOP] * 43)  # pad to identical size
187        elif self._mode == MiniWalletMode.ADDRESS_OP_TRUE:
188            tx.wit.vtxinwit = [CTxInWitness()] * len(tx.vin)
189            for i in tx.wit.vtxinwit:
190                assert_equal(len(self._taproot_info.leaves), 1)
191                leaf_info = list(self._taproot_info.leaves.values())[0]
192                i.scriptWitness.stack = [
193                    leaf_info.script,
194                    bytes([leaf_info.version | self._taproot_info.negflag]) + self._taproot_info.internal_pubkey,
195                ]
196        else:
197            assert False
198
199    def generate(self, num_blocks, **kwargs):
200        """Generate blocks with coinbase outputs to the internal address, and call rescan_utxos"""
201        blocks = self._test_node.generatetodescriptor(num_blocks, self.get_descriptor(), **kwargs)
202        # Calling rescan_utxos here makes sure that after a generate the utxo
203        # set is in a clean state. For example, the wallet will update
204        # - if the caller consumed utxos, but never used them
205        # - if the caller sent a transaction that is not mined or got rbf'd
206        # - after block re-orgs
207        # - the utxo height for mined mempool txs
208        # - However, the wallet will not consider remaining mempool txs
209        self.rescan_utxos()
210        return blocks
211
212    def get_output_script(self):
213        return self._scriptPubKey
214
215    def get_descriptor(self):
216        return descsum_create(f'raw({self._scriptPubKey.hex()})')
217
218    def get_address(self):
219        assert_equal(self._mode, MiniWalletMode.ADDRESS_OP_TRUE)
220        return self._address
221
222    def get_utxo(self, *, txid: str = '', vout: Optional[int] = None, mark_as_spent=True, confirmed_only=False) -> dict:
223        """
224        Returns a utxo and marks it as spent (pops it from the internal list)
225
226        Args:
227        txid: get the first utxo we find from a specific transaction
228        """
229        self._utxos = sorted(self._utxos, key=lambda k: (k['value'], -k['height']))  # Put the largest utxo last
230        blocks_height = self._test_node.getblockchaininfo()['blocks']
231        mature_coins = list(filter(lambda utxo: not utxo['coinbase'] or COINBASE_MATURITY - 1 <= blocks_height - utxo['height'], self._utxos))
232        if txid:
233            utxo_filter: Any = filter(lambda utxo: txid == utxo['txid'], self._utxos)
234        else:
235            utxo_filter = reversed(mature_coins)  # By default the largest utxo
236        if vout is not None:
237            utxo_filter = filter(lambda utxo: vout == utxo['vout'], utxo_filter)
238        if confirmed_only:
239            utxo_filter = filter(lambda utxo: utxo['confirmations'] > 0, utxo_filter)
240        index = self._utxos.index(next(utxo_filter))
241        if mark_as_spent:
242            return self._utxos.pop(index)
243        else:
244            return self._utxos[index]
245
246    def get_utxos(self, *, include_immature_coinbase=False, mark_as_spent=True, confirmed_only=False):
247        """Returns the list of all utxos and optionally mark them as spent"""
248        if not include_immature_coinbase:
249            blocks_height = self._test_node.getblockchaininfo()['blocks']
250            utxo_filter = filter(lambda utxo: not utxo['coinbase'] or COINBASE_MATURITY - 1 <= blocks_height - utxo['height'], self._utxos)

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.