Multihop support

Makefile

@@ -73,7 +73,10 @@ interchaintest-docker-events:
 interchaintest-docker-legacy:
 	cd interchaintest && go test -race -v -run TestRelayerDockerLegacyProcessor .
 
-interchaintest-events:
+interchaintest-multihop:
+	cd interchaintest && go test -race -v -run TestRelayerMultihop .
+
+interchaintest-events: interchaintest-multihop
 	cd interchaintest && go test -race -v -run TestRelayerEventProcessor .
 
 interchaintest-legacy:

cmd/appstate.go

@@ -59,7 +59,7 @@ func (a *appState) AddPathFromFile(ctx context.Context, stderr io.Writer, file,
 // It returns any input or validation errors.
 // If the path was successfully added, it returns nil.
 func (a *appState) AddPathFromUserInput(ctx context.Context, stdin io.Reader, stderr io.Writer, src, dst, name string) error {
-	// TODO: confirm name is available before going through input.
+	// TODO: confirm name is available before going through input, add the ability to configure multi-hop paths
 
 	var (
 		value string

cmd/config.go

@@ -401,26 +401,63 @@ func (iw *ProviderConfigYAMLWrapper) UnmarshalYAML(n *yaml.Node) error {
 }
 
 // ChainsFromPath takes the path name and returns the properly configured chains
-func (c *Config) ChainsFromPath(path string) (map[string]*relayer.Chain, string, string, error) {
+func (c *Config) ChainsFromPath(path string) (map[string]*relayer.Chain, string, string, []*relayer.Chain, error) {
 	pth, err := c.Paths.Get(path)
 	if err != nil {
-		return nil, "", "", err
+		return nil, "", "", nil, err
 	}
 
 	src, dst := pth.Src.ChainID, pth.Dst.ChainID
 	chains, err := c.Chains.Gets(src, dst)
 	if err != nil {
-		return nil, "", "", err
+		return nil, "", "", nil, err
 	}
 
 	if err = chains[src].SetPath(pth.Src); err != nil {
-		return nil, "", "", err
+		return nil, "", "", nil, err
+	}
+	hops := []*relayer.Chain{}
+	lastChain := chains[src]
+	for i, hop := range pth.Hops {
+		hopChain, err := c.Chains.Get(hop.ChainID)
+		if err != nil {
+			return nil, "", "", nil, err
+		}
+		if err = hopChain.SetRelayPaths(hop.PathEnds); err != nil {
+			return nil, "", "", nil, err
+		}
+		hops = append(hops, hopChain)
+		// Find a path between adjacent chains and populate clients and connections
+		pthPrevToCurrHop := c.Paths.Find(lastChain.ChainID(), hopChain.ChainID())
+		if pthPrevToCurrHop != nil {
+			hopChain.RelayPathEnds[0].ClientID = pthPrevToCurrHop.Dst.ClientID
+			hopChain.RelayPathEnds[0].ConnectionID = pthPrevToCurrHop.Dst.ConnectionID
+			if i == 0 {
+				lastChain.PathEnd.ClientID = pthPrevToCurrHop.Src.ClientID
+				lastChain.PathEnd.ConnectionID = pthPrevToCurrHop.Src.ConnectionID
+			} else {
+				lastChain.RelayPathEnds[1].ClientID = pthPrevToCurrHop.Src.ClientID
+				lastChain.RelayPathEnds[1].ConnectionID = pthPrevToCurrHop.Src.ConnectionID
+			}
+		}
+		// Connect the last hop to the destination
+		if i == len(pth.Hops)-1 {
+			pthHopToDst := c.Paths.Find(hopChain.ChainID(), dst)
+			if pthHopToDst != nil {
+				hopChain.RelayPathEnds[1].ClientID = pthHopToDst.Src.ClientID
+				hopChain.RelayPathEnds[1].ConnectionID = pthHopToDst.Src.ConnectionID
+				pth.Dst.ClientID = pthHopToDst.Dst.ClientID
+				pth.Dst.ConnectionID = pthHopToDst.Dst.ConnectionID
+			}
+		}
+		chains[hop.ChainID] = hopChain
+		lastChain = hopChain
 	}
 	if err = chains[dst].SetPath(pth.Dst); err != nil {
-		return nil, "", "", err
+		return nil, "", "", nil, err
 	}
 
-	return chains, src, dst, nil
+	return chains, src, dst, hops, nil
 }
 
 // MustYAML returns the yaml string representation of the Paths

cmd/paths.go

@@ -232,15 +232,16 @@ $ %s config add-paths examples/demo/configs/paths`, appName)),
 
 func pathsNewCmd(a *appState) *cobra.Command {
 	cmd := &cobra.Command{
-		Use:     "new src_chain_id dst_chain_id path_name",
+		Use:     "new src_chain_id dst_chain_id path_name [hop1_chain_id hop2_chain_id ... hopN_chain_id]",
 		Aliases: []string{"n"},
 		Short:   "Create a new blank path to be used in generating a new path (connection & client) between two chains",
-		Args:    withUsage(cobra.ExactArgs(3)),
+		Args:    withUsage(cobra.MinimumNArgs(3)),
 		Example: strings.TrimSpace(fmt.Sprintf(`
 $ %s paths new ibc-0 ibc-1 demo-path
 $ %s pth n ibc-0 ibc-1 demo-path`, appName, appName)),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			src, dst := args[0], args[1]
+			hops := args[3:]
 			_, err := a.Config.Chains.Gets(src, dst)
 			if err != nil {
 				return fmt.Errorf("chains need to be configured before paths to them can be added: %w", err)
@@ -250,7 +251,39 @@ $ %s pth n ibc-0 ibc-1 demo-path`, appName, appName)),
 				Src: &relayer.PathEnd{ChainID: src},
 				Dst: &relayer.PathEnd{ChainID: dst},
 			}
-
+			p.Hops = make([]*relayer.PathHop, len(hops))
+			lastChainID := p.Src.ChainID
+			for i, hop := range hops {
+				// TODO: this logic is similar to Config.ChainsFromPath(), look into consolidating
+				pthPrevToCurrHop := a.Config.Paths.Find(lastChainID, hop)
+				newHop := &relayer.PathHop{
+					ChainID: hop,
+					PathEnds: [2]*relayer.PathEnd{
+						{
+							ChainID:      hop,
+							ClientID:     pthPrevToCurrHop.Dst.ClientID,
+							ConnectionID: pthPrevToCurrHop.Dst.ConnectionID,
+						}, {},
+					},
+				}
+				if i == 0 {
+					p.Src.ClientID = pthPrevToCurrHop.Src.ClientID
+					p.Src.ConnectionID = pthPrevToCurrHop.Src.ConnectionID
+				} else {
+					p.Hops[i-1].PathEnds[1].ClientID = pthPrevToCurrHop.Src.ClientID
+					p.Hops[i-1].PathEnds[1].ConnectionID = pthPrevToCurrHop.Src.ConnectionID
+				}
+				if i == len(hops)-1 {
+					newHop.PathEnds[1].ChainID = hop
+					pthCurrHopToDst := a.Config.Paths.Find(hop, p.Dst.ChainID)
+					newHop.PathEnds[1].ClientID = pthCurrHopToDst.Src.ClientID
+					newHop.PathEnds[1].ConnectionID = pthCurrHopToDst.Src.ConnectionID
+					p.Dst.ClientID = pthCurrHopToDst.Dst.ClientID
+					p.Dst.ConnectionID = pthCurrHopToDst.Dst.ConnectionID
+				}
+				p.Hops[i] = newHop
+				lastChainID = newHop.ChainID
+			}
 			name := args[2]
 			if err = a.Config.Paths.Add(name, p); err != nil {
 				return err
@@ -433,9 +466,14 @@ $ %s pth fch`, appName, defaultHome, appName)),
 					ClientID:     ibc.Chain2.ClientID,
 					ConnectionID: ibc.Chain2.ConnectionID,
 				}
+				hops, err := relayer.NewPathHops(ibc, srcPathEnd, dstPathEnd, &a.Config.Chains)
+				if err != nil {
+					return err
+				}
 				newPath := &relayer.Path{
-					Src: srcPathEnd,
-					Dst: dstPathEnd,
+					Src:  srcPathEnd,
+					Dst:  dstPathEnd,
+					Hops: hops,
 				}
 				client.Close()
 

cmd/start.go

@@ -59,6 +59,9 @@ $ %s start demo-path2 --max-tx-size 10`, appName, appName, appName, appName)),
 					// collect unique chain IDs
 					chains[path.Src.ChainID] = nil
 					chains[path.Dst.ChainID] = nil
+					for _, h := range path.Hops {
+						chains[h.ChainID] = nil
+					}
 				}
 			} else {
 				for n, path := range a.Config.Paths {
@@ -70,6 +73,9 @@ $ %s start demo-path2 --max-tx-size 10`, appName, appName, appName, appName)),
 					// collect unique chain IDs
 					chains[path.Src.ChainID] = nil
 					chains[path.Dst.ChainID] = nil
+					for _, h := range path.Hops {
+						chains[h.ChainID] = nil
+					}
 				}
 			}
 

cmd/tx.go

@@ -85,7 +85,7 @@ func createClientsCmd(a *appState) *cobra.Command {
 
 			path := args[0]
 
-			c, src, dst, err := a.Config.ChainsFromPath(path)
+			c, src, dst, _, err := a.Config.ChainsFromPath(path)
 			if err != nil {
 				return err
 			}
@@ -245,7 +245,7 @@ corresponding update-client messages.`,
 		Args:    withUsage(cobra.ExactArgs(1)),
 		Example: strings.TrimSpace(fmt.Sprintf(`$ %s transact update-clients demo-path`, appName)),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			c, src, dst, err := a.Config.ChainsFromPath(args[0])
+			c, src, dst, _, err := a.Config.ChainsFromPath(args[0])
 			if err != nil {
 				return err
 			}
@@ -271,7 +271,7 @@ func upgradeClientsCmd(a *appState) *cobra.Command {
 		Short: "upgrades IBC clients between two configured chains with a configured path and chain-id",
 		Args:  withUsage(cobra.ExactArgs(2)),
 		RunE: func(cmd *cobra.Command, args []string) error {
-			c, src, dst, err := a.Config.ChainsFromPath(args[0])
+			c, src, dst, _, err := a.Config.ChainsFromPath(args[0])
 			if err != nil {
 				return err
 			}
@@ -339,7 +339,7 @@ $ %s tx conn demo-path --timeout 5s`,
 
 			pathName := args[0]
 
-			c, src, dst, err := a.Config.ChainsFromPath(pathName)
+			c, src, dst, _, err := a.Config.ChainsFromPath(pathName)
 			if err != nil {
 				return err
 			}
@@ -426,7 +426,7 @@ $ %s tx chan demo-path --timeout 5s --max-retries 10`,
 
 			pathName := args[0]
 
-			c, src, dst, err := a.Config.ChainsFromPath(pathName)
+			c, src, dst, hops, err := a.Config.ChainsFromPath(pathName)
 			if err != nil {
 				return err
 			}
@@ -475,7 +475,7 @@ $ %s tx chan demo-path --timeout 5s --max-retries 10`,
 			}
 
 			// create channel if it isn't already created
-			return c[src].CreateOpenChannels(cmd.Context(), c[dst], retries, to, srcPort, dstPort, order, version, override, a.Config.memo(cmd), pathName)
+			return c[src].CreateOpenChannels(cmd.Context(), c[dst], hops, retries, to, srcPort, dstPort, order, version, override, a.Config.memo(cmd), pathName)
 		},
 	}
 
@@ -502,7 +502,7 @@ $ %s tx channel-close demo-path channel-0 transfer -o 3s`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			pathName := args[0]
 
-			c, src, dst, err := a.Config.ChainsFromPath(pathName)
+			c, src, dst, hops, err := a.Config.ChainsFromPath(pathName)
 			if err != nil {
 				return err
 			}
@@ -538,7 +538,7 @@ $ %s tx channel-close demo-path channel-0 transfer -o 3s`,
 				return err
 			}
 
-			return c[src].CloseChannel(cmd.Context(), c[dst], retries, to, channelID, portID, a.Config.memo(cmd), pathName)
+			return c[src].CloseChannel(cmd.Context(), c[dst], hops, retries, to, channelID, portID, a.Config.memo(cmd), pathName)
 		},
 	}
 
@@ -587,12 +587,23 @@ $ %s tx connect demo-path --src-port transfer --dst-port transfer --order unorde
 			}
 
 			src, dst := pth.Src.ChainID, pth.Dst.ChainID
-			c, err := a.Config.Chains.Gets(src, dst)
+			chainIDs := []string{src}
+			for _, hop := range pth.Hops {
+				chainIDs = append(chainIDs, hop.ChainID)
+			}
+			chainIDs = append(chainIDs, dst)
+			c, err := a.Config.Chains.Gets(chainIDs...)
 			if err != nil {
 				return err
 			}
 
 			c[src].PathEnd = pth.Src
+			hops := []*relayer.Chain{}
+			for _, hop := range pth.Hops {
+				hopChain := c[hop.ChainID]
+				c[hop.ChainID].RelayPathEnds = hop.PathEnds
+				hops = append(hops, hopChain)
+			}
 			c[dst].PathEnd = pth.Dst
 
 			srcPort, err := cmd.Flags().GetString(flagSrcPort)
@@ -645,30 +656,37 @@ $ %s tx connect demo-path --src-port transfer --dst-port transfer --order unorde
 				return err
 			}
 
-			// create clients if they aren't already created
-			clientSrc, clientDst, err := c[src].CreateClients(cmd.Context(), c[dst], allowUpdateAfterExpiry, allowUpdateAfterMisbehaviour, override, customClientTrustingPeriod, memo)
-			if err != nil {
-				return fmt.Errorf("error creating clients: %w", err)
-			}
-			if clientSrc != "" || clientDst != "" {
-				if err := a.OverwriteConfigOnTheFly(cmd, pathName, clientSrc, clientDst, "", ""); err != nil {
-					return err
+			for i, srcChainID := range chainIDs {
+				if i == len(chainIDs)-1 {
+					// When we reach dst we already connected via the previous hop
+					break
 				}
-			}
+				dstChainID := chainIDs[i+1]
 
-			// create connection if it isn't already created
-			connectionSrc, connectionDst, err := c[src].CreateOpenConnections(cmd.Context(), c[dst], retries, to, memo, initialBlockHistory, pathName)
-			if err != nil {
-				return fmt.Errorf("error creating connections: %w", err)
-			}
-			if connectionSrc != "" || connectionDst != "" {
-				if err := a.OverwriteConfigOnTheFly(cmd, pathName, "", "", connectionSrc, connectionDst); err != nil {
-					return err
+				// create clients if they aren't already created
+				clientSrc, clientDst, err := c[srcChainID].CreateClients(cmd.Context(), c[dstChainID], allowUpdateAfterExpiry, allowUpdateAfterMisbehaviour, override, customClientTrustingPeriod, memo)
+				if err != nil {
+					return fmt.Errorf("error creating clients: %w", err)
+				}
+				if clientSrc != "" || clientDst != "" {
+					if err := a.OverwriteConfigOnTheFly(cmd, pathName, clientSrc, clientDst, "", ""); err != nil {
+						return err
+					}
 				}
-			}
 
+				// create connection if it isn't already created
+				connectionSrc, connectionDst, err := c[srcChainID].CreateOpenConnections(cmd.Context(), c[dstChainID], retries, to, memo, initialBlockHistory, pathName)
+				if err != nil {
+					return fmt.Errorf("error creating connections: %w", err)
+				}
+				if connectionSrc != "" || connectionDst != "" {
+					if err := a.OverwriteConfigOnTheFly(cmd, pathName, "", "", connectionSrc, connectionDst); err != nil {
+						return err
+					}
+				}
+			}
 			// create channel if it isn't already created
-			return c[src].CreateOpenChannels(cmd.Context(), c[dst], retries, to, srcPort, dstPort, order, version, override, memo, pathName)
+			return c[src].CreateOpenChannels(cmd.Context(), c[dst], hops, retries, to, srcPort, dstPort, order, version, override, memo, pathName)
 		},
 	}
 	cmd = timeoutFlag(a.Viper, cmd)
@@ -752,6 +770,9 @@ $ %s tx flush demo-path channel-0`,
 				// collect unique chain IDs
 				chains[path.Src.ChainID] = nil
 				chains[path.Dst.ChainID] = nil
+				for _, h := range path.Hops {
+					chains[h.ChainID] = nil
+				}
 			} else {
 				for n, path := range a.Config.Paths {
 					paths = append(paths, relayer.NamedPath{
@@ -762,6 +783,9 @@ $ %s tx flush demo-path channel-0`,
 					// collect unique chain IDs
 					chains[path.Src.ChainID] = nil
 					chains[path.Dst.ChainID] = nil
+					for _, h := range path.Hops {
+						chains[h.ChainID] = nil
+					}
 				}
 			}