Skip to content

docs(cli): document ping, stop, and getblockheader RPCs#1027

Open
Husteem wants to merge 1 commit into
getfloresta:masterfrom
Husteem:docs/rpc-cleanup-part2
Open

docs(cli): document ping, stop, and getblockheader RPCs#1027
Husteem wants to merge 1 commit into
getfloresta:masterfrom
Husteem:docs/rpc-cleanup-part2

Conversation

@Husteem
Copy link
Copy Markdown

@Husteem Husteem commented May 5, 2026

Description and Notes

Adds RPC documentation for ping, stop, and getblockheader endpoints following the established template and tone of getblockchaininfo.md.

Part of #799

How to verify the changes have made

The documentation was verified against the Rust source in floresta-rpc and floresta-cli crates. Field names, return types, and command behavior were cross-referenced with the actual implementation to confirm accuracy.

You can verify by running:

floresta-cli ping
floresta-cli stop
floresta-cli getblockheader <block_hash>

And comparing the output against the documented fields.

Contributor Checklist

@moisesPompilio
Copy link
Copy Markdown
Collaborator

This PR is adding the documentation for getblockheader here: #1006, so I think it would be better to remove that from your PR. Also, you forgot to pass this documentation on to floresta-cli and floresta-rpc.

@moisesPompilio moisesPompilio added the documentation Improvements or additions to documentation label May 5, 2026
@moisesPompilio moisesPompilio added this to the Q2/2026 milestone May 5, 2026
@github-project-automation github-project-automation Bot moved this to Backlog in Floresta May 5, 2026
@moisesPompilio moisesPompilio moved this from Backlog to Needs review in Floresta May 5, 2026
@moisesPompilio moisesPompilio self-requested a review May 5, 2026 13:46
@jaoleal jaoleal self-requested a review May 5, 2026 20:45
Copy link
Copy Markdown
Member

@jaoleal jaoleal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for taking some time on this...

Also, could you separate documentation per-rpc ? that would be 3 commits

Comment thread doc/rpc/stop.md Outdated

Returns the string `"Floresta stopping"` to indicate that the shutdown sequence has been initiated.

### Error Enum `CommandError`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Error Enum `CommandError`
### Error Enum

Comment thread doc/rpc/ping.md Outdated

Returns `null` upon successful execution.

### Error Enum `CommandError`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Error Enum `CommandError`
### Error Enum

Comment thread doc/rpc/getblockheader.md Outdated
- `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`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Error Enum `CommandError`
### Error Enum

@Husteem Husteem force-pushed the docs/rpc-cleanup-part2 branch from d89326e to b02e83d Compare May 8, 2026 11:47
Copy link
Copy Markdown
Member

@jaoleal jaoleal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ping.md is present on both commits

jaoleal

This comment was marked as outdated.

@moisesPompilio
Copy link
Copy Markdown
Collaborator

@Husteem forgot to pass this documentation on to floresta-cli and floresta-rpc.

@Husteem
Copy link
Copy Markdown
Author

Husteem commented May 8, 2026

@Husteem forgot to pass this documentation on to floresta-cli and floresta-rpc.

my bad, I'll do that.
i will make a PR once I get clarification on my mentioned comment.

@Husteem Husteem force-pushed the docs/rpc-cleanup-part2 branch from b02e83d to f528819 Compare May 12, 2026 14:38
@Husteem Husteem force-pushed the docs/rpc-cleanup-part2 branch from f528819 to 40905b2 Compare May 12, 2026 14:44
@jaoleal
Copy link
Copy Markdown
Member

jaoleal commented May 13, 2026

You forgot to add them to floresta-rpc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Needs review

Development

Successfully merging this pull request may close these issues.

3 participants