feat: added a cosmos-to-cosmos relayer module with basic tests

.github/workflows/e2e.yml

@@ -78,6 +78,7 @@ jobs:
           - TestWithRelayerTestSuite/TestTimeoutPacketFromEth_Plonk
           - TestWithRelayerTestSuite/Test_10_TimeoutPacketFromEth_Groth16
           - TestWithRelayerTestSuite/Test_5_TimeoutPacketFromEth_Plonk
+          - TestWithCosmosRelayerTestSuite/TestRelayerInfo
           - TestWithSP1ICS07TendermintTestSuite/TestDeploy_Groth16
           - TestWithSP1ICS07TendermintTestSuite/TestDeploy_Plonk
           - TestWithSP1ICS07TendermintTestSuite/TestUpdateClient_Groth16

Cargo.toml

@@ -47,7 +47,6 @@ tokio       = { version = "1.0", default-features = false }
 axum        = { version = "0.7", default-features = false }
 tonic       = { version = "0.12", default-features = false }
 tonic-build = { version = "0.12", default-features = false }
-reqwest     = { version = "0.12", default-features = false }
 
 tracing            = { version = "0.1", default-features = false }
 tracing-subscriber = { version = "0.3", default-features = false }

e2e/interchaintestv8/chainconfig/chain_config.go

@@ -7,11 +7,15 @@ import (
 
 var DefaultChainSpecs = []*interchaintest.ChainSpec{
 	// -- IBC-Go --
-	{
+	IbcGoChainSpec("ibc-go-simd-1", "simd-1"),
+}
+
+func IbcGoChainSpec(name, chainId string) *interchaintest.ChainSpec {
+	return &interchaintest.ChainSpec{
 		ChainConfig: ibc.ChainConfig{
 			Type:    "cosmos",
-			Name:    "ibc-go-simd",
-			ChainID: "simd-1",
+			Name:    name,
+			ChainID: chainId,
 			Images: []ibc.DockerImage{
 				{
 					Repository: "ghcr.io/cosmos/ibc-go-wasm-simd", // FOR LOCAL IMAGE USE: Docker Image Name
@@ -29,5 +33,5 @@ var DefaultChainSpecs = []*interchaintest.ChainSpec{
 			TrustingPeriod: "508h",
 			NoHostMount:    false,
 		},
-	},
+	}
 }

e2e/interchaintestv8/cosmos_relayer_test.go

@@ -0,0 +1,118 @@
+package main
+
+import (
+	"context"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/suite"
+
+	"github.com/strangelove-ventures/interchaintest/v8/chain/cosmos"
+	"github.com/strangelove-ventures/interchaintest/v8/ibc"
+
+	"github.com/srdtrk/solidity-ibc-eureka/e2e/v8/chainconfig"
+	"github.com/srdtrk/solidity-ibc-eureka/e2e/v8/e2esuite"
+	"github.com/srdtrk/solidity-ibc-eureka/e2e/v8/relayer"
+	"github.com/srdtrk/solidity-ibc-eureka/e2e/v8/testvalues"
+	relayertypes "github.com/srdtrk/solidity-ibc-eureka/e2e/v8/types/relayer"
+)
+
+// CosmosRelayerTestSuite is a struct that holds the test suite for two Cosmos chains.
+type CosmosRelayerTestSuite struct {
+	e2esuite.TestSuite
+
+	SimdA *cosmos.CosmosChain
+	SimdB *cosmos.CosmosChain
+
+	SimdASubmitter ibc.Wallet
+	SimdBSubmitter ibc.Wallet
+
+	AtoBRelayerClient relayertypes.RelayerServiceClient
+	BtoARelayerClient relayertypes.RelayerServiceClient
+}
+
+// TestWithIbcEurekaTestSuite is the boilerplate code that allows the test suite to be run
+func TestWithCosmosRelayerTestSuite(t *testing.T) {
+	suite.Run(t, new(CosmosRelayerTestSuite))
+}
+
+// SetupSuite calls the underlying IbcEurekaTestSuite's SetupSuite method
+// and deploys the IbcEureka contract
+func (s *CosmosRelayerTestSuite) SetupSuite(ctx context.Context) {
+	chainconfig.DefaultChainSpecs = append(chainconfig.DefaultChainSpecs, chainconfig.IbcGoChainSpec("ibc-go-simd-2", "simd-2"))
+
+	os.Setenv(testvalues.EnvKeyEthTestnetType, testvalues.EthTestnetTypeNone)
+
+	s.TestSuite.SetupSuite(ctx)
+
+	s.SimdA, s.SimdB = s.CosmosChains[0], s.CosmosChains[1]
+	s.SimdASubmitter = s.CreateAndFundCosmosUser(ctx, s.SimdA)
+	s.SimdBSubmitter = s.CreateAndFundCosmosUser(ctx, s.SimdB)
+
+	var relayerProcess *os.Process
+	var configInfo relayer.CosmosToCosmosConfigInfo
+	s.Require().True(s.Run("Start Relayer", func() {
+		err := os.Chdir("../..")
+		s.Require().NoError(err)
+
+		configInfo = relayer.CosmosToCosmosConfigInfo{
+			ChainATmRPC: s.SimdA.GetHostRPCAddress(),
+			ChainBTmRPC: s.SimdB.GetHostRPCAddress(),
+			ChainAUser:  s.SimdASubmitter.FormattedAddress(),
+			ChainBUser:  s.SimdBSubmitter.FormattedAddress(),
+		}
+
+		err = configInfo.GenerateCosmosToCosmosConfigFile(testvalues.RelayerConfigFilePath)
+		s.Require().NoError(err)
+
+		relayerProcess, err = relayer.StartRelayer(testvalues.RelayerConfigFilePath)
+		s.Require().NoError(err)
+
+		s.T().Cleanup(func() {
+			os.Remove(testvalues.RelayerConfigFilePath)
+		})
+	}))
+
+	s.T().Cleanup(func() {
+		if relayerProcess != nil {
+			_ = relayerProcess.Kill()
+		}
+	})
+
+	s.Require().True(s.Run("Create Relayer Client", func() {
+		var err error
+		s.AtoBRelayerClient, err = relayer.GetGRPCClient(configInfo.ChainAToChainBGRPCAddress())
+		s.Require().NoError(err)
+
+		s.BtoARelayerClient, err = relayer.GetGRPCClient(configInfo.ChainBToChainAGRPCAddress())
+		s.Require().NoError(err)
+	}))
+}
+
+// TestRelayer is a test that runs the relayer
+func (s *CosmosRelayerTestSuite) TestRelayerInfo() {
+	ctx := context.Background()
+	s.SetupSuite(ctx)
+
+	s.Run("Chain A to B Relayer Info", func() {
+		info, err := s.AtoBRelayerClient.Info(context.Background(), &relayertypes.InfoRequest{})
+		s.Require().NoError(err)
+		s.Require().NotNil(info)
+
+		s.T().Logf("Relayer Info: %+v", info)
+
+		s.Require().Equal(s.SimdA.Config().ChainID, info.SourceChain.ChainId)
+		s.Require().Equal(s.SimdB.Config().ChainID, info.TargetChain.ChainId)
+	})
+
+	s.Run("Chain B to A Relayer Info", func() {
+		info, err := s.BtoARelayerClient.Info(context.Background(), &relayertypes.InfoRequest{})
+		s.Require().NoError(err)
+		s.Require().NotNil(info)
+
+		s.T().Logf("Relayer Info: %+v", info)
+
+		s.Require().Equal(s.SimdB.Config().ChainID, info.SourceChain.ChainId)
+		s.Require().Equal(s.SimdA.Config().ChainID, info.TargetChain.ChainId)
+	})
+}

e2e/interchaintestv8/e2esuite/light_clients.go

@@ -39,7 +39,7 @@ func (s *TestSuite) UpdateEthClient(ctx context.Context, ibcContractAddress stri
 		return
 	}
 
-	eth, simd := s.ChainA, s.ChainB
+	eth, simd := s.EthChain, s.CosmosChains[0]
 
 	// Wait until we have a block number greater than the minimum update to
 	var updateTo int64
@@ -222,7 +222,7 @@ func (s *TestSuite) UpdateEthClient(ctx context.Context, ibcContractAddress stri
 }
 
 func (s *TestSuite) createUnionLightClient(ctx context.Context, simdRelayerUser ibc.Wallet, ibcContractAddress string, rustFixtureGenerator *types.RustFixtureGenerator) {
-	eth, simd := s.ChainA, s.ChainB
+	eth, simd := s.EthChain, s.CosmosChains[0]
 
 	file, err := os.Open("e2e/interchaintestv8/wasm/ethereum_light_client_minimal.wasm.gz")
 	s.Require().NoError(err)
@@ -329,7 +329,7 @@ func (s *TestSuite) createUnionLightClient(ctx context.Context, simdRelayerUser
 }
 
 func (s *TestSuite) createDummyLightClient(ctx context.Context, simdRelayerUser ibc.Wallet) {
-	eth, simd := s.ChainA, s.ChainB
+	eth, simd := s.EthChain, s.CosmosChains[0]
 
 	file, err := os.Open("e2e/interchaintestv8/wasm/wasm_dummy_light_client.wasm.gz")
 	s.Require().NoError(err)

e2e/interchaintestv8/e2esuite/suite.go

@@ -31,14 +31,13 @@ const anvilFaucetPrivateKey = "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5ef
 type TestSuite struct {
 	suite.Suite
 
-	ChainA         ethereum.Ethereum
+	EthChain       ethereum.Ethereum
 	ethTestnetType string
-	ChainB         *cosmos.CosmosChain
-	UserB          ibc.Wallet
+	CosmosChains   []*cosmos.CosmosChain
+	CosmosUsers    []ibc.Wallet
 	dockerClient   *dockerclient.Client
 	network        string
 	logger         *zap.Logger
-	ExecRep        *testreporter.RelayerExecReporter
 
 	EthereumLightClientID         string
 	TendermintLightClientID       string
@@ -59,7 +58,7 @@ func (s *TestSuite) SetupSuite(ctx context.Context) {
 	case testvalues.EthTestnetTypePoS:
 		kurtosisChain, err := chainconfig.SpinUpKurtosisPoS(ctx) // TODO: Run this in a goroutine and wait for it to be ready
 		s.Require().NoError(err)
-		s.ChainA, err = ethereum.NewEthereum(ctx, kurtosisChain.RPC, &kurtosisChain.BeaconApiClient, kurtosisChain.Faucet)
+		s.EthChain, err = ethereum.NewEthereum(ctx, kurtosisChain.RPC, &kurtosisChain.BeaconApiClient, kurtosisChain.Faucet)
 		s.Require().NoError(err)
 		s.T().Cleanup(func() {
 			ctx := context.Background()
@@ -68,6 +67,8 @@ func (s *TestSuite) SetupSuite(ctx context.Context) {
 			}
 			kurtosisChain.Destroy(ctx)
 		})
+	case testvalues.EthTestnetTypeNone:
+		// Do nothing
 	default:
 		s.T().Fatalf("Unknown Ethereum testnet type: %s", s.ethTestnetType)
 	}
@@ -80,40 +81,48 @@ func (s *TestSuite) SetupSuite(ctx context.Context) {
 	chains, err := cf.Chains(s.T().Name())
 	s.Require().NoError(err)
 
-	s.ChainB = chains[0].(*cosmos.CosmosChain)
-
 	ic := interchaintest.NewInterchain()
 	for _, chain := range chains {
 		ic = ic.AddChain(chain)
 	}
 
-	s.ExecRep = testreporter.NewNopReporter().RelayerExecReporter(s.T())
+	execRep := testreporter.NewNopReporter().RelayerExecReporter(s.T())
 
 	// TODO: Run this in a goroutine and wait for it to be ready
-	s.Require().NoError(ic.Build(ctx, s.ExecRep, interchaintest.InterchainBuildOptions{
+	s.Require().NoError(ic.Build(ctx, execRep, interchaintest.InterchainBuildOptions{
 		TestName:         s.T().Name(),
 		Client:           s.dockerClient,
 		NetworkID:        s.network,
 		SkipPathCreation: true,
 	}))
 
-	// map all query request types to their gRPC method paths for cosmos chains
-	s.Require().NoError(populateQueryReqToPath(ctx, s.ChainB))
-
 	if s.ethTestnetType == testvalues.EthTestnetTypePoW {
-		anvil := chains[1].(*icethereum.EthereumChain)
+		anvil := chains[len(chains)-1].(*icethereum.EthereumChain)
 		faucet, err := crypto.ToECDSA(ethcommon.FromHex(anvilFaucetPrivateKey))
 		s.Require().NoError(err)
 
-		s.ChainA, err = ethereum.NewEthereum(ctx, anvil.GetHostRPCAddress(), nil, faucet)
+		s.EthChain, err = ethereum.NewEthereum(ctx, anvil.GetHostRPCAddress(), nil, faucet)
 		s.Require().NoError(err)
+
+		// Remove the Ethereum chain from the cosmos chains
+		chains = chains[:len(chains)-1]
+	}
+
+	for _, chain := range chains {
+		cosmosChain := chain.(*cosmos.CosmosChain)
+		s.CosmosChains = append(s.CosmosChains, cosmosChain)
 	}
 
+	// map all query request types to their gRPC method paths for cosmos chains
+	s.Require().NoError(populateQueryReqToPath(ctx, s.CosmosChains[0]))
+
 	// Fund user accounts
 	cosmosUserFunds := sdkmath.NewInt(testvalues.InitialBalance)
-	cosmosUsers := interchaintest.GetAndFundTestUsers(s.T(), ctx, s.T().Name(), cosmosUserFunds, s.ChainB)
-	s.UserB = cosmosUsers[0]
+	cosmosUsers := interchaintest.GetAndFundTestUsers(s.T(), ctx, s.T().Name(), cosmosUserFunds, chains...)
+	s.CosmosUsers = cosmosUsers
 
 	s.proposalIDs = make(map[string]uint64)
-	s.proposalIDs[s.ChainB.Config().ChainID] = 1
+	for _, chain := range s.CosmosChains {
+		s.proposalIDs[chain.Config().ChainID] = 1
+	}
 }

e2e/interchaintestv8/e2esuite/utils.go

@@ -53,12 +53,6 @@ import (
 	ethereumligthclient "github.com/srdtrk/solidity-ibc-eureka/e2e/v8/types/ethereumlightclient"
 )
 
-// FundAddressChainB sends funds to the given address on Chain B.
-// The amount sent is 1,000,000,000 of the chain's denom.
-func (s *TestSuite) FundAddressChainB(ctx context.Context, address string) {
-	s.fundAddress(ctx, s.ChainB, s.UserB.KeyName(), address)
-}
-
 // BroadcastMessages broadcasts the provided messages to the given chain and signs them on behalf of the provided user.
 // Once the broadcast response is returned, we wait for two blocks to be created on chain.
 func (s *TestSuite) BroadcastMessages(ctx context.Context, chain *cosmos.CosmosChain, user ibc.Wallet, gas uint64, msgs ...sdk.Msg) (*sdk.TxResponse, error) {
@@ -96,32 +90,12 @@ func (s *TestSuite) BroadcastMessages(ctx context.Context, chain *cosmos.CosmosC
 	return &resp, nil
 }
 
-// fundAddress sends funds to the given address on the given chain
-func (s *TestSuite) fundAddress(ctx context.Context, chain *cosmos.CosmosChain, keyName, address string) {
-	err := chain.SendFunds(ctx, keyName, ibc.WalletAmount{
-		Address: address,
-		Denom:   chain.Config().Denom,
-		Amount:  sdkmath.NewInt(1_000_000_000),
-	})
-	s.Require().NoError(err)
-
-	// wait for 2 blocks for the funds to be received
-	err = testutil.WaitForBlocks(ctx, 2, chain)
-	s.Require().NoError(err)
-}
-
-// GetRelayerUsers returns two ibc.Wallet instances which can be used for the relayer users
-// on the two chains.
-func (s *TestSuite) GetRelayerUsers(ctx context.Context) (*ecdsa.PrivateKey, ibc.Wallet) {
-	eth, simd := s.ChainA, s.ChainB
-
-	ethKey, err := eth.CreateAndFundUser()
-	s.Require().NoError(err)
-
+// CreateAndFundCosmosUser returns a new cosmos user with the given initial balance and funds it with the native chain denom.
+func (s *TestSuite) CreateAndFundCosmosUser(ctx context.Context, chain *cosmos.CosmosChain) ibc.Wallet {
 	cosmosUserFunds := sdkmath.NewInt(testvalues.InitialBalance)
-	cosmosUsers := interchaintest.GetAndFundTestUsers(s.T(), ctx, s.T().Name(), cosmosUserFunds, simd)
+	cosmosUsers := interchaintest.GetAndFundTestUsers(s.T(), ctx, s.T().Name(), cosmosUserFunds, chain)
 
-	return ethKey, cosmosUsers[0]
+	return cosmosUsers[0]
 }
 
 // GetEvmEvent parses the logs in the given receipt and returns the first event that can be parsed