Static RPC conformance checks - Githubissues

ChainSafe / forest

🌲 Rust Filecoin Node Implementation

https://forest.chainsafe.io

Apache License 2.0

623 stars 149 forks source link

Static RPC conformance checks #4309

Open LesnyRumcajs opened 4 months ago

LesnyRumcajs commented 4 months ago

Issue summary

It'd be beneficial for tracking RPC progress and conformance to have a way to statically check conformance between Forest and Lotus RPC API.

Lotus API spec is defined in here Forest API spec might be defined along the lines of this

Challenges:

completely different formats that included complex types from different programming languages - how much work will it be? Is it worth the time invested?,
Lotus spec is missing some methods, e.g., ChainNotify. If we do this, we should inquire Lotus team.
Is the snap format stable? Is Lotus spec format stable?

Ideas:

Can the spec formats between implementations be somehow unified? The snap files seem to be specific to Rust insta tool. What I'd like to see is some sort of OpenAPI language-agnostic approach.

Other information and links

lemmih commented 1 month ago

Related issue: https://github.com/ChainSafe/forest/issues/4365