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.

7,999 bytes · SHA-256 6eed909b365b819a… · 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"""Test RPC help output."""
6
7from test_framework.test_framework import BitcoinTestFramework
8from test_framework.util import assert_equal, assert_raises_rpc_error
9
10from collections import defaultdict
11import json
12import os
13import re
14
15
16def parse_string(s):
17    assert_equal(s[0], '"')
18    assert_equal(s[-1], '"')
19    return s[1:-1]
20
21def process_mapping(fname):
22    """Find and parse conversion table in implementation file `fname`."""
23    cmds = []
24    string_params = []
25    in_rpcs = False
26    with open(fname, "r") as f:
27        for line in f:
28            line = line.rstrip()
29            if not in_rpcs:
30                if re.match(r'static const CRPCConvertParam vRPCConvertParams\[] =', line):
31                    in_rpcs = True
32            else:
33                if line.startswith('};'):
34                    in_rpcs = False
35                elif '{' in line and '"' in line:
36                    # Match lines with ParamFormat::STRING
37                    m_string = re.search(r'{ *("[^"]*") *, *([0-9]+) *, *("[^"]*") *, *ParamFormat::STRING *},?', line)
38                    if m_string:
39                        name = parse_string(m_string.group(1))
40                        idx = int(m_string.group(2))
41                        argname = parse_string(m_string.group(3))
42                        string_params.append((name, idx, argname))
43                        continue
44
45                    # Match lines with ParamFormat::JSON and ParamFormat::JSON_OR_STRING
46                    m_json = re.search(r'{ *("[^"]*") *, *([0-9]+) *, *("[^"]*") *(?:, *ParamFormat::(JSON_OR_STRING|JSON))? *},?', line)
47                    if m_json:
48                        name = parse_string(m_json.group(1))
49                        idx = int(m_json.group(2))
50                        argname = parse_string(m_json.group(3))
51                        cmds.append((name, idx, argname))
52
53    assert not in_rpcs
54    return cmds, string_params
55
56class HelpRpcTest(BitcoinTestFramework):
57    def set_test_params(self):
58        self.num_nodes = 1
59        self.uses_wallet = None
60
61    def run_test(self):
62        self.test_client_conversion_table()
63        self.test_client_string_conversion_table()
64        self.test_categories()
65        self.dump_help()
66        if self.is_wallet_compiled():
67            self.wallet_help()
68
69    def test_client_conversion_table(self):
70        file_conversion_table = os.path.join(self.config["environment"]["SRCDIR"], 'src', 'rpc', 'client.cpp')
71        mapping_client, _ = process_mapping(file_conversion_table)
72        # Ignore echojson in client table
73        mapping_client = [m for m in mapping_client if m[0] != 'echojson']
74
75        mapping_server = self.nodes[0].help("dump_all_command_conversions")
76        # Filter all RPCs whether they need conversion
77        mapping_server_conversion = [tuple(m[:3]) for m in mapping_server if not m[3]]
78
79        # Only check if all RPC methods have been compiled (i.e. wallet is enabled)
80        if self.is_wallet_compiled() and sorted(mapping_client) != sorted(mapping_server_conversion):
81            raise AssertionError("RPC client conversion table ({}) and RPC server named arguments mismatch!\n{}".format(
82                file_conversion_table,
83                set(mapping_client).symmetric_difference(mapping_server_conversion),
84            ))
85
86        # Check for conversion difference by argument name.
87        # It is preferable for API consistency that arguments with the same name
88        # have the same conversion, so bin by argument name.
89        all_methods_by_argname = defaultdict(list)
90        converts_by_argname = defaultdict(list)
91        for m in mapping_server:
92            all_methods_by_argname[m[2]].append(m[0])
93            converts_by_argname[m[2]].append(m[3])
94
95        for argname, convert in converts_by_argname.items():
96            if all(convert) != any(convert):
97                # Only allow dummy and psbt to fail consistency check
98                assert argname in ['dummy', "psbt"], ('WARNING: conversion mismatch for argument named %s (%s)' % (argname, list(zip(all_methods_by_argname[argname], converts_by_argname[argname]))))
99
100    def test_client_string_conversion_table(self):
101        file_conversion_table = os.path.join(self.config["environment"]["SRCDIR"], 'src', 'rpc', 'client.cpp')
102        _, string_params_client = process_mapping(file_conversion_table)
103        mapping_server = self.nodes[0].help("dump_all_command_conversions")
104        server_tuples = {tuple(m[:3]) for m in mapping_server}
105
106        # Filter string parameters based on wallet compilation status
107        if self.is_wallet_compiled():
108            # Check that every entry in string parameters exists on the server
109            stale_entries = [entry for entry in string_params_client if entry not in server_tuples]
110            if stale_entries:
111                raise AssertionError(f"String parameters contains entries not present on the server: {stale_entries}")
112            filtered_string_params = string_params_client
113        else:
114            available_string_params = [entry for entry in string_params_client if entry in server_tuples]
115            filtered_string_params = available_string_params
116
117        # Validate that all entries are legitimate server parameters
118        server_method_param_tuples = {(m[0], m[1], m[2]) for m in mapping_server}
119        invalid_entries = [entry for entry in filtered_string_params if entry not in server_method_param_tuples]
120        if invalid_entries:
121            raise AssertionError(f"String parameters contains invalid entries: {invalid_entries}")
122
123    def test_categories(self):
124        node = self.nodes[0]
125
126        # wrong argument count
127        assert_raises_rpc_error(-1, 'help', node.help, 'foo', 'bar')
128
129        # invalid argument
130        if not self.options.usecli:
131            assert_raises_rpc_error(-3, "JSON value of type number is not of expected type string", node.help, 0)
132
133        # help of unknown command
134        assert_equal(node.help('foo'), 'help: unknown command: foo')
135
136        # command titles
137        titles = [line[3:-3] for line in node.help().splitlines() if line.startswith('==')]
138
139        components = ['Blockchain', 'Control', 'Mining', 'Network', 'Rawtransactions', 'Util']
140
141        if self.is_wallet_compiled():
142            components.append('Wallet')
143
144        if self.is_external_signer_compiled():
145            components.append('Signer')
146
147        if self.is_zmq_compiled():
148            components.append('Zmq')
149
150        assert_equal(titles, sorted(components))
151
152    def dump_help(self):
153        dump_dir = os.path.join(self.options.tmpdir, 'rpc_help_dump')
154        os.mkdir(dump_dir)
155        calls = [line.split(' ', 1)[0] for line in self.nodes[0].help().splitlines() if line and not line.startswith('==')]
156        for call in calls:
157            help_text = self.nodes[0].help(call)
158            with open(os.path.join(dump_dir, call), 'w') as f:
159                # Make sure the node can generate the help at runtime without crashing
160                f.write(help_text)
161            # Make sure any curl examples have a JSON-RPC payload that is valid JSON
162            for match in re.finditer(r"--data-binary '(.*)' -H", help_text):
163                payload = match.group(1)
164                try:
165                    json.loads(payload)
166                except json.JSONDecodeError as e:
167                    raise AssertionError(f"HelpExampleRpc for '{call}' is not valid JSON: {payload!r}\n{e}")
168
169    def wallet_help(self):
170        assert 'getnewaddress ( "label" "address_type" )' in self.nodes[0].help('getnewaddress')
171        self.restart_node(0, extra_args=['-nowallet=1'])
172        assert 'getnewaddress ( "label" "address_type" )' in self.nodes[0].help('getnewaddress')
173
174if __name__ == '__main__':
175    HelpRpcTest(__file__).main()
176

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.