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.

11,453 bytes · SHA-256 9e4d119b62fe1ea5… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2017-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 external signer.
6
7Verify that a bitcoind node can use an external signer command
8See also rpc_signer.py for tests without wallet context.
9"""
10import os
11import sys
12
13from test_framework.test_framework import BitcoinTestFramework
14from test_framework.util import (
15    assert_equal,
16    assert_greater_than,
17    assert_raises_rpc_error,
18)
19
20
21class WalletSignerTest(BitcoinTestFramework):
22    def mock_signer_path(self):
23        path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'mocks', 'signer.py')
24        return sys.executable + " " + path
25
26    def mock_no_connected_signer_path(self):
27        path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'mocks', 'no_signer.py')
28        return sys.executable + " " + path
29
30    def mock_invalid_signer_path(self):
31        path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'mocks', 'invalid_signer.py')
32        return sys.executable + " " + path
33
34    def mock_multi_signers_path(self):
35        path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'mocks', 'multi_signers.py')
36        return sys.executable + " " + path
37
38    def set_test_params(self):
39        self.num_nodes = 2
40
41        self.extra_args = [
42            [],
43            [f"-signer={self.mock_signer_path()}", '-keypool=10'],
44        ]
45
46    def skip_test_if_missing_module(self):
47        self.skip_if_no_external_signer()
48        self.skip_if_no_wallet()
49
50    def set_mock_result(self, node, res):
51        with open(os.path.join(node.cwd, "mock_result"), "w") as f:
52            f.write(res)
53
54    def clear_mock_result(self, node):
55        os.remove(os.path.join(node.cwd, "mock_result"))
56
57    def run_test(self):
58        self.test_valid_signer()
59        self.test_disconnected_signer()
60        self.restart_node(1, [f"-signer={self.mock_invalid_signer_path()}", "-keypool=10"])
61        self.test_invalid_signer()
62        self.restart_node(1, [f"-signer={self.mock_multi_signers_path()}", "-keypool=10"])
63        self.test_multiple_signers()
64
65    def test_valid_signer(self):
66        self.log.debug(f"-signer={self.mock_signer_path()}")
67
68        # Create new wallets for an external signer.
69        # disable_private_keys and descriptors must be true:
70        assert_raises_rpc_error(-4, "Private keys must be disabled when using an external signer", self.nodes[1].createwallet, wallet_name='not_hww', disable_private_keys=False, external_signer=True)
71        self.nodes[1].createwallet(wallet_name='hww', disable_private_keys=True, external_signer=True)
72        hww = self.nodes[1].get_wallet_rpc('hww')
73        assert_equal(hww.getwalletinfo()["external_signer"], True)
74
75        # Flag can't be set afterwards (could be added later for non-blank descriptor based watch-only wallets)
76        self.nodes[1].createwallet(wallet_name='not_hww', disable_private_keys=True, external_signer=False)
77        not_hww = self.nodes[1].get_wallet_rpc('not_hww')
78        assert_equal(not_hww.getwalletinfo()["external_signer"], False)
79        assert_raises_rpc_error(-8, "Wallet flag is immutable: external_signer", not_hww.setwalletflag, "external_signer", True)
80
81
82        self.set_mock_result(self.nodes[1], '0 {"invalid json"}')
83        assert_raises_rpc_error(-1, 'Unable to parse JSON',
84            self.nodes[1].createwallet, wallet_name='hww2', disable_private_keys=True, external_signer=True
85        )
86        self.clear_mock_result(self.nodes[1])
87
88        assert_equal(hww.getwalletinfo()["keypoolsize"], 40)
89
90        address1 = hww.getnewaddress(address_type="bech32")
91        assert_equal(address1, "bcrt1qm90ugl4d48jv8n6e5t9ln6t9zlpm5th68x4f8g")
92        address_info = hww.getaddressinfo(address1)
93        assert_equal(address_info['solvable'], True)
94        assert_equal(address_info['ismine'], True)
95        assert_equal(address_info['hdkeypath'], "m/84h/1h/0h/0/0")
96
97        address2 = hww.getnewaddress(address_type="p2sh-segwit")
98        assert_equal(address2, "2N2gQKzjUe47gM8p1JZxaAkTcoHPXV6YyVp")
99        address_info = hww.getaddressinfo(address2)
100        assert_equal(address_info['solvable'], True)
101        assert_equal(address_info['ismine'], True)
102        assert_equal(address_info['hdkeypath'], "m/49h/1h/0h/0/0")
103
104        address3 = hww.getnewaddress(address_type="legacy")
105        assert_equal(address3, "n1LKejAadN6hg2FrBXoU1KrwX4uK16mco9")
106        address_info = hww.getaddressinfo(address3)
107        assert_equal(address_info['solvable'], True)
108        assert_equal(address_info['ismine'], True)
109        assert_equal(address_info['hdkeypath'], "m/44h/1h/0h/0/0")
110
111        address4 = hww.getnewaddress(address_type="bech32m")
112        assert_equal(address4, "bcrt1phw4cgpt6cd30kz9k4wkpwm872cdvhss29jga2xpmftelhqll62ms4e9sqj")
113        address_info = hww.getaddressinfo(address4)
114        assert_equal(address_info['solvable'], True)
115        assert_equal(address_info['ismine'], True)
116        assert_equal(address_info['hdkeypath'], "m/86h/1h/0h/0/0")
117
118        self.log.info('Test walletdisplayaddress')
119        for address in [address1, address2, address3]:
120            result = hww.walletdisplayaddress(address)
121            assert_equal(result, {"address": address})
122
123        assert_raises_rpc_error(
124            -4,
125            "Error: sendtoaddress and sendmany are not supported for wallets with external signers; use send instead",
126            hww.sendtoaddress,
127            self.nodes[0].getnewaddress(),
128            0.01,
129        )
130        assert_raises_rpc_error(
131            -4,
132            "Error: sendtoaddress and sendmany are not supported for wallets with external signers; use send instead",
133            hww.sendmany,
134            "",
135            {self.nodes[0].getnewaddress(): 0.01},
136        )
137
138        # Handle error thrown by script
139        self.set_mock_result(self.nodes[1], "2")
140        assert_raises_rpc_error(-1, 'RunCommandParseJSON error',
141            hww.walletdisplayaddress, address1
142        )
143        self.clear_mock_result(self.nodes[1])
144
145        # Returned address MUST match:
146        address_fail = hww.getnewaddress(address_type="bech32")
147        assert_equal(address_fail, "bcrt1ql7zg7ukh3dwr25ex2zn9jse926f27xy2jz58tm")
148        assert_raises_rpc_error(-1, 'Signer echoed unexpected address wrong_address',
149            hww.walletdisplayaddress, address_fail
150        )
151
152        self.log.info('Prepare mock PSBT')
153        self.nodes[0].sendtoaddress(address4, 1)
154        self.generate(self.nodes[0], 1)
155
156        # Load private key into wallet to generate a signed PSBT for the mock
157        self.nodes[1].createwallet(wallet_name="mock", disable_private_keys=False, blank=True)
158        mock_wallet = self.nodes[1].get_wallet_rpc("mock")
159        assert mock_wallet.getwalletinfo()['private_keys_enabled']
160
161        result = mock_wallet.importdescriptors([{
162            "desc": "tr([00000001/86h/1h/0']tprv8ZgxMBicQKsPd7Uf69XL1XwhmjHopUGep8GuEiJDZmbQz6o58LninorQAfcKZWARbtRtfnLcJ5MQ2AtHcQJCCRUcMRvmDUjyEmNUWwx8UbK/0/*)#7ew68cn8",
163            "timestamp": 0,
164            "range": [0,1],
165            "internal": False,
166            "active": True
167        },
168        {
169            "desc": "tr([00000001/86h/1h/0']tprv8ZgxMBicQKsPd7Uf69XL1XwhmjHopUGep8GuEiJDZmbQz6o58LninorQAfcKZWARbtRtfnLcJ5MQ2AtHcQJCCRUcMRvmDUjyEmNUWwx8UbK/1/*)#0dtm6drl",
170            "timestamp": 0,
171            "range": [0, 0],
172            "internal": True,
173            "active": True
174        }])
175        assert_equal(result[0], {'success': True})
176        assert_equal(result[1], {'success': True})
177        assert_equal(mock_wallet.getwalletinfo()["txcount"], 1)
178        dest = self.nodes[0].getnewaddress(address_type='bech32')
179        mock_psbt = mock_wallet.walletcreatefundedpsbt([], {dest:0.5}, 0, {'replaceable': True}, True)['psbt']
180        mock_psbt_signed = mock_wallet.walletprocesspsbt(psbt=mock_psbt, sign=True, sighashtype="ALL", bip32derivs=True)
181        mock_tx = mock_psbt_signed["hex"]
182        assert mock_wallet.testmempoolaccept([mock_tx])[0]["allowed"]
183
184        assert_equal(hww.getwalletinfo()["txcount"], 1)
185
186        assert hww.testmempoolaccept([mock_tx])[0]["allowed"]
187
188        with open(os.path.join(self.nodes[1].cwd, "mock_psbt"), "w") as f:
189            f.write(mock_psbt_signed["psbt"])
190
191        self.log.info('Test send using hww1')
192
193        # Don't broadcast transaction yet so the RPC returns the raw hex
194        res = hww.send(outputs={dest:0.5},add_to_wallet=False)
195        assert res["complete"]
196        assert_equal(res["hex"], mock_tx)
197
198        self.log.info('Test sendall using hww1')
199
200        res = hww.sendall(recipients=[{dest:0.5}, hww.getrawchangeaddress()], add_to_wallet=False)
201        assert res["complete"]
202        assert_equal(res["hex"], mock_tx)
203        # Broadcast transaction so we can bump the fee
204        hww.sendrawtransaction(res["hex"])
205
206        self.log.info('Prepare fee bumped mock PSBT')
207
208        # Now that the transaction is broadcast, bump fee in mock wallet:
209        orig_tx_id = res["txid"]
210        mock_psbt_bumped = mock_wallet.psbtbumpfee(orig_tx_id)["psbt"]
211        mock_psbt_bumped_signed = mock_wallet.walletprocesspsbt(psbt=mock_psbt_bumped, sign=True, sighashtype="ALL", bip32derivs=True)
212
213        with open(os.path.join(self.nodes[1].cwd, "mock_psbt"), "w") as f:
214            f.write(mock_psbt_bumped_signed["psbt"])
215
216        self.log.info('Test bumpfee using hww1')
217
218        # Bump fee
219        res = hww.bumpfee(orig_tx_id)
220        assert_greater_than(res["fee"], res["origfee"])
221        assert_equal(res["errors"], [])
222
223
224    def test_disconnected_signer(self):
225        self.log.info('Test disconnected external signer')
226
227        # First create a wallet with the signer connected
228        self.nodes[1].createwallet(wallet_name='hww_disconnect', disable_private_keys=True, external_signer=True)
229        hww = self.nodes[1].get_wallet_rpc('hww_disconnect')
230        assert_equal(hww.getwalletinfo()["external_signer"], True)
231
232        # Fund wallet
233        self.nodes[0].sendtoaddress(hww.getnewaddress(address_type="bech32m"), 1)
234        self.generate(self.nodes[0], 1)
235
236        # Restart node with no signer connected
237        self.log.debug(f"-signer={self.mock_no_connected_signer_path()}")
238        self.restart_node(1, [f"-signer={self.mock_no_connected_signer_path()}", "-keypool=10"])
239        self.nodes[1].loadwallet('hww_disconnect')
240        hww = self.nodes[1].get_wallet_rpc('hww_disconnect')
241
242        # Try to spend
243        dest = hww.getrawchangeaddress()
244        assert_raises_rpc_error(-25, "External signer not found", hww.send, outputs=[{dest:0.5}])
245
246    def test_invalid_signer(self):
247        self.log.debug(f"-signer={self.mock_invalid_signer_path()}")
248        self.log.info('Test invalid external signer')
249        assert_raises_rpc_error(-1, "Invalid descriptor", self.nodes[1].createwallet, wallet_name='hww_invalid', disable_private_keys=True, external_signer=True)
250

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.