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

Write FRC based on existing RPC API interface #12011

Open
rvagg opened this issue May 17, 2024 · 7 comments
Open

Write FRC based on existing RPC API interface #12011

rvagg opened this issue May 17, 2024 · 7 comments
Milestone

Comments

@rvagg
Copy link
Member

rvagg commented May 17, 2024

Write a standard's document detailing the "Filecoin Node RPC API" that can be consumed by Miner/Boost/Curio/etc. and published and conformance-tested by Lotus, Forest, Venus, etc.

@rvagg rvagg added this to the DX-Streamline milestone May 17, 2024
@rvagg rvagg added this to FilOz May 17, 2024
@jennijuju
Copy link
Member

FYI - Forest team will take a pass and have a first draft around EOM which we can contribute to later on.

@LesnyRumcajs @lemmih once you have the first draft, could you please share it here? Thanks!

@rvagg rvagg moved this to 🐱Todo in FilOz May 17, 2024
@aatifsyed
Copy link

Forest have a draft OpenRPC document - is that what you had in mind @rvagg?

@lemmih
Copy link

lemmih commented May 17, 2024

Forest have a draft OpenRPC document - is that what you had in mind @rvagg?

The V1 list contains many rarely used methods, and it would be easier to wait to standardize them. I'd like to define the set of methods required by Boost and Curio and the set of methods one can expect from a public RPC server. These methods should then be specified via OpenRPC.

@rvagg
Copy link
Member Author

rvagg commented May 20, 2024

OpenRPC might be a good place to start. We were discussing the possibility of submitting an FRC to https://github.com/filecoin-project/FIPs/tree/master/FRCs - tbh I don't recall what FRC stands for, "Filecoin Request for Comments" perhaps? It's not a FIP that requires network consensus, more like documentation of a standard that others may or may not choose to follow around something relating to Filecoin. If we can get a doc submitted to there with a basic API that nodes can conform to then we can at least start the process of having a shared space where we discuss and negotiate important API questions. It doesn't rule out implementations having their own additional APIs but there's at least a documented base set of APIs and a process for evolving them across implementations.

@f8-ptrk
Copy link
Contributor

f8-ptrk commented Jun 19, 2024

https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0001.md#fip-types

Informational (FRC) - describes a Filecoin design issue, or provides general guidelines or information to the Filecoin community, but does not propose a new feature. Informational FTPs do not necessarily represent Filecoin community consensus or a recommendation, so users and implementers are free to ignore Informational FTPs or follow their advice

pending filecoin-project/FIPs#850

https://github.com/filecoin-project/FIPs/pull/850/files#diff-5b017e89462c065ecc78ee57a49fbaef71982e54f5658e41ed558e2667a87902R68

A Filecoin Request for Comment (FRC) is an informational document which suggests standards and best practices for the Filecoin community. It may suggest rules or procedures, including other tools and protocols that best support network functionality and/or interoperability. Though FRCs are reviewed and maintained by FIP Editors, they do not need to achieve community consensus in order to be published. Individuals are responsible for the information published in FRCs, but should know that this information does not necessarily represent community preference. FRCs may contradict one another if the contradiction is justified. Network participants and implementers are welcome to ignore FRCs or follow their advice.

@BigLep BigLep moved this from 🐱Todo to ⌨️In Progress in FilOz Jul 9, 2024
@BigLep
Copy link
Member

BigLep commented Jul 9, 2024

I believe this is happening in filecoin-project/FIPs#1027 (please correct me if I'm confusing things).

@rvagg
Copy link
Member Author

rvagg commented Jul 10, 2024

And discussion @ filecoin-project/FIPs#1032

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ⌨️ In Progress
Development

No branches or pull requests

6 participants