Skip to content

Commit 79f7343

Browse files
committed
Merge #15757: List new RPCs in psbt.md and descriptors.md
9b085f4 Mention new descriptor RPCs in descriptors.md (Pieter Wuille) 28d78de Mention new PSBT RPCs in psbt.md (Pieter Wuille) Pull request description: The documentation in `psbt.md` and `descriptors.md` does not list new and updated RPCs (`analyzepsbt`, `utxoupdatepsbt`, `joinpsbts`, `deriveaddresses`, `getdescriptorinfo`, `listunspent`). Fix this. It'd be good to have this in 0.18 (only documentation). ACKs for commit 9b085f: fanquake: utACK 9b085f4 Tree-SHA512: ee16907e8c15351a530f11fc0a585c50835a7bf5aec997ac0e897949d9b9e41a28ddebbeaba69753fee7d2de75e518091518185085fcd1f6ada94b7231097b2e
2 parents a238fcc + 9b085f4 commit 79f7343

File tree

2 files changed

+23
-6
lines changed

2 files changed

+23
-6
lines changed

doc/descriptors.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
11
# Support for Output Descriptors in Bitcoin Core
22

3-
Since Bitcoin Core v0.17, there is support for Output Descriptors in the
4-
`scantxoutset` RPC call. This is a simple language which can be used to
5-
describe collections of output scripts.
6-
7-
This document describes the language. For the specifics on usage for scanning
8-
the UTXO set, see the `scantxoutset` RPC help.
3+
Since Bitcoin Core v0.17, there is support for Output Descriptors. This is a
4+
simple language which can be used to describe collections of output scripts.
5+
Supporting RPCs are:
6+
- `scantxoutset` takes as input descriptors to scan for, and also reports
7+
specialized descriptors for the matching UTXOs.
8+
- `getdescriptorinfo` analyzes a descriptor, and reports a canonicalized version
9+
with checksum added.
10+
- `deriveaddresses` takes as input a descriptor and computes the corresponding
11+
addresses.
12+
- `listunspent` outputs a specialized descriptor for the reported unspent outputs.
13+
14+
This document describes the language. For the specifics on usage, see the RPC
15+
documentation for the functions mentioned above.
916

1017
## Features
1118

doc/psbt.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,25 @@ hardware implementations will typically implement multiple roles simultaneously.
6767
input a PSBT, adds UTXO, key, and script data to inputs and outputs that miss
6868
it, and optionally signs inputs. Where possible it also finalizes the partial
6969
signatures.
70+
- **`utxoupdatepsbt` (Updater)** is a node RPC that takes a PSBT and updates it
71+
to include information available from the UTXO set (works only for SegWit
72+
inputs).
7073
- **`finalizepsbt` (Finalizer, Extractor)** is a utility RPC that finalizes any
7174
partial signatures, and if all inputs are finalized, converts the result to a
7275
fully signed transaction which can be broadcast with `sendrawtransaction`.
7376
- **`combinepsbt` (Combiner)** is a utility RPC that implements a Combiner. It
7477
can be used at any point in the workflow to merge information added to
7578
different versions of the same PSBT. In particular it is useful to combine the
7679
output of multiple Updaters or Signers.
80+
- **`joinpsbts`** (Creator) is a utility RPC that joins multiple PSBTs together,
81+
concatenating the inputs and outputs. This can be used to construct CoinJoin
82+
transactions.
7783
- **`decodepsbt`** is a diagnostic utility RPC which will show all information in
7884
a PSBT in human-readable form, as well as compute its eventual fee if known.
85+
- **`analyzepsbt`** is a utility RPC that examines an RPC and reports the
86+
next steps in the workflow if known, computes the fee of the resulting
87+
transaction, and estimates the weight and feerate if possible.
88+
7989

8090
### Workflows
8191

0 commit comments

Comments
 (0)