base-org / web

https://base.org
Apache License 2.0
243 stars 284 forks source link

Docs Request: Balance between too much info, and arbitrary ordering of structs breaking erc-20 #434

Open briandoyle81CB opened 5 months ago

briandoyle81CB commented 5 months ago

What is the issue you are encountering with the docs?

typeof.eth — 04/05/2024 8:49 PM Minor feedback: one of my mentees was having trouble with the ERC20 exercise due to one of her function signatures being off due to the Issue struct.

IMO, explaining how function selectors work and how structs are really just tuples is probably not worth it for new peeps, so I wonder if it would help to provide the expected struct upfront rather than describe the structs and assume they’ll be defined in the order that they’re described.

Because the unit tests expect a specific ABI, I’d probably choose to provide the whole interface that has the methods and structs that the tests expect, but idk, that might be giving away too much.

Links to Impacted Docs

https://docs.base.org/base-camp/docs/erc-20-token/erc-20-exercise/

Describe the solution you'd like to see.

Brian needs to find a better balance here

Additional context

No response

whyte01 commented 5 months ago

Awesome