doc: Add missing supported rpcs to doc/descriptors.md #18025

andrewtoth commented at 3:47 AM on January 30, 2020: contributor

Improve descriptor docs by adding missing rpcs.

fanquake added the label Docs on Jan 30, 2020

andrewtoth force-pushed on Jan 30, 2020

laanwj commented at 1:40 PM on January 30, 2020: member

Thanks for adding documentation. The list looks good to me. ACK b7982c92df44d0b526c5db57019a455edd933deb

Sjors commented at 3:12 PM on January 30, 2020: member

ACK b7982c9, though there's also generatetodescriptor (regtest only).

andrewtoth commented at 3:18 PM on January 30, 2020: contributor

@Sjors I wasn't sure if I should add that since it's hidden.

Sjors commented at 3:22 PM on January 30, 2020: member

@andrewtoth it's not really hidden; if you start bitcoind -regtest it's listed with bitcoin-cli help. The audience for this particular document is probably developers.

in doc/descriptors.md:17 in b7982c92df outdated

   9 | @@ -10,6 +10,11 @@ Supporting RPCs are:
  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 | +- `getaddressinfo` - returns a descriptor for solvable addresses. (Since v0.18)
  14 | +- `importmulti` - takes as input an array of descriptors and imports them into
  15 | +  the wallet. (Since v0.18)
  16 | +- `utxoupdatepsbt` - takes as input an array of descriptors and adds information
  17 | +  to the psbt. (Since v0.19)

jonatack commented at 3:27 PM on January 30, 2020:

nit x 3: s/. (Since v.0.19)/ (since v0.19)./

jonatack commented at 3:32 PM on January 30, 2020: contributor

Concept ACK. I agree with @Sjors wrt #18025 (comment). Should the eight rpcs be listed in alphabetical order, or some other type of ordering?

andrewtoth commented at 3:54 PM on January 30, 2020: contributor

@Sjors Updated to add generatetodescriptor. @jonatack I added them in order of earliest version to be supported, and then the order they appear in help.

Sjors commented at 3:54 PM on January 30, 2020: member

Thanks, 5024291a86296cd69ff1e12a44625ff67a0d86bf looks good, but please squash those two commits into one.

andrewtoth force-pushed on Jan 30, 2020

andrewtoth commented at 4:16 PM on January 30, 2020: contributor

squashed

emilengler commented at 4:52 PM on January 30, 2020: contributor

ACK 7347fe57eef4b4da0cf9df1657b4688cb3aed54a

nit: Maybe it would be better to use v0.19.0.1 to avoid confusion

andrewtoth commented at 5:01 PM on January 30, 2020: contributor

nit: Maybe it would be better to use v0.19.0.1 to avoid confusion @emilengler as Sjors pointed out this document is mainly for developers, so I doubt this will cause any confusion. It's also technically true, even though v0.19.0 didn't get an official release.

Sjors commented at 5:48 PM on January 30, 2020: member

ACK 7347fe5

in doc/descriptors.md:18 in 7347fe57ee outdated

   9 | @@ -10,6 +10,13 @@ Supporting RPCs are:
  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 | +- `getaddressinfo` - outputs a descriptor for solvable addresses (since v0.18).
  14 | +- `importmulti` - takes as input descriptors to import into the wallet
  15 | +  (since v0.18).
  16 | +- `generatetodescriptor` - takes as input a descriptor and generates coins to it
  17 | +  (`regtest` only, since v0.19).
  18 | +- `utxoupdatepsbt` - takes as input descriptors to add information to the psbt

jonatack commented at 9:18 PM on January 30, 2020:

Apologies for not seeing it before, but the new entries add a hyphen (" - ") between the rpc name and the description which the existing entries do not have.

andrewtoth commented at 11:35 PM on January 30, 2020:

Huh wonder why I thought there were hyphens... anyways fixed.

jonatack commented at 9:22 PM on January 30, 2020: contributor

ACK 7347fe5 modulo comment (sorry, feel free to ignore). I think the major+minor release versions are sufficient and encompass all patch versions.

Add missing supported rpcs to doc/descriptors.md c7ec9a1888

andrewtoth force-pushed on Jan 30, 2020

fanquake approved

fanquake commented at 12:38 AM on January 31, 2020: member

ACK c7ec9a18888e040a2e1de2cc740a6ef0372d336d - I think this has been bikeshed enough.

jonatack commented at 12:41 AM on January 31, 2020: contributor

ACK c7ec9a18888e040a2e1de2cc740a6ef0372d336d

fanquake referenced this in commit 3e1bf71064 on Jan 31, 2020

fanquake merged this on Jan 31, 2020

fanquake closed this on Jan 31, 2020

emilengler commented at 2:07 PM on March 7, 2020: contributor

@vova557 Welcome to Bitcoin Core but please speak English so we can all understand you ;)