loaders: Add loaderResult, remove {userdoc,devdoc}

shazow / whatsabi

Extract the ABI (and resolve proxies, and get other metadata) from Ethereum bytecode, even without source code.

https://shazow.github.io/whatsabi/

MIT License

1.06k stars 74 forks source link

loaders: Add loaderResult, remove {userdoc,devdoc} #127

Closed shazow closed 1 month ago

shazow commented 1 month ago

Add ContractResult.loaderResult?: any
Remove userdoc and devdoc added earlier, should be accessed via loaderResult now.
Updated tests
Added test for Compound USDCv3 TransparentProxy resolving via Etherscan. We still need to fix our own proxy resolving for this one.
Resolves #125

shazow commented 1 month ago

cc @yohamta

yohamta commented 1 month ago

@shazow Thank you for the quick implementation, it looks great!

I was thinking that having the response types for each API defined somewhere could be helpful for users to determine the type of loaderResult. What do you think about that?

shazow commented 1 month ago

Could do that, would you like to do a PR?

shazow commented 1 month ago

The type can also be inferred by ContractResult.loader type (or ContractResult.loader.name)

yohamta commented 1 month ago

Thank you for the suggestion. I’ll submit a PR if it seems helpful.

shazow commented 1 month ago

Thank you! I don't want to commit to always have an exact replica of upstream APIs but it would be helpful for documenting what to expect. Could do something like SourcifyContractResult|EtherscanContractResult|any.