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

doc : RPC md book documentation #389

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

elielnfinic
Copy link
Contributor

Fixes #339

@elielnfinic elielnfinic force-pushed the el/doc/rpc_doc_2 branch 2 times, most recently from 21c5f93 to 9adfea4 Compare February 11, 2025 07:44
@elielnfinic elielnfinic changed the title RPC md book documentation doc : RPC md book documentation Feb 11, 2025
@elielnfinic elielnfinic marked this pull request as ready for review February 11, 2025 11:03
Copy link
Collaborator

@dan-da dan-da left a comment

Choose a reason for hiding this comment

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

looks pretty good overall. thanks for writing this up.

I will likely have some additional edits before (or soon after) merging. and/or I might have more comments/suggestions later. I only had time for a quick once-over just now.

The RPC server provides several methods that allow clients to interact with the node. The list of methods and examples are provided on the [`neptune-cash` crate documentation](https://docs.rs/neptune-cash/latest/neptune_cash/rpc_server/trait.RPC.html).

## RPC consistency guarantees
State that can be queried via RPCs is guaranteed to be at least up-to-date with the chain state immediately prior to the call's execution. However, the state returned by RPCs that reflect the mempool may not be up-to-date with the current mempool state.
Copy link
Collaborator

Choose a reason for hiding this comment

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

is that true about the mempool?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I might be wrong. Please educate me on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add mdbook docs for RPC API and improve doc-comments.
3 participants