Commit Graph

11 Commits

Author SHA1 Message Date
woltx
bd5a32f7db doc: add taproot descriptor to getdescriptors example
Wallets import descriptors for all supported address types in a
BIP44/49/84/86 compatible manner, so show the BIP86 tr() descriptor in
the example response as well.
2026-06-11 10:33:08 -07:00
woltx
7131c82937 doc: clarify which commands receive --chain, --fingerprint and --stdin
Bitcoin Core passes --chain and --fingerprint to every signer command
except enumerate, so mark them "(required except for enumerate)" and
name the current commands only as examples. Keep --stdin documented as
required for all commands so the interface stays flexible, noting that
Bitcoin Core currently only uses it for signtx.

Add the missing flags to the getdescriptors and displayaddress usage
examples and the corresponding doxygen comments, matching the order and
form of the actual invocations, add testnet4 to the chain name lists,
and drop the getaddressinfo implementation detail from the
walletdisplayaddress description.
2026-06-11 10:33:03 -07:00
woltx
4fdd4d8d29 doc: replace stale signtransaction wording with current signtx flow
The protocol documentation still described a "signtransaction" command
driven by sendtoaddress and sendmany. Those RPCs never gained external
signer support: it was effectively precluded by #21201, which was
merged a few days before external signer support landed in #16546, so
the interaction was missed in review (#33112 has a commit making the
rejection explicit). Spending from an external signer wallet uses
send/sendall (and bumpfee for fee-bumping), which invoke the signer
with `<cmd> --stdin` and pass the `signtx` subcommand and PSBT over
stdin.

Update the spending example and the protocol description accordingly,
using `bitcoin rpc` for the example since it enables -named by default.
2026-06-11 10:32:24 -07:00
woltx
fab92257fe doc, rpc: document enumerate model field and fingerprint deduplication
The external signer "enumerate" response uses the optional "model"
field, not "name". Document that Bitcoin Core maps it to the "name"
field of the enumeratesigners RPC result, and that signers with
duplicate master key fingerprints are skipped.

Also document that wallet operations require exactly one connected
signer.

Co-authored-by: optout <13562139+optout21@users.noreply.github.com>
Co-authored-by: naiyoma <lankas.aurelia@gmail.com>
2026-06-11 10:32:01 -07:00
Danny van Heumen
3381855e51 doc: external signer: update interface, --stdin flag, IPC-command signtx, contains updates from #33947 2026-05-15 01:41:05 +02:00
Ryan Ofsky
258bda80c0 doc: Mention bitcoin wrapper executable in documentation 2025-05-12 14:49:17 -04:00
Sjors Provoost
dc55531087 wallet: compare address returned by displayaddress
Update external signer documentation to reflect this requirement, which HWI already implements.
2024-04-16 17:47:43 +02:00
Sjors Provoost
b54b2e7b1a Move external signer out of wallet module
This commit moves the ExternalSigner class and RPC methods out of the wallet module.

The enumeratesigners RPC can be used without a wallet since #21417.
With additional modifications external signers could be used without a wallet in general, e.g. via signrawtransaction.

The signerdisplayaddress RPC is ranamed to walletdisplayaddress because it requires wallet context.
A future displayaddress RPC call without wallet context could take a descriptor argument.

This commit fixes a rpc_help.py failure when configured with --disable-wallet.
2021-04-08 17:56:00 +02:00
Sjors Provoost
57ff5a42ab doc: specify minimum HWI version 2021-03-11 15:26:50 +01:00
Hennadii Stepanov
8b08d0f2a5 build, doc: Fix configure script output indentation and typos 2021-02-24 12:28:35 +02:00
Sjors Provoost
f75e0c1edd doc: add external-signer.md 2021-02-23 14:34:32 +01:00