refactor: reduce ibc relayer resource declarations

bryanchriswhite · bryanchriswhite · commit 779690c7cbdd · 2025-07-02T00:25:51.000+02:00
diff --git a/Tiltfile b/Tiltfile
@@ -24,6 +24,8 @@ def merge_dicts(base, updates):
 # so that if we merge something that passes E2E tests but was not manually validated by the developer, the developer
 # environment is not broken for future engineers.
 
+load("./tiltfiles/ibc.tilt", "default_ibc_validator_configs")
+
 # Create a localnet config file from defaults, and if a default configuration doesn't exist, populate it with default values
 localnet_config_path = "localnet_config.yaml"
 localnet_config_defaults = {
@@ -96,9 +98,7 @@ localnet_config_defaults = {
 
     "ibc": {
         "enabled": False,
-        "relay_pairs_enabled": {
-            "pocket-agoriclocal": False,
-        }
+        "validator_configs": default_ibc_validator_configs,
     }
 }
 
diff --git a/tiltfiles/ibc.tilt b/tiltfiles/ibc.tilt
@@ -1,7 +1,47 @@
 load("ext://helm_resource", "helm_resource", "helm_repo")
 
+pocket_chain_id = "pocket"
+pocket_validator_resource_name = "validator"
+
+default_context_path = os.path.join(".", "localnet", "kubernetes")
 ibc_relayer_dockerfile_path = os.path.join(".", "localnet", "dockerfiles", "ibc-relayer.dockerfile")
-agoric_dockerfile_path = os.path.join(".", "localnet", "dockerfiles", "agoric-validator.dockerfile")
+ibc_relayer_config = {
+    "dockerfile_path": ibc_relayer_dockerfile_path,
+}
+
+default_ibc_validator_configs = {
+    "agoric": {
+        "enabled": False,
+        "chain_id": "agoriclocal",
+        "values_path": os.path.join(".", "localnet", "kubernetes", "values-agoric.yaml"),
+        "tilt_ui_name": "Agoric Validator",
+        "chart_name": "agoric-validator",
+        "dockerfile_path": os.path.join(".", "localnet", "dockerfiles", "agoric-validator.dockerfile"),
+        # TODO_IMPROVE: can we consolidate this with the chart_name?
+        "image_name": "agoric",
+        "port_forwards": ["46657:26657", "11090:9090", "40009:40009", ]
+        # NOTE: this chain ID is baked into the image genesis.json and is difficult to change.
+    }
+}
+
+
+# NOTE: Starlark (tilt) doesn't support multiple kwargs; otherwise,
+# we could simply do `dict(**default_ibc_validator_configs, **ibc_config)`.
+def deep_merge(a, b):
+    result = dict(a)  # shallow copy of a
+
+    for key, b_value in b.items():
+        a_value = a.get(key)
+
+        if type(a_value) == "dict" and type(b_value) == "dict":
+            # Recurse into nested dicts
+            result[key] = deep_merge(a_value, b_value)
+        else:
+            # b overrides a
+            result[key] = b_value
+
+    return result
+
 
 # ⚠️ IBC Disabled Resource
 # - Creates a Tilt resource that prints a message indicating IBC is disabled
@@ -16,111 +56,74 @@ def ibc_disabled_resource(reason):
 # - Loads IBC resources if enabled in config
 # - Otherwise, creates a disabled resource with instructions
 def check_and_load_ibc(chart_prefix, ibc_config):
-    if ibc_config["enabled"]:
-        load_ibc_resources(chart_prefix, ibc_config)
+    if ibc_config.get("enabled", False):
+        load_ibc_resources(chart_prefix, ibc_config["validator_configs"])
     else:
         ibc_disabled_resource(
             "Localnet IBC resources disabled. Set `ibc.enabled` to `true` in `localnet_config.yaml` to enable them.")
 
 
-# Check and Load Agoric
-# - If the pocket-agoriclocal relay pair is enabled:
-#   - Builds Agoric docker image
-#   - Deploys Agoric via Helm/k8s
-#   - Sets up Agoric k8s resource with port-forwards
-def check_and_load_agoric(chart_prefix, ibc_config):
-    if ibc_config["relay_pairs_enabled"].get("pocket-agoriclocal", False):
-        docker_build(
-            "agoric",
-            context=os.path.join(".", "localnet", "kubernetes"),  # needs any folder, less context is faster
-            dockerfile=agoric_dockerfile_path
-        )
-
-        # Deploy helm chart
-        helm_resource(
-            "agoric-validator",
-            chart_prefix + "agoric-validator",
-            flags=[
-                "--values=./localnet/kubernetes/values-agoric.yaml",
-            ],
-            image_deps=["agoric"],
-            image_keys=[("image.repository", "image.tag")],
-        )
+# Load IBC Resources
+# - Loads IBC validator resources if enabled
+# - Builds ibc-relayer docker image if any validator configs are enabled
+# - Iterates through all enabled validator configs and loads relayer resources for each
+def load_ibc_resources(chart_prefix, validator_configs):
+    has_validator_configs = len(validator_configs.keys()) != 0
+    has_enabled_validator_configs = False
+    if has_validator_configs:
+        for validator_config in validator_configs.values():
+            if validator_config.get("enabled", False):
+                has_enabled_validator_configs = True
+                break
+
+    if not validator_configs or not has_validator_configs or not has_enabled_validator_configs:
+        ibc_disabled_resource(
+            "Localnet IBC resources disabled. Set `ibc.validator_configs.<network_name>.enabled` to `true` in `localnet_config.yaml` to enable them.")
+        return
 
-        # Update k8s resource with new name, lebels, and port-forwards
-        k8s_resource(
-            "agoric-validator",
-            # TODO_IN_THIS_COMMIT: consider extracting to const
-            new_name="Agoriclocal Validator",
-            labels=["IBC"],
-            port_forwards=[
-                "46657:26657",
-                "11090:9090",
-                "40009:40009"
-            ],
-        )
+    # Merge default IBC validator configs with the user-provided ones; user-provided configs take precedence.
+    merged_ibc_validator_configs = deep_merge(default_ibc_validator_configs, validator_configs)
 
+    docker_build(
+        "ibc-relayer",
+        context=os.path.join(".", "localnet", "ibc-relayer"),  # needs any folder, doesn't matter
+        dockerfile=ibc_relayer_dockerfile_path)
 
-# Pair Pretty Printer
-# - Converts a pair string like "pocket-agoriclocal" to "Pocket->Agoriclocal"
-def pair_pretty(pair):
-    chain_a_id, chain_b_id = pair.split("-")
-    if chain_a_id == "pocket":
-        chain_a_id = "pokt"
+    load_ibc_relayer_server_resources(chart_prefix, merged_ibc_validator_configs)
 
-    if chain_b_id == "pocket":
-        chain_b_id = "pokt"
+    for ibc_network_name, ibc_validator_config in merged_ibc_validator_configs.items():
+        load_ibc_relayer_setup_resources(chart_prefix, ibc_network_name, ibc_validator_config)
+        check_and_load_ibc_validator(chart_prefix, ibc_validator_config)
 
-    return chain_a_id.title() + "->" + chain_b_id.title()
 
+# Load IBC relayer server resources sets up the hermes relayer for
+# pairs of pocket with each enabled IBC validator.
+def load_ibc_relayer_server_resources(chart_prefix, ibc_validator_configs):
+    resource_deps = [
+        pocket_validator_resource_name,
+    ]
 
-# TODO_IN_THIS_COMMIT: update comment...
-# Load IBC Relayer Server Resources
-# - Sets up the server-side relayer for a given pair
-# - Adds appropriate resource dependencies based on which chain is "pocket"
-def load_ibc_relayer_server_resources(chart_prefix, pairs):
-    resource_deps = []
     chain_config_values_flags = []
-    # DEV_NOTE: starlark (tilt) doesn't support python sets.
-    chain_id_set = {}
-    for pair in pairs:
-        chain_a_id, chain_b_id = pair.split("-")
-        chain_id_set[chain_a_id] = True
-        chain_id_set[chain_b_id] = True
-
-        # TODO_IN_THIS_COMMIT: extract to constant
-        if chain_a_id == "pocket":
-            resource_deps = [
-                "validator",
-                chain_b_id.title() + " Validator",
-            ]
-        elif chain_b_id == "pocket":
-            resource_deps = [
-                # TODO_IN_THIS_COMMIT: extract to constant
-                "validator",
-                chain_a_id.title() + " Validator",
-            ]
-        else:
-            resource_deps = [
-                chain_a_id.title() + "Validator",
-                chain_b_id.title() + "Validator",
-                # TODO_IN_THIS_COMMIT: extract to constant
-                "IBC Setup",
-            ]
-
-    chain_ids = chain_id_set.keys()
-    for chain_id in chain_ids:
+    for network_name, ibc_validator_config in ibc_validator_configs.items():
+        chain_id = ibc_validator_config["chain_id"]
+        tilt_ui_name = "Pokt->" + chain_id.title()
+        ibc_setup_resource_name = "🏗️ " + tilt_ui_name
         chain_config_values_flags.append(
             "--values=" +
             os.path.join("localnet", "kubernetes", "values-ibc-relayer-config-" + chain_id + ".yaml"))
 
+        validator_resource_name = ibc_validator_config.get("tilt_ui_name", chain_id.title() + " Validator")
+        resource_deps.append(validator_resource_name)
+        resource_deps.append(ibc_setup_resource_name)
+
     # Deploy helm chart
     helm_resource(
         "ibc-relayer",
         chart_prefix + "ibc-relayer",
         flags=[
                   "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-common.yaml"),
                   "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-daemon.yaml"),
+                  "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-config-" + pocket_chain_id + ".yaml"),
               ] + chain_config_values_flags,
         resource_deps=resource_deps,
         image_deps=["ibc-relayer"],
@@ -139,36 +142,27 @@ def load_ibc_relayer_server_resources(chart_prefix, pairs):
 # Load IBC Relayer Setup Resource
 # - Sets up the CLI/setup resource for a given pair
 # - Adds appropriate resource dependencies based on which chain is "pocket"
-def load_ibc_relayer_setup_resources(chart_prefix, pair):
-    # TODO_IN_THIS_COMMIT: rename to chain_one_id and chain_two_id to disambiguate with a, b, c, d used elsewhere.
-    chain_a_id, chain_b_id = pair.split("-")
-    if chain_a_id == "pocket":
-        resource_deps = [
-            "validator",
-            chain_b_id.title() + " Validator",
-        ]
-    elif chain_b_id == "pocket":
-        resource_deps = [
-            "validator",
-            chain_a_id.title() + " Validator",
-        ]
-    else:
-        resource_deps = [
-            chain_a_id.title() + " Validator",
-            chain_b_id.title() + " Validator",
-        ]
+def load_ibc_relayer_setup_resources(chart_prefix, network_name, validator_config):
+    chain_id = validator_config["chain_id"]
+    tilt_ui_name = "Pokt->" + network_name.title()
+    validator_resource_name = validator_config.get("tilt_ui_name", chain_id.title() + " Validator")
+    resource_deps = [
+        pocket_validator_resource_name,
+        validator_resource_name,
+    ]
 
     # Deploy helm chart
     helm_resource(
-        "ibc-relayer-setup-" + pair,
+        "ibc-relayer-setup-" + network_name,
         chart_prefix + "ibc-relayer",
         flags=[
             "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-common.yaml"),
             "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-cli.yaml"),
-            "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-config-" + chain_a_id + ".yaml"),
-            "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-config-" + chain_b_id + ".yaml"),
-            "--set=chain_a_id=" + chain_a_id,
-            "--set=chain_b_id=" + chain_b_id
+            "--values=" + os.path.join("localnet", "kubernetes",
+                                       "values-ibc-relayer-config-" + pocket_chain_id + ".yaml"),
+            "--values=" + os.path.join("localnet", "kubernetes", "values-ibc-relayer-config-" + chain_id + ".yaml"),
+            "--set=chain_a_id=" + pocket_chain_id,
+            "--set=chain_b_id=" + chain_id
         ],
         resource_deps=resource_deps,
         image_deps=["ibc-relayer"],
@@ -179,30 +173,61 @@ def load_ibc_relayer_setup_resources(chart_prefix, pair):
     # port-forwards, and the manual trigger mode.
     k8s_resource(
         # workload=release_name,
-        "ibc-relayer-setup-" + pair,
-        new_name="🏗️ " + pair_pretty(pair),
+        "ibc-relayer-setup-" + network_name,
+        new_name="🏗️ " + tilt_ui_name,
         labels=["IBC_Pairs_Setup"],
         trigger_mode=TRIGGER_MODE_MANUAL,
         resource_deps=resource_deps,
     )
 
 
-# Load IBC Resources
-# - Loads Agoric resources if enabled
-# - Builds ibc-relayer docker image if any relay pairs are enabled
-# - Iterates through all enabled relay pairs and loads relayer resources for each
-def load_ibc_resources(chart_prefix, ibc_config):
-    check_and_load_agoric(chart_prefix, ibc_config)
+# Check and load the given IBC validator
+# - If the given validator config is enabled:
+#   - Builds validator docker image
+#   - Deploys up validator k8s resource with port-forwards
+def check_and_load_ibc_validator(chart_prefix, validator_config):
+    if not validator_config.get("enabled", False):
+        return
+
+    image_deps_and_keys = {}
+    if validator_config.get("dockerfile_path", False):
+        image_name = validator_config["image_name"]
+        context_path = validator_config.get("context", default_context_path)
+        dockerfile_path = validator_config.get("dockerfile_path", None)
+
+        image_deps_and_keys = {
+            "image_deps": [image_name],
+            "image_keys": [("image.repository", "image.tag")],
+        }
 
-    if len(ibc_config["relay_pairs_enabled"]) > 0:
         docker_build(
-            "ibc-relayer",
-            context=os.path.join(".", "localnet", "ibc-relayer"),  # needs any folder, doesn't matter
-            dockerfile=ibc_relayer_dockerfile_path)
+            image_name,
+            context=context_path,
+            dockerfile=dockerfile_path
+        )
 
-        pairs = [key for (key, val) in ibc_config["relay_pairs_enabled"].items() if val == True]
-        load_ibc_relayer_server_resources(chart_prefix, pairs)
+    # TODO_IMPROVE: consider computing a default chart_name.
+    chain_id = validator_config["chain_id"]
+    chart_name = validator_config["chart_name"]
+    values_path = validator_config["values_path"]
+    port_forwards = validator_config["port_forwards"]
+    # Tilt UI name defaults to the titlized chain ID plus "Validator" (e.g. "Agoriclocal Validator")
+    tilt_ui_name = validator_config.get("tilt_ui_name", chain_id.title() + " Validator")
 
-    for pair, enabled in ibc_config["relay_pairs_enabled"].items():
-        if enabled:
-            load_ibc_relayer_setup_resources(chart_prefix, pair)
+    # Deploy helm chart
+    helm_resource(
+        chart_name,
+        chart_prefix + chart_name,
+        flags=[
+            "--values=" + values_path,
+        ],
+        **image_deps_and_keys,
+    )
+
+    # Update k8s resource with new name, lebels, and port-forwards
+    k8s_resource(
+        chart_name,
+        new_name=tilt_ui_name,
+        labels=["IBC"],
+        port_forwards=port_forwards,
+    )
