Fix proto services for balancer and superfluid module #1672
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
C:x/gamm
ValarDragon
approved these changes
Jun 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This fix is necessary in order to support ORM.
The legacy problem with proto package for balancer has been a problem for a long time, which has been fixed and addressed over multiple PRs(#1208, #1469). The latest decision that has been made upon this legacy package issue was to change the
tx.proto(https://github.com/osmosis-labs/osmosis/blob/main/proto/osmosis/gamm/pool-models/balancer/tx.proto) to the correct package while leavingbalacerPool.protounder the legacy wrong package so that we wouldn't have to deal with migration logic.Even though such decision has fixed duplicate package issue that has been a blocker for typescript proto generation, it is now an issue with orm support, as protoc does not allow one package path to have different packages within the protofiles(ex. protoc-gen-go-grpc: Go package "github.com/osmosis-labs/osmosis/api/osmosis/gamm/pool-models/balancer" has inconsistent names gammv1beta1 (osmosis/gamm/pool-models/balancer/balancerPool.proto) and balancerv1beta1 (osmosis/gamm/pool-models/balancer/tx.proto)).
There would be multiple ways to fix this problem, open to other ways of fixing this as well.
The way this PR solves it is physically creating a new folder for the
tx.protofile under theproto/gamm/pool-models/balancerfolder to avoid the problem stated above.As for the superfluid module, we have had inconsistency with the packages as well proto package for
gov.protoset toosmosis.superfluid.v1beta, while the other proto packages have the proto package ofosmosis.superfluid. The suggested fix in this PR is creating a new folder underproto/superfluidto fix the duplicate proto package path issue.Brief Changelog
proto/gamm/pool-models/balancer/tx.protoandproto/superfluid/gov.protoTesting and Verifying
Additional testing needed that this fix does not break unknown unknowns in the state side.
Documentation and Release Note
Unreleasedsection inCHANGELOG.md?nox/<module>/spec/) / Osmosis docs repo / not documented)