feat!: local-ic remove relayer file dependency (#908) (#909)

* Remove `relayer.json` in favor of CLI arguments

* py: make nested directories for config

* git keep `configs`

* exist_ok=True

* remove .gitkeep

* remove forced `config` directory check

(cherry picked from commit b85a060)

Co-authored-by: Reece Williams <[email protected]>

.github/workflows/local-interchain.yaml

@@ -27,14 +27,14 @@ jobs:
         with:
             go-version: ${{ env.GO_VERSION }}
 
-      - name: build local-interchain        
+      - name: build local-interchain
         run: go mod tidy && make install
 
       - name: Upload localic artifact
         uses: actions/upload-artifact@v3
         with:
           name: local-ic
-          path: ~/go/bin/local-ic          
+          path: ~/go/bin/local-ic
 
 
   rust-e2e:
@@ -46,7 +46,7 @@ jobs:
         working-directory: ./local-interchain
     strategy:
       fail-fast: false
-      
+
     steps:
       - name: checkout chain
         uses: actions/checkout@v3
@@ -64,17 +64,17 @@ jobs:
         with:
           name: local-ic
           path: /tmp
-      
+
       - name: Make local-ic executable
         run: chmod +x /tmp/local-ic
 
-      - name: Start background ibc local-interchain        
+      - name: Start background ibc local-interchain
         run: /tmp/local-ic start juno_ibc --api-port 8080 &
-      
+
       - name: Run Rust Script
         run: cd rust && cargo run --package localic-bin --bin localic-bin
 
-      - name: Cleanup        
+      - name: Cleanup
         run: killall local-ic && exit 0
 
   python-e2e:
@@ -85,12 +85,12 @@ jobs:
       run:
         working-directory: ./local-interchain
     strategy:
-      matrix:        
-        test:          
+      matrix:
+        test:
           - ["api_test", 8081]
           - ["ibc_contract", 8082]
       fail-fast: false
-      
+
     steps:
       - name: checkout chain
         uses: actions/checkout@v3
@@ -100,22 +100,22 @@ jobs:
         with:
           python-version: '3.10'
           cache: 'pip'
-      - run: pip install -r python/requirements.txt --break-system-packages  
+      - run: pip install -r python/requirements.txt --break-system-packages
 
       - name: Download Tarball Artifact
         uses: actions/download-artifact@v3
         with:
           name: local-ic
           path: /tmp
-      
+
       - name: Make local-ic executable
         run: chmod +x /tmp/local-ic
 
       - name: Start background ibc local-interchain
         run: /tmp/local-ic start juno_ibc --api-port ${{ matrix.test[1] }} &
-      
-      - name: Run Python Script        
+
+      - name: Run Python Script
         run: python3 ./python/${{ matrix.test[0] }}.py --api-port ${{ matrix.test[1] }}
 
-      - name: Cleanup        
+      - name: Cleanup
         run: killall local-ic && exit 0

local-interchain/README.md

@@ -10,7 +10,7 @@ A simple way to config and run IBC local chain testing environments with any lan
 
 **Install on Mac / Linux**
 ```bash
-git clone https://github.com/strangelove-ventures/interchaintest.git 
+git clone https://github.com/strangelove-ventures/interchaintest.git
 
 cd interchaintest/local-interchain
 
@@ -24,14 +24,15 @@ Follow [this guide](./docs/WINDOWS.md) to setup the Windows OS environment for i
 
 ## Running
 
-- *(optional)* Edit `./configs/relayer.json`
 - Copy: `cp ./configs/base_ibc.json ./configs/mytest1_ignored.json`
-- Run: `local-ic start mytest1_ignored.json`
-- Run in different directory: `ICTEST_HOME=/root/local-interchain local-ic start myother_ignored.json`
+- Run: `local-ic start mytest1_ignored.json [flags]`
+- Run in different directory: `ICTEST_HOME=/root/local-interchain local-ic start myother_ignored.json [flags]`
+
+Modify the relayer information on `start` with the --relayer-* flags.
 
 **NOTE** The ICTEST_HOME path must contain the directories `chains` and `configs` to be valid.
 
-*(Default: `make install` links to the cloned directory. `go install .` will use your home directory /local-interchain)*
+*(Default: `make install` links to the cloned directory. `go install .` will use your home directory ~/local-interchain)*
 
 *(Ending the config file with `_ignored.json` or `_ignore.json` will ignore it from git)*
 
@@ -71,12 +72,12 @@ Read more about the API [here](./docs/REST_API.md)
 
 ```json
 {
-    "name": "juno",            
+    "name": "juno",
     "chain_id": "localjuno-2",
     "denom": "ujuno",
-    "docker_image": {        
+    "docker_image": {
         "version": "v14.1.0"
-    },    
+    },
     "gas_prices": "0%DENOM%",
     "gas_adjustment": 2.0
 }
@@ -90,7 +91,7 @@ Here is a base chain template with every feature the configuration accepts. Acco
 
 ```json
 {
-    "name": "juno",            
+    "name": "juno",
     "chain_id": "localjuno-1",
     "denom": "ujuno",
     "binary": "junod",
@@ -106,7 +107,7 @@ Here is a base chain template with every feature the configuration accepts. Acco
     "gas_prices": "0%DENOM%",
     "gas_adjustment": 2.0,
     "number_vals": 1,
-    "number_node": 0,    
+    "number_node": 0,
     "ibc_paths": ["juno-ibc-1"],
     "debugging": true,
     "block_time": "500ms",
@@ -125,15 +126,15 @@ Here is a base chain template with every feature the configuration accepts. Acco
                 "key": "app_state.gov.deposit_params.min_deposit.0.denom",
                 "value": "ujuno"
             }
-        ],     
+        ],
         "accounts": [
             {
                 "name": "acc0",
                 "address": "juno1efd63aw40lxf3n4mhf7dzhjkr453axurv2zdzk",
                 "amount": "10000000%DENOM%",
                 "mnemonic": "decorate bright ozone fork gallery riot bus exhaust worth way bone indoor calm squirrel merry zero scheme cotton until shop any excess stage laundry"
             }
-        ]                
+        ]
     }
 },
 ```

local-interchain/cmd/local-ic/root.go

@@ -42,7 +42,7 @@ func GetDirectory() string {
 		MakeFileInstallDirectory = path.Join(dirname, "local-interchain")
 	}
 
-	if err := directoryRequirementChecks(MakeFileInstallDirectory, "configs", "chains"); err != nil {
+	if err := directoryRequirementChecks(MakeFileInstallDirectory, "chains"); err != nil {
 		log.Fatal(err)
 	}
 

local-interchain/cmd/local-ic/start_chain.go

@@ -3,14 +3,21 @@ package main
 import (
 	"path"
 	"path/filepath"
+	"strings"
 
 	"github.com/spf13/cobra"
 	"github.com/strangelove-ventures/localinterchain/interchain"
+	"github.com/strangelove-ventures/localinterchain/interchain/types"
 )
 
 const (
 	FlagAPIAddressOverride = "api-address"
 	FlagAPIPortOverride    = "api-port"
+
+	FlagRelayerImage        = "relayer-image"
+	FlagRelayerVersion      = "relayer-version"
+	FlagRelayerUidGid       = "relayer-uidgid"
+	FlagRelayerStartupFlags = "relayer-startup-flags"
 )
 
 var startCmd = &cobra.Command{
@@ -35,14 +42,33 @@ var startCmd = &cobra.Command{
 		apiAddr, _ := cmd.Flags().GetString(FlagAPIAddressOverride)
 		apiPort, _ := cmd.Flags().GetUint16(FlagAPIPortOverride)
 
+		relayerImg := cmd.Flag(FlagRelayerImage).Value.String()
+		relayerVer := cmd.Flag(FlagRelayerVersion).Value.String()
+		relayerUidGid := cmd.Flag(FlagRelayerUidGid).Value.String()
+		relayerFlags := strings.Split(cmd.Flag(FlagRelayerStartupFlags).Value.String(), " ")
+
 		interchain.StartChain(parentDir, configPath, &interchain.AppConfig{
 			Address: apiAddr,
 			Port:    apiPort,
+
+			Relayer: types.Relayer{
+				DockerImage: types.DockerImage{
+					Repository: relayerImg,
+					Version:    relayerVer,
+					UidGid:     relayerUidGid,
+				},
+				StartupFlags: relayerFlags,
+			},
 		})
 	},
 }
 
 func init() {
 	startCmd.Flags().String(FlagAPIAddressOverride, "127.0.0.1", "override the default API address")
 	startCmd.Flags().Uint16(FlagAPIPortOverride, 8080, "override the default API port")
+
+	startCmd.Flags().String(FlagRelayerImage, "ghcr.io/cosmos/relayer", "override the docker relayer image")
+	startCmd.Flags().String(FlagRelayerVersion, "latest", "override the default relayer version")
+	startCmd.Flags().String(FlagRelayerUidGid, "100:1000", "override the default image UID:GID")
+	startCmd.Flags().String(FlagRelayerStartupFlags, "--block-history=100", "override the default relayer startup flags")
 }

local-interchain/interchain/config.go

@@ -43,21 +43,15 @@ func LoadConfig(installDir, chainCfgFile string) (*types.Config, error) {
 	chainsDir := filepath.Join(installDir, "chains")
 	cfgFilePath := filepath.Join(chainsDir, configFile)
 
-	// configs Folder
-	configsDir := filepath.Join(installDir, "configs")
-	relayerFilePath := filepath.Join(configsDir, "relayer.json")
-
 	config, err := loadConfig(config, cfgFilePath)
 	if err != nil {
 		return nil, err
 	}
-	config, _ = loadConfig(config, relayerFilePath)
 
 	log.Println("Using directory:", installDir)
 	log.Println("Using chain config:", cfgFilePath)
 
 	chains := config.Chains
-	relayer := config.Relayer
 
 	for i := range chains {
 		chain := chains[i]
@@ -73,8 +67,6 @@ func LoadConfig(installDir, chainCfgFile string) (*types.Config, error) {
 		}
 	}
 
-	config.Relayer = relayer.SetRelayerDefaults()
-
 	return config, nil
 }
 

local-interchain/interchain/handlers/actions.go

@@ -195,11 +195,13 @@ func (a *actions) relayerCheck(w http.ResponseWriter, r *http.Request) error {
 
 func KillAll(ctx context.Context, ic *interchaintest.Interchain, vals map[string]*cosmos.ChainNode, relayer ibc.Relayer, eRep ibc.RelayerExecReporter) {
 	if relayer != nil {
-		relayer.StopRelayer(ctx, eRep)
+		if err := relayer.StopRelayer(ctx, eRep); err != nil {
+			panic(err)
+		}
 	}
 
 	for _, v := range vals {
-		go v.StopContainer(ctx)
+		go v.StopContainer(ctx) // nolint:errcheck
 	}
 
 	ic.Close()

local-interchain/interchain/logs.go

@@ -14,8 +14,13 @@ import (
 )
 
 func WriteRunningChains(configsDir string, bz []byte) {
-	filepath := filepath.Join(configsDir, "configs", "logs.json")
-	_ = os.WriteFile(filepath, bz, 0644)
+	path := filepath.Join(configsDir, "configs")
+	if _, err := os.Stat(path); os.IsNotExist(err) {
+		os.MkdirAll(path, os.ModePerm)
+	}
+
+	file := filepath.Join(path, "logs.json")
+	_ = os.WriteFile(file, bz, 0644)
 }
 
 func DumpChainsInfoToLogs(configDir string, config *types.Config, chains []ibc.Chain, connections []types.IBCChannel) {

local-interchain/interchain/start.go

@@ -22,6 +22,8 @@ import (
 type AppConfig struct {
 	Address string
 	Port    uint16
+
+	Relayer types.Relayer
 }
 
 func StartChain(installDir, chainCfgFile string, ac *AppConfig) {
@@ -63,6 +65,8 @@ func StartChain(installDir, chainCfgFile string, ac *AppConfig) {
 		}
 	}
 
+	config.Relayer = ac.Relayer
+
 	WriteRunningChains(installDir, []byte("{}"))
 
 	// ibc-path-name -> index of []cosmos.CosmosChain
@@ -151,9 +155,14 @@ func StartChain(installDir, chainCfgFile string, ac *AppConfig) {
 			paths = append(paths, k)
 		}
 
-		relayer.StartRelayer(ctx, eRep, paths...)
+		if err := relayer.StartRelayer(ctx, eRep, paths...); err != nil {
+			log.Fatal("relayer.StartRelayer", err)
+		}
+
 		defer func() {
-			relayer.StopRelayer(ctx, eRep)
+			if err := relayer.StopRelayer(ctx, eRep); err != nil {
+				log.Fatal("relayer.StopRelayer", err)
+			}
 		}()
 	}
 

local-interchain/interchain/types/types.go

@@ -21,6 +21,11 @@ type DockerImage struct {
 	UidGid     string `json:"uid_gid"`
 }
 
+type Relayer struct {
+	DockerImage  DockerImage `json:"docker_image"`
+	StartupFlags []string    `json:"startup_flags"`
+}
+
 type IBCChannel struct {
 	ChainID string             `json:"chain_id"`
 	Channel *ibc.ChannelOutput `json:"channel"`

local-interchain/python/helpers/file_cache.py

@@ -15,6 +15,7 @@ class Cache:
     @staticmethod
     def reset_contracts_cache_json():
         if not os.path.exists(contracts_json_path):
+            os.makedirs(os.path.dirname(contracts_json_path), exist_ok=True)
             with open(contracts_json_path, "w") as f:
                 f.write(json.dumps({"start_time": 0, "file_cache": {}}))
 
@@ -33,6 +34,7 @@ def get_chain_start_time_from_logs() -> int:
     def get_cache_or_default(contracts: dict, ictest_chain_start: int) -> dict:
         cache_time: str | int = 0
         if os.path.exists(contracts_json_path):
+            os.makedirs(os.path.dirname(contracts_json_path), exist_ok=True)
             with open(contracts_json_path, "r") as f:
                 c = dict(json.load(f))
                 cache_time = c.get("start_time", 0)