Skip to content

Commit

Permalink
Adding note about new channel states (cosmos#5698)
Browse files Browse the repository at this point in the history
  • Loading branch information
chatton authored Jan 24, 2024
1 parent 9faaff5 commit 378e48d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/docs/01-ibc/06-channel-upgrades.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,15 @@ The state will change to `FLUSHCOMPLETE` once there are no in-flight packets lef

All other parameters will remain the same during the upgrade handshake until the upgrade handshake completes. When the channel is reset to `OPEN` on a successful upgrade handshake, the relevant fields on the channel end will be switched over to the `UpgradeFields` specified in the upgrade.

:::warning

Due to the addition of new channel states, packets can still be received and processed in both `FLUSHING` and `FLUSHCOMPLETE` states.
Packets can also be acknowledged in the `FLUSHING` state. Acknowledging will **not** be possible when the channel is in the `FLUSHCOMPLETE` state, since all packets sent from that channel end have been flushed.
Application developers should consider these new states when implementing application logic that relies on the channel state.
It is still only possible to send packets when the channel is in the `OPEN` state, but sending is disallowed when the channel enters `FLUSHING` and `FLUSHCOMPLETE`. When the channel reopens, sending will be possible again.

:::

## Cancelling a Channel Upgrade

Channel upgrade cancellation is performed by submitting a `MsgChannelUpgradeCancel` message.
Expand Down

0 comments on commit 378e48d

Please sign in to comment.