Improving the RPC help

[gdassori]

trafficstars

Hello. I have seen that both the hsw-cli and hsd-cli rpc interfaces are not documented:

$ ./hsd-cli rpc help
Select a command.

And fails badly when called with no arguments:

$ ./hsw-cli rpc
AssertionError [ERR_ASSERTION]: Assertion failed.

I would love to contribute, and I thought that addressing those issues could be a good start. However, I see there's the API unification issue (#543), and could be the reason why no one looked at this behaviours yet.

What's your takes?

[pinheadmz]

I think this has been mentioned in other issues, we have a solution upstream in bcoin that just needs to be ported over to hsd: https://github.com/bcoin-org/bcoin/pull/705

There were recent updates to hs-client that have not been released yet in a new npm version but are merged into master:

https://github.com/handshake-org/hs-client/pull/38

https://github.com/handshake-org/hs-client/pull/35

The assertion error you have here is a good catch, that's not good UX, and that should be fixed in the https://github.com/handshake-org/hs-client repo, if you feel like opening a new issue or submitting a pull request there!

[gdassori]

Ah, I see, sorry for the duplicate and thanks for the prompt response, better to check out the master instead of the last release before heading to the issue tracker :) So see you on the client repository for the assertion error, I close this one.

[pinheadmz]

Thanks for submitting! I'm actually going to re-open this to remind us to port that bcoin rpc help thing over -- its also something you could do if you feel like contributing!