FIP: Client Interoperability OpenRPC

[aatifsyed]

What is success?

A complete OpenRPC (JSON) document for a subset of "Client Interoperability Methods"

• With buy-in from the Lotus developers
• Accepted as a FIP

Current status

• Forest has an OpenRPC document
  • We believe this is structurally correct, given our snapshot testing
• Lotus has an OpenRPC document
  • We believe this is structurally incorrect #3668

Outstanding work

• [ ] @ansermino will add shallow documentation for each method
  • Currently in Notion, will be in Google Docs for Lotus review
• [ ] @aatifsyed will find the structural inconsistencies between Forest's and Lotus' OpenRPC documents as a seed for discussion
• @aatifsyed
  • [ ] Specify ChainNotify, maybe with help from @elmattic
  • [ ] Sign off on first three sections of hackmd
• [ ] Branch a canonical spec from forest
  • [ ] Create a repository, start linking to https://playground.open-rpc.org/
• [ ] Choose which methods count as "Client Interoperability Methods" which will synthesise requirements from the following stakeholders
  • Boost (have a list)
  • Curio (have a list)
  • Web3Mine?
  • Glif (have a list)
  • Lotus?
• [ ] Code changes in forest
  • migrate method descriptions to forest
  • add tagging functionality to trait RpcEndpoint
• [ ] Create a new repo for spec
  • stretch: add a test suite
• stretch: generate docs from the OpenRPC document
  • super stretch: the docs are runnable with a fancy UI

[ruseinov]

Looks good, probably good to link to curio and boost lists as we already have them somewhere in GH.