-
Notifications
You must be signed in to change notification settings - Fork 157
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
Document RPC implementation status #4129
Merged
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e89f87a
Add rpc docs page
ansermino 150903e
fmt and fix colour
ansermino c5485bd
Replces api status with project link
ansermino c36e80e
Merge branch 'main' into ansermino/rpc-docs
ansermino 0e16034
Stylize slack channel
ansermino 7972f08
Remove unused css
ansermino File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<style> | ||
.notImp {background-color: #1f1fff; padding: 0 5px;} | ||
.partSupp {background-color: #9d00ec; padding: 0 5px;} | ||
.supp {background-color: #0c7326; padding: 0 5px;} | ||
.plan {background-color: #ce4d00; padding: 0 5px;} | ||
</style> | ||
|
||
# JSON-RPC API | ||
|
||
<div class="warning"> | ||
|
||
This API is still a WIP, with more methods being added continuously. | ||
|
||
Need a specific method? Let us know on | ||
[Github](https://github.com/ChainSafe/forest/issues) or Slack (#fil-forest-help) | ||
ansermino marked this conversation as resolved.
Show resolved
Hide resolved
|
||
🙏 | ||
|
||
</div> | ||
|
||
# Overview | ||
|
||
The RPC interface is the primary mechanism for interacting with Forest. The | ||
implementation is still a WIP, with support for more methods being added | ||
continuously. | ||
|
||
As there is presently no cross-client specification, the Lotus | ||
[V0](https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v0-methods.md) | ||
and | ||
[V1](https://github.com/filecoin-project/lotus/blob/master/documentation/en/api-v1-unstable-methods.md) | ||
APIs are the reference for Forest's implementation. | ||
|
||
# Supported Methods | ||
|
||
We currently track all methods and their implementation state | ||
[here](https://github.com/orgs/ChainSafe/projects/29). |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to add it to the README for discoverability?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes! I would like to make some bigger changes to the readme. Opened this as a starting point: #4219