Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve debuggability of exported method numbers. #980

Open
Stebalien opened this issue Dec 20, 2022 · 4 comments
Open

Improve debuggability of exported method numbers. #980

Stebalien opened this issue Dec 20, 2022 · 4 comments

Comments

@Stebalien
Copy link
Member

For example, there's no easy way to figure out what method 2280458852 on the market actor is.

@rjan90 rjan90 added this to FilOz Sep 17, 2024
@github-project-automation github-project-automation bot moved this to 📌 Triage in FilOz Sep 17, 2024
@rjan90 rjan90 added the good first issue Good for newcomers label Sep 17, 2024
@rjan90 rjan90 moved this from 📌 Triage to 🐱 Todo in FilOz Sep 24, 2024
@Abhay-2811
Copy link
Contributor

Hey @Stebalien is it ok if I start working on this?

@Stebalien
Copy link
Member Author

Sure! If you have an idea of how to solve it. The only thing I can think of is to auto-generate documentation.

@Abhay-2811
Copy link
Contributor

Can you elaborate on the issue I'm new to the repo and trying to understand the code base. If you have any insights that might help!

@Stebalien Stebalien removed the good first issue Good for newcomers label Oct 5, 2024
@Stebalien
Copy link
Member Author

Basically, "exported" methods are assigned method numbers according to FIP-0042. Unfortunately, that means that, if someone sees a message with the method number 3302309124, they're going to have a lot off difficulty figuring out which method that is. In this case, the method is ChangeWorkerAddress on the Miner actor.

The goal of this issue is to provide some form of auto-generated documentation that maps these method numbers back to their method names. Probably by auto-generating some form of json document that can then be imported into the main Filecoin documentation.

However, this is a pretty open-ended project, isn't very well defined, and is probably not very approachable for newcomers. I'm not sure why it was tagged as a good first issue, but I've removed that label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🐱 Todo
Development

No branches or pull requests

3 participants