FIPs icon indicating copy to clipboard operation
FIPs copied to clipboard

Common Node API

Open ansermino opened this issue 1 year ago • 7 comments

A work-in-progress to establish a common API for all node implementations.

Many todos remain at this point, most notably:

  • Further discussion on which methods are included and the associated rationale
  • Sufficient conformance testing to validate implementations are adherent to the specification

ansermino avatar Jun 27 '24 18:06 ansermino

@filecoin-project/lotus-maintainers 👀 plz

jennijuju avatar Jun 27 '24 22:06 jennijuju

IMO, this should go under the FRC section instead of the FIP section as it's not a consensus critical change (and therefore doesn't have to go through the entire FIP process).

Stebalien avatar Jun 27 '24 22:06 Stebalien

I am supportive of the motivation and direction of this proposal. Will give a more thorough review once the methods list are proposed

jennijuju avatar Jun 27 '24 22:06 jennijuju

FWIW, I think this is a great idea.

Stebalien avatar Jun 27 '24 22:06 Stebalien

IMO, this should go under the FRC section instead of the FIP section as it's not a consensus critical change (and therefore doesn't have to go through the entire FIP process).

@Stebalien We chose to be a technical FIP based on this guidance: https://github.com/filecoin-project/FIPs/blob/020bcb412ee20a2879b4a710337959c51b938d3b/FIPS/fip-0001.md?plain=1#L30

Happy to move to FRC if that fits better - maybe the above could be amended?

aatifsyed avatar Jul 02 '24 14:07 aatifsyed

I am supportive of the motivation and direction of this proposal. Will give a more thorough review once the methods list are proposed

🙏 @jennijuju

We have a working doc with all the methods here: https://docs.google.com/spreadsheets/d/1fFkQuEjvFAd2s1dGX5zGmhxsEMLMUZ4uQFnIXgSZA5w/edit?usp=sharing

A few methods we're still unsure of, but we've taken a stance of most of them. Rationale is included for those that are excluded, and those that are included should fit into one of the categories we describe

ansermino avatar Jul 02 '24 19:07 ansermino

Since GitHub didn't backlink it, the accompanying discussion for this PR is https://github.com/filecoin-project/FIPs/discussions/1032

BigLep avatar Jul 12 '24 14:07 BigLep

2025-05-12 conversation with FilOz and Chainsafe:

  • Need to add OpenAPI json spec
  • Chainsafe will open a new PR

BigLep avatar May 12 '25 15:05 BigLep

The Forest team is going to open this PR fresh since the original authors are no longer around. We're 95% of the way with this PR and just want to get something merged at this stage.

I'm assigning number 0104 to this FRC. @AlexeyKrasnoperov @LesnyRumcajs please use that number in your new PR.

rvagg avatar May 12 '25 16:05 rvagg

Closing this PR. @AlexeyKrasnoperov will create a brand new one.

LesnyRumcajs avatar May 14 '25 19:05 LesnyRumcajs

Replacement PR: https://github.com/filecoin-project/FIPs/pull/1158

BigLep avatar May 27 '25 18:05 BigLep