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

Remove amino converter workaround #105

Open
Tracked by #85
ryanchristo opened this issue Jul 13, 2023 · 0 comments
Open
Tracked by #85

Remove amino converter workaround #105

ryanchristo opened this issue Jul 13, 2023 · 0 comments
Labels
blocked dev Engineering task

Comments

@ryanchristo
Copy link
Member

ryanchristo commented Jul 13, 2023

This issue tracks the removal of the amino converter workaround and is dependent on upstream fixes.

In #69, a workaround was implemented to support amino. In summary, the amino converters for several messages used within the application were not handling undefined values, which is how amino translates zero-values. We override the amino converters from the regen-js api pacakge (i.e. @regen-network/api) with custom amino converters in src/api/group.amino.ts.

In order to create custom amino converters, we had to import types from the src directory within the api package. The types are not available in the types directory because the code within the src directory includes typescript errors (regen-network/regen-js#84) and therefore will not compile. We had to manual resolve some typescript errors within src (which will be overwritten on running codegen) and tag a release with manual changes (i.e. v1.0.0-alpha5, which includes regen-network/regen-js#79 and regen-network/regen-js#87) in order to run and build the groups application without upstream typescript errors.

Another thing to be aware of, and depending on the upstream solution, when we remove the amino converter workaround, we may need a solution for amino support with MsgSubmitProposal similar to what was proposed in cosmology-tech/telescope#281 for messages that create and update a group policy. The type we need for MsgSubmitProposal is currently unavailable but also may not be necessary depending on the upstream solution. The partial implementation is included in #69.

@ryanchristo ryanchristo added blocked dev Engineering task labels Jul 13, 2023
@ryanchristo ryanchristo changed the title Remove amino amino converter workaround Remove amino converter workaround Jul 13, 2023
@ryanchristo ryanchristo added the nice to have Would be nice as part of this epic, but no necessary label Jul 13, 2023
@ryanchristo ryanchristo removed the nice to have Would be nice as part of this epic, but no necessary label Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked dev Engineering task
Projects
None yet
Development

No branches or pull requests

1 participant