Document how the `abi-coder` package works

Open Dhaiwat10 opened this issue 2 years ago • 4 comments

Most of the code for the abi-coder package is undocumented. Since it has several moving parts in different places, it makes it tricky to navigate the codebase when the need for maintenance or a bug fix arises.

I think we should add at least some basic documentation (maybe in the readme) outlining the encoding/decoding flow, which would make navigating and understanding the code easy.

Apr 18 '23 02:04 Dhaiwat10

A high level overview would still be nice IMO, ethers have something similar.

Dec 08 '23 14:12 danielbate

@Dhaiwat10 Are you still working on this one?

Dec 08 '23 14:12 danielbate

@danielbate Hey mate, missed your comment on the issue. No I unfortunately completely forgot about this issue and never started working on it. Feel free to take it if you want!

Dec 14 '23 15:12 Dhaiwat10

No worries man, ty for the update 🙌🏻

Dec 14 '23 15:12 danielbate