Remove IBC logic from x/upgrade #8673

colin-axner · 2021-02-23T12:12:07Z

Description

As part of the preparation for #8501, IBC needs to be removed from x/upgrade. We still need to set upgraded client states and consensus states in the upgrade store (otherwise chains would need to do an IBC breaking upgrade, which is not desirable).

To mitigate these issues, x/upgrade will now set bytes for the client state and consensus states, thereby removing notions of what IBC is setting in the upgrade store. The abci begin blocker setting of consensus states has been moved to 02-client. A new proposal type is added to IBC which wraps an upgrade plan. If the proposal is successful it will execute IBC upgrade logic and schedule an upgrade

closes: #XXXX

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 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.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

…bc-from-upgrade

x/upgrade/abci_test.go

amaury1093 · 2021-02-24T14:20:52Z

proto/cosmos/upgrade/v1beta1/query.proto

@@ -64,5 +64,5 @@ message QueryUpgradedConsensusStateRequest {
 // QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState
 // RPC method.
 message QueryUpgradedConsensusStateResponse {
-  google.protobuf.Any upgraded_consensus_state = 1;
+  bytes upgraded_consensus_state = 1;


This is proto-breaking. Could we just add a new field instead? Or else we can also bump to v1beta2

I can do whichever you prefer. The old fields would just be unused if I added a new field. It would also be unusable since I cannot fulfill the UnpackInterfaces function since there won't be a interface to unpack into. I presume I'd have to change this for the Upgrade Plan as well or does only the Query definitions matter?

Not bumping to v1beta2 would be ideal. If the old field is not used anymore, I would say let's go for reserved, like here

See https://developers.google.com/protocol-buffers/docs/proto#updating

Non-required fields can be removed, as long as the field number is not used again in your updated message type. You may want to rename the field instead, perhaps adding the prefix "OBSOLETE_", or make the field number reserved, so that future users of your .proto can't accidentally reuse the number.

sweet, thanks for catching this. Updated it, let me know if anything is wrong

The proto-breakage check still says breaking, but I presume this is fine?

Do I need the reserved "option"; part?

codecov · 2021-02-24T15:05:18Z

Codecov Report

Merging #8673 (9dbcbe1) into master (a93edee) will decrease coverage by 0.05%.
The diff coverage is 59.50%.

@@            Coverage Diff             @@
##           master    #8673      +/-   ##
==========================================
- Coverage   61.45%   61.39%   -0.06%     
==========================================
  Files         673      671       -2     
  Lines       38306    38415     +109     
==========================================
+ Hits        23541    23586      +45     
- Misses      12285    12360      +75     
+ Partials     2480     2469      -11

Impacted Files	Coverage Δ
x/ibc/core/02-client/keeper/grpc_query.go	`60.46% <0.00%> (-16.01%)`	⬇️
x/ibc/core/02-client/proposal_handler.go	`75.00% <0.00%> (-25.00%)`	⬇️
x/ibc/core/02-client/types/keys.go	`100.00% <ø> (ø)`
x/ibc/core/keeper/grpc_query.go	`0.00% <0.00%> (ø)`
x/ibc/light-clients/07-tendermint/types/upgrade.go	`73.33% <ø> (-3.34%)`	⬇️
x/upgrade/abci.go	`92.30% <ø> (-1.03%)`	⬇️
x/upgrade/keeper/grpc_query.go	`58.82% <0.00%> (+8.82%)`	⬆️
x/upgrade/types/proposal.go	`84.61% <ø> (-0.57%)`	⬇️
x/upgrade/keeper/keeper.go	`73.40% <60.00%> (+5.30%)`	⬆️
x/ibc/core/02-client/types/proposal.go	`82.53% <77.50%> (-8.77%)`	⬇️
... and 19 more

AdityaSripal

Mainly worried about illegible data in the proposal.

Maybe we should move the proposal to IBC now. The IBC proposal can contain the ibcexported ClientState, and then just marshal it before storing in x/upgrade

docs/core/proto-docs.md

proto/cosmos/upgrade/v1beta1/query.proto

x/ibc/core/02-client/abci_test.go

x/ibc/light-clients/07-tendermint/types/upgrade.go

x/ibc/light-clients/07-tendermint/types/upgrade_test.go

amaury1093 · 2021-02-25T10:33:57Z

proto/cosmos/upgrade/v1beta1/query.proto

@@ -64,5 +64,8 @@ message QueryUpgradedConsensusStateRequest {
 // QueryUpgradedConsensusStateResponse is the response type for the Query/UpgradedConsensusState
 // RPC method.
 message QueryUpgradedConsensusStateResponse {
-  google.protobuf.Any upgraded_consensus_state = 1;
+  reserved 1;
+  reserved "option";


Suggested change

reserved "option";

You can remove this. This is to reserve a field name. Since you're using the same field name in the new field, there's no need to reserve anything.

Good to know, thanks. I'm waiting on a confirmation from @AdityaSripal, but I think the direction with this pr might be to remove IBC entirely:

create a duplicate proposal type in IBC that wraps an upgrade plan, then call ScheduleUpgrade from within IBC

handle IBC related logic in IBC

This would make this field obsolete. Any preference for how to deprecate QueryUpgradedConsensusStateResponse? And for Plan I guess reserving the field and name would be sufficient

Cool. Yes, reserving both field number and name should be enough.

x/upgrade/types/plan.go

…sdk into colin/rm-ibc-from-upgrade

Add a new Key to the IBC client store to track the IBC Upgrade Height. This allows IBC upgrades to correctly remove old IBC upgrade states

…sdk into colin/rm-ibc-from-upgrade

colin-axner · 2021-03-01T12:00:59Z

x/ibc/core/02-client/types/proposal.go

 	if up.Plan.Time.Unix() > 0 {
 		return sdkerrors.Wrap(ErrInvalidUpgradeProposal, "IBC chain upgrades must only set height")
 	}

+	if up.Plan.Height <= 0 {


This is unreachable but safe to have. plan.ValidateBasic won't allow not setting time and height and it won't allow setting both time and height

colin-axner · 2021-03-01T12:46:43Z

@cwgoes @AdityaSripal @fedekunze see the last bit of logic added. Will merge after I get approvals again

cwgoes

ACK

…bc-from-upgrade

…sdk into colin/rm-ibc-from-upgrade

x/ibc/core/02-client/keeper/keeper.go

Revert using a key to track IBC upgrades. By clearing any IBC state using an old plan in ScheduleUpgrade, IBC upgrades do not need to be tracked by IBC. This reduces code complexity and reduces potential for bugs.

AdityaSripal

ACK final approach, great work @colin-axner!

robert-zaremba · 2021-08-03T23:33:17Z

proto/cosmos/upgrade/v1beta1/query.proto

-  google.protobuf.Any upgraded_consensus_state = 1;
+  reserved 1;
+
+  bytes upgraded_consensus_state = 2;


why this was changed?

Sorry for not documenting it, but I believe the reason why is because then the upgrade module would have a dependency on the IBC module which we wanted to completely avoid. In order to return the correct Any, the upgrade module would need to understand what an IBC consensus state is, thus creating a dependency on the IBC module

Is there an issue with the new behaviour?

It breaks the API. It seams that you were not correctly using this function - because Any was not used.

This is just a convenience function for the cli. Relayers who perform the client upgrade functionality do ABCI queries to obtain the proofs necessary

@AmauryM

* add zeroed custom fields check to tm client * remove custom fields function from x/upgrade and fix tests * use []byte in x/upgrade, move abci to 02-client * remove x/ibc from types * whoops, delete testing files * fix upgrade tests * fix tm tests * fix tests * update CHANGELOG * revert proto breakage, use reserved field cc @AmauryM * add IBC Upgrade Proposal type * remove IBC from upgrade types * add IBC upgrade logic to 02-client * fix all tests for x/upgrade * Add CLI for IBC Upgrade Proposal * Update x/ibc/core/02-client/types/proposal_test.go Co-authored-by: Federico Kunze <[email protected]> * add gRPC for upgraded client state * test fixes * add HandleUpgradeProposal tests * update docs and remove unnecessary code * self review bug and test fixes * neatness * construct empty rest handler * fix tests * fix stringer tests * Update docs/core/proto-docs.md Co-authored-by: Christopher Goes <[email protected]> * add key in ibc store tracking ibc upgrade heights Add a new Key to the IBC client store to track the IBC Upgrade Height. This allows IBC upgrades to correctly remove old IBC upgrade states * update abci and tests * revert key storage after discussion with @AdityaSripal Revert using a key to track IBC upgrades. By clearing any IBC state using an old plan in ScheduleUpgrade, IBC upgrades do not need to be tracked by IBC. This reduces code complexity and reduces potential for bugs. * clear IBC states on cancelled upgrades Co-authored-by: Federico Kunze <[email protected]> Co-authored-by: Christopher Goes <[email protected]>

colin-axner added 3 commits February 23, 2021 12:04

add zeroed custom fields check to tm client

e65921b

remove custom fields function from x/upgrade and fix tests

64b59fd

use []byte in x/upgrade, move abci to 02-client

1234383

colin-axner requested review from AdityaSripal and fedekunze February 23, 2021 12:12

colin-axner added 2 commits February 23, 2021 13:14

remove x/ibc from types

c5c0d26

whoops, delete testing files

31ca56d

colin-axner force-pushed the colin/rm-ibc-from-upgrade branch from 1101778 to 31ca56d Compare February 24, 2021 11:30

colin-axner added 4 commits February 24, 2021 13:11

fix upgrade tests

9ea85b8

fix tm tests

3449f66

fix tests

01cc2d7

Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/rm-i…

975133b

…bc-from-upgrade

colin-axner commented Feb 24, 2021

View reviewed changes

x/upgrade/abci_test.go Show resolved Hide resolved

x/upgrade/abci_test.go Outdated Show resolved Hide resolved

colin-axner marked this pull request as ready for review February 24, 2021 13:12

colin-axner requested review from aaronc, alessio and alexanderbez as code owners February 24, 2021 13:12

colin-axner requested a review from cwgoes February 24, 2021 13:12

update CHANGELOG

21fb511

amaury1093 reviewed Feb 24, 2021

View reviewed changes

colin-axner added 2 commits February 24, 2021 17:27

revert proto breakage, use reserved field cc @AmauryM

862dc37

Merge branch 'master' into colin/rm-ibc-from-upgrade

1d5bdd5

AdityaSripal requested changes Feb 24, 2021

View reviewed changes

amaury1093 reviewed Feb 25, 2021

View reviewed changes

colin-axner commented Feb 25, 2021

View reviewed changes

x/upgrade/types/plan.go Show resolved Hide resolved

colin-axner added 4 commits February 25, 2021 13:21

add IBC Upgrade Proposal type

dd180e8

remove IBC from upgrade types

99f8a76

add IBC upgrade logic to 02-client

973cef5

Merge branch 'colin/rm-ibc-from-upgrade' of github.com:cosmos/cosmos-…

c47f4ce

…sdk into colin/rm-ibc-from-upgrade

colin-axner added 3 commits March 1, 2021 12:42

add key in ibc store tracking ibc upgrade heights

2a6adb0

Add a new Key to the IBC client store to track the IBC Upgrade Height. This allows IBC upgrades to correctly remove old IBC upgrade states

Merge branch 'colin/rm-ibc-from-upgrade' of github.com:cosmos/cosmos-…

0b51095

…sdk into colin/rm-ibc-from-upgrade

update abci and tests

d40e695

colin-axner commented Mar 1, 2021

View reviewed changes

Merge branch 'master' into colin/rm-ibc-from-upgrade

7906b28

colin-axner mentioned this pull request Mar 1, 2021

Move x/ibc to it's own repository #8501

Closed

4 tasks

Merge branch 'master' into colin/rm-ibc-from-upgrade

0404d4e

colin-axner requested review from fedekunze, AdityaSripal and cwgoes March 1, 2021 12:46

cwgoes approved these changes Mar 1, 2021

View reviewed changes

colin-axner added 3 commits March 1, 2021 14:55

Merge branch 'master' into colin/rm-ibc-from-upgrade

9dbcbe1

Merge branch 'master' of github.com:cosmos/cosmos-sdk into colin/rm-i…

73fefb9

…bc-from-upgrade

Merge branch 'colin/rm-ibc-from-upgrade' of github.com:cosmos/cosmos-…

abc4ebb

…sdk into colin/rm-ibc-from-upgrade

colin-axner mentioned this pull request Mar 1, 2021

Remove IBC from the SDK #8735

Merged

9 tasks

AdityaSripal reviewed Mar 1, 2021

View reviewed changes

x/ibc/core/02-client/keeper/keeper.go Outdated Show resolved Hide resolved

colin-axner added 3 commits March 1, 2021 17:10

revert key storage after discussion with @AdityaSripal

95cb360

Revert using a key to track IBC upgrades. By clearing any IBC state using an old plan in ScheduleUpgrade, IBC upgrades do not need to be tracked by IBC. This reduces code complexity and reduces potential for bugs.

clear IBC states on cancelled upgrades

5e20b2f

Merge branch 'master' into colin/rm-ibc-from-upgrade

57f2c8d

AdityaSripal approved these changes Mar 1, 2021

View reviewed changes

colin-axner added the A:automerge Automatically merge PR once all prerequisites pass. label Mar 1, 2021

mergify bot merged commit 1c6e267 into master Mar 1, 2021

mergify bot deleted the colin/rm-ibc-from-upgrade branch March 1, 2021 16:28

webmaster128 mentioned this pull request Jun 2, 2021

Compare Cosmos SDK v0.43-beta1 confio/cosmjs-types#2

Closed

aaronc mentioned this pull request Jun 2, 2021

Address v1beta1 proto breaking changes #9446

Closed

arijitAD mentioned this pull request Aug 2, 2021

Upgrade cosmos sdk to latest release. akash-network/node#1343

Merged

12 tasks

robert-zaremba reviewed Aug 3, 2021

View reviewed changes

amaury1093 mentioned this pull request Aug 4, 2021

revert: Mark upgrade query field as deprecated instead of reserved #9847

Closed

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove IBC logic from x/upgrade #8673

Remove IBC logic from x/upgrade #8673

colin-axner commented Feb 23, 2021 •

edited

Loading

amaury1093 Feb 24, 2021

colin-axner Feb 24, 2021

amaury1093 Feb 24, 2021

colin-axner Feb 24, 2021

colin-axner Feb 24, 2021

codecov bot commented Feb 24, 2021 •

edited

Loading

AdityaSripal left a comment

amaury1093 Feb 25, 2021

colin-axner Feb 25, 2021

amaury1093 Feb 25, 2021

colin-axner Mar 1, 2021

colin-axner commented Mar 1, 2021

cwgoes left a comment

AdityaSripal left a comment

robert-zaremba Aug 3, 2021

colin-axner Aug 4, 2021

robert-zaremba Aug 4, 2021

colin-axner Aug 4, 2021 •

edited

Loading

Remove IBC logic from x/upgrade #8673

Remove IBC logic from x/upgrade #8673

Conversation

colin-axner commented Feb 23, 2021 • edited Loading

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Feb 24, 2021 • edited Loading

Codecov Report

AdityaSripal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner commented Mar 1, 2021

cwgoes left a comment

Choose a reason for hiding this comment

AdityaSripal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner Aug 4, 2021 • edited Loading

Choose a reason for hiding this comment

colin-axner commented Feb 23, 2021 •

edited

Loading

codecov bot commented Feb 24, 2021 •

edited

Loading

colin-axner Aug 4, 2021 •

edited

Loading