bitcoin: rpc: doc: RPCHelpMan missing request parameters for getblocktemplate

Motivation

The getblocktemplate help currently shows these available request parameters (as part of the template_request object):

$ ./bitcoin-cli help getblocktemplate

$ ./bitcoin-cli help getblocktemplate

...

Arguments:
1. template_request         (json object, optional, default={}) Format of the template
     {
       "mode": "str",       (string, optional) This must be set to "template", "proposal" (see BIP 23), or omitted
       "capabilities": [    (json array, optional) A list of strings
         "str",             (string) client side supported feature, 'longpoll', 'coinbasevalue', 'proposal', 'serverlist', 'workid'
         ...
       ],
       "rules": [           (json array, required) A list of strings
         "segwit",          (string, required) (literal) indicates client side segwit support
         "str",             (string) other client side supported softfork deployment
         ...
       ],
     }
...

It seems two (optional) parameters are missing: longpollid and data.

Possible solution

Seems like a good first issue to me:

Understand what both parameters do, their type etc.
Add two entries to the template_request object, with a helpful concise description, and consider their optional status
Verify output is correct by calling ./bitcoin-cli help getblocktemplate

Useful Skills

No response

Guidance for new contributors

Want to work on this issue?

For guidance on contributing, please read CONTRIBUTING.md before opening your pull request.

About this issue

Original URL
State: closed
Created a year ago
Comments: 15 (13 by maintainers)

Commits related to this issue

Added `longpollid` and `data` params to `template_request` in `getblocktemplate` #27998 — committed to ItIsOHM/bitcoin by ItIsOHM a year ago
Deleted stray file `vcpkg` Added `longpollid` and `data` params to `template_request` in `getblocktemplate` #27998 Fixed descriptions for `longpollid` and `data` — committed to ItIsOHM/bitcoin by ItIsOHM a year ago
Added `longpollid` and `data` params to `template_request` #27998 Added `longpollid` and `data` params to `template_request` in `getblocktemplate` #27998 — committed to ItIsOHM/bitcoin by ItIsOHM a year ago
Added `longpollid` and `data` params to `template_request` #27998 Added `longpollid` and `data` params to `template_request` in `getblocktemplate` #27998 — committed to ItIsOHM/bitcoin by ItIsOHM a year ago
Merge bitcoin/bitcoin#28056: rpc: doc: Added `longpollid` and `data` params to `template_request` f6a26196cfb7e2c90e25f82b0e2f569a05013cae Added `longpollid` and `data` params to `template_request` #... — committed to bitcoin/bitcoin by fanquake a year ago
Merge bitcoin/bitcoin#28056: rpc: doc: Added `longpollid` and `data` params to `template_request` f6a26196cfb7e2c90e25f82b0e2f569a05013cae Added `longpollid` and `data` params to `template_request` #... — committed to syscoin/syscoin by fanquake a year ago
Added `longpollid` and `data` params to `template_request` #27998 Added `longpollid` and `data` params to `template_request` in `getblocktemplate` #27998 Github-Pull: #28056 Rebased-From: f6a26196cf... — committed to luke-jr/bitcoin by ItIsOHM a year ago

Most upvoted comments

hey i am a newbie can anyone guide me what to do next to become a first contributor (this is my first project)

Hi @iemafzalhassan (and other future contributors), I suggest the articles section of https://jonatack.github.io.

jonatack on Jul 9, 2023

hey i am a newbie can anyone guide me what to do next to become a first contributor (this is my first project)

Hi @iemafzalhassan (and other future contributors), I suggest the articles section of https://jonatack.github.io.

Thanks a lot for this @jonatack!

ItIsOHM on Jul 9, 2023

hey i am a newbie can anyone guide me what to do next to become a first contributor (this is my first project)

Hi @iemafzalhassan (and other future contributors), I suggest the articles section of https://jonatack.github.io.

Thnkew so much 🤩🥳

iemafzalhassan on Jul 9, 2023

Yeah the approach is good. Great, have a look and then for further implementation feedback I’d suggest you open a PR with the code changes (definitely worth going through CONTRIBUTING.md first).

stickies-v on Jul 4, 2023

Update: I downloaded and installed Bitcoin Core, which then helped me to run bitcoind and bitcoin-cli. I’ll try to make the changes to a new branch 😄

ItIsOHM on Jul 3, 2023

Absolutely, just open the PR whenever you feel ready, or ask away here if you have any problems you can’t figure out.

stickies-v on Jul 3, 2023