Multi payload packet by AdityaSripal · Pull Request #8545 · cosmos/ibc-go

AdityaSripal · 2025-06-18T17:47:43Z

Description

closes: IBCGO-2371

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
Include changelog entry when appropriate (e.g. chores should be omitted from changelog).
Wrote unit and integration tests if relevant.
Updated documentation (docs/) if anything is changed.
Added godoc comments if relevant.
Self-reviewed Files changed in the GitHub PR explorer.
Provide a conventional commit message to follow the repository standards.

codecov · 2025-06-18T17:55:54Z

Codecov Report

Attention: Patch coverage is 93.54839% with 2 lines in your changes missing coverage. Please review.

Project coverage is 57.63%. Comparing base (5f8fd48) to head (933c996).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
modules/core/04-channel/v2/keeper/msg_server.go	66.66%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8545      +/-   ##
==========================================
+ Coverage   57.58%   57.63%   +0.05%     
==========================================
  Files         317      317              
  Lines       22666    22668       +2     
==========================================
+ Hits        13052    13065      +13     
+ Misses       9006     8998       -8     
+ Partials      608      605       -3

Flag	Coverage Δ
08-wasm	`65.99% <ø> (ø)`
e2e	`1.13% <ø> (ø)`
ibc-go	`63.06% <93.54%> (+0.05%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…aditya/multi-payload

linear · 2025-06-21T20:55:20Z

IBCGO-2371 Multi-payload support

Copilot

Pull Request Overview

This PR expands the packet handling functionality to support sending multiple payloads atomically in the same IBC packet. Key changes include:

Adding support for asynchronous payloads via a new NewAsyncMockPayload function and handling of async packet result status in the mock IBC module.
Refactoring endpoint methods (MsgSendPacket and MsgSendPacketWithSender) to accept variadic payload parameters for multiple payload support.
Updating tests and keeper logic to validate and manage multiple payloads as well as updating error messaging for payload validation.

Reviewed Changes

Copilot reviewed 15 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
testing/mock/v2/mock.go	Introduces NewAsyncMockPayload to support async payloads.
testing/mock/v2/ibc_module.go	Updates OnRecvPacket to detect async payloads and return corresponding status.
testing/endpoint_v2.go	Refactors MsgSendPacket and MsgSendPacketWithSender to support multiple payloads.
modules/core/04-channel/v2/types/*	Adjusts payload validation and error messages to reflect multi-payload support.
modules/core/04-channel/v2/keeper/* and msg_server.*	Updates acknowledgement, packet, and message server logic to handle multiple payloads.
modules/apps/transfer/v2/transfer_test.go	Adds tests for transfer flows with multiple payloads.
CHANGELOG.md	Adds changelog entry documenting multi-payload packet support.

Comments suppressed due to low confidence (2)

testing/mock/v2/mock.go:38

[nitpick] Consider adding a comment documenting NewAsyncMockPayload to clarify its purpose, its behavior, and how it differs from NewMockPayload and NewErrorMockPayload.

func NewAsyncMockPayload(sourcePort, destPort string) channeltypesv2.Payload {

testing/endpoint_v2.go:24

[nitpick] Update the function documentation for MsgSendPacket to clearly specify that it now accepts multiple payloads and describe the expected behavior when multiple payloads are provided.

func (endpoint *Endpoint) MsgSendPacket(timeoutTimestamp uint64, payloads ...channeltypesv2.Payload) (channeltypesv2.Packet, error) {

modules/core/04-channel/v2/keeper/msg_server.go

gjermundgaraba · 2025-06-22T09:32:49Z

bugbot run

cursor

✅ BugBot reviewed your changes and found no bugs!

BugBot free trial expires on July 22, 2025
You have used $0.00 of your $50.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎

gjermundgaraba

This looks very good! I left a couple of nits and minor cleanups with the tests. Feel free to merge if you agree with these and get the fixed 👍

gjermundgaraba · 2025-06-22T12:47:48Z

modules/core/04-channel/v2/keeper/packet.go

+	}
+
+	// Validate the acknowledgement against the payload length
+	if ack.Success() {


nit: could be a single if statement

I left as is, because i find it more readable as to why the check exists

gjermundgaraba · 2025-06-22T12:50:37Z

modules/core/04-channel/v2/keeper/packet_test.go

 	var (
 		path        *ibctesting.Path
 		packet      types.Packet
+		payload     types.Payload


I don't think this does anything. There is already a payload in the test function itself that is set with payload := ....

If it's never going to change, but you need access to it, you could just set it once at the top and use it as you do already. But right now I think it will always be empty.

gjermundgaraba · 2025-06-22T12:52:41Z

modules/core/04-channel/v2/keeper/packet_test.go

 	var (
-		packet types.Packet
-		ack    types.Acknowledgement
+		packet  types.Packet


In this one, it does get set in the test function itself, but as far as I can tell, it never changes, so you could just set it once here and use it directly and not reset it every test

The payloads are getting modulated in the test cases

gjermundgaraba · 2025-06-22T12:53:07Z

modules/core/04-channel/v2/keeper/packet_test.go

 	var (
 		path         *ibctesting.Path
 		packet       types.Packet
+		payload      types.Payload


same deal here, I believe

gjermundgaraba · 2025-06-22T12:54:32Z

modules/core/04-channel/v2/types/msgs_test.go


 func (s *TypesTestSuite) TestMsgSendPacketValidateBasic() {
 	var msg *types.MsgSendPacket
+	var payload types.Payload


This one doesn't look like it's used in the test function itself, so probably don't need to define it here?

It gets used in the test cases

AdityaSripal added 2 commits June 18, 2025 17:39

remove restriction in types package

a7c4eea

fix acknowledgement, and start keeper package testing

27925fc

AdityaSripal added 2 commits June 19, 2025 13:52

04-channel tests

4203039

add transfer tests

f3f306e

AdityaSripal marked this pull request as ready for review June 19, 2025 15:32

AdityaSripal requested review from DeshErBojhaa, gjermundgaraba and srdtrk as code owners June 19, 2025 15:32

AdityaSripal added 3 commits June 20, 2025 10:08

Merge branch 'main' into aditya/multi-payload

2a643ea

CHANGELOG

a921b42

Merge branch 'aditya/multi-payload' of github.com:cosmos/ibc-go into …

c3f52f3

…aditya/multi-payload

gjermundgaraba linked an issue Jun 21, 2025 that may be closed by this pull request

Multi-payload support #8556

Closed

gjermundgaraba requested a review from Copilot June 21, 2025 20:55

Copilot AI reviewed Jun 21, 2025

View reviewed changes

modules/core/04-channel/v2/keeper/msg_server.go Show resolved Hide resolved

cursor bot reviewed Jun 22, 2025

View reviewed changes

gjermundgaraba added 2 commits June 22, 2025 13:28

Merge branch 'main' into aditya/multi-payload

003a38c

lint

37f19cf

gjermundgaraba approved these changes Jun 22, 2025

View reviewed changes

gjermundgaraba and others added 3 commits June 22, 2025 19:20

Merge branch 'main' into aditya/multi-payload

53a99d4

address review

f83db84

merge

933c996

AdityaSripal merged commit 38dd181 into main Jun 23, 2025
52 checks passed

AdityaSripal deleted the aditya/multi-payload branch June 23, 2025 12:45

AdityaSripal restored the aditya/multi-payload branch June 25, 2025 11:15

Conversation

AdityaSripal commented Jun 18, 2025 • edited by gjermundgaraba Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

codecov bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

linear bot commented Jun 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

gjermundgaraba commented Jun 22, 2025

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

✅ BugBot reviewed your changes and found no bugs!

Uh oh!

gjermundgaraba left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

AdityaSripal commented Jun 18, 2025 •

edited by gjermundgaraba

Loading

codecov bot commented Jun 18, 2025 •

edited

Loading