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.

6,810 bytes · SHA-256 2dee0db67ab0a32c… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2018-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"""Useful util functions for testing the wallet"""
6from collections import namedtuple
7import unittest
8
9from test_framework.address import (
10    byte_to_base58,
11    key_to_p2pkh,
12    key_to_p2sh_p2wpkh,
13    key_to_p2wpkh,
14)
15from test_framework.key import ECKey
16from test_framework.messages import (
17    CTxIn,
18    CTxInWitness,
19    WITNESS_SCALE_FACTOR,
20)
21from test_framework.script_util import (
22    key_to_p2pkh_script,
23    key_to_p2wpkh_script,
24    script_to_p2sh_script,
25)
26
27
28Key = namedtuple('Key', ['privkey',
29                         'pubkey',
30                         'p2pkh_script',
31                         'p2pkh_addr',
32                         'p2wpkh_script',
33                         'p2wpkh_addr',
34                         'p2sh_p2wpkh_script',
35                         'p2sh_p2wpkh_redeem_script',
36                         'p2sh_p2wpkh_addr'])
37
38
39def get_generate_key():
40    """Generate a fresh key
41
42    Returns a named tuple of privkey, pubkey and all address and scripts."""
43    privkey, pubkey = generate_keypair(wif=True)
44    return Key(privkey=privkey,
45               pubkey=pubkey.hex(),
46               p2pkh_script=key_to_p2pkh_script(pubkey).hex(),
47               p2pkh_addr=key_to_p2pkh(pubkey),
48               p2wpkh_script=key_to_p2wpkh_script(pubkey).hex(),
49               p2wpkh_addr=key_to_p2wpkh(pubkey),
50               p2sh_p2wpkh_script=script_to_p2sh_script(key_to_p2wpkh_script(pubkey)).hex(),
51               p2sh_p2wpkh_redeem_script=key_to_p2wpkh_script(pubkey).hex(),
52               p2sh_p2wpkh_addr=key_to_p2sh_p2wpkh(pubkey))
53
54
55def test_address(node, address, **kwargs):
56    """Get address info for `address` and test whether the returned values are as expected."""
57    addr_info = node.getaddressinfo(address)
58    for key, value in kwargs.items():
59        if value is None:
60            if key in addr_info.keys():
61                raise AssertionError("key {} unexpectedly returned in getaddressinfo.".format(key))
62        elif addr_info[key] != value:
63            raise AssertionError("key {} value {} did not match expected value {}".format(key, addr_info[key], value))
64
65def bytes_to_wif(b, compressed=True):
66    if compressed:
67        b += b'\x01'
68    return byte_to_base58(b, 239)
69
70def generate_keypair(compressed=True, wif=False):
71    """Generate a new random keypair and return the corresponding ECKey /
72    bytes objects. The private key can also be provided as WIF (wallet
73    import format) string instead, which is often useful for wallet RPC
74    interaction."""
75    privkey = ECKey()
76    privkey.generate(compressed)
77    pubkey = privkey.get_pubkey().get_bytes()
78    if wif:
79        privkey = bytes_to_wif(privkey.get_bytes(), compressed)
80    return privkey, pubkey
81
82def calculate_input_weight(scriptsig_hex, witness_stack_hex=None):
83    """Given a scriptSig and a list of witness stack items for an input in hex format,
84       calculate the total input weight. If the input has no witness data,
85       `witness_stack_hex` can be set to None."""
86    tx_in = CTxIn(scriptSig=bytes.fromhex(scriptsig_hex))
87    witness_size = 0
88    if witness_stack_hex is not None:
89        tx_inwit = CTxInWitness()
90        for witness_item_hex in witness_stack_hex:
91            tx_inwit.scriptWitness.stack.append(bytes.fromhex(witness_item_hex))
92        witness_size = len(tx_inwit.serialize())
93    return len(tx_in.serialize()) * WITNESS_SCALE_FACTOR + witness_size
94
95class WalletUnlock():
96    """
97    A context manager for unlocking a wallet with a passphrase and automatically locking it afterward.
98    """
99
100    MAXIMUM_TIMEOUT = 999000
101
102    def __init__(self, wallet, passphrase, timeout=MAXIMUM_TIMEOUT):
103        self.wallet = wallet
104        self.passphrase = passphrase
105        self.timeout = timeout
106
107    def __enter__(self):
108        self.wallet.walletpassphrase(self.passphrase, self.timeout)
109
110    def __exit__(self, *args):
111        _ = args
112        self.wallet.walletlock()
113
114
115class TestFrameworkWalletUtil(unittest.TestCase):
116    def test_calculate_input_weight(self):
117        SKELETON_BYTES = 32 + 4 + 4  # prevout-txid, prevout-index, sequence
118        SMALL_LEN_BYTES = 1  # bytes needed for encoding scriptSig / witness item lengths < 253
119        LARGE_LEN_BYTES = 3  # bytes needed for encoding scriptSig / witness item lengths >= 253
120
121        # empty scriptSig, no witness
122        self.assertEqual(calculate_input_weight(""),
123                         (SKELETON_BYTES + SMALL_LEN_BYTES) * WITNESS_SCALE_FACTOR)
124        self.assertEqual(calculate_input_weight("", None),
125                         (SKELETON_BYTES + SMALL_LEN_BYTES) * WITNESS_SCALE_FACTOR)
126        # small scriptSig, no witness
127        scriptSig_small = "00"*252
128        self.assertEqual(calculate_input_weight(scriptSig_small, None),
129                         (SKELETON_BYTES + SMALL_LEN_BYTES + 252) * WITNESS_SCALE_FACTOR)
130        # small scriptSig, empty witness stack
131        self.assertEqual(calculate_input_weight(scriptSig_small, []),
132                         (SKELETON_BYTES + SMALL_LEN_BYTES + 252) * WITNESS_SCALE_FACTOR + SMALL_LEN_BYTES)
133        # large scriptSig, no witness
134        scriptSig_large = "00"*253
135        self.assertEqual(calculate_input_weight(scriptSig_large, None),
136                         (SKELETON_BYTES + LARGE_LEN_BYTES + 253) * WITNESS_SCALE_FACTOR)
137        # large scriptSig, empty witness stack
138        self.assertEqual(calculate_input_weight(scriptSig_large, []),
139                         (SKELETON_BYTES + LARGE_LEN_BYTES + 253) * WITNESS_SCALE_FACTOR + SMALL_LEN_BYTES)
140        # empty scriptSig, 5 small witness stack items
141        self.assertEqual(calculate_input_weight("", ["00", "11", "22", "33", "44"]),
142                         ((SKELETON_BYTES + SMALL_LEN_BYTES) * WITNESS_SCALE_FACTOR) + SMALL_LEN_BYTES + 5 * SMALL_LEN_BYTES + 5)
143        # empty scriptSig, 253 small witness stack items
144        self.assertEqual(calculate_input_weight("", ["00"]*253),
145                         ((SKELETON_BYTES + SMALL_LEN_BYTES) * WITNESS_SCALE_FACTOR) + LARGE_LEN_BYTES + 253 * SMALL_LEN_BYTES + 253)
146        # small scriptSig, 3 large witness stack items
147        self.assertEqual(calculate_input_weight(scriptSig_small, ["00"*253]*3),
148                         ((SKELETON_BYTES + SMALL_LEN_BYTES + 252) * WITNESS_SCALE_FACTOR) + SMALL_LEN_BYTES + 3 * LARGE_LEN_BYTES + 3*253)
149        # large scriptSig, 3 large witness stack items
150        self.assertEqual(calculate_input_weight(scriptSig_large, ["00"*253]*3),
151                         ((SKELETON_BYTES + LARGE_LEN_BYTES + 253) * WITNESS_SCALE_FACTOR) + SMALL_LEN_BYTES + 3 * LARGE_LEN_BYTES + 3*253)
152

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.