refactor: use explicit checks in ica controller upgrade handlers #5472
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
colin-axner
commented
Dec 20, 2023
colin-axner
commented
Dec 20, 2023
| @@ -162,30 +187,49 @@ func (k Keeper) OnChanUpgradeInit(ctx sdk.Context, portID, channelID string, ord | |||
| return "", err | |||
| } | |||
|
|
|||
| if err := icatypes.ValidateControllerMetadata(ctx, k.channelKeeper, connectionHops, metadata); err != nil { | |||
| return "", errorsmod.Wrap(err, "invalid metadata") | |||
| // ValidateControllerMetadata will ensure the interchain account version has not changed and that the | |||
There was a problem hiding this comment.
we could pull here down into a helper func ValidateUpgradeMetadata, pulling out the relevant checks from ValidateControllerMetadata, but left as duplication between upgrade init and upgrade ack for now
…troller Updated UpgradeInit logic Updated UpgradeAck logic Refactored UpgradeInit tests
colin-axner
force-pushed
the
colin/5462-controller-cbs
branch
from
33769a6 to
6fe19e1
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #5472 +/- ##
==========================================
+ Coverage 80.96% 81.09% +0.13%
==========================================
Files 197 197
Lines 15221 15234 +13
==========================================
+ Hits 12323 12354 +31
+ Misses 2427 2412 -15
+ Partials 471 468 -3
|
colin-axner
requested review from
AdityaSripal and
damiannolan
as code owners
colin-axner
commented
Dec 21, 2023
| order channeltypes.Order | ||
| ) | ||
|
|
||
| // updateMetadata is a helper function which modifies the metadata stored in the channel version | ||
| // and marshals it into a string to pass to OnChanUpgradeInit as the counterpartyVersion string. | ||
| updateMetadata := func(modificationFn func(*icatypes.Metadata)) { |
There was a problem hiding this comment.
updated to match upgrade ack
chatton
approved these changes
Jan 4, 2024
crodriguezvega
approved these changes
Jan 4, 2024
Comment on lines
+202
to
208
| if currentMetadata.ControllerConnectionId != proposedMetadata.ControllerConnectionId { | ||
| return "", errorsmod.Wrap(connectiontypes.ErrInvalidConnection, "proposed controller connection ID must not change") | ||
| } | ||
|
|
||
| if currentMetadata.HostConnectionId != proposedMetadata.HostConnectionId { | ||
| return "", errorsmod.Wrap(connectiontypes.ErrInvalidConnection, "proposed host connection ID must not change") | ||
| } |
There was a problem hiding this comment.
I don't feel too strongly about it, but if these checks are not reachable in either OnChanUpgradeInit and OnChanUpgradeAck, couldn't we just remove them and add a comment above the call to ValidateControllerMetadata to explain that this function protects against these changes?
mergify bot
pushed a commit
that referenced
this pull request
Jan 4, 2024
* refactor: explicit checks in upgrade init and upgrade ack for ica controller Updated UpgradeInit logic Updated UpgradeAck logic Refactored UpgradeInit tests * test: complete upgrade ack tests * test: add code cov * lint appease * nit: use correct error type * nit comment change * fix typo --------- Co-authored-by: Cian Hatton <cian@interchain.io> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 4a021a3)
crodriguezvega
pushed a commit
that referenced
this pull request
Jan 5, 2024
…) (#5518) * refactor: explicit checks in upgrade init and upgrade ack for ica controller Updated UpgradeInit logic Updated UpgradeAck logic Refactored UpgradeInit tests * test: complete upgrade ack tests * test: add code cov * lint appease * nit: use correct error type * nit comment change * fix typo --------- Co-authored-by: Cian Hatton <cian@interchain.io> Co-authored-by: Carlos Rodriguez <carlos@interchain.io> (cherry picked from commit 4a021a3) Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
3 tasks
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.
Description
ref: #5462
Commit Message / Changelog Entry
see the guidelines for commit messages. (view raw markdown for examples)
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.
docs/) or specification (x/<module>/spec/).godoccomments.Files changedin the Github PR explorer.Codecov Reportin the comment section below once CI passes.