docs(cli): document getroots, getpeerinfo, and uptime RPCs#1028
Merged
Davidson-Souza merged 1 commit intoMay 18, 2026
Conversation
Collaborator
|
You also need to pass this documentation through to |
jaoleal
reviewed
May 5, 2026
Member
jaoleal
left a comment
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
| - `state` - (string) The current state of this peer. Can be "Ready" (fully handshaked and active), "Awaiting" (still establishing connection), or "Banned" (connection rejected/dropped). | ||
| - `transport_protocol` - (string) The transport protocol used to communicate with the peer (e.g., "V1" or "V2"). | ||
|
|
||
| ### Error Enum `CommandError` |
Member
There was a problem hiding this comment.
Suggested change
| ### Error Enum `CommandError` | |
| ### Error Enum |
|
|
||
| Returns a numeric value representing the number of seconds that the node has been running. | ||
|
|
||
| ### Error Enum `CommandError` |
Member
There was a problem hiding this comment.
Suggested change
| ### Error Enum `CommandError` | |
| ### Error Enum |
|
|
||
| Returns a JSON array of strings representing the actual hex-encoded roots of the utreexo accumulator. | ||
|
|
||
| ### Error Enum `CommandError` |
Member
There was a problem hiding this comment.
Suggested change
| ### Error Enum `CommandError` | |
| ### Error Enum |
Member
|
Can you make this a single commit ? |
Contributor
Author
Member
|
Squash this pr in a single commit |
Husteem
force-pushed
the
docs/rpc-cleanup-part1
branch
from
d5f1f13 to
84b0a99
Compare
Contributor
Author
|
hi, dose it looks good now? |
Member
|
You forgot to add them to floresta-rpc too |
Husteem
force-pushed
the
docs/rpc-cleanup-part1
branch
from
84b0a99 to
40cca42
Compare
jaoleal
approved these changes
May 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description and Notes
Adds RPC documentation for
getroots,getpeerinfo, anduptimeendpoints following the established template and tone ofgetblockchaininfo.md.Part of #799
How to verify the changes done?
The documentation was verified against a live
florestadnode running onregtest. Field names, return types, and enum values (peer connection states, transport protocols) were cross-referenced with the Rust source infloresta-rpcandfloresta-wirecrates to confirm accuracy.You can verify by running:
And comparing the output against the documented fields.
Contributor Checklist