Documentation

[jenpaff]

Document every API on README

[smitrajput]

Hello,

I might be in a good position to help @Vectorized out with this issue.

Why?

I built an ERC4337-compliant wallet a while ago with

• call batching
• gas sponsorship (in ETH)
• access control to the last argument
• multi-factor auth,

which looks like a decent overlap with this delegation contract to start with.

Plus, happened to get some good context on EIP-7702 and ithacaxyz/exp-0001 recently (outside of some general optimizoor fanboying), to realise how feature-stacked this delegation contract for next-gen accounts is, inspiring some contributions.

How?

I'd suggest starting with a simple forge-generated book of all contract docs, which would look similar to this version of superform-core hosted on my github pages. From there, I'll start adding missing docs as comments in all the contracts, with more peripheral contextual information wherever required, whose design can then be refined like Uniswap's (also created with forge-docs).

I understand that these docs are not directly in the README as you asked, so curious if this solution fits the bill and if not, how would you want me to go about it?

Essential Context

Apart from the aforementioned resources, I've skimmed the core contracts and will dive deeper after your confirmation. Please let me know other resources, context I should have before getting started (if any).

All ears to your response.