chore: adding implementation for SendPacket message server #7383

chatton · 2024-10-02T15:55:22Z

Description

This PR adds the bulk of the implementation for the SendPacket message server V2 implementation. There are a few follow up items that need to be completed before this handler is complete. I will link these in follow up issues.

Part of: #7359

closes: #7353

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.

chatton · 2024-10-02T16:02:22Z

modules/core/04-channel/types/timeout.go

@@ -14,6 +14,14 @@ func NewTimeout(height clienttypes.Height, timestamp uint64) Timeout {
 	}
 }

+// NewTimeoutWithTimestamp creates a new Timeout with only the timestamp set.
+func NewTimeoutWithTimestamp(timestamp uint64) Timeout {


we only care about timestamp in the eureka spec

chatton · 2024-10-02T16:03:02Z

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

+	timeoutTimestamp uint64,
+	data []channeltypesv2.PacketData,
+) (uint64, error) {
+	// TODO: add aliasing logic


@chatton create an issue for this!

chatton · 2024-10-02T16:03:19Z

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

@@ -0,0 +1,25 @@
+package types


duplicate from packet-server keeper

chatton · 2024-10-02T16:06:18Z

modules/core/05-port/types/module.go

+	// OnSendPacket is executed when a packet is being sent from sending chain.
+	// this callback is provided with the source and destination IDs, the signer, the packet sequence and the packet data
+	// for this specific application.
+	OnSendPacket(


I figure we can add them one method at a time

chatton · 2024-10-02T16:06:49Z

modules/core/05-port/types/module.go

@@ -108,6 +108,28 @@ type IBCModule interface {
 	) error
 }

+// IBCModuleV2 defines an interface that implements all the callbacks
+// that modules must define as specified in IBC Protocol V2
+type IBCModuleV2 interface {


not convinced this is the best place for this interface, open to suggestions! (Also do we want V2 in the name? )

It really should be referenced as api.IBCModule, I wonder if it makes sense to create the api directory now, would be a weird partial transition if you didn't move over the light client module

Main dependency concern is that if you move this api elsewhere, you may need to define interfaces or move the concrete implementations

chatton · 2024-10-02T16:06:59Z

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

@@ -0,0 +1,10 @@
+package types


duplicate from packet-server

chatton · 2024-10-02T16:07:37Z

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

+	errorsmod "cosmossdk.io/errors"
+
+	clienttypes "github.com/cosmos/ibc-go/v9/modules/core/02-client/types"
+	channeltypes "github.com/cosmos/ibc-go/v9/modules/core/04-channel/types"


Maybe we want to a new timeout type that lives just in channeltypesv2? To not need this dependency

lets keep track of it in issue and close if it seems overkill?

the timeout being referenced by the light client interface seems unavoidable to me, so I think that's the main consideration. Checkout #7055 for context on how this might look going forward as well. In #7055, you could remove the timeout type and separate legacy behaviour by providing the timestamp/height type separately

DimitrisJim · 2024-10-03T07:29:00Z

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

+	timeoutTimestamp uint64,
+	data []channeltypesv2.PacketData,
+) (uint64, error) {
+	// TODO: add aliasing logic https://github.com/cosmos/ibc-go/issues/7387


any reason why we can't just add the fallback now?

colin-axner · 2024-10-03T10:43:50Z

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

+		sdkCtx.Logger().Error("send packet failed", "error", errorsmod.Wrap(err, "Invalid address for msg Signer"))
+		return nil, errorsmod.Wrap(err, "Invalid address for msg Signer")


Suggested change

sdkCtx.Logger().Error("send packet failed", "error", errorsmod.Wrap(err, "Invalid address for msg Signer"))

return nil, errorsmod.Wrap(err, "Invalid address for msg Signer")

sdkCtx.Logger().Error("send packet failed", "error", errorsmod.Wrap(err, "invalid address for msg Signer"))

return nil, errorsmod.Wrap(err, "invalid address for msg Signer")

colin-axner · 2024-10-03T10:46:00Z

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

+	errorsmod "cosmossdk.io/errors"
+
+	clienttypes "github.com/cosmos/ibc-go/v9/modules/core/02-client/types"
+	channeltypes "github.com/cosmos/ibc-go/v9/modules/core/04-channel/types"


the timeout being referenced by the light client interface seems unavoidable to me, so I think that's the main consideration. Checkout #7055 for context on how this might look going forward as well. In #7055, you could remove the timeout type and separate legacy behaviour by providing the timestamp/height type separately

DimitrisJim · 2024-10-03T11:01:40Z

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

do we want to name this relay.go? I think this currently mimics the name in channel/keeper/ though right?

yeah I think we should call it relay.go

DimitrisJim · 2024-10-03T11:04:02Z

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

+	}
+
+	// construct packet from given fields and channel state
+	packet := channeltypesv2.NewPacket(sequence, sourceID, counterparty.CounterpartyChannelId, timeoutTimestamp, data...)


do we want to name counterparty.CounterpartyChannelId as destID? Ditto for clientId := counterparty.ClientId. We currently have this assignments in the relay.go of packet-server and feel like they would be nice to do here too (will help with refactor of Counterparty -> Channel down the line)

Leaving it up to you.

chatton · 2024-10-03T12:41:56Z

Sorry guys! I ended up making a few more changes,

I added the aliasing logic as suggested
included some tests (wiring needed to happen to ibc core keeper to allow this)
moved module into api dir (great suggestion @colin-axner )

DimitrisJim

ack changes, slam it!

sonarcloud · 2024-10-03T14:22:50Z

Quality Gate passed for 'ibc-go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

chatton added 2 commits October 2, 2024 16:52

chore: adding implementation for SendPacket message server

ed5a7a9

chore: adding issue links

807bf77

chatton marked this pull request as ready for review October 2, 2024 16:02

chatton requested review from colin-axner, AdityaSripal and damiannolan as code owners October 2, 2024 16:02

chatton commented Oct 2, 2024

View reviewed changes

chore: add additional issue link

200109c

chatton commented Oct 2, 2024

View reviewed changes

DimitrisJim reviewed Oct 3, 2024

View reviewed changes

chatton added 2 commits October 3, 2024 09:31

chore: using sourceID

795bcf7

chore: adding commented aliasing code

33e64df

colin-axner approved these changes Oct 3, 2024

View reviewed changes

DimitrisJim reviewed Oct 3, 2024

View reviewed changes

chatton added 2 commits October 3, 2024 13:36

chore: adding tests for aliasing and required functions

cc8525d

chore: moved IBCModule interface into api directort

3186b71

chore: merge feature branch

cfa2a3d

DimitrisJim approved these changes Oct 3, 2024

View reviewed changes

chatton merged commit ef8b0ab into feat/ibc-eureka Oct 3, 2024
63 of 65 checks passed

chatton deleted the cian/issue#7359-investigate-addition-of-ibcmodule-v2-application-interface branch October 3, 2024 14:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: adding implementation for SendPacket message server #7383

chore: adding implementation for SendPacket message server #7383

chatton commented Oct 2, 2024

chatton Oct 2, 2024

chatton Oct 2, 2024

chatton Oct 2, 2024

chatton Oct 2, 2024

chatton Oct 2, 2024

colin-axner Oct 3, 2024

chatton Oct 2, 2024

chatton Oct 2, 2024

DimitrisJim Oct 3, 2024

colin-axner Oct 3, 2024

DimitrisJim Oct 3, 2024

colin-axner Oct 3, 2024

colin-axner Oct 3, 2024

DimitrisJim Oct 3, 2024

chatton Oct 3, 2024

DimitrisJim Oct 3, 2024

chatton commented Oct 3, 2024

DimitrisJim left a comment

sonarcloud bot commented Oct 3, 2024

		sdkCtx.Logger().Error("send packet failed", "error", errorsmod.Wrap(err, "Invalid address for msg Signer"))
		return nil, errorsmod.Wrap(err, "Invalid address for msg Signer")

chore: adding implementation for SendPacket message server #7383

chore: adding implementation for SendPacket message server #7383

Conversation

chatton commented Oct 2, 2024

Description

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chatton commented Oct 3, 2024

DimitrisJim left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 3, 2024

Quality Gate passed for 'ibc-go'