Acknowledge packets asynchronously #1392
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sug0
added a commit
to heliaxdev/cosmos-ibc-rs
that referenced
this pull request
Jan 15, 2025
|
cc @rnbguy |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1392 +/- ##
==========================================
- Coverage 67.09% 67.07% -0.03%
==========================================
Files 226 226
Lines 22425 22485 +60
==========================================
+ Hits 15047 15082 +35
- Misses 7378 7403 +25 ☔ View full report in Codecov by Sentry. |
Farhad-Shabani
requested changes
Jan 16, 2025
There was a problem hiding this comment.
Hey @sug0, thanks for upstreaming the changes! I’ve requested a few updates. In addition to those, it would be great if you could:
- select "Allow edits from maintainers" so we can move quickly on fixing minor findings
- Update the README under ibc-core: https://github.com/cosmos/ibc-rs/tree/main/ibc-core#asynchronous-acknowledgements
- Update your branch once add optional arbitrary impls #1390 merged.
4. (If there is) share a pointer to your codebase where this changes has been integrated to better understand your use case.
sug0
added a commit
to heliaxdev/cosmos-ibc-rs
that referenced
this pull request
Jan 16, 2025
sug0
force-pushed
the
tiago/optional-ack-rebased
branch
from
b388e85 to
2bfea0b
Compare
sug0
added a commit
to heliaxdev/cosmos-ibc-rs
that referenced
this pull request
Jan 17, 2025
sug0
force-pushed
the
tiago/optional-ack-rebased
branch
from
2bfea0b to
6c30f13
Compare
sug0
added a commit
to heliaxdev/cosmos-ibc-rs
that referenced
this pull request
Jan 17, 2025
sug0
force-pushed
the
tiago/optional-ack-rebased
branch
from
6c30f13 to
f6b68fe
Compare
sug0
force-pushed
the
tiago/optional-ack-rebased
branch
from
f6b68fe to
2adeb6b
Compare
Farhad-Shabani
approved these changes
Jan 17, 2025
| @@ -0,0 +1,2 @@ | |||
| - Support asynchronous packet acknowledgements. | |||
There was a problem hiding this comment.
Suggested change
| - Support asynchronous packet acknowledgements. | |
| - [ibc-core] Support asynchronous packet acknowledgements. |
Comment on lines
+126
to
+147
| /// ICS-26 `onRecvPacket` callback implementation. | ||
| /// | ||
| /// # Note on optional acknowledgements | ||
| /// | ||
| /// Acknowledgements can be committed asynchronously, hence | ||
| /// the `Option` type. In general, acknowledgements should | ||
| /// be committed to storage, accompanied by an ack event, | ||
| /// as soon as a packet is received. This will be done | ||
| /// automatically as long as `Some(ack)` is returned from | ||
| /// this callback. However, in some cases, such as when | ||
| /// implementing a multiple hop packet delivery protocol, | ||
| /// a packet can only be acknowledged after it has reached | ||
| /// the last hop. | ||
| /// | ||
| /// ## Committing a packet asynchronously | ||
| /// | ||
| /// Event emission and state updates for packet acknowledgements | ||
| /// can be performed asynchronously using [`emit_packet_acknowledgement_event`] | ||
| /// and [`commit_packet_acknowledgment`], respectively. | ||
| /// | ||
| /// [`commit_packet_acknowledgment`]: ../../channel/handler/fn.commit_packet_acknowledgment.html | ||
| /// [`emit_packet_acknowledgement_event`]: ../../channel/handler/fn.emit_packet_acknowledgement_event.html |
There was a problem hiding this comment.
This is great! Much appreciated!
Merged
via the queue into
informalsystems:main
with commit Jan 17, 2025
27f10ac
12 of 13 checks passed
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Potentially related to #361
Description
This PR introduces the ability to acknowledge IBC packets asynchronously, bringing
ibc-rs's API closer toibc-go.These changes were required in order to implement the packet forward middleware on top of
ibc-rs.PR author checklist:
unclog.docs/).Reviewer checklist:
Files changedin the GitHub PR explorer.