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

refactor: adapt testing endpoint query for channel upgrade proofs #5165

Merged
merged 1 commit into from
Nov 27, 2023
Merged

refactor: adapt testing endpoint query for channel upgrade proofs #5165

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
49 changes: 30 additions & 19 deletions modules/core/04-channel/keeper/upgrade_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ func (suite *KeeperTestSuite) TestChanUpgradeTry() {
// ensure clients are up to date to receive valid proofs
suite.Require().NoError(path.EndpointB.UpdateClient())

proofCounterpartyChannel, proofCounterpartyUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

upgrade, err := suite.chainB.GetSimApp().IBCKeeper.ChannelKeeper.ChanUpgradeTry(
suite.chainB.GetContext(),
Expand All @@ -292,8 +292,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTry() {
proposedUpgrade.Fields.ConnectionHops,
counterpartyUpgrade.Fields,
path.EndpointA.GetChannel().UpgradeSequence,
proofCounterpartyChannel,
proofCounterpartyUpgrade,
proofChannel,
proofUpgrade,
proofHeight,
)

Expand Down Expand Up @@ -542,7 +542,7 @@ func (suite *KeeperTestSuite) TestChanUpgradeAck() {

tc.malleate()

proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()

err = suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper.ChanUpgradeAck(
suite.chainA.GetContext(), path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID, counterpartyUpgrade,
Expand Down Expand Up @@ -839,7 +839,7 @@ func (suite *KeeperTestSuite) TestChanUpgradeConfirm() {

tc.malleate()

proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

err = suite.chainB.GetSimApp().IBCKeeper.ChannelKeeper.ChanUpgradeConfirm(
suite.chainB.GetContext(), path.EndpointB.ChannelConfig.PortID, path.EndpointB.ChannelID, counterpartyChannelState, counterpartyUpgrade,
Expand Down Expand Up @@ -1075,10 +1075,12 @@ func (suite *KeeperTestSuite) TestChanUpgradeOpen() {

tc.malleate()

proofCounterpartyChannel, _, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight := path.EndpointB.QueryProof(channelKey)

err = suite.chainA.GetSimApp().IBCKeeper.ChannelKeeper.ChanUpgradeOpen(
suite.chainA.GetContext(), path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID,
path.EndpointB.GetChannel().State, proofCounterpartyChannel, proofHeight,
path.EndpointB.GetChannel().State, proofChannel, proofHeight,
)

if tc.expError == nil {
Expand Down Expand Up @@ -1489,9 +1491,9 @@ func (suite *KeeperTestSuite) TestWriteUpgradeCancelChannel() {

func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {
var (
path *ibctesting.Path
proofHeight exported.Height
proofCounterpartyChannel []byte
path *ibctesting.Path
proofChannel []byte
proofHeight exported.Height
)

timeoutUpgrade := func() {
Expand All @@ -1510,7 +1512,9 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {
"success: proof timestamp has passed",
func() {
timeoutUpgrade()
proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()

channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
nil,
},
Expand Down Expand Up @@ -1572,7 +1576,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)

// modify state so the proof becomes invalid.
channel.State = types.FLUSHING
Expand All @@ -1592,7 +1597,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
types.ErrInvalidUpgradeSequence,
},
Expand All @@ -1605,7 +1611,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {

suite.Require().NoError(path.EndpointB.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
types.ErrInvalidUpgradeTimeout,
},
Expand All @@ -1620,7 +1627,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
types.ErrInvalidCounterparty,
},
Expand All @@ -1640,7 +1648,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {
suite.Require().NoError(path.EndpointA.UpdateClient())
suite.Require().NoError(path.EndpointB.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
connectiontypes.ErrConnectionNotFound,
},
Expand All @@ -1654,7 +1663,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)
},
types.ErrUpgradeTimeoutFailed,
},
Expand All @@ -1676,7 +1686,8 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {
suite.Require().NoError(path.EndpointB.ChanUpgradeTry())
suite.Require().NoError(path.EndpointA.ChanUpgradeAck())

proofCounterpartyChannel, _, proofHeight = path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight = path.EndpointB.QueryProof(channelKey)

tc.malleate()

Expand All @@ -1685,7 +1696,7 @@ func (suite *KeeperTestSuite) TestChanUpgradeTimeout() {
path.EndpointA.ChannelConfig.PortID,
path.EndpointA.ChannelID,
path.EndpointB.GetChannel(),
proofCounterpartyChannel,
proofChannel,
proofHeight,
)

Expand Down
23 changes: 14 additions & 9 deletions modules/core/keeper/msg_server_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1005,7 +1005,7 @@ func (suite *KeeperTestSuite) TestChannelUpgradeTry() {
counterpartyUpgrade, found := suite.chainA.GetSimApp().GetIBCKeeper().ChannelKeeper.GetUpgrade(suite.chainA.GetContext(), path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
suite.Require().True(found)

proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

msg = &channeltypes.MsgChannelUpgradeTry{
PortId: path.EndpointB.ChannelConfig.PortID,
Expand Down Expand Up @@ -1174,7 +1174,7 @@ func (suite *KeeperTestSuite) TestChannelUpgradeAck() {

counterpartyUpgrade := path.EndpointB.GetChannelUpgrade()

proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()

msg = &channeltypes.MsgChannelUpgradeAck{
PortId: path.EndpointA.ChannelConfig.PortID,
Expand Down Expand Up @@ -1247,7 +1247,7 @@ func (suite *KeeperTestSuite) TestChannelUpgradeConfirm() {
counterpartyChannelState := path.EndpointA.GetChannel().State
counterpartyUpgrade := path.EndpointA.GetChannelUpgrade()

proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

msg = &channeltypes.MsgChannelUpgradeConfirm{
PortId: path.EndpointB.ChannelConfig.PortID,
Expand Down Expand Up @@ -1336,7 +1336,7 @@ func (suite *KeeperTestSuite) TestChannelUpgradeConfirm() {
err := path.EndpointB.UpdateClient()
suite.Require().NoError(err)

proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

msg.CounterpartyUpgrade = upgrade
msg.ProofChannel = proofChannel
Expand Down Expand Up @@ -1383,7 +1383,7 @@ func (suite *KeeperTestSuite) TestChannelUpgradeConfirm() {
counterpartyChannelState := path.EndpointA.GetChannel().State
counterpartyUpgrade := path.EndpointA.GetChannelUpgrade()

proofChannel, proofUpgrade, proofHeight := path.EndpointB.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, proofHeight := path.EndpointA.QueryChannelUpgradeProof()

msg = &channeltypes.MsgChannelUpgradeConfirm{
PortId: path.EndpointB.ChannelConfig.PortID,
Expand Down Expand Up @@ -1484,7 +1484,8 @@ func (suite *KeeperTestSuite) TestChannelUpgradeOpen() {
suite.Require().NoError(err)

counterpartyChannel := path.EndpointB.GetChannel()
proofChannel, _, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
proofChannel, proofHeight := path.EndpointB.QueryProof(channelKey)

msg = &channeltypes.MsgChannelUpgradeOpen{
PortId: path.EndpointA.ChannelConfig.PortID,
Expand Down Expand Up @@ -1646,7 +1647,9 @@ func (suite *KeeperTestSuite) TestChannelUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

channelProof, _, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
channelProof, proofHeight := path.EndpointB.QueryProof(channelKey)

msg.ProofChannel = channelProof
msg.ProofHeight = proofHeight
},
Expand Down Expand Up @@ -1687,7 +1690,8 @@ func (suite *KeeperTestSuite) TestChannelUpgradeTimeout() {

suite.Require().NoError(path.EndpointA.UpdateClient())

_, _, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
_, _, proofHeight := path.EndpointB.QueryChannelUpgradeProof()

msg.ProofHeight = proofHeight
msg.ProofChannel = []byte("invalid proof")
},
Expand Down Expand Up @@ -1720,7 +1724,8 @@ func (suite *KeeperTestSuite) TestChannelUpgradeTimeout() {
suite.Require().NoError(path.EndpointB.ChanUpgradeTry())
suite.Require().NoError(path.EndpointA.ChanUpgradeAck())

channelProof, _, proofHeight := path.EndpointA.QueryChannelUpgradeProof()
channelKey := host.ChannelKey(path.EndpointA.ChannelConfig.PortID, path.EndpointA.ChannelID)
channelProof, proofHeight := path.EndpointB.QueryProof(channelKey)

msg = &channeltypes.MsgChannelUpgradeTimeout{
PortId: path.EndpointA.ChannelConfig.PortID,
Expand Down
23 changes: 9 additions & 14 deletions testing/endpoint.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,19 +569,14 @@ func (endpoint *Endpoint) TimeoutOnClose(packet channeltypes.Packet) error {
}

// QueryChannelUpgradeProof returns all the proofs necessary to execute UpgradeTry/UpgradeAck/UpgradeOpen.
// It returns the proof for the channel on the counterparty chain, the proof for the upgrade attempt on the
// counterparty chain, and the height at which the proof was queried.
// It returns the proof for the channel on the endpoint's chain, the proof for the upgrade attempt on the
// endpoint's chain, and the height at which the proof was queried.
Copy link
Contributor

Choose a reason for hiding this comment

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

nice, much more intuitive this way!

func (endpoint *Endpoint) QueryChannelUpgradeProof() ([]byte, []byte, clienttypes.Height) {
counterpartyChannelID := endpoint.Counterparty.ChannelID
counterpartyPortID := endpoint.Counterparty.ChannelConfig.PortID
channelKey := host.ChannelKey(endpoint.ChannelConfig.PortID, endpoint.ChannelID)
proofChannel, height := endpoint.QueryProof(channelKey)

// query proof for the channel on the counterparty
channelKey := host.ChannelKey(counterpartyPortID, counterpartyChannelID)
proofChannel, height := endpoint.Counterparty.QueryProof(channelKey)

// query proof for the upgrade attempt on the counterparty
upgradeKey := host.ChannelUpgradeKey(counterpartyPortID, counterpartyChannelID)
proofUpgrade, _ := endpoint.Counterparty.QueryProof(upgradeKey)
upgradeKey := host.ChannelUpgradeKey(endpoint.ChannelConfig.PortID, endpoint.ChannelID)
proofUpgrade, _ := endpoint.QueryProof(upgradeKey)

return proofChannel, proofUpgrade, height
}
Expand Down Expand Up @@ -629,7 +624,7 @@ func (endpoint *Endpoint) ChanUpgradeTry() error {
require.NoError(endpoint.Chain.TB, err)

upgrade := endpoint.GetProposedUpgrade()
proofChannel, proofUpgrade, height := endpoint.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, height := endpoint.Counterparty.QueryChannelUpgradeProof()

counterpartyUpgrade, found := endpoint.Counterparty.Chain.App.GetIBCKeeper().ChannelKeeper.GetUpgrade(endpoint.Counterparty.Chain.GetContext(), endpoint.Counterparty.ChannelConfig.PortID, endpoint.Counterparty.ChannelID)
require.True(endpoint.Chain.TB, found)
Expand Down Expand Up @@ -658,7 +653,7 @@ func (endpoint *Endpoint) ChanUpgradeAck() error {
err := endpoint.UpdateClient()
require.NoError(endpoint.Chain.TB, err)

proofChannel, proofUpgrade, height := endpoint.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, height := endpoint.Counterparty.QueryChannelUpgradeProof()

counterpartyUpgrade, found := endpoint.Counterparty.Chain.App.GetIBCKeeper().ChannelKeeper.GetUpgrade(endpoint.Counterparty.Chain.GetContext(), endpoint.Counterparty.ChannelConfig.PortID, endpoint.Counterparty.ChannelID)
require.True(endpoint.Chain.TB, found)
Expand All @@ -681,7 +676,7 @@ func (endpoint *Endpoint) ChanUpgradeConfirm() error {
err := endpoint.UpdateClient()
require.NoError(endpoint.Chain.TB, err)

proofChannel, proofUpgrade, height := endpoint.QueryChannelUpgradeProof()
proofChannel, proofUpgrade, height := endpoint.Counterparty.QueryChannelUpgradeProof()

counterpartyUpgrade, found := endpoint.Counterparty.Chain.App.GetIBCKeeper().ChannelKeeper.GetUpgrade(endpoint.Counterparty.Chain.GetContext(), endpoint.Counterparty.ChannelConfig.PortID, endpoint.Counterparty.ChannelID)
require.True(endpoint.Chain.TB, found)
Expand Down
Loading