doc: add "trusted" string to gettransaction help #16951

pull fanquake wants to merge 1 commits into bitcoin:master from fanquake:gettransaction_missing_trusted changing 1 files +2 −1

fanquake commented at 8:36 AM on September 24, 2019: member

The trusted field was missing from the gettransaction help. Also mark it as optional in the listtransactions help output.

src/bitcoin-cli -regtest -rpcwallet="" gettransaction 7bb085b29c57e05e20c0ff7d0587b13ab4b3e89aeea60390b084bf6a72dfcdc2 true
{
  "amount": 212.06645349,
  "confirmations": 0,
  "trusted": false,
  "txid": "7bb085b29c57e05e20c0ff7d0587b13ab4b3e89aeea60390b084bf6a72dfcdc2",
  "walletconflicts": [
    "287d8fa228ba4cf25aa358f1b0f81d23e4ac08cc32b2ef9a71282197bc8bae63",
    "514933c0cec0caf16275fa0def453cd336fad6ed86fcf88c21a117b77f44469e"
  ],
  "time": 1569310347,
<snip....>
  "hex": "02000000....."
}

doc: add "trusted" string to gettransaction help 7b2e930ff1
fanquake added the label Docs on Sep 24, 2019
fanquake added the label RPC/REST/ZMQ on Sep 24, 2019

in src/wallet/rpcwallet.cpp:1399 in 7b2e930ff1

1395 | @@ -1396,7 +1396,7 @@ UniValue listtransactions(const JSONRPCRequest& request)
1396 |              "                                         'send' category of transactions.\n"
1397 |              "    \"confirmations\": n,       (numeric) The number of confirmations for the transaction. Negative confirmations indicate the\n"
1398 |              "                                         transaction conflicts with the block chain\n"
1399 | -            "    \"trusted\": xxx,           (bool) Whether we consider the outputs of this unconfirmed transaction safe to spend.\n"
1400 | +            "    \"trusted\": xxx,           (bool, optional) Whether we consider the outputs of this unconfirmed transaction safe to spend.\n"

laanwj commented at 8:41 AM on September 24, 2019:

if this is optional, I think the help text should also mention when the value is present or not.

laanwj commented at 8:42 AM on September 24, 2019: member

Concept ACK, thanks for adding documentation
DrahtBot commented at 9:28 AM on September 24, 2019: member


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



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #16689 (rpc: add missing fields to wallet rpc help output by ariard)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
fanquake commented at 10:16 AM on September 24, 2019: member

Will be included as part of #16689. Will comment over there.
fanquake closed this on Sep 24, 2019
fanquake deleted the branch on Jan 22, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Labels

doc: add "trusted" string to gettransaction help #16951

Conflicts