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

Add flush status check in SendPacket #3912

Merged
merged 13 commits into from
Jun 28, 2023
Merged

Add flush status check in SendPacket #3912

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
a290fed
add check for not equal NOTINFLUSH for SendPacket
chatton Jun 21, 2023
adfc53e
added test cases
chatton Jun 21, 2023
31acbec
Merge branch '04-channel-upgrades' into cian/issue#3875-add-flush-sta…
chatton Jun 21, 2023
40d9351
split out status flush check into separate conditional
chatton Jun 21, 2023
3d29ad0
removed redundant flush status check
chatton Jun 21, 2023
23b897f
Reorder check, be more specific with the cause.
DimitrisJim Jun 22, 2023
6943317
Merge branch '04-channel-upgrades' into cian/issue#3875-add-flush-sta…
DimitrisJim Jun 22, 2023
3a2fdd0
added additional test case
chatton Jun 26, 2023
ed4bdac
Merge branch '04-channel-upgrades' into cian/issue#3875-add-flush-sta…
chatton Jun 28, 2023
1f406ea
remove unrequired check on endpoint B upgrade version
chatton Jun 28, 2023
135a990
addressing PR feedback
chatton Jun 28, 2023
d4fd43f
Merge branch '04-channel-upgrades' into cian/issue#3875-add-flush-sta…
chatton Jun 28, 2023
6666805
Merge branch '04-channel-upgrades' into cian/issue#3875-add-flush-sta…
chatton Jun 28, 2023
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
9 changes: 8 additions & 1 deletion modules/core/04-channel/keeper/packet.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,14 @@ func (k Keeper) SendPacket(
return 0, errorsmod.Wrap(types.ErrChannelNotFound, sourceChannel)
}

if channel.State != types.OPEN {
if channel.FlushStatus != types.NOTINFLUSH {
DimitrisJim marked this conversation as resolved.
Show resolved Hide resolved
return 0, errorsmod.Wrapf(
types.ErrInvalidChannelState,
"channel should not be in %s state", types.NOTINFLUSH.String(),
DimitrisJim marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

minor preference for single line error return (I prefer to limit the amount of lines errors take when they aren't the most important check like proof verification, I would actually want to condense the != OPEN check eventually)

)
}

if channel.State != types.OPEN || channel.FlushStatus != types.NOTINFLUSH {
charleenfei marked this conversation as resolved.
Show resolved Hide resolved
return 0, errorsmod.Wrapf(
types.ErrInvalidChannelState,
"channel is not OPEN (got %s)", channel.State.String(),
Expand Down
24 changes: 24 additions & 0 deletions modules/core/04-channel/keeper/packet_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,30 @@ func (suite *KeeperTestSuite) TestSendPacket() {

channelCap = capabilitytypes.NewCapability(5)
}, false},
{
Copy link
Contributor

Choose a reason for hiding this comment

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

does it make sense to add an additional check for channel state? I.e:

{
    "channel is in INITUPGRADE stage", 
    func() {
	suite.coordinator.Setup(path)

	path.EndpointA.ChannelConfig.ProposedUpgrade.Fields.Version = ibcmock.UpgradeVersion
	path.EndpointB.ChannelConfig.ProposedUpgrade.Fields.Version = ibcmock.UpgradeVersion

	err := path.EndpointA.ChanUpgradeInit()
	suite.Require().NoError(err)
    }, 
    false
},

"invalid flush status: FLUSHING",
func() {
suite.coordinator.Setup(path)
sourceChannel = path.EndpointA.ChannelID

channel := path.EndpointA.GetChannel()
channel.FlushStatus = types.FLUSHING
path.EndpointA.SetChannel(channel)
},
false,
},
{
"invalid flush status: FLUSHCOMPLETE",
func() {
suite.coordinator.Setup(path)
sourceChannel = path.EndpointA.ChannelID

channel := path.EndpointA.GetChannel()
channel.FlushStatus = types.FLUSHCOMPLETE
path.EndpointA.SetChannel(channel)
},
false,
},
}

for i, tc := range testCases {
Expand Down