docs(cli): document ping, stop, and getblockheader RPCs#1027
Conversation
|
This PR is adding the documentation for |
jaoleal
left a comment
There was a problem hiding this comment.
Hi, thanks for taking some time on this...
Also, could you separate documentation per-rpc ? that would be 3 commits
|
|
||
| Returns the string `"Floresta stopping"` to indicate that the shutdown sequence has been initiated. | ||
|
|
||
| ### Error Enum `CommandError` |
There was a problem hiding this comment.
| ### Error Enum `CommandError` | |
| ### Error Enum |
|
|
||
| Returns `null` upon successful execution. | ||
|
|
||
| ### Error Enum `CommandError` |
There was a problem hiding this comment.
| ### Error Enum `CommandError` | |
| ### Error Enum |
| - `bits` - (numeric) The compressed difficulty target for this block. | ||
| - `nonce` - (numeric) The nonce used to solve the Proof-of-Work puzzle for this block. | ||
|
|
||
| ### Error Enum `CommandError` |
There was a problem hiding this comment.
| ### Error Enum `CommandError` | |
| ### Error Enum |
d89326e to
b02e83d
Compare
|
@Husteem forgot to pass this documentation on to |
my bad, I'll do that. |
b02e83d to
f528819
Compare
f528819 to
40905b2
Compare
|
You forgot to add them to floresta-rpc |
Description and Notes
Adds RPC documentation for
ping,stop, andgetblockheaderendpoints following the established template and tone ofgetblockchaininfo.md.Part of #799
How to verify the changes have made
The documentation was verified against the Rust source in
floresta-rpcandfloresta-clicrates. Field names, return types, and command behavior were cross-referenced with the actual implementation to confirm accuracy.You can verify by running:
And comparing the output against the documented fields.
Contributor Checklist