Draft: support middleware in ICS20 #351

thomas-nguy · 2021-08-27T02:24:40Z

Description

closes: #347

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.

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the module structure standards.
Wrote unit and integration tests
Updated relevant documentation (docs/) or specification (x/<module>/spec/)
Added relevant godoc comments.
Added a relevant changelog entry to the Unreleased section in CHANGELOG.md
Re-reviewed Files changed in the Github PR explorer
Review Codecov Report in the comment section below once CI passes

lgtm-com · 2021-08-27T02:57:59Z

This pull request introduces 3 alerts when merging 29caccd2048b2d29456afcb8c26056b5be1e0b6b into 358bfa5 - view on LGTM.com

new alerts:

2 for Useless assignment to local variable
1 for Useless assignment to field

lgtm-com · 2021-08-27T03:34:47Z

This pull request introduces 2 alerts when merging 5dabfe5 into 358bfa5 - view on LGTM.com

new alerts:

1 for Useless assignment to local variable
1 for Useless assignment to field

crodriguezvega

Thanks for opening this PR!
Is it necessary to add/modify tests together with these changes?

crodriguezvega · 2021-08-27T07:38:41Z

modules/apps/transfer/keeper/callbacks.go

+	channelCap *capabilitytypes.Capability,
+	packet exported.PacketI,
+) error {
+	//todo


What's this todo?

I think it is probably slightly unclear of how to implement this function. But the general idea is we need to Authenticate the capability passed in as being the app capability, then we need to get our own capability and pass it into the SendPacket function of the middleware above us

I can draft up code later

I have some ideas here.

crodriguezvega · 2021-08-27T07:39:52Z

modules/apps/transfer/module.go

@@ -37,7 +38,8 @@ var (
 )

 // AppModuleBasic is the IBC Transfer AppModuleBasic
-type AppModuleBasic struct{}
+type AppModuleBasic struct {
+}


This change is not needed, right?

crodriguezvega · 2021-08-27T07:40:26Z

modules/apps/transfer/module.go

@@ -102,6 +106,11 @@ func NewAppModule(k keeper.Keeper) AppModule {
 	}
 }

+// SetMiddleware set ICS30 middleware


Typo: it should be sets.

crodriguezvega · 2021-08-27T07:52:01Z

modules/apps/transfer/types/keys.go

@@ -29,8 +29,14 @@ const (

 	// DenomPrefix is the prefix used for internal SDK coin representation.
 	DenomPrefix = "ibc"
+
+	KeyAppCapability = "app_capabilities"


I think in order to be consistent with other modules this should be KeyAppCapabilityPrefix = "appCapabilities". Maybe @colin-axner can confirm whether what I say is correct or not.

I agree, but it looks like these changes come from @AdityaSripal pr

crodriguezvega · 2021-08-27T07:59:16Z

modules/apps/transfer/types/keys.go

 )

+func AppCapabilityName(channelID, portID string) string {


And for consistency I think this function should be called AppCapabilityPath.

We can leave it as AppCapabilityName (it isn't being used as a storage path, but as a capability name). This code can be added into 05-port though via the main branch (I can do this)

crodriguezvega · 2021-08-27T08:03:26Z

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

+
+import "strings"
+
+// SplitChannelVersion middleware version will split the channel version string


I believe it should read as SplitChannelVersion splits ....

yes, but it was taken from @AdityaSripal's pr

This change can go directly into the main branch, before any of these pr's. I can open a pr

colin-axner

Excellent! Thanks for taking up this initiative! I'll be adding the middleware to interchain accounts as well soon. That should help fill in any remaining gaps and I'll also figure out how to test for these changes

colin-axner · 2021-08-27T09:41:29Z

modules/apps/transfer/module.go

@@ -102,6 +106,11 @@ func NewAppModule(k keeper.Keeper) AppModule {
 	}
 }

+// SetMiddleware set ICS30 middleware
+func (am AppModule) SetMiddleware(app porttypes.IBCModule) {


The intent here is to avoid breaking API of NewAppModule? Nice call 👍

colin-axner · 2021-08-27T09:44:04Z

modules/apps/transfer/module.go

+		return am.app.OnChanCloseInit(ctx, portID, channelID)
+	}
+
+	return nil


this function shouldn't change. ICS 20 should never allow OnChanCloseInit to succeed

colin-axner · 2021-08-27T09:46:06Z

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

+
+import "strings"
+
+// SplitChannelVersion middleware version will split the channel version string


yes, but it was taken from @AdityaSripal's pr

This change can go directly into the main branch, before any of these pr's. I can open a pr

colin-axner · 2021-08-27T09:48:13Z

modules/apps/transfer/module.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	capabilitykeeper "github.com/cosmos/cosmos-sdk/x/capability/keeper"


nit: this should go in the middle section of imports

colin-axner · 2021-08-27T09:54:18Z

modules/apps/transfer/module.go

+	transferVersion, appVersion := channeltypes.SplitChannelVersion(version)
+
+	if transferVersion == "" {
+		// middleware not supported


Suggested change

// middleware not supported

// This may occur if:

// - transfer is acting as the base application in the middleware stack

// - the connected base application has chosen not to append its own version

colin-axner · 2021-08-27T10:07:47Z

modules/apps/transfer/module.go

+	appCap, ok = am.scopedKeeper.GetCapability(ctx, types.AppCapabilityName(channelID, portID))
+	if !ok {
+		return sdkerrors.Wrap(capabilitytypes.ErrCapabilityNotFound,
+			"could not find app capability on OnChanOpenTry even after OnChanOpenInit called on this chain first (crossing hellos)")


I would have an error message like "could not find app capability for channel %s and port %s", channelID, portID"

or something like that. @crodriguezvega any suggestion on format we should follow?

@colin-axner what you propose looks good!

colin-axner · 2021-08-27T10:12:38Z

modules/apps/transfer/types/keys.go

@@ -29,8 +29,14 @@ const (

 	// DenomPrefix is the prefix used for internal SDK coin representation.
 	DenomPrefix = "ibc"
+
+	KeyAppCapability = "app_capabilities"


I agree, but it looks like these changes come from @AdityaSripal pr

colin-axner · 2021-08-27T10:14:55Z

modules/apps/transfer/types/keys.go

 )

+func AppCapabilityName(channelID, portID string) string {


We can leave it as AppCapabilityName (it isn't being used as a storage path, but as a capability name). This code can be added into 05-port though via the main branch (I can do this)

colin-axner · 2021-08-27T10:20:00Z

modules/apps/transfer/keeper/callbacks.go

+	channelCap *capabilitytypes.Capability,
+	packet exported.PacketI,
+) error {
+	//todo


I think it is probably slightly unclear of how to implement this function. But the general idea is we need to Authenticate the capability passed in as being the app capability, then we need to get our own capability and pass it into the SendPacket function of the middleware above us

I can draft up code later

lgtm-com · 2021-08-28T06:19:49Z

This pull request introduces 2 alerts when merging 1df0d88 into 9d5da17 - view on LGTM.com

new alerts:

1 for Useless assignment to local variable
1 for Useless assignment to field

fedekunze

Looks good, although I'd like to see additional documentation on how to incorporate the middleware into the module

fedekunze · 2021-08-28T16:33:23Z

modules/apps/transfer/module.go

+	if cpTransferVersion != transferVersion {
+		return sdkerrors.Wrapf(types.ErrInvalidVersion, "expected counterparty version: %s, got: %s", types.Version, cpTransferVersion)
 	}


I'd move this above the ValidateTransferChannelParams since it doesn't require stateful validation

fedekunze · 2021-08-28T16:34:27Z

modules/apps/transfer/module.go

+	scopedKeeper capabilitykeeper.ScopedKeeper
+	app          porttypes.IBCModule


can you add comments for each of these fields and explain what they do in the context of the AppModule?

jackzampolin · 2021-08-29T00:27:37Z

Unclear how I could implement my idea for hub packet forwarding with this proposed middleware setup. Also would love feedback on the following PR:

https://github.com/strangelove-ventures/ibc-go/pull/1

colin-axner · 2021-08-30T10:16:31Z

Looks good, although I'd like to see additional documentation on how to incorporate the middleware into the module

Outside the scope of this pr as it isn't the responsibility of an external contributor. I've opened #359 (core maintainers will address this issue)

crodriguezvega · 2021-11-09T10:30:05Z

@thomas-nguy is there anything we can do to help you move forward with this PR? @colin-axner has finished a PR where he implemented middleware for another feature and we have now middleware documentation available as well. I hope these two sources can offer some guidance about how to develop middleware.

If you need any assistance, please let us know!

thomas-nguy · 2021-11-10T00:56:27Z

@crodriguezvega thanks for the reminder, I will have a look this week and try to complete a PR

thomas-nguy · 2021-11-10T14:25:02Z

i'm restarting the implementation from a clean main branch (#533)

* add markdown linter * fix existing markdowns

thomas-nguy requested review from AdityaSripal, colin-axner and fedekunze as code owners August 27, 2021 02:24

support middleware callback in ICS20

5dfaf88

thomas-nguy force-pushed the thomas/middleware-ICS20 branch from 7fcd78f to 5dfaf88 Compare August 27, 2021 02:26

add callback

5dabfe5

thomas-nguy force-pushed the thomas/middleware-ICS20 branch from 29caccd to 5dabfe5 Compare August 27, 2021 03:04

crodriguezvega reviewed Aug 27, 2021

View reviewed changes

colin-axner reviewed Aug 27, 2021

View reviewed changes

fix comments

1df0d88

fedekunze marked this pull request as draft August 28, 2021 16:29

fedekunze reviewed Aug 28, 2021

View reviewed changes

jackzampolin mentioned this pull request Aug 28, 2021

bech32 forwarding osmosis-labs/osmosis#425

Closed

colin-axner mentioned this pull request Sep 6, 2021

feat: Add handshake logic to ics29 #307

Merged

9 tasks

thomas-nguy closed this Nov 10, 2021

CosmosCar pushed a commit to caelus-labs/ibc-go that referenced this pull request Nov 6, 2023

Merge pull request cosmos#351 from celestiaorg/tzdybal/markdown-lint

e917abf

* add markdown linter * fix existing markdowns

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft: support middleware in ICS20 #351

Draft: support middleware in ICS20 #351

thomas-nguy commented Aug 27, 2021

lgtm-com bot commented Aug 27, 2021

lgtm-com bot commented Aug 27, 2021

crodriguezvega left a comment

crodriguezvega Aug 27, 2021

colin-axner Aug 27, 2021

jackzampolin Aug 28, 2021

crodriguezvega Aug 27, 2021

crodriguezvega Aug 27, 2021

crodriguezvega Aug 27, 2021

colin-axner Aug 27, 2021 •

edited

Loading

crodriguezvega Aug 27, 2021

colin-axner Aug 27, 2021

crodriguezvega Aug 27, 2021 •

edited

Loading

colin-axner Aug 27, 2021

colin-axner left a comment

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

crodriguezvega Aug 27, 2021

colin-axner Aug 27, 2021 •

edited

Loading

colin-axner Aug 27, 2021

colin-axner Aug 27, 2021

lgtm-com bot commented Aug 28, 2021

fedekunze left a comment

fedekunze Aug 28, 2021

fedekunze Aug 28, 2021

jackzampolin commented Aug 29, 2021

colin-axner commented Aug 30, 2021 •

edited

Loading

crodriguezvega commented Nov 9, 2021

thomas-nguy commented Nov 10, 2021 •

edited

Loading

thomas-nguy commented Nov 10, 2021


		import "strings"

		// SplitChannelVersion middleware version will split the channel version string

-		// middleware not supported
+		// This may occur if:
+		// - transfer is acting as the base application in the middleware stack
+		// - the connected base application has chosen not to append its own version

		scopedKeeper capabilitykeeper.ScopedKeeper
		app porttypes.IBCModule

Draft: support middleware in ICS20 #351

Draft: support middleware in ICS20 #351

Conversation

thomas-nguy commented Aug 27, 2021

Description

lgtm-com bot commented Aug 27, 2021

lgtm-com bot commented Aug 27, 2021

crodriguezvega left a 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

colin-axner Aug 27, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

crodriguezvega Aug 27, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colin-axner left a 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

colin-axner Aug 27, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lgtm-com bot commented Aug 28, 2021

fedekunze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jackzampolin commented Aug 29, 2021

colin-axner commented Aug 30, 2021 • edited Loading

crodriguezvega commented Nov 9, 2021

thomas-nguy commented Nov 10, 2021 • edited Loading

thomas-nguy commented Nov 10, 2021

colin-axner Aug 27, 2021 •

edited

Loading

crodriguezvega Aug 27, 2021 •

edited

Loading

colin-axner Aug 27, 2021 •

edited

Loading

colin-axner commented Aug 30, 2021 •

edited

Loading

thomas-nguy commented Nov 10, 2021 •

edited

Loading