Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rpcwallet: Add missing transaction categories to rpc helptexts #14653

Merged
merged 2 commits into from Dec 20, 2018

Conversation

Projects
None yet
10 participants
@andrewtoth
Copy link
Contributor

commented Nov 5, 2018

The current helptext for listtransactions, listsinceblock and gettransaction only list two of the five possible options for category. This incorrectly implies that these are the only two options, and can cause problems if the other three options aren't accounted for. Also, some of the documentation is incorrect when specifying which options are returned for which categories.

This PR updates the helptext for these RPCs and adds a functional regression test for the cases when the other three categories are returned.

@DrahtBot

This comment has been minimized.

Copy link
Contributor

commented Nov 5, 2018

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

Conflicts

No conflicts as of last run.

Coverage

Coverage Change (pull 14653) Reference (master)
Lines +0.0176 % 87.0960 %
Functions -0.0612 % 84.3822 %
Branches +0.0122 % 51.5722 %

Updated at: 2018-11-05T21:23:44.257742.

Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated
@meshcollider

This comment has been minimized.

Copy link
Member

commented Nov 6, 2018

Thanks, utACK 31066f5
The listsinceblock RPC helptext also still refers to the 'move' category which was removed when accounts were, you could fix that up too in the same commit if you want :)

@andrewtoth andrewtoth force-pushed the andrewtoth:listtransactions-help branch Nov 7, 2018

@andrewtoth

This comment has been minimized.

Copy link
Contributor Author

commented Nov 7, 2018

@meshcollider done. Also updated the gettransaction help.

@meshcollider

This comment has been minimized.

Copy link
Member

commented Nov 11, 2018

LGTM, re-utACK 4a78c48

Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated

@andrewtoth andrewtoth force-pushed the andrewtoth:listtransactions-help branch Nov 13, 2018

@andrewtoth

This comment has been minimized.

Copy link
Contributor Author

commented Nov 13, 2018

@promag Reformatted help docs, added tests for all rpcs that have transaction category.

@andrewtoth andrewtoth force-pushed the andrewtoth:listtransactions-help branch Nov 14, 2018

@andrewtoth andrewtoth changed the title Add all category options to listtransactions help Add all transaction category options to rpc helptexts Nov 17, 2018

@andrewtoth andrewtoth changed the title Add all transaction category options to rpc helptexts Add missing transaction category options to rpc helptexts Nov 17, 2018

@andrewtoth andrewtoth changed the title Add missing transaction category options to rpc helptexts Add missing transaction categories to rpc helptexts Nov 17, 2018

@chris-belcher

This comment has been minimized.

Copy link
Contributor

commented Nov 18, 2018

ACK a2c555d

@andrewtoth

This comment has been minimized.

Copy link
Contributor Author

commented Nov 20, 2018

@promag Are the formatting and tests ok?

@meshcollider Sorry to keep invalidating your utACKs. I updated to include category tests for all 3 rpcs.

Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated

@andrewtoth andrewtoth force-pushed the andrewtoth:listtransactions-help branch 5 times, most recently Nov 21, 2018

Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated
Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated
Show resolved Hide resolved src/wallet/rpcwallet.cpp Outdated

@andrewtoth andrewtoth force-pushed the andrewtoth:listtransactions-help branch Nov 23, 2018

@ryanofsky
Copy link
Contributor

left a comment

utACK f3f6dde. Clearly a good change. It cleans up inaccurate documentation and adds a test.

@ryanofsky

This comment has been minimized.

Copy link
Contributor

commented Dec 18, 2018

This looks like it could be merged.

@promag

This comment has been minimized.

Copy link
Member

commented Dec 18, 2018

utACK f3f6dde.

@luke-jr

This comment has been minimized.

Copy link
Member

commented Dec 20, 2018

utACK

@MarcoFalke MarcoFalke changed the title Add missing transaction categories to rpc helptexts rpcwallet: Add missing transaction categories to rpc helptexts Dec 20, 2018

@MarcoFalke MarcoFalke merged commit f3f6dde into bitcoin:master Dec 20, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

MarcoFalke added a commit that referenced this pull request Dec 20, 2018

Merge #14653: rpcwallet: Add missing transaction categories to rpc he…
…lptexts

f3f6dde Test coinbase category in wallet rpcs (andrewtoth)
e982f0b Add all category options to wallet rpc help (andrewtoth)

Pull request description:

  The current helptext for `listtransactions`, `listsinceblock` and `gettransaction` only list two of the five possible options for `category`. This incorrectly implies that these are the only two options, and can cause problems if the other three options aren't accounted for. Also, some of the documentation is incorrect when specifying which options are returned for which categories.

  This PR updates the helptext for these RPCs and adds a functional regression test for the cases when the other three categories are returned.

Tree-SHA512: 67dd7ff6269a3b0f17f5d1a61b0ae1fb1f3778f05e1c440bfbb9b3a005c9c6d740abcace20f3d597cf2bd6779c494448690f13fab0bd2340f206213bc7890b51

@andrewtoth andrewtoth deleted the andrewtoth:listtransactions-help branch Apr 29, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.