doc: Remove field in getblocktemplate help that has never been used. #12764

1. 
   conscott commented at 5:44 am on March 23, 2018: contributor

   BIP 22 - getblocktemplate specifies an optional flag, required if the transaction must be in the block.

   Luke’s implementation #936 did not include this flag, and it was later added to the help description in #3246 (more than a year later) but the field was still never actually implemented. As far as I can tell, bitcoin core would have never actually included this in a getblocktemplate call, so it seems logical to remove it from the help description.

   If I am missing something or this is considered harmless - I can close the PR.

2. fanquake added the label RPC/REST/ZMQ on Mar 23, 2018
3. fanquake added the label Mining on Mar 23, 2018
4. conscott force-pushed on Mar 23, 2018
5. conscott force-pushed on Mar 23, 2018
6. 
   instagibbs commented at 3:53 pm on March 23, 2018: member

   kicked travis, random timeout
7. conscott force-pushed on Mar 24, 2018
8. conscott force-pushed on Mar 24, 2018
9. [RPC] Remove field in getblocktemplate help that has never been used ac8a1d092e
10. conscott force-pushed on Mar 26, 2018
11. 
    laanwj commented at 7:49 pm on March 27, 2018: member

    Interesting, good catch. Though personally I think it makes sense to describe this possible field if it is in BIP22. Both for consistency with our documentation and the BIP, and in case core would ever want to set this flag, you’d want client implementations to take it into account. On the other hand that’s probably very unlikely. Needs more discussion.
12. 
    jnewbery commented at 8:05 pm on March 27, 2018: member

    Tested ACK ac8a1d092ef59b141605f6eaf027c034dad910e6
13. 
    luke-jr commented at 5:01 pm on June 12, 2018: member

    Anyone writing a client should read BIP22 and consider all its possible fields. IMO either we should document potentially-relevant ones in help, or only refer to the BIP instead.
14. 
    MarcoFalke commented at 7:20 pm on June 12, 2018: member

    utACK ac8a1d0. It would be misleading to mention the field here and then ignore it without notice.
15. 
    DrahtBot commented at 5:28 pm on July 21, 2018: member
16. DrahtBot closed this on Jul 21, 2018

    ---

17. DrahtBot reopened this on Jul 21, 2018

    ---

18. MarcoFalke renamed this:
    Remove field in getblocktemplate help that has never been used.
    doc: Remove field in getblocktemplate help that has never been used.
    on Jul 21, 2018
19. MarcoFalke added the label Docs on Jul 21, 2018
20. MarcoFalke merged this on Jul 22, 2018
21. MarcoFalke closed this on Jul 22, 2018

    ---

22. MarcoFalke referenced this in commit 10b9a811b6 on Jul 22, 2018
23. conscott deleted the branch on Jul 31, 2018
24. deadalnix referenced this in commit 310321ec95 on May 8, 2020
25. PastaPastaPasta referenced this in commit 91c63934d4 on Jul 17, 2020
26. PastaPastaPasta referenced this in commit bccd4d113c on Jul 17, 2020
27. PastaPastaPasta referenced this in commit 2aa30a70e8 on Jul 17, 2020
28. MarcoFalke locked this on Sep 8, 2021

Contributors
conscott instagibbs laanwj jnewbery luke-jr MarcoFalke DrahtBot

Labels
Docs RPC/REST/ZMQ Mining