Skip to content

Adding version to UnmarshalPacketData interface#6988

Merged
chatton merged 3 commits intomainfrom
cian/issue#6976-modify-unmarshalpacketdata-interface-to-return-version
Jul 30, 2024
Merged

Adding version to UnmarshalPacketData interface#6988
chatton merged 3 commits intomainfrom
cian/issue#6976-modify-unmarshalpacketdata-interface-to-return-version

Conversation

@chatton
Copy link
Copy Markdown
Contributor

@chatton chatton commented Jul 30, 2024

Description

closes: #6976

This PR updates the UnmarshalPacketData to return the underlying application version.

Note: in a few tests, we needed to make them stateful since we are fetching the version via the ics20Wrapper

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against the correct branch (see CONTRIBUTING.md).
  • Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/).
  • Added relevant godoc comments.
  • Provide a conventional commit message to follow the repository standards.
  • Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
  • Re-reviewed Files changed in the GitHub PR explorer.
  • Review SonarCloud Report in the comment section below once CI passes.

@chatton chatton marked this pull request as ready for review July 30, 2024 10:36
DimitrisJim
DimitrisJim reviewed Jul 30, 2024
View reviewed changes
modules/apps/27-interchain-accounts/controller/ibc_middleware.go
// into an InterchainAccountPacketData. This function implements the optional
// PacketDataUnmarshaler interface required for ADR 008 support.
func (IBCMiddleware) UnmarshalPacketData(_ sdk.Context, _, _ string, bz []byte) (interface{}, error) {
func (im IBCMiddleware) UnmarshalPacketData(ctx sdk.Context, portID string, channelID string, bz []byte) (interface{}, string, error) {
Copy link
Copy Markdown
Contributor

@DimitrisJim DimitrisJim Jul 30, 2024

Choose a reason for hiding this comment

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

is some linter complaining about name, name type pattern?

Copy link
Copy Markdown
Contributor Author

@chatton chatton Jul 30, 2024

Choose a reason for hiding this comment

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

no it's required to fetch the app version below

Copy link
Copy Markdown
Contributor

@DimitrisJim DimitrisJim Jul 30, 2024

Choose a reason for hiding this comment

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

ah, meant if a linter was complaining for having these as portID, channelID string as opposed to portID string, channelID string

Copy link
Copy Markdown
Contributor Author

@chatton chatton Jul 30, 2024

Choose a reason for hiding this comment

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

nothing was shouting at me about it I don't think 🤔

@chatton
Copy link
Copy Markdown
Contributor Author

chatton commented Jul 30, 2024

I seem to have broken some transfer E2Es (also failing locally) looking into it now

@chatton
Copy link
Copy Markdown
Contributor Author

chatton commented Jul 30, 2024

test fixed by #6993

colin-axner
colin-axner reviewed Jul 30, 2024
View reviewed changes
modules/apps/transfer/ibc_module_test.go Outdated
suite.Require().True(ok)

packetData, err := unmarshalerStack.UnmarshalPacketData(suite.chainA.GetContext(), path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, data)
packetData, _, err := unmarshalerStack.UnmarshalPacketData(suite.chainA.GetContext(), path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, data)
Copy link
Copy Markdown
Contributor

@colin-axner colin-axner Jul 30, 2024

Choose a reason for hiding this comment

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

we should assert the version?

Can do using the if statement below?

Copy link
Copy Markdown
Contributor Author

@chatton chatton Jul 30, 2024

Choose a reason for hiding this comment

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

yes good call, will add 👍

colin-axner
colin-axner approved these changes Jul 30, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@colin-axner colin-axner left a comment

Choose a reason for hiding this comment

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

Nice one! Thank you @chatton 🙏 The changes LGTM. Only thing I noticed was that in transfer we could do an assertion on the returned version

DimitrisJim
DimitrisJim approved these changes Jul 30, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

thanks for picking this up!

@DimitrisJim
Copy link
Copy Markdown
Contributor

DimitrisJim commented Jul 30, 2024

lets not forget to slap backport label

@chatton chatton enabled auto-merge July 30, 2024 14:26
@chatton chatton added this pull request to the merge queue Jul 30, 2024
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Jul 30, 2024

Quality Gate Passed Quality Gate passed for 'ibc-go'

Issues
20 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

Merged via the queue into main with commit 75ec6e9 Jul 30, 2024
@chatton chatton deleted the cian/issue#6976-modify-unmarshalpacketdata-interface-to-return-version branch July 30, 2024 14:35
mergify bot pushed a commit that referenced this pull request Jul 30, 2024
@chatton @mergify
Adding version to UnmarshalPacketData interface (#6988)
ac0fcd8 
* chore: adding version to UnmarshalPacketData interface

* chore: addressing PR feedback

(cherry picked from commit 75ec6e9)
@mergify mergify bot mentioned this pull request Jul 30, 2024
Merged
10 tasks
@colin-axner
Copy link
Copy Markdown
Contributor

colin-axner commented Jul 30, 2024

We forgot to update docs on this as well

colin-axner pushed a commit that referenced this pull request Jul 30, 2024
@mergify @chatton
Adding version to UnmarshalPacketData interface (#6988) (#6997)
6b5c687 
* chore: adding version to UnmarshalPacketData interface

* chore: addressing PR feedback

(cherry picked from commit 75ec6e9)

Co-authored-by: Cian Hatton <cian@interchain.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AdityaSripal AdityaSripal Awaiting requested review from AdityaSripal

@damiannolan damiannolan Awaiting requested review from damiannolan

@srdtrk srdtrk Awaiting requested review from srdtrk

@crodriguezvega crodriguezvega Awaiting requested review from crodriguezvega

@gjermundgaraba gjermundgaraba Awaiting requested review from gjermundgaraba

@bznein bznein Awaiting requested review from bznein

2 more reviewers

@DimitrisJim DimitrisJim DimitrisJim approved these changes

@colin-axner colin-axner colin-axner approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Modify UnmarshalPacketData interface to return version

3 participants

@chatton @DimitrisJim @colin-axner