Bitcoin Institute

[PATCH] RPC: display existing extended-help descriptions

1 messages BitcoinTalk Jeff Garzik July 30, 2010 — July 30, 2010

Several RPC commands have multi-line help descriptions, but they do not appear to be shown anywhere.  The following patch implements a

help [command]

parameter that provides access to these extended descriptions.

Patch: http://pastebin.ca/1911586
Raw: http://pastebin.ca/raw/1911586

Here is example output for the new “help listreceivedbyaddress” sub-command:

[jgarzik@bd ~]$ /garz/repo/bitcoin/bitcoind -datadir=/garz/bitcoin/data help listreceivedbyaddress

listreceivedbyaddress [minconf=1] [includeempty=false]
[minconf] is the minimum number of confirmations before payments are included.
[includeempty] whether to include addresses that haven't received any payments.
Returns an array of objects containing:
  "address" : receiving address
  "label" : the label of the receiving address
  "amount" : total amount received by the address
  "confirmations" : number of confirmations of the most recent transaction included