filecoin-project
Write FRC based on existing RPC API interface
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.
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!
Forest have a draft OpenRPC document - is that what you had in mind @rvagg?
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.
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.
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 https://github.com/filecoin-project/FIPs/pull/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.
I believe this is happening in https://github.com/filecoin-project/FIPs/pull/1027 (please correct me if I'm confusing things).
Replacement PR opened here: https://github.com/filecoin-project/FIPs/pull/1158 with a OpenRPC spec added to the resources directory.
