search

massalabs / massa

The Decentralized and Scaled Blockchain
https://massa.net
5.56k stars 712 forks source link

OpenRPC Specification #2462

Closed aoudiamoncef closed 2 years ago

aoudiamoncef commented 2 years ago

Related to #1058

Example with Ethereum

May be convert Wiki documentation to OpenRPC spec ?

openrpc

I'm waiting for feedback

Thanks

damip commented 2 years ago

Thanks for the idea.

@yvan-sraka you were mentionning using a swagger-like description. Would that be of interest?

qdrn commented 2 years ago

Should we close this one @aoudiamoncef ?

damip commented 2 years ago

Should we close this one @aoudiamoncef ?

I think this one is quite important and needs to be followed up

aoudiamoncef commented 2 years ago

It will be my next contribution to Massa. It's in progress . Its painfull to write it in raw JSON. We could cheat and made it with existing OpenAPI GUI tools like ApiCurio . At the end, OpenRPC is similare to a POST based OpenAPI spec.

qdrn commented 2 years ago

It will be my next contribution to Massa. It's in progress . Its painfull to write it in raw JSON. We could cheat and made it with existing OpenAPI GUI tools like ApiCurio . At the end, OpenRPC is similare to a POST based OpenAPI spec.

Nice. Thanks for the update!

aoudiamoncef commented 2 years ago

Hi,

With the help of @rykcod, we finished the first step which consists of translating current documentation to OpenAPI format.

Now we should validate it together before translating to OpenRPC.

@qdrn if you are interested to review the current work, I'll send you an invitation link to join us.

damip commented 2 years ago

Let's make sure the spec is hosted in the massa repo, docs folder and that the CI updates everything auomatically.

aoudiamoncef commented 2 years ago

We have an draft OpenRPC spec, we should enrich it to be complete. I'm still working on it. stay tuned.

TODO :

Useful links: Playground OpenRPC OpenRPC spec Ethereum OpenRPC spec Massa OpenRPC spec VSCode OpenRPC

qdrn commented 2 years ago

Hi,

With the help of @rykcod, we finished the first step which consists of translating current documentation to OpenAPI format.

Now we should validate it together before translating to OpenRPC.

@qdrn if you are interested to review the current work, I'll send you an invitation link to join us.

That would be nice.

aoudiamoncef commented 2 years ago

Hi @qdrn,

I've added a minimale Massa OpenRPC spec. We need some testing on a running node. We have to gather feedback and improve the spec.

IMHO, we should merge It to avoid offset with the raw documentation, any changes should be reported on this contract.

Methods are sorted by tag (private/public) than by name.