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.

Sign up for GitHub

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

Jump to bottom

feat: remove consumer panic when ccv channel is closed (backport #1127) #1137

Merged
merged 1 commit into from
Jul 12, 2023
Merged

feat: remove consumer panic when ccv channel is closed (backport #1127) #1137

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ Add an entry to the unreleased section whenever merging a PR to main that is not
* (fix) [#720](https://github.com/cosmos/interchain-security/issues/720) Fix the attribute `AttributeDistributionTotal` value in `FeeDistribution` event emit.
* (deps) [#1119](https://github.com/cosmos/interchain-security/pull/1119) bump cometbft from `v0.37.1` to `0.37.2`.

## v3.1.0

Date July 11th, 2023
MSalopek marked this conversation as resolved.
Show resolved Hide resolved

A minor upgrade to v3.0.0, which removes the panic in the consumer ccv module which would occur in an emergency scenario where the ccv channel is closed.

* (feat) [#1127](https://github.com/cosmos/interchain-security/pull/1127) Remove consumer panic when ccv channel is closed

## v3.0.0

Date: June 21st, 2023
Expand Down
28 changes: 0 additions & 28 deletions tests/integration/stop_consumer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package integration

import (
abci "github.com/cometbft/cometbft/abci/types"
sdk "github.com/cosmos/cosmos-sdk/types"
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types"
Expand Down Expand Up @@ -211,30 +210,3 @@ func (s *CCVTestSuite) checkConsumerChainIsRemoved(chainID string, checkChannel
s.Require().Empty(slashData)
s.Require().Empty(vscMaturedData)
}

// TestProviderChannelClosed checks that a consumer chain panics
// when the provider channel was established and then closed
func (suite *CCVTestSuite) TestProviderChannelClosed() {
suite.SetupCCVChannel(suite.path)
// establish provider channel with a first VSC packet
suite.SendEmptyVSCPacket()

consumerKeeper := suite.consumerApp.GetConsumerKeeper()

channelID, found := consumerKeeper.GetProviderChannel(suite.consumerChain.GetContext())
suite.Require().True(found)

// close provider channel
err := consumerKeeper.ChanCloseInit(suite.consumerChain.GetContext(), ccv.ConsumerPortID, channelID)
suite.Require().NoError(err)
suite.Require().True(consumerKeeper.IsChannelClosed(suite.consumerChain.GetContext(), channelID))

// assert begin blocker did panics
defer func() {
if r := recover(); r != nil {
return
}
suite.Require().Fail("Begin blocker did not panic with a closed channel")
}()
suite.consumerApp.BeginBlocker(suite.consumerChain.GetContext(), abci.RequestBeginBlock{})
}
4 changes: 0 additions & 4 deletions testutil/integration/debug_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,6 @@ func TestStopConsumerOnChannelClosed(t *testing.T) {
runCCVTestByName(t, "TestStopConsumerOnChannelClosed")
}

func TestProviderChannelClosed(t *testing.T) {
runCCVTestByName(t, "TestProviderChannelClosed")
}

//
// Throttle tests
//
Expand Down
5 changes: 1 addition & 4 deletions x/ccv/consumer/module.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,9 @@ func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
channelID, found := am.keeper.GetProviderChannel(ctx)
if found && am.keeper.IsChannelClosed(ctx, channelID) {
// The CCV channel was established, but it was then closed;
// the consumer chain is no longer safe, thus it MUST shut down.
// This is achieved by panicking, similar as it's done in the
// x/upgrade module of cosmos-sdk.
// the consumer chain is not secured anymore, but we allow it to run as a POA chain and log an error.
channelClosedMsg := fmt.Sprintf("CCV channel %q was closed - shutdown consumer chain since it is not secured anymore", channelID)
am.keeper.Logger(ctx).Error(channelClosedMsg)
panic(channelClosedMsg)
}

// map next block height to the vscID of the current block height
Expand Down