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

feat: add names to all events and functions signatures inputs #191

Open
sammccord opened this issue Oct 9, 2024 · 7 comments
Open

feat: add names to all events and functions signatures inputs #191

sammccord opened this issue Oct 9, 2024 · 7 comments
Labels

Comments

@sammccord
Copy link
Contributor

Description

Frontend needs to show detailed info about action steps. They have the signature, and @boostxyz/signatures to get the event/function name, but would need names for individual inputs to both help users create boosts, and our devs to build richer ui.

Suggested Solution

Add names to all events and functions in boost-protocol/packages/signatures/manifests

ie
Transfer(address indexed,address indexed,uint256 indexed)
becomes
Transfer(address indexed from,address indexed to,uint256 indexed amount)

@Quazia
Copy link
Collaborator

Quazia commented Oct 9, 2024

This will cause args to get returned as K:V pairs instead of an array - they're unnamed for internal use intentionally. We could maintain both or maintain the named list and employ a helper to strip out the names. This is related to the signatures ergonomics work @topocount was going to focus on next. The ask here is basically that we need to serve the event as a human readable ABI with params in some way right?

@Quazia
Copy link
Collaborator

Quazia commented Oct 9, 2024

Another somewhat related thing I noticed recently too is there are some issues if we have the same event selector but the configuration of what is indexed is different - i.e. Transfer(address indexed,address indexed,uint256 indexed) vs Transfer(address indexed,address indexed,uint256)

@topocount
Copy link
Contributor

@Quazia We have a ticket for that isssue with indexed vs nonindexed args here: https://linear.app/rh-app/issue/BOOST-4764/modify-the-eventaction-validators-to-account-for-indexed-args-through

@sammccord
Copy link
Contributor Author

This will cause args to get returned as K:V pairs instead of an array - they're unnamed for internal use intentionally. We could maintain both or maintain the named list and employ a helper to strip out the names. This is related to the signatures ergonomics work @topocount was going to focus on next. The ask here is basically that we need to serve the event as a human readable ABI with params in some way right?

Yeah, Boost detail designs, and create flow rely on input names to label actions to be less error-prone and make the ui richer.

@topocount
Copy link
Contributor

@sammccord this needs to be downstream of the work on signature package eronomics, as it'll break EventAction right now.

@soulstar9792
Copy link

May I ask if the new-comers work for a paid position?

@sammccord
Copy link
Contributor Author

May I ask if the new-comers work for a paid position?

@soulstar9792 Thanks for inquiring. We are not currently hiring freelance contributors without prior history of contributions to the repository.

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

No branches or pull requests

4 participants