Closed LesnyRumcajs closed 5 days ago
Notes before our first handover meeting:
forest/#4677
and
forest/#4692
,
we have an OpenRPC description for every method in the list.v0
and v1
:
forest-tool shed openrpc --path ...
,
and most of our methods are on v0
.
There is some evidence that
there are meaningful differences between v0
and v1
,
but also some evidence
that there isn't.tool openrpc select ...
subcommand in the `filecoin-common-node-api repo,
which takes a single OpenRPC document as input,
intended to produce a spec.v0
only
(we should only care about v1
methods).v1
API (#4678),
at least for the methods in the list, that we test in CI,
and use tool openrpc select ...
to dump the spec.test-suite
.
This can be done bit-by-bit,
probably addressing bugs you find on the way.
Notes from our first meeting:
forest-tool shed openrpc --path ...
to dump the schemas to ./schemas
File -> Download -> Tab Separated Values
to download the method list from google sheets.tool openrpc csv2json ...
to convert the tsv to json.tool openrpc select ...
to trim the (currently v0
, soon to be v1
) schema in ./schemas
to output spec.json
tool openrpc validate ...
to validate spec.json
, and captured method calls (see https://github.com/ChainSafe/filecoin-common-node-api/issues/18 for how to run)We did a walkthrough of the codebase :)
@ansermino As suggested by me, the complete list of methods from the spreadsheet has been moved to method-list.json. So we will do modifications there from now on.
@elmattic Do we consider this done?
Yes, let's close this.
Moving forward, @elmattic will take ownership of this repository. This requires quite a bit of knowledge transfer from @aatifsyed. This is tracked here.
Tasks:
Deadline: 6.09.2024