Fix unnecessary retention of irrelevant messages (cosmos#980)

ComposableFi · Oct 7, 2022 · 811889c · 811889c
1 parent 26715dd
commit 811889c
Show file tree

Hide file tree

Showing 7 changed files with 163 additions and 86 deletions.
diff --git a/relayer/channel.go b/relayer/channel.go
@@ -47,11 +47,11 @@ func (c *Chain) CreateOpenChannels(
 
 	srcPathChain := pathChain{
 		provider: c.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 	dstPathChain := pathChain{
 		provider: dst.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 
 	// Timeout is per message. Four channel handshake messages, allowing maxRetries for each.
@@ -120,11 +120,11 @@ func (c *Chain) CloseChannel(
 ) error {
 	srcPathChain := pathChain{
 		provider: c.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 	dstPathChain := pathChain{
 		provider: dst.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 
 	// Timeout is per message. Two close channel handshake messages, allowing maxRetries for each.

diff --git a/relayer/connection.go b/relayer/connection.go
@@ -28,11 +28,11 @@ func (c *Chain) CreateOpenConnections(
 
 	srcpathChain := pathChain{
 		provider: c.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, c.PathEnd.ChainID, c.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 	dstpathChain := pathChain{
 		provider: dst.ChainProvider,
-		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChannelKey{}),
+		pathEnd:  processor.NewPathEnd(pathName, dst.PathEnd.ChainID, dst.PathEnd.ClientID, "", []processor.ChainChannelKey{}),
 	}
 
 	// Timeout is per message. Four connection handshake messages, allowing maxRetries for each.

diff --git a/relayer/processor/path_end.go b/relayer/processor/path_end.go
@@ -10,11 +10,17 @@ type PathEnd struct {
 
 	// Can be either "allowlist" or "denylist"
 	Rule       string
-	FilterList []ChannelKey // which channels to allow or deny
+	FilterList []ChainChannelKey // which channels to allow or deny
+}
+
+type ChainChannelKey struct {
+	ChainID             string
+	CounterpartyChainID string
+	ChannelKey          ChannelKey
 }
 
 // NewPathEnd constructs a PathEnd, validating initial parameters.
-func NewPathEnd(pathName string, chainID string, clientID string, rule string, filterList []ChannelKey) PathEnd {
+func NewPathEnd(pathName string, chainID string, clientID string, rule string, filterList []ChainChannelKey) PathEnd {
 	return PathEnd{
 		PathName:   pathName,
 		ChainID:    chainID,
@@ -29,34 +35,34 @@ const (
 	RuleDenyList  = "denylist"
 )
 
-func (pe PathEnd) checkChannelMatch(listChannelID, listPortID string, channelKey ChannelKey) bool {
+func (pe PathEnd) checkChannelMatch(listChainID, listChannelID, listPortID string, channelKey ChainChannelKey) bool {
 	if listChannelID == "" {
 		return false
 	}
-	if listChannelID == channelKey.ChannelID {
+	if listChannelID == channelKey.ChannelKey.ChannelID && listChainID == channelKey.ChainID {
 		if listPortID == "" {
 			return true
 		}
-		if listPortID == channelKey.PortID {
+		if listPortID == channelKey.ChannelKey.PortID {
 			return true
 		}
 	}
-	if listChannelID == channelKey.CounterpartyChannelID {
+	if listChannelID == channelKey.ChannelKey.CounterpartyChannelID && listChainID == channelKey.CounterpartyChainID {
 		if listPortID == "" {
 			return true
 		}
-		if listPortID == channelKey.CounterpartyPortID {
+		if listPortID == channelKey.ChannelKey.CounterpartyPortID {
 			return true
 		}
 	}
 	return false
 }
 
-func (pe PathEnd) shouldRelayChannelSingle(channelKey ChannelKey, listChannel ChannelKey, allowList bool) bool {
-	if pe.checkChannelMatch(listChannel.ChannelID, listChannel.PortID, channelKey) {
+func (pe PathEnd) shouldRelayChannelSingle(channelKey ChainChannelKey, listChannel ChainChannelKey, allowList bool) bool {
+	if pe.checkChannelMatch(listChannel.ChainID, listChannel.ChannelKey.ChannelID, listChannel.ChannelKey.PortID, channelKey) {
 		return allowList
 	}
-	if pe.checkChannelMatch(listChannel.CounterpartyChannelID, listChannel.CounterpartyPortID, channelKey) {
+	if pe.checkChannelMatch(listChannel.CounterpartyChainID, listChannel.ChannelKey.CounterpartyChannelID, listChannel.ChannelKey.CounterpartyPortID, channelKey) {
 		return allowList
 	}
 	return !allowList
@@ -66,7 +72,7 @@ func (pe PathEnd) shouldRelayChannelSingle(channelKey ChannelKey, listChannel Ch
 // if port ID is non-empty on allowlist channel, allow only that specific port
 // if port ID is empty on blocklist channel, block all ports
 // if port ID is non-empty on blocklist channel, block only that specific port
-func (pe PathEnd) ShouldRelayChannel(channelKey ChannelKey) bool {
+func (pe PathEnd) ShouldRelayChannel(channelKey ChainChannelKey) bool {
 	if pe.Rule == RuleAllowList {
 		for _, allowedChannel := range pe.FilterList {
 			if pe.shouldRelayChannelSingle(channelKey, allowedChannel, true) {

diff --git a/relayer/processor/path_end_runtime.go b/relayer/processor/path_end_runtime.go
@@ -95,7 +95,7 @@ func (pathEnd *pathEndRuntime) mergeMessageCache(messageCache IBCMessagesCache,
 	channelHandshakeMessages := make(ChannelMessagesCache)
 
 	for ch, pmc := range messageCache.PacketFlow {
-		if pathEnd.info.ShouldRelayChannel(ch) {
+		if pathEnd.info.ShouldRelayChannel(ChainChannelKey{ChainID: pathEnd.info.ChainID, ChannelKey: ch}) {
 			if inSync && pathEnd.metrics != nil {
 				for eventType, pCache := range pmc {
 					pathEnd.metrics.AddPacketsObserved(pathEnd.info.PathName, pathEnd.info.ChainID, ch.ChannelID, ch.PortID, eventType, len(pCache))