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

fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting #1722

Merged

Conversation

freak12techno
Copy link
Contributor

@freak12techno freak12techno commented Mar 24, 2024

Description

Fixes the issue described here: #1251 (comment)

Converts QueryAllPairsValConAddrByConsumerChainID output to consumer addresses, so instead of raw bytes in gRPC/REST response we now have this:
image

I patched my Gaia node with this: https://api.cosmos.quokkastake.io/interchain_security/ccv/provider/consumer_chain_id?chain_id=neutron-1, seems to work more correct, also tested it with gRPC and it also works.


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • Included the correct type prefix in the PR title
  • Added ! to the type prefix if the change is state-machine breaking
  • Confirmed this PR does not introduce changes requiring state migrations, OR migration code has been added to consumer and/or provider modules
  • Targeted the correct branch (see PR Targeting)
  • Provided a link to the relevant issue or specification
  • Followed the guidelines for building SDK modules
  • Included the necessary unit and integration tests
  • Added a changelog entry to CHANGELOG.md
  • Included comments for documenting Go code
  • Updated the relevant documentation or specification
  • Reviewed "Files changed" and left comments if necessary
  • Confirmed all CI checks have passed
  • If this PR is library API breaking, bump the go.mod version string of the repo, and follow through on a new major release

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! the type prefix if the change is state-machine breaking
  • confirmed this PR does not introduce changes requiring state migrations, OR confirmed migration code has been added to consumer and/or provider modules
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage

@freak12techno freak12techno requested a review from a team as a code owner March 24, 2024 11:52
@github-actions github-actions bot added the C:x/provider Assigned automatically by the PR labeler label Mar 24, 2024
@freak12techno
Copy link
Contributor Author

@mpoke need someone to review this, can you review that or tag somebody please?

@freak12techno
Copy link
Contributor Author

Also, one off-top thing that's not related but that I can fix in this PR, if that's an issue (not sure if it is):
https://github.com/cosmos/interchain-security/blob/main/proto/interchain_security/ccv/provider/v1/query.proto#L203 here it has 2 keys with yaml:"address", wonder if it may cause any issues or if it's expected?

Copy link
Contributor

@insumity insumity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, one off-top thing that's not related but that I can fix in this PR, if that's an issue (not sure if it is):
https://github.com/cosmos/interchain-security/blob/main/proto/interchain_security/ccv/provider/v1/query.proto#L203 here it has 2 keys with yaml:"address", wonder if it may cause any issues or if it's expected?

Yes, it would be nice to have consumer_address and provider_address instead of both being address.

LGTM

@freak12techno
Copy link
Contributor Author

@insumity okay, done and also fixed tests, should do the trick as it's now passing on my laptop locally.
Can you clarify whether this proto file change would be breaking and therefore if I need to add ! to my PR?

@insumity
Copy link
Contributor

@freak12techno This is a node API breaking change, not a state-machine breaking one.

@freak12techno
Copy link
Contributor Author

@insumity gotcha, I thought whether changing the yaml thing in proto file would result in a breaking change or not, but regardless of the yaml thing it will be API breaking, as it returns data in a different format now, am I correct?
Also, let me know if I should use another prefix or signal in any way that this change would change the API response (not its format, but the data it returns).

@insumity
Copy link
Contributor

insumity commented Mar 27, 2024

@freak12techno Yes, as mentioned, this is a node API breaking change. See here:

A change is considered to be node API breaking if it modifies the API provided by a node of either consumer or provider chains. This includes events, queries, CLI interfaces.

Your current prefix is fine.

Thank you very much for your fix!

@freak12techno
Copy link
Contributor Author

@insumity gotcha. Last question: I see mbt tests failing here, but they seem to also fail in other PRs, can you clarify whether this is ok or should I update something in my PR to make it pass?

@p-offtermatt
Copy link
Contributor

@insumity gotcha. Last question: I see mbt tests failing here, but they seem to also fail in other PRs, can you clarify whether this is ok or should I update something in my PR to make it pass?

The failure is not due to this PR, fine to merge despite it

@freak12techno
Copy link
Contributor Author

@insumity @p-offtermatt can we get this merged?

Copy link
Contributor

@p-offtermatt p-offtermatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! Will merge

@freak12techno
Copy link
Contributor Author

@p-offtermatt sorry for pinging again, I think auto merge won't work here as there's a failed CI check which is failing not because of my changes. Can you maybe merge it manually?

@mpoke mpoke merged commit b0c0df9 into cosmos:main Apr 15, 2024
17 of 18 checks passed
@freak12techno freak12techno deleted the add-all-assigned-keys-query-formatting branch April 15, 2024 11:20
mergify bot pushed a commit that referenced this pull request Apr 22, 2024
…#1722)

* fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting

* fix: name PairValConAddrProviderAndConsumer more appropriately

* chore: fixed tests

(cherry picked from commit b0c0df9)
mergify bot pushed a commit that referenced this pull request Apr 22, 2024
…#1722)

* fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting

* fix: name PairValConAddrProviderAndConsumer more appropriately

* chore: fixed tests

(cherry picked from commit b0c0df9)
p-offtermatt pushed a commit that referenced this pull request Apr 22, 2024
… (backport #1722) (#1795)

fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting (#1722)

* fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting

* fix: name PairValConAddrProviderAndConsumer more appropriately

* chore: fixed tests

(cherry picked from commit b0c0df9)

Co-authored-by: Sergey <83376337+freak12techno@users.noreply.github.com>
mpoke pushed a commit that referenced this pull request Apr 22, 2024
… (backport #1722) (#1794)

fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting (#1722)

* fix: fixed QueryAllPairsValConAddrByConsumerChainID output formatting

* fix: name PairValConAddrProviderAndConsumer more appropriately

* chore: fixed tests

(cherry picked from commit b0c0df9)

Co-authored-by: Sergey <83376337+freak12techno@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:x/provider Assigned automatically by the PR labeler
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants