docs: channel upgrades packet flushing #5348
Merged
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
* updating tests to use expError in favour of expPass bool * move write fn under chanUpgradeAck * make expPass construction two lines instead of one --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Charly <charly@interchain.io>
Co-authored-by: Charly <charly@interchain.io>
* update upgrade seq comparison * pr suggestions
* writeupgradetimeout method, pull in util methods
* adding boilerplate skeleton for chanUpgradeAck handler * updating msg servers args * adding test scaffolding and syncing latest changes of feat branch * configure both proposed upgrades to use mock.UpgradeVersion * updating chanUpgradeAck test cases * updating var naming for consistency, adding additional testcases * rm msg server implementation * adding invalid flush status err and rm lint ignore comment * adding test helpers to endpoint for get/set channel upgrade * lint it * adding initial msg server impl skeleton * pull in code for WriteUpgradeAckChannel * adding result to MsgChannelUpgradeAckResponse * add initial test cases * adding additional testcases * apply testcase naming review suggestions Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * apply error return wrapping suggestions from review Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * fix error to use Wrapf and correct channel id arg, adding success log * correct testing imports and satisy linter * apply self suggestions for testcase context with in-line comments * updating test func to use path.EndpointA and chainA sender acc --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
… server (#3913) * make error wrapping and logging consistent for upgrade try msg server * standardise logging
…here are no packet commitments left (#3964)
* Add ChanUpgradeOpen core handler. * Tests tests tests. * Update upgrade open handler based on feedback. * Reformat testing approach. * Move counterpartyhops assignment inline. * Check err of SetChannelState. * Address feedback. * Remove uneeded modification of version.
* chore: adding check for in flight packets in WriteUpgradeAckChannel * added test for TestWriteUpgradeAckChannel * linter * add client update to UpgradeAckChannel test * mv test * merge * fix post-merge * fix merge issues * review comment --------- Co-authored-by: Charly <charly@interchain.berlin> Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
…3895) * Add implementation for message server handling of ChanUpgradeOpen. * Add tests for msg_server. * Address review feedback. * Remove setting of flush status. * Apply suggestions from code review Co-authored-by: Damian Nolan <damiannolan@gmail.com> * Address rest of review comments. --------- Co-authored-by: Damian Nolan <damiannolan@gmail.com>
* chore: update abort upgrade function to panic on error * apply review suggestions --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
* Amend Ack packet to keep acknowledging if we're in the process of flushing pre-upgrade packets. * Use handshake to reach correct state before mutating any fields. * Add test to verify post-ack channel state after last in-flight packet. * Remove unecessary modifications of version for non initializing channel end. * Test both cases: final in-flight packet and non-final one. * Apply suggestions from code review Co-authored-by: Carlos Rodriguez <carlos@interchain.io> * Remove manual setting of flush status. * Update test name, pass mock version to both channels. --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
* Amend timeout to handle in-flight packets. * Update timeout handler per spec. * Update tests to test for toggling of flush status. * Fix small typos in docstring. --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
…UpgradeOpen. (#4052) * Pass in counterparty portid, channelid. * use direct check on err. * Force distinct channel identifiers when testing UpgradeOpen.
#5409) * Add proto message for pruning acks, msgs, stubs for keeper/msg-server. * Make pruning number of zero into error. * Apply suggestions from code review Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Damian Nolan <damiannolan@gmail.com> * Rename num_to_prune to limit. * make proto-format, add documentation note on limit argument. --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Damian Nolan <damiannolan@gmail.com>
… is enabled (#5358) * wip: happy path test upgrading a channel to wire fee middleware * change package name * trying to have the relayer started before executing governance proposal * passing happy path channel upgrade test * some refactoring * use sdkmath import alias * update docker images --------- Co-authored-by: Charly <charly@interchain.io> Co-authored-by: Damian Nolan <damiannolan@gmail.com>
* chore: update channel upgrades default timeout to 10 mins * chore: make lint-fix
* imp: add upgrade sequence to identified channel * Add ValidateBasic tests for IdentifiedChannel. --------- Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
…age (#5415) * disallow changing ordering in ICA upgrade and increase test coverage * linting * review comments
# Conflicts: # e2e/go.mod # e2e/go.sum # testing/utils.go
* refactor: apply issue design to timeout type * chore: add godocs * tests: add tests for elapsed and ErrTimeoutElapsed functions * rm: unfinished tests * test: tests for ErrTimeoutNotReached * test: add tests for ErrTimeoutNotReached * review suggestion: switcharoo * chore: add in-code comment --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
Co-authored-by: Carlos Rodriguez <carlos@interchain.io>
* Pass appVersion to callback if version can be parsed. * Assert on rest of values passed.
* Move cast to Upgradable module _after_ checking app is set. * Add test to check nil apps are allowed.
* fix sequencing logic and unit tests * added tests * reorder comments * add test * fix typo * refactored a couple of tests * relocate comment * fix: defer incrementing acc sequencing such that is happens on both success and failure tx execution * chore: update version strings in comments * test: wrap test code in suite.Run and add additional assertions * refactor: adapt crossing hellos cancellation test case to use suite.Run and add more assertions --------- Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Damian Nolan <damiannolan@gmail.com>
…r controller. (#5467) * Add passthrough implementations for OnChanUpgradeOpen and OnChanUpgradeRestore for controller. * Drop unused expError from test functions.
…adeOpen` (#5438) Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
* add logic for setting next seq recv, update tests * update next seq recv and ack logic to spec * typos * update test * wip changes for spec * wip set counterparty upgrade * update naming * update endpoint * spec changes * test that counterparty upgrade has been set * update err message * pr review * naming nit * feat: check counterparty next sequence send in recv packet * add comment * lint * add error doc * only do defensive check if counterpartyUpgrade is set * remove unnecessary 0 check * merge conflict fix: add back deleted test --------- Co-authored-by: Charly <charly@interchain.berlin> Co-authored-by: Charly <charly@interchain.io> Co-authored-by: Aditya Sripal <adityasripal@gmail.com> Co-authored-by: Colin Axnér <25233464+colin-axner@users.noreply.github.com>
# Conflicts: # e2e/go.mod # e2e/go.sum
Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: Charly <charly@interchain.berlin> Co-authored-by: Damian Nolan <damiannolan@gmail.com> Co-authored-by: chatton <github.qpeyb@simplelogin.fr> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
DimitrisJim
approved these changes
Jan 2, 2024
|
|
||
| `FLUSHING` and `FLUSHCOMPLETE` are additional states which have been added to enable the upgrade feature. | ||
|
|
||
| This is found in the channel state on `Channel`: |
There was a problem hiding this comment.
does it make more sense to actually paste the State instead of Channel?
There was a problem hiding this comment.
i can paste the list of possible State as well!
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
closes: #5269
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.