[RPC] getblock: Added help text for chainwork value #7232

pull instagibbs wants to merge 1 commits into bitcoin:master from instagibbs:getblockhelp changing 1 files +1 −0

instagibbs commented at 7:09 PM on December 18, 2015: member

I took the text from bitcoin.org's description. @harding Is this originally from there?

edit: Changed the wording
instagibbs renamed this:
~~Added help text for chainwork value~~
[RPC] Added help text for chainwork value
on Dec 18, 2015
harding commented at 9:58 PM on December 18, 2015: contributor

@instagibbs yes; that description was written by me based upon my reading of the code.
jonasschnelli added the label Docs and Output on Dec 19, 2015
fanquake commented at 12:43 AM on December 24, 2015: member

ACK
instagibbs renamed this:
~~[RPC] Added help text for chainwork value~~
[RPC] getblock: Added help text for chainwork value
on Jan 4, 2016
in src/rpcblockchain.cpp:None in 631cfe7758 outdated
```
 383 | @@ -384,6 +384,7 @@ UniValue getblock(const UniValue& params, bool fHelp)
 384 |              "  \"nonce\" : n,           (numeric) The nonce\n"
 385 |              "  \"bits\" : \"1d00ffff\", (string) The bits\n"
 386 |              "  \"difficulty\" : x.xxx,  (numeric) The difficulty\n"
 387 | +            "  \"chainwork\" : \"xxxx\",  (string) The estimated number of block header hashes checked from the genesis block to this block, in hexadecimal\n"
```
MarcoFalke commented at 6:39 PM on January 4, 2016:

I don't understand this sentence. I like (string) Expected number of hashes required to produce the current chain (in hex) better.

instagibbs commented at 7:25 PM on January 4, 2016:

What don't you understand about it specifically? Would:

(string) Expected number of hashes required to produce the chain up to this block (in hex)

be better? As-is it's ambiguous to what "current chain" means. In getblockchaininfo it clearly means the valid chain with most work.

MarcoFalke commented at 8:48 PM on January 4, 2016:

block header hashes

is not immediately clear what this means. Usually blocks with hashes that don't hit the diff are not considered valid, so they are not counted. Then "estimated" gives the hint that they are counted as well.

MarcoFalke commented at 8:49 PM on January 4, 2016:

@instagibbs I like your suggestion as well.
instagibbs commented at 4:42 PM on January 11, 2016: member

Updated wording re: @MarcoFalke comments.
Added help text for chainwork value 94bdd71f9b
instagibbs force-pushed on Jan 11, 2016
MarcoFalke commented at 6:05 PM on January 11, 2016: member

utACK 94bdd71f9b4768c9803ffd133aa7781b19bfa6f9
laanwj merged this on Jan 18, 2016
laanwj closed this on Jan 18, 2016
laanwj referenced this in commit ae20172941 on Jan 18, 2016
laanwj referenced this in commit c0d2382170 on Jan 18, 2016
laanwj commented at 11:21 AM on January 18, 2016: member

utACK
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels