doc: Expand scantxoutset help text to cover tr() and miniscript #27155

1. 
   instagibbs commented at 3:29 PM on February 24, 2023: member

   No description provided.

2. 
   DrahtBot commented at 3:29 PM on February 24, 2023: contributor

   <!--e57a25ab6845829454e8d69fc972939a-->

   The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	darosior
   Concept ACK	Sjors
   Stale ACK	w0xlt, achow101

   If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

3. maflcko renamed this:
   Expand scantxoutset help text to cover tr() and miniscript
   doc: Expand scantxoutset help text to cover tr() and miniscript
   on Feb 24, 2023
4. DrahtBot added the label Docs on Feb 24, 2023
5. fanquake requested review from achow101 on Feb 27, 2023
6. in src/rpc/blockchain.cpp:2112 in ca605f015d outdated

   2107 |          "    combo(<pubkey>)                      P2PK, P2PKH, P2WPKH, and P2SH-P2WPKH outputs for the given pubkey\n"
   2108 |          "    pkh(<pubkey>)                        P2PKH outputs for the given pubkey\n"
   2109 |          "    sh(multi(<n>,<pubkey>,<pubkey>,...)) P2SH-multisig outputs for the given threshold and pubkeys\n"
   2110 | +        "    tr(<pubkey>)                         P2TR\n"
   2111 | +        "    tr(<pubkey>,{pk(<pubkey>)})          P2TR with single fallback pubkey in tapscript\n"
   2112 | +        "    wsh(and_v(v:pk(<pubkey>),after(2)))  P2WSH miniscript with mandatory pubkey and a timelock\n"
   

   ---

   ---

   

   w0xlt commented at 8:28 AM on March 1, 2023:

   Could also include rawtr(<pubkey>) P2TR output with the specified key as output key.

   ---

   

   instagibbs commented at 3:49 PM on March 6, 2023:

   added a version of it, thanks

7. w0xlt approved
8. 
   w0xlt commented at 8:29 AM on March 1, 2023: contributor

   ACK https://github.com/bitcoin/bitcoin/pull/27155/commits/ca605f015dc8fbabbc6c0640d87429d6bf8f553f

9. in src/rpc/blockchain.cpp:2102 in ca605f015d outdated

   2098 | @@ -2099,13 +2099,16 @@ static RPCHelpMan scantxoutset()
   2099 |      const std::string EXAMPLE_DESCRIPTOR_RAW = "raw(76a91411b366edfc0a8b66feebae5c2e25a7b6a5d1cf3188ac)#fm24fxxy";
   2100 |  
   2101 |      return RPCHelpMan{"scantxoutset",
   2102 | -        "\nScans the unspent transaction output set for entries that match certain output descriptors.\n"
   2103 | +        "\nScans the unspent transaction output set for entries that match certain output descriptors or miniscripts.\n"
   

   ---

   ---

   

   darosior commented at 12:06 PM on March 1, 2023:

   nit: i don't think it's worth mentioning Miniscript here, and especially not as something external to descriptors.

   ---

   

   instagibbs commented at 2:16 PM on March 1, 2023:

   hmm true, will remove

   ---

   

   achow101 commented at 3:38 PM on March 6, 2023:

   @instagibbs Are you planning on changing this?

   ---

   

   instagibbs commented at 3:50 PM on March 6, 2023:

   yeah, pushed the change.

10. darosior approved
11. 
    darosior commented at 12:06 PM on March 1, 2023: member

    ACK ca605f015dc8fbabbc6c0640d87429d6bf8f553f -- thanks for improving the doc.

12. 
    Sjors commented at 12:11 PM on March 1, 2023: member

    Concept ACK. Note that the help already refers to doc/descriptors.md so it doesn't have to be super thorough.

13. 
    instagibbs commented at 2:23 PM on March 1, 2023: member

    Wondering if the help text should just give hints to what possible types there are, and point users to the doc in question to map those types to their required formats?

    Should we version the doc/descriptors.md file? By that I mean literally add details in the doc saying when specific formats were added.

14. 
    fanquake commented at 8:02 AM on March 4, 2023: member

    Should we version the doc/descriptors.md file? By that I mean literally add details in the doc saying when specific formats were added.

    cc @achow101

15. 
    achow101 commented at 3:37 PM on March 6, 2023: member

    ACK ca605f015dc8fbabbc6c0640d87429d6bf8f553f

16. 
    achow101 commented at 3:38 PM on March 6, 2023: member

    Should we version the doc/descriptors.md file? By that I mean literally add details in the doc saying when specific formats were added.

    Probably.

17. Expand scantxoutset help text to cover tr() and miniscript e4ede64fe8
18. instagibbs force-pushed on Mar 6, 2023
19. 
    instagibbs commented at 3:51 PM on March 6, 2023: member

    Ok, this is the last PR like this I'll do then; going forward we should version the doc itself with updates.

    Pushed updates.

20. darosior approved
21. 
    darosior commented at 3:53 PM on March 6, 2023: member

    webACK e4ede64fe87b1619f65da5753088d93e6f481b05

22. DrahtBot requested review from w0xlt on Mar 6, 2023
23. 
    achow101 commented at 4:14 PM on March 6, 2023: member

    ACK e4ede64fe87b1619f65da5753088d93e6f481b05

24. achow101 merged this on Mar 6, 2023
25. achow101 closed this on Mar 6, 2023

    ---

26. sidhujag referenced this in commit 6b181d668a on Mar 6, 2023
27. bitcoin locked this on Mar 5, 2024

Contributors

instagibbsDrahtBotw0xltdarosiorachow101Sjorsfanquake

Review Requested
achow101w0xlt