Channel upgrades

[damiannolan]

Meta issue for tracking the ibc-go implementation of the ICS-004 Channel Upgrades specification

Requirements document (coming soon...)
Project board

ADRs

Milestones

• Alpha

Implementation issues

Note: placeholders will be replaced as issues are added and linked to this epic. Some of the issues implemented are outdated and may not be reflected in the most up to date version of the code

Store paths

The following standardised store paths should be added to 24-host:

• Add UpgradeSequencePath to 24-host #1600
• Add RestoreChannelPath to 24-host #1601
• Add UpgradeErrorPath to 24-host #1602
• Add UpgradeTimeoutPath to 24-host #1603

State verification functions

The following state verification functions should be added to 03-connection for verifying proofs against a counterparty lightclient:

• Add VerifyChannelUpgradeSequence method to 03-connection #1608
• Add VerifyChannelUpgradeError and VerifyChannelUpgradeErrorAbsence methods to 03-connection #1609
• Add VerifyChannelUpgradeTimeout method to 03-connection #1610

Upgrade handshake

• Add upgrade states to 04-channel State enum proto #1604
• Add upgrade handshake rpcs to 04-channel protobuf Msg service #1617
  • Implement sdk.Msg interface for channel upgrade handshake messages #1622
  • Implement ChannelUpgradeInit functionality for 04-channel #1618
  • Implement ChannelUpgradeTry functionality for 04-channel #1619
  • Implement ChannelUpgradeAck functionality for 04-channel #1620
  • Implement ChannelUpgradeOpen functionality for 04-channel #1621

Upgrade cancellation

• Add ErrorReceipt to 04-channel protobuf definitions #1605
• Implement RestoreChannel functionality for upgrade cancellation #1612
• Add upgrade cancellation rpc to 04-channel protobuf Msg service #1623
• Correctly Handle RestoreChannel application callbacks #3373
• Implement sdk.Msg interface for MsgUpgradeCancel #1624

Upgrade timeout

• Add UpgradeTimeout to 04-channel protobuf definitions #1606
• Add upgrade timeout rpc to 04-channel protobuf Msg service #1625
• Implement sdk.Msg interface for MsgUpgradeTimeout #1626

Query handlers

• Add UpgradeSequence rpc to 04-channel query service #1902
• Add UpgradeError rpc to 04-channel query service  #1901

Application callbacks

• Add upgrade callbacks IBCModule interface #1614
• Implement transfer channel upgrades callbacks #4127
• Implement 29-fee channel upgrade callbacks #1900

QA scenarios

Automated e2e tests

• Add Scaffolding for E2E Channel Upgrade Test #3421

Pre-releases

Checklist

• Internal audit(s)
• External audit(s)
• Documentation
• Swagger
• Integration with relayers:
  • Hermes
  • Rly

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged/assigned